| <!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: guacamole/client-constants.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> |
| <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 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="#define-members">Macros</a> </div> |
| <div class="headertitle"> |
| <div class="title">client-constants.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Constants 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-constants_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="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:ad9f977643c5ffee5c1eeb426664796a1"><td class="memItemLeft" align="right" valign="top"><a id="ad9f977643c5ffee5c1eeb426664796a1"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#ad9f977643c5ffee5c1eeb426664796a1">GUAC_CLIENT_MAX_STREAMS</a>   64</td></tr> |
| <tr class="memdesc:ad9f977643c5ffee5c1eeb426664796a1"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of inbound or outbound streams supported by any one <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. <br /></td></tr> |
| <tr class="separator:ad9f977643c5ffee5c1eeb426664796a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6fda25106c4c454c22db2c7e042ee142"><td class="memItemLeft" align="right" valign="top"><a id="a6fda25106c4c454c22db2c7e042ee142"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a6fda25106c4c454c22db2c7e042ee142">GUAC_CLIENT_CLOSED_STREAM_INDEX</a>   -1</td></tr> |
| <tr class="memdesc:a6fda25106c4c454c22db2c7e042ee142"><td class="mdescLeft"> </td><td class="mdescRight">The index of a closed stream. <br /></td></tr> |
| <tr class="separator:a6fda25106c4c454c22db2c7e042ee142"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e2b48136e5c358e012a1558d5e5f0c2"><td class="memItemLeft" align="right" valign="top"><a id="a8e2b48136e5c358e012a1558d5e5f0c2"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a8e2b48136e5c358e012a1558d5e5f0c2">GUAC_CLIENT_ID_PREFIX</a>   '$'</td></tr> |
| <tr class="memdesc:a8e2b48136e5c358e012a1558d5e5f0c2"><td class="mdescLeft"> </td><td class="mdescRight">The character prefix which identifies a client ID. <br /></td></tr> |
| <tr class="separator:a8e2b48136e5c358e012a1558d5e5f0c2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4bb4f5b852ac8c3e2d3c89cd5e63efd2"><td class="memItemLeft" align="right" valign="top"><a id="a4bb4f5b852ac8c3e2d3c89cd5e63efd2"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a4bb4f5b852ac8c3e2d3c89cd5e63efd2">GUAC_CLIENT_MOUSE_LEFT</a>   0x01</td></tr> |
| <tr class="memdesc:a4bb4f5b852ac8c3e2d3c89cd5e63efd2"><td class="mdescLeft"> </td><td class="mdescRight">The flag set in the mouse button mask when the left mouse button is down. <br /></td></tr> |
| <tr class="separator:a4bb4f5b852ac8c3e2d3c89cd5e63efd2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad14c5f1800aac863bbebcd676c5c2124"><td class="memItemLeft" align="right" valign="top"><a id="ad14c5f1800aac863bbebcd676c5c2124"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#ad14c5f1800aac863bbebcd676c5c2124">GUAC_CLIENT_MOUSE_MIDDLE</a>   0x02</td></tr> |
| <tr class="memdesc:ad14c5f1800aac863bbebcd676c5c2124"><td class="mdescLeft"> </td><td class="mdescRight">The flag set in the mouse button mask when the middle mouse button is down. <br /></td></tr> |
| <tr class="separator:ad14c5f1800aac863bbebcd676c5c2124"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a88917d2d7143a483c219eee62fd6317f"><td class="memItemLeft" align="right" valign="top"><a id="a88917d2d7143a483c219eee62fd6317f"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a88917d2d7143a483c219eee62fd6317f">GUAC_CLIENT_MOUSE_RIGHT</a>   0x04</td></tr> |
| <tr class="memdesc:a88917d2d7143a483c219eee62fd6317f"><td class="mdescLeft"> </td><td class="mdescRight">The flag set in the mouse button mask when the right mouse button is down. <br /></td></tr> |
| <tr class="separator:a88917d2d7143a483c219eee62fd6317f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a134afd8a0d8f10a34af51fc70981e39d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a134afd8a0d8f10a34af51fc70981e39d">GUAC_CLIENT_MOUSE_SCROLL_UP</a>   0x08</td></tr> |
| <tr class="memdesc:a134afd8a0d8f10a34af51fc70981e39d"><td class="mdescLeft"> </td><td class="mdescRight">The flag set in the mouse button mask when the mouse scrollwheel is scrolled up. <a href="#a134afd8a0d8f10a34af51fc70981e39d">More...</a><br /></td></tr> |
| <tr class="separator:a134afd8a0d8f10a34af51fc70981e39d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a771231574e9d303aa08fc1cecc9069f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#a771231574e9d303aa08fc1cecc9069f0">GUAC_CLIENT_MOUSE_SCROLL_DOWN</a>   0x10</td></tr> |
| <tr class="memdesc:a771231574e9d303aa08fc1cecc9069f0"><td class="mdescLeft"> </td><td class="mdescRight">The flag set in the mouse button mask when the mouse scrollwheel is scrolled down. <a href="#a771231574e9d303aa08fc1cecc9069f0">More...</a><br /></td></tr> |
| <tr class="separator:a771231574e9d303aa08fc1cecc9069f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8a296e1032ff408ab141b0765fb9bfb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="client-constants_8h.html#aa8a296e1032ff408ab141b0765fb9bfb">GUAC_BUFFER_POOL_INITIAL_SIZE</a>   1024</td></tr> |
| <tr class="memdesc:aa8a296e1032ff408ab141b0765fb9bfb"><td class="mdescLeft"> </td><td class="mdescRight">The minimum number of buffers to create before allowing free'd buffers to be reclaimed. <a href="#aa8a296e1032ff408ab141b0765fb9bfb">More...</a><br /></td></tr> |
| <tr class="separator:aa8a296e1032ff408ab141b0765fb9bfb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Constants 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">Macro Definition Documentation</h2> |
| <a id="aa8a296e1032ff408ab141b0765fb9bfb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa8a296e1032ff408ab141b0765fb9bfb">◆ </a></span>GUAC_BUFFER_POOL_INITIAL_SIZE</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define GUAC_BUFFER_POOL_INITIAL_SIZE   1024</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The minimum number of buffers to create before allowing free'd buffers to be reclaimed. </p> |
| <p>In the case a protocol rapidly creates, uses, and destroys buffers, this can prevent unnecessary reuse of the same buffer (which would make draw operations unnecessarily synchronous). </p> |
| |
| </div> |
| </div> |
| <a id="a771231574e9d303aa08fc1cecc9069f0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a771231574e9d303aa08fc1cecc9069f0">◆ </a></span>GUAC_CLIENT_MOUSE_SCROLL_DOWN</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define GUAC_CLIENT_MOUSE_SCROLL_DOWN   0x10</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The flag set in the mouse button mask when the mouse scrollwheel is scrolled down. </p> |
| <p>Note that mouse scrollwheels are actually sets of two buttons. One button is pressed and released for an upward scroll, and the other is pressed and released for a downward scroll. Some mice may actually implement these as separate buttons, not a wheel. </p> |
| |
| </div> |
| </div> |
| <a id="a134afd8a0d8f10a34af51fc70981e39d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a134afd8a0d8f10a34af51fc70981e39d">◆ </a></span>GUAC_CLIENT_MOUSE_SCROLL_UP</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define GUAC_CLIENT_MOUSE_SCROLL_UP   0x08</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The flag set in the mouse button mask when the mouse scrollwheel is scrolled up. </p> |
| <p>Note that mouse scrollwheels are actually sets of two buttons. One button is pressed and released for an upward scroll, and the other is pressed and released for a downward scroll. Some mice may actually implement these as separate buttons, not a wheel. </p> |
| |
| </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.14 |
| </small></address> |
| </body> |
| </html> |
