| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <title>libguac: guacamole/client.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">libguac |
|  <span id="projectnumber">0.8.2</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.1.2 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>Globals</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">client.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* ***** BEGIN LICENSE BLOCK *****</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Version: MPL 1.1/GPL 2.0/LGPL 2.1</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The contents of this file are subject to the Mozilla Public License Version</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * 1.1 (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.mozilla.org/MPL/</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Software distributed under the License is distributed on an "AS IS" basis,</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * for the specific language governing rights and limitations under the</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * License.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * The Original Code is libguac.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * The Initial Developer of the Original Code is</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Michael Jumper.</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Portions created by the Initial Developer are Copyright (C) 2010</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * the Initial Developer. All Rights Reserved.</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Contributor(s):</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Alternatively, the contents of this file may be used under the terms of</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * either the GNU General Public License Version 2 or later (the "GPL"), or</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * in which case the provisions of the GPL or the LGPL are applicable instead</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * of those above. If you wish to allow use of your version of this file only</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * under the terms of either the GPL or the LGPL, and not to allow others to</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * use your version of this file under the terms of the MPL, indicate your</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * decision by deleting the provisions above and replace them with the notice</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * and other provisions required by the GPL or the LGPL. If you do not delete</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * the provisions above, a recipient may use your version of this file under</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * the terms of any one of the MPL, the GPL or the LGPL.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * ***** END LICENSE BLOCK ***** */</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef _GUAC_CLIENT_H</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define _GUAC_CLIENT_H</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <stdarg.h></span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "<a class="code" href="instruction_8h.html" title="Provides functions and structures for reading, writing, and manipulating Guacamole instructions...">instruction.h</a>"</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include "<a class="code" href="layer_8h.html" title="Provides functions and structures required for allocating and using layers.">layer.h</a>"</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="pool_8h.html" title="Provides functions and structures for maintaining dynamically allocated and freed pools of integers...">pool.h</a>"</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Defines the guac_socket object and functionss for using and manipulating it.">socket.h</a>"</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include "<a class="code" href="stream_8h.html" title="Provides functions and structures required for allocating and using nested streams.">stream.h</a>"</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include "<a class="code" href="timestamp_8h.html" title="Provides functions and structures for creating timestamps.">timestamp.h</a>"</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> <a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>;</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="client_8h.html#abf18878fb969a93415805ea80b503d6d"> 63</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#abf18878fb969a93415805ea80b503d6d" title="Handler for server messages (where "server" refers to the server that the proxy client is connected t...">guac_client_handle_messages</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="client_8h.html#a1724a9f56ab5d8f8d562b14a4602dcf3"> 68</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a1724a9f56ab5d8f8d562b14a4602dcf3" title="Handler for Guacamole mouse events.">guac_client_mouse_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> button_mask);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"><a class="code" href="client_8h.html#a5bab062cc67cf64b963f65fe6e910c15"> 73</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a5bab062cc67cf64b963f65fe6e910c15" title="Handler for Guacamole key events.">guac_client_key_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">int</span> keysym, <span class="keywordtype">int</span> pressed);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="client_8h.html#a575ee65a0ae00edcacac3c86fc3af7bd"> 78</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a575ee65a0ae00edcacac3c86fc3af7bd" title="Handler for Guacamole clipboard events.">guac_client_clipboard_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">char</span>* copied);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="client_8h.html#acd660ba1aa9f6fae07d3d36abb23bca8"> 83</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#acd660ba1aa9f6fae07d3d36abb23bca8" title="Handler for Guacamole screen size events.">guac_client_size_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client,</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height);</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="client_8h.html#a6ebaeac958d4feabe9f7f9a22252d629"> 89</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a6ebaeac958d4feabe9f7f9a22252d629" title="Handler for Guacamole audio format events.">guac_client_audio_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">char</span>* mimetype);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="client_8h.html#a686d2e7cc6ec5800aef1fb8034c8fa21"> 94</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a686d2e7cc6ec5800aef1fb8034c8fa21" title="Handler for Guacamole video format events.">guac_client_video_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">char</span>* mimetype);</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="client_8h.html#a7f8c6986f3db9818d016eee6fa562577"> 100</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a7f8c6986f3db9818d016eee6fa562577" title="Handler for freeing up any extra data allocated by the client implementation.">guac_client_free_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> |
| <div class="line"><a name="l00105"></a><span class="lineno"><a class="code" href="client_8h.html#a74756e90266493c7cd3ae009c8c1c717"> 105</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a74756e90266493c7cd3ae009c8c1c717" title="Handler for logging messages.">guac_client_log_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, va_list args); </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> |
| <div class="line"><a name="l00110"></a><span class="lineno"><a class="code" href="client_8h.html#a803471317059958932af72f632928ff4"> 110</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a803471317059958932af72f632928ff4" title="Handler which should initialize the given guac_client.">guac_client_init_handler</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv);</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="client_8h.html#a4bb4f5b852ac8c3e2d3c89cd5e63efd2"> 115</a></span> <span class="preprocessor">#define GUAC_CLIENT_MOUSE_LEFT 0x01</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00120"></a><span class="lineno"><a class="code" href="client_8h.html#ad14c5f1800aac863bbebcd676c5c2124"> 120</a></span> <span class="preprocessor">#define GUAC_CLIENT_MOUSE_MIDDLE 0x02</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00125"></a><span class="lineno"><a class="code" href="client_8h.html#a88917d2d7143a483c219eee62fd6317f"> 125</a></span> <span class="preprocessor">#define GUAC_CLIENT_MOUSE_RIGHT 0x04</span></div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00134"></a><span class="lineno"><a class="code" href="client_8h.html#a134afd8a0d8f10a34af51fc70981e39d"> 134</a></span> <span class="preprocessor">#define GUAC_CLIENT_MOUSE_SCROLL_UP 0x08</span></div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"><a class="code" href="client_8h.html#a771231574e9d303aa08fc1cecc9069f0"> 143</a></span> <span class="preprocessor">#define GUAC_CLIENT_MOUSE_SCROLL_DOWN 0x10</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"><a class="code" href="client_8h.html#aa8a296e1032ff408ab141b0765fb9bfb"> 151</a></span> <span class="preprocessor">#define GUAC_BUFFER_POOL_INITIAL_SIZE 1024</span></div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00157"></a><span class="lineno"><a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3b"> 157</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3b" title="Possible current states of the Guacamole client.">guac_client_state</a> {</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> |
| <div class="line"><a name="l00163"></a><span class="lineno"><a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3bad1ddb6f9bcfcd89a9d8522acfd74d2b0"> 163</a></span>  <a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3bad1ddb6f9bcfcd89a9d8522acfd74d2b0" title="The state of the client from when it has been allocated by the main daemon until it is killed or disc...">GUAC_CLIENT_RUNNING</a>,</div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div> |
| <div class="line"><a name="l00169"></a><span class="lineno"><a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3ba5a21704bd35c396c4c640e0b1fc0c8fd"> 169</a></span>  <a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3ba5a21704bd35c396c4c640e0b1fc0c8fd" title="The state of the client when a stop has been requested, signalling the I/O threads to shutdown...">GUAC_CLIENT_STOPPING</a></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> } <a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3b" title="Possible current states of the Guacamole client.">guac_client_state</a>;</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div> |
| <div class="line"><a name="l00177"></a><span class="lineno"><a class="code" href="structguac__client__info.html"> 177</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structguac__client__info.html" title="Information exposed by the remote client during the connection handshake which can be used by a clien...">guac_client_info</a> {</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div> |
| <div class="line"><a name="l00185"></a><span class="lineno"><a class="code" href="structguac__client__info.html#aed4ddf74fa55fe039f38225c3373f25b"> 185</a></span>  <span class="keywordtype">int</span> <a class="code" href="structguac__client__info.html#aed4ddf74fa55fe039f38225c3373f25b" title="The number of pixels the remote client requests for the display width.">optimal_width</a>;</div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div> |
| <div class="line"><a name="l00193"></a><span class="lineno"><a class="code" href="structguac__client__info.html#a58c3084b5e6b40ad43956562764d8732"> 193</a></span>  <span class="keywordtype">int</span> <a class="code" href="structguac__client__info.html#a58c3084b5e6b40ad43956562764d8732" title="The number of pixels the remote client requests for the display height.">optimal_height</a>;</div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div> |
| <div class="line"><a name="l00199"></a><span class="lineno"><a class="code" href="structguac__client__info.html#a662fb7d39af7bddcb2f5c83a6b54f923"> 199</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** <a class="code" href="structguac__client__info.html#a662fb7d39af7bddcb2f5c83a6b54f923" title="NULL-terminated array of client-supported audio mimetypes.">audio_mimetypes</a>;</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div> |
| <div class="line"><a name="l00205"></a><span class="lineno"><a class="code" href="structguac__client__info.html#a8b5c9d593d6a6a5deaeadbe2973b9fe8"> 205</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** <a class="code" href="structguac__client__info.html#a8b5c9d593d6a6a5deaeadbe2973b9fe8" title="NULL-terminated array of client-supported video mimetypes.">video_mimetypes</a>;</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> } <a class="code" href="structguac__client__info.html" title="Information exposed by the remote client during the connection handshake which can be used by a clien...">guac_client_info</a>;</div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div> |
| <div class="line"><a name="l00215"></a><span class="lineno"><a class="code" href="structguac__client.html"> 215</a></span> <span class="keyword">struct </span><a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> {</div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div> |
| <div class="line"><a name="l00224"></a><span class="lineno"><a class="code" href="structguac__client.html#aa634856fd3c522377ba7345f3308000e"> 224</a></span>  <a class="code" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a>* <a class="code" href="structguac__client.html#aa634856fd3c522377ba7345f3308000e" title="The guac_socket structure to be used to communicate with the web-client.">socket</a>;</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div> |
| <div class="line"><a name="l00232"></a><span class="lineno"><a class="code" href="structguac__client.html#acb3e3f5d0ce5726cdde768f97b473f53"> 232</a></span>  <a class="code" href="client_8h.html#a6f7e91d6dcb20598953948f077910c3b" title="Possible current states of the Guacamole client.">guac_client_state</a> <a class="code" href="structguac__client.html#acb3e3f5d0ce5726cdde768f97b473f53" title="The current state of the client.">state</a>;</div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div> |
| <div class="line"><a name="l00238"></a><span class="lineno"><a class="code" href="structguac__client.html#a3c8e4b4a92bdeaace0fa2dd32f956ab2"> 238</a></span>  <a class="code" href="timestamp_8h.html#a69e916d1ff324fbe0e527f32359c9cea" title="An arbitrary timestamp denoting a relative time value in milliseconds.">guac_timestamp</a> <a class="code" href="structguac__client.html#a3c8e4b4a92bdeaace0fa2dd32f956ab2" title="The time (in milliseconds) of receipt of the last sync message from the client.">last_received_timestamp</a>;</div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div> |
| <div class="line"><a name="l00244"></a><span class="lineno"><a class="code" href="structguac__client.html#a0f3069566c7a5ca76ce4369715589dad"> 244</a></span>  <a class="code" href="timestamp_8h.html#a69e916d1ff324fbe0e527f32359c9cea" title="An arbitrary timestamp denoting a relative time value in milliseconds.">guac_timestamp</a> <a class="code" href="structguac__client.html#a0f3069566c7a5ca76ce4369715589dad" title="The time (in milliseconds) that the last sync message was sent to the client.">last_sent_timestamp</a>;</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div> |
| <div class="line"><a name="l00250"></a><span class="lineno"><a class="code" href="structguac__client.html#ab67a82a9f940360dac0ec0ca96d446cf"> 250</a></span>  <a class="code" href="structguac__client__info.html" title="Information exposed by the remote client during the connection handshake which can be used by a clien...">guac_client_info</a> <a class="code" href="structguac__client.html#ab67a82a9f940360dac0ec0ca96d446cf" title="Information structure containing properties exposed by the remote client during the initial handshake...">info</a>;</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div> |
| <div class="line"><a name="l00257"></a><span class="lineno"><a class="code" href="structguac__client.html#a0569bc7eea8d37b5bd95bcd3821ca0a3"> 257</a></span>  <span class="keywordtype">void</span>* <a class="code" href="structguac__client.html#a0569bc7eea8d37b5bd95bcd3821ca0a3" title="Arbitrary reference to proxy client-specific data.">data</a>;</div> |
| <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div> |
| <div class="line"><a name="l00273"></a><span class="lineno"><a class="code" href="structguac__client.html#a75a6618618ff90b6ade14c750f7d3343"> 273</a></span>  <a class="code" href="client_8h.html#abf18878fb969a93415805ea80b503d6d" title="Handler for server messages (where "server" refers to the server that the proxy client is connected t...">guac_client_handle_messages</a>* <a class="code" href="structguac__client.html#a75a6618618ff90b6ade14c750f7d3343" title="Handler for server messages.">handle_messages</a>;</div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div> |
| <div class="line"><a name="l00300"></a><span class="lineno"><a class="code" href="structguac__client.html#a13f56570676f29a6f463e1542e156416"> 300</a></span>  <a class="code" href="client_8h.html#a1724a9f56ab5d8f8d562b14a4602dcf3" title="Handler for Guacamole mouse events.">guac_client_mouse_handler</a>* <a class="code" href="structguac__client.html#a13f56570676f29a6f463e1542e156416" title="Handler for mouse events sent by the Gaucamole web-client.">mouse_handler</a>;</div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div> |
| <div class="line"><a name="l00318"></a><span class="lineno"><a class="code" href="structguac__client.html#ac0ed2c84d5aa62c435e8024310812259"> 318</a></span>  <a class="code" href="client_8h.html#a5bab062cc67cf64b963f65fe6e910c15" title="Handler for Guacamole key events.">guac_client_key_handler</a>* <a class="code" href="structguac__client.html#ac0ed2c84d5aa62c435e8024310812259" title="Handler for key events sent by the Guacamole web-client.">key_handler</a>;</div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> </div> |
| <div class="line"><a name="l00339"></a><span class="lineno"><a class="code" href="structguac__client.html#addf8b9aeb379e6132797f2b7000fb0d1"> 339</a></span>  <a class="code" href="client_8h.html#a575ee65a0ae00edcacac3c86fc3af7bd" title="Handler for Guacamole clipboard events.">guac_client_clipboard_handler</a>* <a class="code" href="structguac__client.html#addf8b9aeb379e6132797f2b7000fb0d1" title="Handler for clipboard events sent by the Guacamole web-client.">clipboard_handler</a>;</div> |
| <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> </div> |
| <div class="line"><a name="l00356"></a><span class="lineno"><a class="code" href="structguac__client.html#a9768d046d71ad0e81746fa0bffc08092"> 356</a></span>  <a class="code" href="client_8h.html#acd660ba1aa9f6fae07d3d36abb23bca8" title="Handler for Guacamole screen size events.">guac_client_size_handler</a>* <a class="code" href="structguac__client.html#a9768d046d71ad0e81746fa0bffc08092" title="Handler for size events sent by the Guacamole web-client.">size_handler</a>;</div> |
| <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> </div> |
| <div class="line"><a name="l00379"></a><span class="lineno"><a class="code" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169"> 379</a></span>  <a class="code" href="client_8h.html#a7f8c6986f3db9818d016eee6fa562577" title="Handler for freeing up any extra data allocated by the client implementation.">guac_client_free_handler</a>* <a class="code" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169" title="Handler for freeing data when the client is being unloaded.">free_handler</a>;</div> |
| <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> </div> |
| <div class="line"><a name="l00403"></a><span class="lineno"><a class="code" href="structguac__client.html#a055d63be9770e614c7abb2dfc5a8fb0c"> 403</a></span>  <a class="code" href="client_8h.html#a74756e90266493c7cd3ae009c8c1c717" title="Handler for logging messages.">guac_client_log_handler</a>* <a class="code" href="structguac__client.html#a055d63be9770e614c7abb2dfc5a8fb0c" title="Handler for logging informational messages.">log_info_handler</a>;</div> |
| <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> </div> |
| <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> </div> |
| <div class="line"><a name="l00428"></a><span class="lineno"><a class="code" href="structguac__client.html#a59c74b12d77ead505b4e94ba169b2fdf"> 428</a></span>  <a class="code" href="client_8h.html#a74756e90266493c7cd3ae009c8c1c717" title="Handler for logging messages.">guac_client_log_handler</a>* <a class="code" href="structguac__client.html#a59c74b12d77ead505b4e94ba169b2fdf" title="Handler for logging error messages.">log_error_handler</a>;</div> |
| <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> </div> |
| <div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  <a class="code" href="structguac__pool.html" title="A pool of integers.">guac_pool</a>* __buffer_pool;</div> |
| <div class="line"><a name="l00436"></a><span class="lineno"> 436</span> </div> |
| <div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  <a class="code" href="structguac__pool.html" title="A pool of integers.">guac_pool</a>* __layer_pool;</div> |
| <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> </div> |
| <div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <a class="code" href="structguac__pool.html" title="A pool of integers.">guac_pool</a>* __stream_pool;</div> |
| <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> </div> |
| <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> };</div> |
| <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> </div> |
| <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* <a class="code" href="client_8h.html#a33bad42d21ccb561aa71c4f04ae9b22a" title="Returns a new, barebones guac_client.">guac_client_alloc</a>();</div> |
| <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> </div> |
| <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a76cdc454a23fdcbb70d56f923f6b6427" title="Free all resources associated with the given client.">guac_client_free</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00465"></a><span class="lineno"> 465</span> </div> |
| <div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="keywordtype">int</span> <a class="code" href="client_8h.html#a5ed968b0cdbdd8ef0c22ae94d803449c" title="Call the appropriate handler defined by the given client for the given instruction.">guac_client_handle_instruction</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <a class="code" href="structguac__instruction.html" title="Represents a single instruction within the Guacamole protocol.">guac_instruction</a>* instruction);</div> |
| <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> </div> |
| <div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a1e461c0f2d8d13a89310cd1a37ab41df" title="Logs an informational message in the log used by the given client.">guac_client_log_info</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div> |
| <div class="line"><a name="l00489"></a><span class="lineno"> 489</span> </div> |
| <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a23df81a823e4be52c9aa3c9ca1975ed6" title="Logs an error message in the log used by the given client.">guac_client_log_error</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div> |
| <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> </div> |
| <div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a7a7e5b6218aae4481b46b654aae9cd3d" title="Logs an informational message in the log used by the given client.">vguac_client_log_info</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, va_list ap);</div> |
| <div class="line"><a name="l00514"></a><span class="lineno"> 514</span> </div> |
| <div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#ab4f03b7549828c5486375e5da83775ae" title="Logs an error message in the log used by the given client.">vguac_client_log_error</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, va_list ap);</div> |
| <div class="line"><a name="l00527"></a><span class="lineno"> 527</span> </div> |
| <div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a022d4b5587c84f2963b176ab7999aa1b" title="Signals the given client to stop gracefully.">guac_client_stop</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00536"></a><span class="lineno"> 536</span> </div> |
| <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <a class="code" href="structguac__layer.html" title="Represents a single layer within the Guacamole protocol.">guac_layer</a>* <a class="code" href="client_8h.html#af661d3fedd9683631bdc7d1e3205e379" title="Allocates a new buffer (invisible layer).">guac_client_alloc_buffer</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00545"></a><span class="lineno"> 545</span> </div> |
| <div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <a class="code" href="structguac__layer.html" title="Represents a single layer within the Guacamole protocol.">guac_layer</a>* <a class="code" href="client_8h.html#a2085758db585bb9d09d3860ec0fc9587" title="Allocates a new layer.">guac_client_alloc_layer</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> </div> |
| <div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#afc03a32b3113d9a95700cac54f1cbd4b" title="Returns the given buffer to the pool of available buffers, such that it can be reused by any subseque...">guac_client_free_buffer</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <a class="code" href="structguac__layer.html" title="Represents a single layer within the Guacamole protocol.">guac_layer</a>* layer);</div> |
| <div class="line"><a name="l00563"></a><span class="lineno"> 563</span> </div> |
| <div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#a4e5b374211012d1897792335112dcb89" title="Returns the given layer to the pool of available layers, such that it can be reused by any subsequent...">guac_client_free_layer</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <a class="code" href="structguac__layer.html" title="Represents a single layer within the Guacamole protocol.">guac_layer</a>* layer);</div> |
| <div class="line"><a name="l00572"></a><span class="lineno"> 572</span> </div> |
| <div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <a class="code" href="structguac__stream.html" title="Represents a single nested stream within the Guacamole protocol.">guac_stream</a>* <a class="code" href="client_8h.html#a1bea3499e21736b4ea0fb949d3bc8ab9" title="Allocates a new stream.">guac_client_alloc_stream</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client);</div> |
| <div class="line"><a name="l00581"></a><span class="lineno"> 581</span> </div> |
| <div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="keywordtype">void</span> <a class="code" href="client_8h.html#af0103a5aae8ba76badd2e68e827f6782" title="Returns the given stream to the pool of available streams, such that it can be reused by any subseque...">guac_client_free_stream</a>(<a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <a class="code" href="structguac__stream.html" title="Represents a single nested stream within the Guacamole protocol.">guac_stream</a>* stream);</div> |
| <div class="line"><a name="l00590"></a><span class="lineno"> 590</span> </div> |
| <div class="line"><a name="l00591"></a><span class="lineno"> 591</span> </div> |
| <div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structguac__layer.html" title="Represents a single layer within the Guacamole protocol.">guac_layer</a>* <a class="code" href="client_8h.html#a336a485c006394d5eea88bf6d8d422d8" title="The default Guacamole client layer, layer 0.">GUAC_DEFAULT_LAYER</a>;</div> |
| <div class="line"><a name="l00596"></a><span class="lineno"> 596</span> </div> |
| <div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="preprocessor">#endif</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Fri Mar 28 2014 21:41:58 for libguac by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.1.2 |
| </small></address> |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-75289145-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script> |
| <!-- End Google Analytics --> |
| </body> |
| </html> |
