blob: ca7abb36b3fb1a6c9b160f3f437eacd1f6975016 [file] [log] [blame]
<!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/protocol-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
&#160;<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&amp;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&amp;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">protocol-constants.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constants related to the Guacamole protocol.
<a href="#details">More...</a></p>
<p><a href="protocol-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:ab1706e67b56808564438ef853a8d2821"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol-constants_8h.html#ab1706e67b56808564438ef853a8d2821">GUACAMOLE_PROTOCOL_VERSION</a>&#160;&#160;&#160;&quot;VERSION_1_1_0&quot;</td></tr>
<tr class="memdesc:ab1706e67b56808564438ef853a8d2821"><td class="mdescLeft">&#160;</td><td class="mdescRight">This defines the overall protocol version that this build of libguac supports. <a href="#ab1706e67b56808564438ef853a8d2821">More...</a><br /></td></tr>
<tr class="separator:ab1706e67b56808564438ef853a8d2821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5dd5c766aeebead268d0daa6c8c2166"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol-constants_8h.html#af5dd5c766aeebead268d0daa6c8c2166">GUAC_PROTOCOL_BLOB_MAX_LENGTH</a>&#160;&#160;&#160;6048</td></tr>
<tr class="memdesc:af5dd5c766aeebead268d0daa6c8c2166"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of bytes that should be sent in any one blob instruction to ensure the instruction does not exceed the maximum allowed instruction size. <a href="#af5dd5c766aeebead268d0daa6c8c2166">More...</a><br /></td></tr>
<tr class="separator:af5dd5c766aeebead268d0daa6c8c2166"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Constants related to the Guacamole protocol. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af5dd5c766aeebead268d0daa6c8c2166"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5dd5c766aeebead268d0daa6c8c2166">&#9670;&nbsp;</a></span>GUAC_PROTOCOL_BLOB_MAX_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_PROTOCOL_BLOB_MAX_LENGTH&#160;&#160;&#160;6048</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum number of bytes that should be sent in any one blob instruction to ensure the instruction does not exceed the maximum allowed instruction size. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="parser-constants_8h.html#a6cb4157503008653c5200ea640fe8744" title="The maximum number of characters per instruction. ">GUAC_INSTRUCTION_MAX_LENGTH</a> </dd></dl>
</div>
</div>
<a id="ab1706e67b56808564438ef853a8d2821"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1706e67b56808564438ef853a8d2821">&#9670;&nbsp;</a></span>GUACAMOLE_PROTOCOL_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUACAMOLE_PROTOCOL_VERSION&#160;&#160;&#160;&quot;VERSION_1_1_0&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>This defines the overall protocol version that this build of libguac supports. </p>
<p>The protocol version is used to provide compatibility between potentially different versions of Guacamole server and clients. The version number is a MAJOR_MINOR_PATCH version that matches the versioning used throughout the components of the Guacamole project. This version will not necessarily increment with the other components, unless additional functionality is introduced that affects compatibility.</p>
<p>This version is passed by the __guac_protocol_send_args() function from the server to the client during the client/server handshake. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>