blob: a141b0e18638626a72e3c76793989794e6186e03 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libguac: guacamole/argv-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.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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">argv-constants.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constants related to automatic handling of received "argv" instructions.
<a href="#details">More...</a></p>
<p><a href="argv-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:a4d2cae4a9598d24401fdc0067e879029"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#a4d2cae4a9598d24401fdc0067e879029">GUAC_ARGV_OPTION_ONCE</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a4d2cae4a9598d24401fdc0067e879029"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option flag which declares to <a class="el" href="argv_8h.html#abc25c66eecc88d82851aab121f93f599" title="Registers the given callback such that it is automatically invoked when an &quot;argv&quot; stream for an argum...">guac_argv_register()</a> that the associated argument should be processed exactly once. <a href="#a4d2cae4a9598d24401fdc0067e879029">More...</a><br /></td></tr>
<tr class="separator:a4d2cae4a9598d24401fdc0067e879029"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a851551c2d9daf9b473da25aa32693e0e"><td class="memItemLeft" align="right" valign="top"><a id="a851551c2d9daf9b473da25aa32693e0e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#a851551c2d9daf9b473da25aa32693e0e">GUAC_ARGV_OPTION_ECHO</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a851551c2d9daf9b473da25aa32693e0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Option flag which declares to <a class="el" href="argv_8h.html#abc25c66eecc88d82851aab121f93f599" title="Registers the given callback such that it is automatically invoked when an &quot;argv&quot; stream for an argum...">guac_argv_register()</a> that the values received and accepted for the associated argument should be echoed to all connected users via outbound "argv" streams. <br /></td></tr>
<tr class="separator:a851551c2d9daf9b473da25aa32693e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd92a32fe9b7619580d50dbeaed8577d"><td class="memItemLeft" align="right" valign="top"><a id="abd92a32fe9b7619580d50dbeaed8577d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#abd92a32fe9b7619580d50dbeaed8577d">GUAC_ARGV_MAX_LENGTH</a>&#160;&#160;&#160;16384</td></tr>
<tr class="memdesc:abd92a32fe9b7619580d50dbeaed8577d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of bytes to allow for any argument value received via an argv stream and processed using <a class="el" href="argv_8h.html#adb02a115909eed11fcf0d864de04ea8d" title="Hands off management of the given guac_stream, automatically processing data received over that strea...">guac_argv_received()</a>, including null terminator. <br /></td></tr>
<tr class="separator:abd92a32fe9b7619580d50dbeaed8577d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc731c011c87d8db3580baa2f893b87"><td class="memItemLeft" align="right" valign="top"><a id="aabc731c011c87d8db3580baa2f893b87"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#aabc731c011c87d8db3580baa2f893b87">GUAC_ARGV_MAX_NAME_LENGTH</a>&#160;&#160;&#160;256</td></tr>
<tr class="memdesc:aabc731c011c87d8db3580baa2f893b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of bytes to allow within the name of any argument registered with <a class="el" href="argv_8h.html#abc25c66eecc88d82851aab121f93f599" title="Registers the given callback such that it is automatically invoked when an &quot;argv&quot; stream for an argum...">guac_argv_register()</a>, including null terminator. <br /></td></tr>
<tr class="separator:aabc731c011c87d8db3580baa2f893b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e06672efd6fd7d2353d531be842d431"><td class="memItemLeft" align="right" valign="top"><a id="a9e06672efd6fd7d2353d531be842d431"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#a9e06672efd6fd7d2353d531be842d431">GUAC_ARGV_MAX_MIMETYPE_LENGTH</a>&#160;&#160;&#160;4096</td></tr>
<tr class="memdesc:a9e06672efd6fd7d2353d531be842d431"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of bytes to allow within the mimetype of any received argument value passed to a callback registered with <a class="el" href="argv_8h.html#abc25c66eecc88d82851aab121f93f599" title="Registers the given callback such that it is automatically invoked when an &quot;argv&quot; stream for an argum...">guac_argv_register()</a>, including null terminator. <br /></td></tr>
<tr class="separator:a9e06672efd6fd7d2353d531be842d431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69d1917b4f8b6d91b6b6ae17feaac99f"><td class="memItemLeft" align="right" valign="top"><a id="a69d1917b4f8b6d91b6b6ae17feaac99f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="argv-constants_8h.html#a69d1917b4f8b6d91b6b6ae17feaac99f">GUAC_ARGV_MAX_REGISTERED</a>&#160;&#160;&#160;128</td></tr>
<tr class="memdesc:a69d1917b4f8b6d91b6b6ae17feaac99f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of arguments that may be registered via <a class="el" href="argv_8h.html#a3390cfa416876991fcaf08871160415d" title="Waits for receipt of each of the given arguments via guac_argv_received().">guac_argv_await()</a> or guac_argv_await_async() before further argument registrations will fail. <br /></td></tr>
<tr class="separator:a69d1917b4f8b6d91b6b6ae17feaac99f"><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 automatic handling of received "argv" instructions. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4d2cae4a9598d24401fdc0067e879029"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2cae4a9598d24401fdc0067e879029">&#9670;&nbsp;</a></span>GUAC_ARGV_OPTION_ONCE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_ARGV_OPTION_ONCE&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Option flag which declares to <a class="el" href="argv_8h.html#abc25c66eecc88d82851aab121f93f599" title="Registers the given callback such that it is automatically invoked when an &quot;argv&quot; stream for an argum...">guac_argv_register()</a> that the associated argument should be processed exactly once. </p>
<p>If multiple "argv" streams are received for the argument, only the first such stream is processed. Additional streams will be rejected. </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.15
</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>
</body>
</html>