<!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.3.1"/>
<title>libguac: instruction.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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">libguac
 <span id="projectnumber">0.7.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">instruction.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides functions and structures for reading, writing, and manipulating Guacamole instructions.
<a href="#details">More...</a></p>
<p><a href="instruction_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__instruction.html">guac_instruction</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a single instruction within the Guacamole protocol. <a href="structguac__instruction.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa98c61dc8c82ce9af1b69083dd9a1fe1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="instruction_8h.html#aa98c61dc8c82ce9af1b69083dd9a1fe1">guac_instruction_free</a> (<a class="el" href="structguac__instruction.html">guac_instruction</a> *instruction)</td></tr>
<tr class="memdesc:aa98c61dc8c82ce9af1b69083dd9a1fe1"><td class="mdescLeft"> </td><td class="mdescRight">Frees all memory allocated to the given instruction. <a href="#aa98c61dc8c82ce9af1b69083dd9a1fe1">More...</a><br/></td></tr>
<tr class="separator:aa98c61dc8c82ce9af1b69083dd9a1fe1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4e254615c591eb8f26e32e32a65706c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="instruction_8h.html#ae4e254615c591eb8f26e32e32a65706c">guac_instruction_waiting</a> (<a class="el" href="structguac__socket.html">guac_socket</a> *socket, int usec_timeout)</td></tr>
<tr class="memdesc:ae4e254615c591eb8f26e32e32a65706c"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether new instruction data is available on the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection for parsing. <a href="#ae4e254615c591eb8f26e32e32a65706c">More...</a><br/></td></tr>
<tr class="separator:ae4e254615c591eb8f26e32e32a65706c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4ec1deb8e06efb7c5b8acc6501039df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__instruction.html">guac_instruction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="instruction_8h.html#ad4ec1deb8e06efb7c5b8acc6501039df">guac_instruction_read</a> (<a class="el" href="structguac__socket.html">guac_socket</a> *socket, int usec_timeout)</td></tr>
<tr class="memdesc:ad4ec1deb8e06efb7c5b8acc6501039df"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single instruction from the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection. <a href="#ad4ec1deb8e06efb7c5b8acc6501039df">More...</a><br/></td></tr>
<tr class="separator:ad4ec1deb8e06efb7c5b8acc6501039df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a241426fa0e6d94d3866b994ca6b4e1ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__instruction.html">guac_instruction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="instruction_8h.html#a241426fa0e6d94d3866b994ca6b4e1ae">guac_instruction_expect</a> (<a class="el" href="structguac__socket.html">guac_socket</a> *socket, int usec_timeout, const char *opcode)</td></tr>
<tr class="memdesc:a241426fa0e6d94d3866b994ca6b4e1ae"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single instruction with the given opcode from the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection. <a href="#a241426fa0e6d94d3866b994ca6b4e1ae">More...</a><br/></td></tr>
<tr class="separator:a241426fa0e6d94d3866b994ca6b4e1ae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides functions and structures for reading, writing, and manipulating Guacamole instructions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a241426fa0e6d94d3866b994ca6b4e1ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structguac__instruction.html">guac_instruction</a>* guac_instruction_expect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__socket.html">guac_socket</a> * </td>
<td class="paramname"><em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>usec_timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opcode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a single instruction with the given opcode from the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection. </p>
<p>If an error occurs reading the instruction, NULL is returned, and guac_error is set appropriately.</p>
<p>If the instruction read is not the expected instruction, NULL is returned, and guac_error is set to GUAC_STATUS_BAD_STATE.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">socket</td><td>The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection to use. </td></tr>
<tr><td class="paramname">usec_timeout</td><td>The maximum number of microseconds to wait before giving up. </td></tr>
<tr><td class="paramname">opcode</td><td>The opcode of the instruction to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new instruction if an instruction with the given opcode was read, NULL otherwise. If an instruction was read, but the instruction had a different opcode, NULL is returned and guac_error is set to GUAC_STATUS_BAD_STATE. </dd></dl>
</div>
</div>
<a class="anchor" id="aa98c61dc8c82ce9af1b69083dd9a1fe1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void guac_instruction_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__instruction.html">guac_instruction</a> * </td>
<td class="paramname"><em>instruction</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees all memory allocated to the given instruction. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instruction</td><td>The instruction to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad4ec1deb8e06efb7c5b8acc6501039df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structguac__instruction.html">guac_instruction</a>* guac_instruction_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__socket.html">guac_socket</a> * </td>
<td class="paramname"><em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>usec_timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a single instruction from the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection. </p>
<p>If an error occurs reading the instruction, NULL is returned, and guac_error is set appropriately.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">socket</td><td>The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection to use. </td></tr>
<tr><td class="paramname">usec_timeout</td><td>The maximum number of microseconds to wait before giving up. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new instruction if data was successfully read, NULL on error or if the instruction could not be read completely because the timeout elapsed, in which case guac_error will be set to GUAC_STATUS_INPUT_TIMEOUT and subsequent calls to guac_protocol_read_instruction() will return the parsed instruction once enough data is available. </dd></dl>
</div>
</div>
<a class="anchor" id="ae4e254615c591eb8f26e32e32a65706c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_instruction_waiting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__socket.html">guac_socket</a> * </td>
<td class="paramname"><em>socket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>usec_timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether new instruction data is available on the given <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection for parsing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">socket</td><td>The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> connection to use. </td></tr>
<tr><td class="paramname">usec_timeout</td><td>The maximum number of microseconds to wait before giving up. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A positive value if data is available, negative on error, or zero if no data is currently available. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 19 2013 12:42:07 for libguac by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
