| <!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.11"/> |
| <title>libguac: guacamole/client-fntypes.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/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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">0.9.10-incubating</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <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)"> |
| </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="#typedef-members">Typedefs</a> </div> |
| <div class="headertitle"> |
| <div class="title">client-fntypes.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Function type definitions related to the Guacamole client structure, <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="client-fntypes_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="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a7f8c6986f3db9818d016eee6fa562577"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="client-fntypes_8h.html#a7f8c6986f3db9818d016eee6fa562577">guac_client_free_handler</a>(<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a7f8c6986f3db9818d016eee6fa562577"><td class="mdescLeft"> </td><td class="mdescRight">Handler for freeing up any extra data allocated by the client implementation. <a href="#a7f8c6986f3db9818d016eee6fa562577">More...</a><br /></td></tr> |
| <tr class="separator:a7f8c6986f3db9818d016eee6fa562577"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23837e22dbfe152719d596e6918bad3c"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="client-fntypes_8h.html#a23837e22dbfe152719d596e6918bad3c">guac_client_log_handler</a>(<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">guac_client_log_level</a> level, const char *format, va_list args)</td></tr> |
| <tr class="memdesc:a23837e22dbfe152719d596e6918bad3c"><td class="mdescLeft"> </td><td class="mdescRight">Handler for logging messages related to a given <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a> instance. <a href="#a23837e22dbfe152719d596e6918bad3c">More...</a><br /></td></tr> |
| <tr class="separator:a23837e22dbfe152719d596e6918bad3c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a905b087a47315e1836293839daf1f46c"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="client-fntypes_8h.html#a905b087a47315e1836293839daf1f46c">guac_client_init_handler</a>(<a class="el" href="structguac__client.html">guac_client</a> *client)</td></tr> |
| <tr class="memdesc:a905b087a47315e1836293839daf1f46c"><td class="mdescLeft"> </td><td class="mdescRight">The entry point of a client plugin which must initialize the given <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. <a href="#a905b087a47315e1836293839daf1f46c">More...</a><br /></td></tr> |
| <tr class="separator:a905b087a47315e1836293839daf1f46c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Function type definitions related to the Guacamole client structure, <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. </p> |
| </div><h2 class="groupheader">Typedef Documentation</h2> |
| <a class="anchor" id="a7f8c6986f3db9818d016eee6fa562577"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef int guac_client_free_handler(<a class="el" href="structguac__client.html">guac_client</a> *client)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for freeing up any extra data allocated by the client implementation. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The client whose extra data should be freed (if any).</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero if the data was successfully freed, non-zero if an error prevents the data from being freed. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a905b087a47315e1836293839daf1f46c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef int guac_client_init_handler(<a class="el" href="structguac__client.html">guac_client</a> *client)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The entry point of a client plugin which must initialize the given <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. </p> |
| <p>In practice, this function will be called "guac_client_init".</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a> that must be initialized.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero on success, non-zero if initialization fails for any reason. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a23837e22dbfe152719d596e6918bad3c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void guac_client_log_handler(<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">guac_client_log_level</a> level, const char *format, va_list args)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handler for logging messages related to a given <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a> instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The client related to the message being logged.</td></tr> |
| <tr><td class="paramname">level</td><td>The log level at which to log the given message.</td></tr> |
| <tr><td class="paramname">format</td><td>A printf-style format string, defining the message to be logged.</td></tr> |
| <tr><td class="paramname">args</td><td>The va_list containing the arguments to be used when filling the conversion specifiers ("%s", "%i", etc.) within the format string. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </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.11 |
| </small></address> |
| </body> |
| </html> |