libguac  0.9.5
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
instruction.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2013 Glyptodon LLC
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 
24 #ifndef _GUAC_INSTRUCTION_H
25 #define _GUAC_INSTRUCTION_H
26 
34 #include "instruction-types.h"
35 #include "instruction-constants.h"
36 #include "socket-types.h"
37 
39 
43  char* opcode;
44 
48  int argc;
49 
53  char** argv;
54 
59 
63  int __element_length;
64 
68  int __elementc;
69 
73  char* __elementv[GUAC_INSTRUCTION_MAX_ELEMENTS];
74 
75 };
76 
85 
92 void guac_instruction_reset(guac_instruction* instruction);
93 
109  void* buffer, int length);
110 
116 void guac_instruction_free(guac_instruction* instruction);
117 
128 int guac_instruction_waiting(guac_socket* socket, int usec_timeout);
129 
146 guac_instruction* guac_instruction_read(guac_socket* socket, int usec_timeout);
147 
168  int usec_timeout, const char* opcode);
169 
170 #endif
171 
guac_instruction * guac_instruction_read(guac_socket *socket, int usec_timeout)
Reads a single instruction from the given guac_socket connection.
void guac_instruction_reset(guac_instruction *instruction)
Resets the parse state and contents of the given instruction, such that the memory of that instructio...
guac_instruction_parse_state
All possible states of the instruction parser.
Definition: instruction-types.h:36
Constants related to Guacamole instructions.
Type definitions related to the guac_socket object.
char * opcode
The opcode of the instruction.
Definition: instruction.h:43
void guac_instruction_free(guac_instruction *instruction)
Frees all memory allocated to the given instruction.
The core I/O object of Guacamole.
Definition: socket.h:41
guac_instruction * guac_instruction_alloc()
Allocates a new instruction.
int argc
The number of arguments passed to this instruction.
Definition: instruction.h:48
int guac_instruction_waiting(guac_socket *socket, int usec_timeout)
Returns whether new instruction data is available on the given guac_socket connection for parsing...
guac_instruction * guac_instruction_expect(guac_socket *socket, int usec_timeout, const char *opcode)
Reads a single instruction with the given opcode from the given guac_socket connection.
char ** argv
Array of all arguments passed to this instruction.
Definition: instruction.h:53
#define GUAC_INSTRUCTION_MAX_ELEMENTS
The maximum number of elements per instruction, including the opcode.
Definition: instruction-constants.h:45
int guac_instruction_append(guac_instruction *instruction, void *buffer, int length)
Appends data from the given buffer to the given instruction.
guac_instruction_parse_state state
The parse state of the instruction.
Definition: instruction.h:58
Type definitions related to Guacamole instructions.
Represents a single instruction within the Guacamole protocol.
Definition: instruction.h:38