| <!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.6"/> |
| <title>libguac: guacamole/client.h File 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/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.9.3</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <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="summary"> |
| <a href="#nested-classes">Data Structures</a> | |
| <a href="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"> |
| <div class="title">client.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Functions and structure contents for the Guacamole proxy client. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="client_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Data Structures</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client__info.html">guac_client_info</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Information exposed by the remote client during the connection handshake which can be used by a client plugin. <a href="structguac__client__info.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client.html">guac_client</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Guacamole proxy client. <a href="structguac__client.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a33bad42d21ccb561aa71c4f04ae9b22a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__client.html">guac_client</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a33bad42d21ccb561aa71c4f04ae9b22a">guac_client_alloc</a> ()</td></tr> |
| <tr class="memdesc:a33bad42d21ccb561aa71c4f04ae9b22a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new, barebones <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. <a href="#a33bad42d21ccb561aa71c4f04ae9b22a">More...</a><br/></td></tr> |
| <tr class="separator:a33bad42d21ccb561aa71c4f04ae9b22a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a76cdc454a23fdcbb70d56f923f6b6427"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a76cdc454a23fdcbb70d56f923f6b6427">guac_client_free</a> (<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a76cdc454a23fdcbb70d56f923f6b6427"><td class="mdescLeft"> </td><td class="mdescRight">Free all resources associated with the given client. <a href="#a76cdc454a23fdcbb70d56f923f6b6427">More...</a><br/></td></tr> |
| <tr class="separator:a76cdc454a23fdcbb70d56f923f6b6427"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ed968b0cdbdd8ef0c22ae94d803449c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a5ed968b0cdbdd8ef0c22ae94d803449c">guac_client_handle_instruction</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="structguac__instruction.html">guac_instruction</a> *instruction)</td></tr> |
| <tr class="memdesc:a5ed968b0cdbdd8ef0c22ae94d803449c"><td class="mdescLeft"> </td><td class="mdescRight">Call the appropriate handler defined by the given client for the given instruction. <a href="#a5ed968b0cdbdd8ef0c22ae94d803449c">More...</a><br/></td></tr> |
| <tr class="separator:a5ed968b0cdbdd8ef0c22ae94d803449c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e461c0f2d8d13a89310cd1a37ab41df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a1e461c0f2d8d13a89310cd1a37ab41df">guac_client_log_info</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, const char *format,...)</td></tr> |
| <tr class="memdesc:a1e461c0f2d8d13a89310cd1a37ab41df"><td class="mdescLeft"> </td><td class="mdescRight">Logs an informational message in the log used by the given client. <a href="#a1e461c0f2d8d13a89310cd1a37ab41df">More...</a><br/></td></tr> |
| <tr class="separator:a1e461c0f2d8d13a89310cd1a37ab41df"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23df81a823e4be52c9aa3c9ca1975ed6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a23df81a823e4be52c9aa3c9ca1975ed6">guac_client_log_error</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, const char *format,...)</td></tr> |
| <tr class="memdesc:a23df81a823e4be52c9aa3c9ca1975ed6"><td class="mdescLeft"> </td><td class="mdescRight">Logs an error message in the log used by the given client. <a href="#a23df81a823e4be52c9aa3c9ca1975ed6">More...</a><br/></td></tr> |
| <tr class="separator:a23df81a823e4be52c9aa3c9ca1975ed6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7a7e5b6218aae4481b46b654aae9cd3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a7a7e5b6218aae4481b46b654aae9cd3d">vguac_client_log_info</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, const char *format, va_list ap)</td></tr> |
| <tr class="memdesc:a7a7e5b6218aae4481b46b654aae9cd3d"><td class="mdescLeft"> </td><td class="mdescRight">Logs an informational message in the log used by the given client. <a href="#a7a7e5b6218aae4481b46b654aae9cd3d">More...</a><br/></td></tr> |
| <tr class="separator:a7a7e5b6218aae4481b46b654aae9cd3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4f03b7549828c5486375e5da83775ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#ab4f03b7549828c5486375e5da83775ae">vguac_client_log_error</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, const char *format, va_list ap)</td></tr> |
| <tr class="memdesc:ab4f03b7549828c5486375e5da83775ae"><td class="mdescLeft"> </td><td class="mdescRight">Logs an error message in the log used by the given client. <a href="#ab4f03b7549828c5486375e5da83775ae">More...</a><br/></td></tr> |
| <tr class="separator:ab4f03b7549828c5486375e5da83775ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a022d4b5587c84f2963b176ab7999aa1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a022d4b5587c84f2963b176ab7999aa1b">guac_client_stop</a> (<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a022d4b5587c84f2963b176ab7999aa1b"><td class="mdescLeft"> </td><td class="mdescRight">Signals the given client to stop gracefully. <a href="#a022d4b5587c84f2963b176ab7999aa1b">More...</a><br/></td></tr> |
| <tr class="separator:a022d4b5587c84f2963b176ab7999aa1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62a29f7820deaff00a10ec79aa81aed4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a62a29f7820deaff00a10ec79aa81aed4">guac_client_abort</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="protocol-types_8h.html#af946f7f843fa5935dbeeb08f85dec9e2">guac_protocol_status</a> status, const char *format,...)</td></tr> |
| <tr class="memdesc:a62a29f7820deaff00a10ec79aa81aed4"><td class="mdescLeft"> </td><td class="mdescRight">Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred. <a href="#a62a29f7820deaff00a10ec79aa81aed4">More...</a><br/></td></tr> |
| <tr class="separator:a62a29f7820deaff00a10ec79aa81aed4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c0eccd7d0ed3dbf3e7941ce297e0224"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a4c0eccd7d0ed3dbf3e7941ce297e0224">vguac_client_abort</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="protocol-types_8h.html#af946f7f843fa5935dbeeb08f85dec9e2">guac_protocol_status</a> status, const char *format, va_list ap)</td></tr> |
| <tr class="memdesc:a4c0eccd7d0ed3dbf3e7941ce297e0224"><td class="mdescLeft"> </td><td class="mdescRight">Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred. <a href="#a4c0eccd7d0ed3dbf3e7941ce297e0224">More...</a><br/></td></tr> |
| <tr class="separator:a4c0eccd7d0ed3dbf3e7941ce297e0224"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af661d3fedd9683631bdc7d1e3205e379"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__layer.html">guac_layer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#af661d3fedd9683631bdc7d1e3205e379">guac_client_alloc_buffer</a> (<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:af661d3fedd9683631bdc7d1e3205e379"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new buffer (invisible layer). <a href="#af661d3fedd9683631bdc7d1e3205e379">More...</a><br/></td></tr> |
| <tr class="separator:af661d3fedd9683631bdc7d1e3205e379"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2085758db585bb9d09d3860ec0fc9587"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__layer.html">guac_layer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a2085758db585bb9d09d3860ec0fc9587">guac_client_alloc_layer</a> (<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a2085758db585bb9d09d3860ec0fc9587"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new layer. <a href="#a2085758db585bb9d09d3860ec0fc9587">More...</a><br/></td></tr> |
| <tr class="separator:a2085758db585bb9d09d3860ec0fc9587"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc03a32b3113d9a95700cac54f1cbd4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#afc03a32b3113d9a95700cac54f1cbd4b">guac_client_free_buffer</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="structguac__layer.html">guac_layer</a> *layer)</td></tr> |
| <tr class="memdesc:afc03a32b3113d9a95700cac54f1cbd4b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the given buffer to the pool of available buffers, such that it can be reused by any subsequent call to guac_client_allow_buffer(). <a href="#afc03a32b3113d9a95700cac54f1cbd4b">More...</a><br/></td></tr> |
| <tr class="separator:afc03a32b3113d9a95700cac54f1cbd4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e5b374211012d1897792335112dcb89"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a4e5b374211012d1897792335112dcb89">guac_client_free_layer</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="structguac__layer.html">guac_layer</a> *layer)</td></tr> |
| <tr class="memdesc:a4e5b374211012d1897792335112dcb89"><td class="mdescLeft"> </td><td class="mdescRight">Returns the given layer to the pool of available layers, such that it can be reused by any subsequent call to guac_client_allow_layer(). <a href="#a4e5b374211012d1897792335112dcb89">More...</a><br/></td></tr> |
| <tr class="separator:a4e5b374211012d1897792335112dcb89"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1bea3499e21736b4ea0fb949d3bc8ab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__stream.html">guac_stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a1bea3499e21736b4ea0fb949d3bc8ab9">guac_client_alloc_stream</a> (<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a1bea3499e21736b4ea0fb949d3bc8ab9"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new stream. <a href="#a1bea3499e21736b4ea0fb949d3bc8ab9">More...</a><br/></td></tr> |
| <tr class="separator:a1bea3499e21736b4ea0fb949d3bc8ab9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af0103a5aae8ba76badd2e68e827f6782"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#af0103a5aae8ba76badd2e68e827f6782">guac_client_free_stream</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="structguac__stream.html">guac_stream</a> *stream)</td></tr> |
| <tr class="memdesc:af0103a5aae8ba76badd2e68e827f6782"><td class="mdescLeft"> </td><td class="mdescRight">Returns the given stream to the pool of available streams, such that it can be reused by any subsequent call to <a class="el" href="client_8h.html#a1bea3499e21736b4ea0fb949d3bc8ab9" title="Allocates a new stream. ">guac_client_alloc_stream()</a>. <a href="#af0103a5aae8ba76badd2e68e827f6782">More...</a><br/></td></tr> |
| <tr class="separator:af0103a5aae8ba76badd2e68e827f6782"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:a336a485c006394d5eea88bf6d8d422d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a336a485c006394d5eea88bf6d8d422d8"></a> |
| const <a class="el" href="structguac__layer.html">guac_layer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a336a485c006394d5eea88bf6d8d422d8">GUAC_DEFAULT_LAYER</a></td></tr> |
| <tr class="memdesc:a336a485c006394d5eea88bf6d8d422d8"><td class="mdescLeft"> </td><td class="mdescRight">The default Guacamole client layer, layer 0. <br/></td></tr> |
| <tr class="separator:a336a485c006394d5eea88bf6d8d422d8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Functions and structure contents for the Guacamole proxy client. </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a62a29f7820deaff00a10ec79aa81aed4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_abort </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="protocol-types_8h.html#af946f7f843fa5935dbeeb08f85dec9e2">guac_protocol_status</a> </td> |
| <td class="paramname"><em>status</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>...</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred. </p> |
| <p>Note that this is a completely cooperative signal, and can be ignored by the client or the hosting daemon. The message given will be logged to the system logs.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to signal to stop. </td></tr> |
| <tr><td class="paramname">status</td><td>The status to send over the Guacamole protocol. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">...</td><td>Arguments to use when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a33bad42d21ccb561aa71c4f04ae9b22a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__client.html">guac_client</a>* guac_client_alloc </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a new, barebones <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. </p> |
| <p>This new <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a> has no handlers set, but is otherwise usable.</p> |
| <dl class="section return"><dt>Returns</dt><dd>A pointer to the new client. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af661d3fedd9683631bdc7d1e3205e379"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__layer.html">guac_layer</a>* guac_client_alloc_buffer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocates a new buffer (invisible layer). </p> |
| <p>An arbitrary index is automatically assigned if no existing buffer is available for use.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to allocate the buffer for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The next available buffer, or a newly allocated buffer. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2085758db585bb9d09d3860ec0fc9587"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__layer.html">guac_layer</a>* guac_client_alloc_layer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocates a new layer. </p> |
| <p>An arbitrary index is automatically assigned if no existing layer is available for use.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to allocate the layer buffer for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The next available layer, or a newly allocated layer. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1bea3499e21736b4ea0fb949d3bc8ab9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__stream.html">guac_stream</a>* guac_client_alloc_stream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocates a new stream. </p> |
| <p>An arbitrary index is automatically assigned if no previously-allocated stream is available for use.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to allocate the layer buffer for. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The next available stream, or a newly allocated stream. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a76cdc454a23fdcbb70d56f923f6b6427"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Free all resources associated with the given client. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to free all reasources of. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afc03a32b3113d9a95700cac54f1cbd4b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_free_buffer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structguac__layer.html">guac_layer</a> * </td> |
| <td class="paramname"><em>layer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the given buffer to the pool of available buffers, such that it can be reused by any subsequent call to guac_client_allow_buffer(). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to return the buffer to. </td></tr> |
| <tr><td class="paramname">layer</td><td>The buffer to return to the pool of available buffers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e5b374211012d1897792335112dcb89"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_free_layer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structguac__layer.html">guac_layer</a> * </td> |
| <td class="paramname"><em>layer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the given layer to the pool of available layers, such that it can be reused by any subsequent call to guac_client_allow_layer(). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to return the layer to. </td></tr> |
| <tr><td class="paramname">layer</td><td>The buffer to return to the pool of available layer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af0103a5aae8ba76badd2e68e827f6782"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_free_stream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structguac__stream.html">guac_stream</a> * </td> |
| <td class="paramname"><em>stream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the given stream to the pool of available streams, such that it can be reused by any subsequent call to <a class="el" href="client_8h.html#a1bea3499e21736b4ea0fb949d3bc8ab9" title="Allocates a new stream. ">guac_client_alloc_stream()</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to return the buffer to. </td></tr> |
| <tr><td class="paramname">stream</td><td>The stream to return to the pool of available stream. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5ed968b0cdbdd8ef0c22ae94d803449c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_client_handle_instruction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structguac__instruction.html">guac_instruction</a> * </td> |
| <td class="paramname"><em>instruction</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Call the appropriate handler defined by the given client for the given instruction. </p> |
| <p>A comparison is made between the instruction opcode and the initial handler lookup table defined in client-handlers.c. The intial handlers will in turn call the client's handler (if defined).</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client whose handlers should be called. </td></tr> |
| <tr><td class="paramname">instruction</td><td>The instruction to pass to the proxy client via the appropriate handler. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a23df81a823e4be52c9aa3c9ca1975ed6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_log_error </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>...</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Logs an error message in the log used by the given client. </p> |
| <p>The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to log an error for. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">...</td><td>Arguments to use when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1e461c0f2d8d13a89310cd1a37ab41df"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_log_info </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>...</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Logs an informational message in the log used by the given client. </p> |
| <p>The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to log an informational message for. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">...</td><td>Arguments to use when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a022d4b5587c84f2963b176ab7999aa1b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_client_stop </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signals the given client to stop gracefully. </p> |
| <p>This is a completely cooperative signal, and can be ignored by the client or the hosting daemon.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to signal to stop. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4c0eccd7d0ed3dbf3e7941ce297e0224"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void vguac_client_abort </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="protocol-types_8h.html#af946f7f843fa5935dbeeb08f85dec9e2">guac_protocol_status</a> </td> |
| <td class="paramname"><em>status</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">va_list </td> |
| <td class="paramname"><em>ap</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred. </p> |
| <p>Note that this is a completely cooperative signal, and can be ignored by the client or the hosting daemon. The message given will be logged to the system logs.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to signal to stop. </td></tr> |
| <tr><td class="paramname">status</td><td>The status to send over the Guacamole protocol. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">ap</td><td>The va_list containing the arguments to be used when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab4f03b7549828c5486375e5da83775ae"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void vguac_client_log_error </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">va_list </td> |
| <td class="paramname"><em>ap</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Logs an error message in the log used by the given client. </p> |
| <p>The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to log an error for. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">ap</td><td>The va_list containing the arguments to be used when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7a7e5b6218aae4481b46b654aae9cd3d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void vguac_client_log_info </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">va_list </td> |
| <td class="paramname"><em>ap</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Logs an informational message in the log used by the given client. </p> |
| <p>The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The proxy client to log an informational message for. </td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string to log. </td></tr> |
| <tr><td class="paramname">ap</td><td>The va_list containing the arguments to be used when filling the format string for printing. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Tue Sep 30 2014 00:05:02 for libguac by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </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> |
