blob: eb46c86caeb3d3b3065f0a7bf7d82211ba74b2c1 [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/user-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">user-constants.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constants related to the Guacamole user structure, <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a>.
<a href="#details">More...</a></p>
<p><a href="user-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:aa6442383e07f6aa68fbe504037101a87"><td class="memItemLeft" align="right" valign="top"><a id="aa6442383e07f6aa68fbe504037101a87"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#aa6442383e07f6aa68fbe504037101a87">GUAC_USER_ID_PREFIX</a>&#160;&#160;&#160;'@'</td></tr>
<tr class="memdesc:aa6442383e07f6aa68fbe504037101a87"><td class="mdescLeft">&#160;</td><td class="mdescRight">The character prefix which identifies a user ID. <br /></td></tr>
<tr class="separator:aa6442383e07f6aa68fbe504037101a87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e0884fe25345c84beac1c5a13b1c5ce"><td class="memItemLeft" align="right" valign="top"><a id="a9e0884fe25345c84beac1c5a13b1c5ce"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#a9e0884fe25345c84beac1c5a13b1c5ce">GUAC_USER_MAX_STREAMS</a>&#160;&#160;&#160;64</td></tr>
<tr class="memdesc:a9e0884fe25345c84beac1c5a13b1c5ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of inbound or outbound streams supported by any one <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a>. <br /></td></tr>
<tr class="separator:a9e0884fe25345c84beac1c5a13b1c5ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8749ef8d1917591b82b7747edc85d275"><td class="memItemLeft" align="right" valign="top"><a id="a8749ef8d1917591b82b7747edc85d275"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#a8749ef8d1917591b82b7747edc85d275">GUAC_USER_CLOSED_STREAM_INDEX</a>&#160;&#160;&#160;-1</td></tr>
<tr class="memdesc:a8749ef8d1917591b82b7747edc85d275"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of a closed stream. <br /></td></tr>
<tr class="separator:a8749ef8d1917591b82b7747edc85d275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbdfab527f553d531ce690cabd4ae1e7"><td class="memItemLeft" align="right" valign="top"><a id="afbdfab527f553d531ce690cabd4ae1e7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#afbdfab527f553d531ce690cabd4ae1e7">GUAC_USER_MAX_OBJECTS</a>&#160;&#160;&#160;64</td></tr>
<tr class="memdesc:afbdfab527f553d531ce690cabd4ae1e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of objects supported by any one <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a>. <br /></td></tr>
<tr class="separator:afbdfab527f553d531ce690cabd4ae1e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0609bd43bffdfa9ebb8da62f8118c9f"><td class="memItemLeft" align="right" valign="top"><a id="ae0609bd43bffdfa9ebb8da62f8118c9f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#ae0609bd43bffdfa9ebb8da62f8118c9f">GUAC_USER_UNDEFINED_OBJECT_INDEX</a>&#160;&#160;&#160;-1</td></tr>
<tr class="memdesc:ae0609bd43bffdfa9ebb8da62f8118c9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of an object which has not been defined. <br /></td></tr>
<tr class="separator:ae0609bd43bffdfa9ebb8da62f8118c9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb353db4f79b67678376bb521db182e5"><td class="memItemLeft" align="right" valign="top"><a id="acb353db4f79b67678376bb521db182e5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#acb353db4f79b67678376bb521db182e5">GUAC_USER_OBJECT_ROOT_NAME</a>&#160;&#160;&#160;&quot;/&quot;</td></tr>
<tr class="memdesc:acb353db4f79b67678376bb521db182e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The stream name reserved for the root of a Guacamole protocol object. <br /></td></tr>
<tr class="separator:acb353db4f79b67678376bb521db182e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3135ba0f5c4cf3099374f612446b490"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="user-constants_8h.html#af3135ba0f5c4cf3099374f612446b490">GUAC_USER_STREAM_INDEX_MIMETYPE</a>&#160;&#160;&#160;&quot;application/vnd.glyptodon.guacamole.stream-index+json&quot;</td></tr>
<tr class="memdesc:af3135ba0f5c4cf3099374f612446b490"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mimetype of a stream containing a map of available stream names to their corresponding mimetypes. <a href="#af3135ba0f5c4cf3099374f612446b490">More...</a><br /></td></tr>
<tr class="separator:af3135ba0f5c4cf3099374f612446b490"><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 user structure, <a class="el" href="structguac__user.html" title="Representation of a physical connection within a larger logical connection which may be shared...">guac_user</a>. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af3135ba0f5c4cf3099374f612446b490"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3135ba0f5c4cf3099374f612446b490">&#9670;&nbsp;</a></span>GUAC_USER_STREAM_INDEX_MIMETYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_USER_STREAM_INDEX_MIMETYPE&#160;&#160;&#160;&quot;application/vnd.glyptodon.guacamole.stream-index+json&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mimetype of a stream containing a map of available stream names to their corresponding mimetypes. </p>
<p>The root of a Guacamole protocol object is guaranteed to have this type. </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>