<!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: plugin.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="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">plugin.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides functions and structures required for handling a client plugin.
<a href="#details">More...</a></p>
<p><a href="plugin_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__client__plugin.html">guac_client_plugin</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A handle to a client plugin, containing enough information about the plugin to complete the initial protocol handshake and instantiate a new client supporting the protocol provided by the client plugin. <a href="structguac__client__plugin.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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac328a06358d3e07e10999e556f77c05a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac328a06358d3e07e10999e556f77c05a"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#ac328a06358d3e07e10999e556f77c05a">GUAC_PROTOCOL_LIBRARY_PREFIX</a>   "libguac-client-"</td></tr>
<tr class="memdesc:ac328a06358d3e07e10999e556f77c05a"><td class="mdescLeft"> </td><td class="mdescRight">String prefix which begins the library filename of all client plugins. <br/></td></tr>
<tr class="separator:ac328a06358d3e07e10999e556f77c05a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3601bb5aaa3ca309987f70bd48005fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3601bb5aaa3ca309987f70bd48005fd"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#af3601bb5aaa3ca309987f70bd48005fd">GUAC_PROTOCOL_LIBRARY_SUFFIX</a>   ".so"</td></tr>
<tr class="memdesc:af3601bb5aaa3ca309987f70bd48005fd"><td class="mdescLeft"> </td><td class="mdescRight">String suffix which ends the library filename of all client plugins. <br/></td></tr>
<tr class="separator:af3601bb5aaa3ca309987f70bd48005fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ce2e3a2b6be66e9ab382fb8d2ab2621"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ce2e3a2b6be66e9ab382fb8d2ab2621"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#a4ce2e3a2b6be66e9ab382fb8d2ab2621">GUAC_PROTOCOL_NAME_LIMIT</a>   256</td></tr>
<tr class="memdesc:a4ce2e3a2b6be66e9ab382fb8d2ab2621"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of characters (COUNTING NULL TERMINATOR) to allow for protocol names within the library filename of client plugins. <br/></td></tr>
<tr class="separator:a4ce2e3a2b6be66e9ab382fb8d2ab2621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03c00580f4455d35c1ed33ed4dcfe2fe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#a03c00580f4455d35c1ed33ed4dcfe2fe">GUAC_PROTOCOL_LIBRARY_LIMIT</a></td></tr>
<tr class="memdesc:a03c00580f4455d35c1ed33ed4dcfe2fe"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of characters (INCLUDING NULL TERMINATOR) that a character array containing the concatenation of the library prefix, protocol name, and suffix can contain, assuming the protocol name is limited to GUAC_PROTOCOL_NAME_LIMIT characters. <a href="#a03c00580f4455d35c1ed33ed4dcfe2fe">More...</a><br/></td></tr>
<tr class="separator:a03c00580f4455d35c1ed33ed4dcfe2fe"><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:a5d95162caf28067b3e0c8552ad59f245"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__client__plugin.html">guac_client_plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#a5d95162caf28067b3e0c8552ad59f245">guac_client_plugin_open</a> (const char *protocol)</td></tr>
<tr class="memdesc:a5d95162caf28067b3e0c8552ad59f245"><td class="mdescLeft"> </td><td class="mdescRight">Open the plugin which provides support for the given protocol, if it exists. <a href="#a5d95162caf28067b3e0c8552ad59f245">More...</a><br/></td></tr>
<tr class="separator:a5d95162caf28067b3e0c8552ad59f245"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76adff92e9932de247e3ab8347b534f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#a76adff92e9932de247e3ab8347b534f9">guac_client_plugin_close</a> (<a class="el" href="structguac__client__plugin.html">guac_client_plugin</a> *plugin)</td></tr>
<tr class="memdesc:a76adff92e9932de247e3ab8347b534f9"><td class="mdescLeft"> </td><td class="mdescRight">Close the given plugin, releasing all associated resources. <a href="#a76adff92e9932de247e3ab8347b534f9">More...</a><br/></td></tr>
<tr class="separator:a76adff92e9932de247e3ab8347b534f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0285343fcb5a967b17b7ff39f05e96ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.html#a0285343fcb5a967b17b7ff39f05e96ce">guac_client_plugin_init_client</a> (<a class="el" href="structguac__client__plugin.html">guac_client_plugin</a> *plugin, <a class="el" href="structguac__client.html">guac_client</a> *client, int argc, char **argv)</td></tr>
<tr class="memdesc:a0285343fcb5a967b17b7ff39f05e96ce"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the given <a class="el" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> using the initialization routine provided by the given <a class="el" href="structguac__client__plugin.html" title="A handle to a client plugin, containing enough information about the plugin to complete the initial p...">guac_client_plugin</a>. <a href="#a0285343fcb5a967b17b7ff39f05e96ce">More...</a><br/></td></tr>
<tr class="separator:a0285343fcb5a967b17b7ff39f05e96ce"><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 required for handling a client plugin. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a03c00580f4455d35c1ed33ed4dcfe2fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GUAC_PROTOCOL_LIBRARY_LIMIT</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">( \</div>
<div class="line"> \</div>
<div class="line"> sizeof(<a class="code" href="plugin_8h.html#ac328a06358d3e07e10999e556f77c05a" title="String prefix which begins the library filename of all client plugins.">GUAC_PROTOCOL_LIBRARY_PREFIX</a>) - 1 <span class="comment">/* "libguac-client-" */</span> \</div>
<div class="line"> + <a class="code" href="plugin_8h.html#a4ce2e3a2b6be66e9ab382fb8d2ab2621" title="The maximum number of characters (COUNTING NULL TERMINATOR) to allow for protocol names within the li...">GUAC_PROTOCOL_NAME_LIMIT</a> - 1 <span class="comment">/* [up to 256 chars] */</span> \</div>
<div class="line"> + <span class="keyword">sizeof</span>(<a class="code" href="plugin_8h.html#af3601bb5aaa3ca309987f70bd48005fd" title="String suffix which ends the library filename of all client plugins.">GUAC_PROTOCOL_LIBRARY_SUFFIX</a>) - 1 <span class="comment">/* ".so" */</span> \</div>
<div class="line"> + 1 <span class="comment">/* NULL terminator */</span> \</div>
<div class="line"> \</div>
<div class="line">)</div>
</div><!-- fragment -->
<p>The maximum number of characters (INCLUDING NULL TERMINATOR) that a character array containing the concatenation of the library prefix, protocol name, and suffix can contain, assuming the protocol name is limited to GUAC_PROTOCOL_NAME_LIMIT characters. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a76adff92e9932de247e3ab8347b534f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_client_plugin_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__client__plugin.html">guac_client_plugin</a> * </td>
<td class="paramname"><em>plugin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the given plugin, releasing all associated resources. </p>
<p>This function must be called after use of a client plugin is finished.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin</td><td>The client plugin to close. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, non-zero if an error occurred while releasing the resources associated with the plugin. </dd></dl>
</div>
</div>
<a class="anchor" id="a0285343fcb5a967b17b7ff39f05e96ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_client_plugin_init_client </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structguac__client__plugin.html">guac_client_plugin</a> * </td>
<td class="paramname"><em>plugin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>argv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the given <a class="el" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> using the initialization routine provided by the given <a class="el" href="structguac__client__plugin.html" title="A handle to a client plugin, containing enough information about the plugin to complete the initial p...">guac_client_plugin</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin</td><td>The client plugin to use to initialize the new client. </td></tr>
<tr><td class="paramname">client</td><td>The <a class="el" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> to initialize. </td></tr>
<tr><td class="paramname">argc</td><td>The number of arguments being passed to the client. </td></tr>
<tr><td class="paramname">argv</td><td>All arguments to be passed to the client. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if initialization was successful, non-zero otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d95162caf28067b3e0c8552ad59f245"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structguac__client__plugin.html">guac_client_plugin</a>* guac_client_plugin_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>protocol</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the plugin which provides support for the given protocol, if it exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">protocol</td><td>The name of the protocol to retrieve the client plugin for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The client plugin supporting the given protocol, or NULL if an error occurs or no such plugin exists. </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>
