| <!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_socket 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_socket Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The core I/O object of Guacamole. |
| <a href="structguac__socket.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:ac8340e5627b43138bb50aac6c4368c0d"><td class="memItemLeft" align="right" valign="top"><a id="ac8340e5627b43138bb50aac6c4368c0d"></a> |
| void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#ac8340e5627b43138bb50aac6c4368c0d">data</a></td></tr> |
| <tr class="memdesc:ac8340e5627b43138bb50aac6c4368c0d"><td class="mdescLeft"> </td><td class="mdescRight">Arbitrary socket-specific data. <br /></td></tr> |
| <tr class="separator:ac8340e5627b43138bb50aac6c4368c0d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10042a8e591737aec8d4db5a3423b250"><td class="memItemLeft" align="right" valign="top"><a id="a10042a8e591737aec8d4db5a3423b250"></a> |
| <a class="el" href="socket-fntypes_8h.html#a75396c8cb7b0ba91102fcd447a1eb36b">guac_socket_read_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#a10042a8e591737aec8d4db5a3423b250">read_handler</a></td></tr> |
| <tr class="memdesc:a10042a8e591737aec8d4db5a3423b250"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called when data needs to be read from the socket. <br /></td></tr> |
| <tr class="separator:a10042a8e591737aec8d4db5a3423b250"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f5f24200b0dad4ef1443b863d1bfc7d"><td class="memItemLeft" align="right" valign="top"><a id="a0f5f24200b0dad4ef1443b863d1bfc7d"></a> |
| <a class="el" href="socket-fntypes_8h.html#a7198af0a6bbac52794eb248c81d90c6a">guac_socket_write_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#a0f5f24200b0dad4ef1443b863d1bfc7d">write_handler</a></td></tr> |
| <tr class="memdesc:a0f5f24200b0dad4ef1443b863d1bfc7d"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called whenever data is written to this socket. <br /></td></tr> |
| <tr class="separator:a0f5f24200b0dad4ef1443b863d1bfc7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc6ff82e38b84c9e876fd797aafedd1b"><td class="memItemLeft" align="right" valign="top"><a id="afc6ff82e38b84c9e876fd797aafedd1b"></a> |
| <a class="el" href="socket-fntypes_8h.html#a894bc88c6288ee6b6713a2ea64bd05a0">guac_socket_flush_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#afc6ff82e38b84c9e876fd797aafedd1b">flush_handler</a></td></tr> |
| <tr class="memdesc:afc6ff82e38b84c9e876fd797aafedd1b"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called whenever this socket needs to be flushed. <br /></td></tr> |
| <tr class="separator:afc6ff82e38b84c9e876fd797aafedd1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d39f1476d3d3440485697a0eabfe471"><td class="memItemLeft" align="right" valign="top"><a id="a1d39f1476d3d3440485697a0eabfe471"></a> |
| <a class="el" href="socket-fntypes_8h.html#a1b714d65f18d57bb52f929c7d3909526">guac_socket_lock_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#a1d39f1476d3d3440485697a0eabfe471">lock_handler</a></td></tr> |
| <tr class="memdesc:a1d39f1476d3d3440485697a0eabfe471"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called whenever a socket needs to be acquired for exclusive access, such as when an instruction is about to be written. <br /></td></tr> |
| <tr class="separator:a1d39f1476d3d3440485697a0eabfe471"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67be8367b5e1b330ee151b22c692500b"><td class="memItemLeft" align="right" valign="top"><a id="a67be8367b5e1b330ee151b22c692500b"></a> |
| <a class="el" href="socket-fntypes_8h.html#af1a6f8eb81522aab289c9f4ed6051d3f">guac_socket_unlock_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#a67be8367b5e1b330ee151b22c692500b">unlock_handler</a></td></tr> |
| <tr class="memdesc:a67be8367b5e1b330ee151b22c692500b"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called whenever exclusive access to a socket is being released, such as when an instruction has finished being written. <br /></td></tr> |
| <tr class="separator:a67be8367b5e1b330ee151b22c692500b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad29e7f8a6819ca7bb541e8a947d5bc4f"><td class="memItemLeft" align="right" valign="top"><a id="ad29e7f8a6819ca7bb541e8a947d5bc4f"></a> |
| <a class="el" href="socket-fntypes_8h.html#a934350207615e0e2066954f9484153f8">guac_socket_select_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#ad29e7f8a6819ca7bb541e8a947d5bc4f">select_handler</a></td></tr> |
| <tr class="memdesc:ad29e7f8a6819ca7bb541e8a947d5bc4f"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called whenever <a class="el" href="socket_8h.html#a41b0d7a25ccda3d0ae20143880cf53b7" title="Waits for input to be available on the given guac_socket object until the specified timeout elapses...">guac_socket_select()</a> is invoked on this socket. <br /></td></tr> |
| <tr class="separator:ad29e7f8a6819ca7bb541e8a947d5bc4f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1044cde496cfe11c914c623dc1e29678"><td class="memItemLeft" align="right" valign="top"><a id="a1044cde496cfe11c914c623dc1e29678"></a> |
| <a class="el" href="socket-fntypes_8h.html#a9700a8ba2011d6e6ce13e3e6c6397fc2">guac_socket_free_handler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#a1044cde496cfe11c914c623dc1e29678">free_handler</a></td></tr> |
| <tr class="memdesc:a1044cde496cfe11c914c623dc1e29678"><td class="mdescLeft"> </td><td class="mdescRight">Handler which will be called when the socket is free'd (closed). <br /></td></tr> |
| <tr class="separator:a1044cde496cfe11c914c623dc1e29678"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2d5236c7e570dfee207511241edaa9b"><td class="memItemLeft" align="right" valign="top"><a id="ac2d5236c7e570dfee207511241edaa9b"></a> |
| <a class="el" href="socket-types_8h.html#a0ac0c0cd123b57d8aba5e6ec6fd20939">guac_socket_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#ac2d5236c7e570dfee207511241edaa9b">state</a></td></tr> |
| <tr class="memdesc:ac2d5236c7e570dfee207511241edaa9b"><td class="mdescLeft"> </td><td class="mdescRight">The current state of this <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a>. <br /></td></tr> |
| <tr class="separator:ac2d5236c7e570dfee207511241edaa9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf00e9c13ff3808fceb4c71c1172fb51"><td class="memItemLeft" align="right" valign="top"><a id="adf00e9c13ff3808fceb4c71c1172fb51"></a> |
| <a class="el" href="timestamp-types_8h.html#a69e916d1ff324fbe0e527f32359c9cea">guac_timestamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__socket.html#adf00e9c13ff3808fceb4c71c1172fb51">last_write_timestamp</a></td></tr> |
| <tr class="memdesc:adf00e9c13ff3808fceb4c71c1172fb51"><td class="mdescLeft"> </td><td class="mdescRight">The timestamp associated with the time the last block of data was written to this <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a>. <br /></td></tr> |
| <tr class="separator:adf00e9c13ff3808fceb4c71c1172fb51"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The core I/O object of Guacamole. </p> |
| <p><a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole. ">guac_socket</a> provides buffered input and output as well as convenience methods for efficiently writing base64 data. </p> |
| </div><hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>guacamole/<a class="el" href="socket_8h_source.html">socket.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> |
