| <!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"/> |
| <meta name="generator" content="Doxygen 1.8.14"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>libguac: guac_client Struct Reference</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/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">libguac |
|  <span id="projectnumber">1.1.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.14 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </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><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Data Fields</a> </div> |
| <div class="headertitle"> |
| <div class="title">guac_client Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Guacamole proxy client. |
| <a href="structguac__client.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:aa634856fd3c522377ba7345f3308000e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__socket.html">guac_socket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#aa634856fd3c522377ba7345f3308000e">socket</a></td></tr> |
| <tr class="memdesc:aa634856fd3c522377ba7345f3308000e"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> structure to be used to communicate with all connected web-clients (users). <a href="#aa634856fd3c522377ba7345f3308000e">More...</a><br /></td></tr> |
| <tr class="separator:aa634856fd3c522377ba7345f3308000e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb3e3f5d0ce5726cdde768f97b473f53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3b">guac_client_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#acb3e3f5d0ce5726cdde768f97b473f53">state</a></td></tr> |
| <tr class="memdesc:acb3e3f5d0ce5726cdde768f97b473f53"><td class="mdescLeft"> </td><td class="mdescRight">The current state of the client. <a href="#acb3e3f5d0ce5726cdde768f97b473f53">More...</a><br /></td></tr> |
| <tr class="separator:acb3e3f5d0ce5726cdde768f97b473f53"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0569bc7eea8d37b5bd95bcd3821ca0a3"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a0569bc7eea8d37b5bd95bcd3821ca0a3">data</a></td></tr> |
| <tr class="memdesc:a0569bc7eea8d37b5bd95bcd3821ca0a3"><td class="mdescLeft"> </td><td class="mdescRight">Arbitrary reference to proxy client-specific data. <a href="#a0569bc7eea8d37b5bd95bcd3821ca0a3">More...</a><br /></td></tr> |
| <tr class="separator:a0569bc7eea8d37b5bd95bcd3821ca0a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f3069566c7a5ca76ce4369715589dad"><td class="memItemLeft" align="right" valign="top"><a id="a0f3069566c7a5ca76ce4369715589dad"></a> |
| <a class="el" href="timestamp-types_8h.html#a69e916d1ff324fbe0e527f32359c9cea">guac_timestamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a0f3069566c7a5ca76ce4369715589dad">last_sent_timestamp</a></td></tr> |
| <tr class="memdesc:a0f3069566c7a5ca76ce4369715589dad"><td class="mdescLeft"> </td><td class="mdescRight">The time (in milliseconds) that the last sync message was sent to the client. <br /></td></tr> |
| <tr class="separator:a0f3069566c7a5ca76ce4369715589dad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79e29c931fd448cf51f7153fea064169"><td class="memItemLeft" align="right" valign="top"><a class="el" href="client-fntypes_8h.html#a7f8c6986f3db9818d016eee6fa562577">guac_client_free_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169">free_handler</a></td></tr> |
| <tr class="memdesc:a79e29c931fd448cf51f7153fea064169"><td class="mdescLeft"> </td><td class="mdescRight">Handler for freeing data when the client is being unloaded. <a href="#a79e29c931fd448cf51f7153fea064169">More...</a><br /></td></tr> |
| <tr class="separator:a79e29c931fd448cf51f7153fea064169"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3eb24ba13be9ecb3a8c6f64a73932f43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="client-fntypes_8h.html#a23837e22dbfe152719d596e6918bad3c">guac_client_log_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a3eb24ba13be9ecb3a8c6f64a73932f43">log_handler</a></td></tr> |
| <tr class="memdesc:a3eb24ba13be9ecb3a8c6f64a73932f43"><td class="mdescLeft"> </td><td class="mdescRight">Logging handler. <a href="#a3eb24ba13be9ecb3a8c6f64a73932f43">More...</a><br /></td></tr> |
| <tr class="separator:a3eb24ba13be9ecb3a8c6f64a73932f43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad38b9ded1f04bfe8eb235e551fc08094"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#ad38b9ded1f04bfe8eb235e551fc08094">connection_id</a></td></tr> |
| <tr class="memdesc:ad38b9ded1f04bfe8eb235e551fc08094"><td class="mdescLeft"> </td><td class="mdescRight">The unique identifier allocated for the connection, which may be used within the Guacamole protocol to refer to this connection. <a href="#ad38b9ded1f04bfe8eb235e551fc08094">More...</a><br /></td></tr> |
| <tr class="separator:ad38b9ded1f04bfe8eb235e551fc08094"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a73aeff08af6cf6cadd7abce74c7ff4b2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a73aeff08af6cf6cadd7abce74c7ff4b2">connected_users</a></td></tr> |
| <tr class="memdesc:a73aeff08af6cf6cadd7abce74c7ff4b2"><td class="mdescLeft"> </td><td class="mdescRight">The number of currently-connected users. <a href="#a73aeff08af6cf6cadd7abce74c7ff4b2">More...</a><br /></td></tr> |
| <tr class="separator:a73aeff08af6cf6cadd7abce74c7ff4b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0adcf1953de6c315c2da9dac4b3eceb3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="user-fntypes_8h.html#a88717a7ab29ac1e4a853fcc2caa8f872">guac_user_join_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a0adcf1953de6c315c2da9dac4b3eceb3">join_handler</a></td></tr> |
| <tr class="memdesc:a0adcf1953de6c315c2da9dac4b3eceb3"><td class="mdescLeft"> </td><td class="mdescRight">Handler for join events, called whenever a new user is joining an active connection. <a href="#a0adcf1953de6c315c2da9dac4b3eceb3">More...</a><br /></td></tr> |
| <tr class="separator:a0adcf1953de6c315c2da9dac4b3eceb3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad956a3935832e9048a2727d8c5a46cf6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="user-fntypes_8h.html#aaa5806d288a42d93a54864b6c35617b8">guac_user_leave_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#ad956a3935832e9048a2727d8c5a46cf6">leave_handler</a></td></tr> |
| <tr class="memdesc:ad956a3935832e9048a2727d8c5a46cf6"><td class="mdescLeft"> </td><td class="mdescRight">Handler for leave events, called whenever a new user is leaving an active connection. <a href="#ad956a3935832e9048a2727d8c5a46cf6">More...</a><br /></td></tr> |
| <tr class="separator:ad956a3935832e9048a2727d8c5a46cf6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e07a8086579ede2c692460998a87cac"><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html#a0e07a8086579ede2c692460998a87cac">args</a></td></tr> |
| <tr class="memdesc:a0e07a8086579ede2c692460998a87cac"><td class="mdescLeft"> </td><td class="mdescRight">NULL-terminated array of all arguments accepted by this client , in order. <a href="#a0e07a8086579ede2c692460998a87cac">More...</a><br /></td></tr> |
| <tr class="separator:a0e07a8086579ede2c692460998a87cac"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Guacamole proxy client. </p> |
| <p>Represents a Guacamole proxy client (the client which communicates to a server on behalf of Guacamole, on behalf of the web-client). </p> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="a0e07a8086579ede2c692460998a87cac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0e07a8086579ede2c692460998a87cac">◆ </a></span>args</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char** guac_client::args</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>NULL-terminated array of all arguments accepted by this client , in order. </p> |
| <p>New users will specify these arguments when they join the connection, and the values of those arguments will be made available to the function initializing newly-joined users.</p> |
| <p>The guac_client_init entry point is expected to initialize this, if arguments are expected.</p> |
| <p>Example: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span>* __my_args[] = {</div><div class="line"> <span class="stringliteral">"hostname"</span>,</div><div class="line"> <span class="stringliteral">"port"</span>,</div><div class="line"> <span class="stringliteral">"username"</span>,</div><div class="line"> <span class="stringliteral">"password"</span>,</div><div class="line"> NULL</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> guac_client_init(<a class="code" href="structguac__client.html">guac_client</a>* client) {</div><div class="line"> client-><a class="code" href="structguac__client.html#a0e07a8086579ede2c692460998a87cac">args</a> = __my_args;</div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a73aeff08af6cf6cadd7abce74c7ff4b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a73aeff08af6cf6cadd7abce74c7ff4b2">◆ </a></span>connected_users</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_client::connected_users</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The number of currently-connected users. </p> |
| <p>This value may include inactive users if cleanup of those users has not yet finished. </p> |
| |
| </div> |
| </div> |
| <a id="ad38b9ded1f04bfe8eb235e551fc08094"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad38b9ded1f04bfe8eb235e551fc08094">◆ </a></span>connection_id</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char* guac_client::connection_id</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The unique identifier allocated for the connection, which may be used within the Guacamole protocol to refer to this connection. </p> |
| <p>This identifier is guaranteed to be unique from all existing connections and will not collide with any available protocol names. </p> |
| |
| </div> |
| </div> |
| <a id="a0569bc7eea8d37b5bd95bcd3821ca0a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0569bc7eea8d37b5bd95bcd3821ca0a3">◆ </a></span>data</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* guac_client::data</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Arbitrary reference to proxy client-specific data. </p> |
| <p>Implementors of a Guacamole proxy client can store any data they want here, which can then be retrieved as necessary in the message handlers. </p> |
| |
| </div> |
| </div> |
| <a id="a79e29c931fd448cf51f7153fea064169"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a79e29c931fd448cf51f7153fea064169">◆ </a></span>free_handler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="client-fntypes_8h.html#a7f8c6986f3db9818d016eee6fa562577">guac_client_free_handler</a>* guac_client::free_handler</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for freeing data when the client is being unloaded. </p> |
| <p>This handler will be called when the client needs to be unloaded by the proxy, and any data allocated by the proxy client should be freed.</p> |
| <p>Note that this handler will NOT be called if the client's guac_client_init() function fails.</p> |
| <p>Implement this handler if you store data inside the client.</p> |
| <p>Example: </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> <a class="code" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169">free_handler</a>(<a class="code" href="structguac__client.html">guac_client</a>* client);</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> guac_client_init(<a class="code" href="structguac__client.html">guac_client</a>* client) {</div><div class="line"> client-><a class="code" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169">free_handler</a> = <a class="code" href="structguac__client.html#a79e29c931fd448cf51f7153fea064169">free_handler</a>;</div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a0adcf1953de6c315c2da9dac4b3eceb3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0adcf1953de6c315c2da9dac4b3eceb3">◆ </a></span>join_handler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="user-fntypes_8h.html#a88717a7ab29ac1e4a853fcc2caa8f872">guac_user_join_handler</a>* guac_client::join_handler</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for join events, called whenever a new user is joining an active connection. </p> |
| <p>Note that because users may leave the connection at any time, a reference to a <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a> can become invalid at any time and should never be maintained outside the scope of a function invoked by libguac to which that <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a> was passed (the scope in which the <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a> reference is guaranteed to be valid) UNLESS that reference is properly invalidated within the leave_handler.</p> |
| <p>The handler is given a pointer to a newly-allocated <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a> which must then be initialized, if needed.</p> |
| <p>Example: </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> <a class="code" href="structguac__client.html#a0adcf1953de6c315c2da9dac4b3eceb3">join_handler</a>(<a class="code" href="structguac__user.html">guac_user</a>* user, <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv);</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> guac_client_init(<a class="code" href="structguac__client.html">guac_client</a>* client) {</div><div class="line"> client-><a class="code" href="structguac__client.html#a0adcf1953de6c315c2da9dac4b3eceb3">join_handler</a> = <a class="code" href="structguac__client.html#a0adcf1953de6c315c2da9dac4b3eceb3">join_handler</a>;</div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="ad956a3935832e9048a2727d8c5a46cf6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad956a3935832e9048a2727d8c5a46cf6">◆ </a></span>leave_handler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="user-fntypes_8h.html#aaa5806d288a42d93a54864b6c35617b8">guac_user_leave_handler</a>* guac_client::leave_handler</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for leave events, called whenever a new user is leaving an active connection. </p> |
| <p>The handler is given a pointer to the leaving <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a> whose custom data and associated resources must now be freed, if any.</p> |
| <p>Example: </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> <a class="code" href="structguac__client.html#ad956a3935832e9048a2727d8c5a46cf6">leave_handler</a>(<a class="code" href="structguac__user.html">guac_user</a>* user);</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> guac_client_init(<a class="code" href="structguac__client.html">guac_client</a>* client) {</div><div class="line"> client-><a class="code" href="structguac__client.html#ad956a3935832e9048a2727d8c5a46cf6">leave_handler</a> = <a class="code" href="structguac__client.html#ad956a3935832e9048a2727d8c5a46cf6">leave_handler</a>;</div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a3eb24ba13be9ecb3a8c6f64a73932f43"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3eb24ba13be9ecb3a8c6f64a73932f43">◆ </a></span>log_handler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="client-fntypes_8h.html#a23837e22dbfe152719d596e6918bad3c">guac_client_log_handler</a>* guac_client::log_handler</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Logging handler. </p> |
| <p>This handler will be called via <a class="el" href="client_8h.html#ad53666bbe29346497cabb04fc9628208" title="Writes a message in the log used by the given client. ">guac_client_log()</a> when the client needs to log messages of any type.</p> |
| <p>In general, only programs loading the client should implement this handler, as those are the programs that would provide the logging facilities.</p> |
| <p>Client implementations should expect these handlers to already be set.</p> |
| <p>Example: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> <a class="code" href="structguac__client.html#a3eb24ba13be9ecb3a8c6f64a73932f43">log_handler</a>(<a class="code" href="structguac__client.html">guac_client</a>* client, <a class="code" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">guac_client_log_level</a> level, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, va_list <a class="code" href="structguac__client.html#a0e07a8086579ede2c692460998a87cac">args</a>);</div><div class="line"></div><div class="line"><span class="keywordtype">void</span> function_of_daemon() {</div><div class="line"></div><div class="line"> <a class="code" href="structguac__client.html">guac_client</a>* client = [pass <a class="code" href="structguac__client.html#a3eb24ba13be9ecb3a8c6f64a73932f43">log_handler</a> to guac_client_plugin_get_client()];</div><div class="line"></div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aa634856fd3c522377ba7345f3308000e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa634856fd3c522377ba7345f3308000e">◆ </a></span>socket</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__socket.html">guac_socket</a>* guac_client::socket</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> structure to be used to communicate with all connected web-clients (users). </p> |
| <p>Unlike the user-level <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a>, this <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> will broadcast instructions to all connected users simultaneously. It is expected that the implementor of any Guacamole proxy client will provide their own mechanism of I/O for their protocol. The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> structure is used only to communicate conveniently with the Guacamole web-client. </p> |
| |
| </div> |
| </div> |
| <a id="acb3e3f5d0ce5726cdde768f97b473f53"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb3e3f5d0ce5726cdde768f97b473f53">◆ </a></span>state</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3b">guac_client_state</a> guac_client::state</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The current state of the client. </p> |
| <p>When the client is first allocated, this will be initialized to GUAC_CLIENT_RUNNING. It will remain at GUAC_CLIENT_RUNNING until an event occurs which requires the client to shutdown, at which point the state becomes GUAC_CLIENT_STOPPING. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>guacamole/<a class="el" href="client_8h_source.html">client.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.14 |
| </small></address> |
| </body> |
| </html> |
