blob: 842228f2db547cf65d21dc326a50e4692306f9b4 [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/client-types.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="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">client-types.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Type definitions 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-types_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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6f7e91d6dcb20598953948f077910c3b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3b">guac_client_state</a> { <a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3bad1ddb6f9bcfcd89a9d8522acfd74d2b0">GUAC_CLIENT_RUNNING</a>,
<a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3ba5a21704bd35c396c4c640e0b1fc0c8fd">GUAC_CLIENT_STOPPING</a>
}</td></tr>
<tr class="memdesc:a6f7e91d6dcb20598953948f077910c3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Possible current states of the Guacamole client. <a href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3b">More...</a><br /></td></tr>
<tr class="separator:a6f7e91d6dcb20598953948f077910c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfeeb4ff06541220c91ce3401d840727"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">guac_client_log_level</a> { <br />
&#160;&#160;<a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727a4fd231414f22c9a104106ddaf2b12c2c">GUAC_LOG_ERROR</a> = 3,
<a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727a24865770a939aa238cd69cd7f11205be">GUAC_LOG_WARNING</a> = 4,
<a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727aedc7d68f866aa570a055a88030d36b29">GUAC_LOG_INFO</a> = 6,
<a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727a070794a24cef7ef430b2edaff3c9ea9b">GUAC_LOG_DEBUG</a> = 7,
<br />
&#160;&#160;<a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727ab507f156c21f790e9311c6c19f8a79eb">GUAC_LOG_TRACE</a> = 8
<br />
}</td></tr>
<tr class="memdesc:adfeeb4ff06541220c91ce3401d840727"><td class="mdescLeft">&#160;</td><td class="mdescRight">All supported log levels used by the logging subsystem of each Guacamole client. <a href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">More...</a><br /></td></tr>
<tr class="separator:adfeeb4ff06541220c91ce3401d840727"><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>Type definitions 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">Enumeration Type Documentation</h2>
<a id="adfeeb4ff06541220c91ce3401d840727"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfeeb4ff06541220c91ce3401d840727">&#9670;&nbsp;</a></span>guac_client_log_level</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="client-types_8h.html#adfeeb4ff06541220c91ce3401d840727">guac_client_log_level</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>All supported log levels used by the logging subsystem of each Guacamole client. </p>
<p>With the exception of GUAC_LOG_TRACE, these log levels correspond to a subset of the log levels defined by RFC 5424. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adfeeb4ff06541220c91ce3401d840727a4fd231414f22c9a104106ddaf2b12c2c"></a>GUAC_LOG_ERROR&#160;</td><td class="fielddoc"><p>Fatal errors. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfeeb4ff06541220c91ce3401d840727a24865770a939aa238cd69cd7f11205be"></a>GUAC_LOG_WARNING&#160;</td><td class="fielddoc"><p>Non-fatal conditions that indicate problems. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfeeb4ff06541220c91ce3401d840727aedc7d68f866aa570a055a88030d36b29"></a>GUAC_LOG_INFO&#160;</td><td class="fielddoc"><p>Informational messages of general interest to users or administrators. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfeeb4ff06541220c91ce3401d840727a070794a24cef7ef430b2edaff3c9ea9b"></a>GUAC_LOG_DEBUG&#160;</td><td class="fielddoc"><p>Informational messages which can be useful for debugging, but are otherwise not useful to users or administrators. </p>
<p>It is expected that debug level messages, while verbose, will not negatively affect performance. </p>
</td></tr>
<tr><td class="fieldname"><a id="adfeeb4ff06541220c91ce3401d840727ab507f156c21f790e9311c6c19f8a79eb"></a>GUAC_LOG_TRACE&#160;</td><td class="fielddoc"><p>Informational messages which can be useful for debugging, like GUAC_LOG_DEBUG, but which are so low-level that they may affect performance. </p>
</td></tr>
</table>
</div>
</div>
<a id="a6f7e91d6dcb20598953948f077910c3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f7e91d6dcb20598953948f077910c3b">&#9670;&nbsp;</a></span>guac_client_state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="client-types_8h.html#a6f7e91d6dcb20598953948f077910c3b">guac_client_state</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible current states of the Guacamole client. </p>
<p>Currently, the only two states are GUAC_CLIENT_RUNNING and GUAC_CLIENT_STOPPING. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6f7e91d6dcb20598953948f077910c3bad1ddb6f9bcfcd89a9d8522acfd74d2b0"></a>GUAC_CLIENT_RUNNING&#160;</td><td class="fielddoc"><p>The state of the client from when it has been allocated by the main daemon until it is killed or disconnected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6f7e91d6dcb20598953948f077910c3ba5a21704bd35c396c4c640e0b1fc0c8fd"></a>GUAC_CLIENT_STOPPING&#160;</td><td class="fielddoc"><p>The state of the client when a stop has been requested, signalling the I/O threads to shutdown. </p>
</td></tr>
</table>
</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>