libguac  0.9.0
 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 "socket.h"
35 
39 #define GUAC_INSTRUCTION_MAX_LENGTH 8192
40 
44 #define GUAC_INSTRUCTION_MAX_DIGITS 5
45 
49 #define GUAC_INSTRUCTION_MAX_ELEMENTS 64
50 
55 
61 
67 
72 
77 
79 
83 typedef struct guac_instruction {
84 
88  char* opcode;
89 
93  int argc;
94 
98  char** argv;
99 
104 
108  int __element_length;
109 
113  int __elementc;
114 
118  char* __elementv[GUAC_INSTRUCTION_MAX_ELEMENTS];
119 
121 
130 
137 void guac_instruction_reset(guac_instruction* instruction);
138 
154  void* buffer, int length);
155 
161 void guac_instruction_free(guac_instruction* instruction);
162 
173 int guac_instruction_waiting(guac_socket* socket, int usec_timeout);
174 
191 guac_instruction* guac_instruction_read(guac_socket* socket, int usec_timeout);
192 
213  int usec_timeout, const char* opcode);
214 
215 #endif
216