| <!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"/> |
| <title>libguac: guacamole/plugin.h Source File</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.8.2</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.1.2 --> |
| <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 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="headertitle"> |
| <div class="title">plugin.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="plugin_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* ***** BEGIN LICENSE BLOCK *****</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Version: MPL 1.1/GPL 2.0/LGPL 2.1</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The contents of this file are subject to the Mozilla Public License Version</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * 1.1 (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.mozilla.org/MPL/</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Software distributed under the License is distributed on an "AS IS" basis,</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * for the specific language governing rights and limitations under the</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * License.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * The Original Code is libguac.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * The Initial Developer of the Original Code is</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Michael Jumper.</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Portions created by the Initial Developer are Copyright (C) 2010</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * the Initial Developer. All Rights Reserved.</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Contributor(s):</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Alternatively, the contents of this file may be used under the terms of</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * either the GNU General Public License Version 2 or later (the "GPL"), or</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * in which case the provisions of the GPL or the LGPL are applicable instead</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * of those above. If you wish to allow use of your version of this file only</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * under the terms of either the GPL or the LGPL, and not to allow others to</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * use your version of this file under the terms of the MPL, indicate your</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * decision by deleting the provisions above and replace them with the notice</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * and other provisions required by the GPL or the LGPL. If you do not delete</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * the provisions above, a recipient may use your version of this file under</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * the terms of any one of the MPL, the GPL or the LGPL.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * ***** END LICENSE BLOCK ***** */</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef _GUAC_PLUGIN_H</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define _GUAC_PLUGIN_H</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "<a class="code" href="client_8h.html" title="Provides functions and structures required for defining (and handling) a proxy client.">client.h</a>"</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="plugin_8h.html#ac328a06358d3e07e10999e556f77c05a"> 53</a></span> <span class="preprocessor">#define GUAC_PROTOCOL_LIBRARY_PREFIX "libguac-client-"</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="plugin_8h.html#af3601bb5aaa3ca309987f70bd48005fd"> 58</a></span> <span class="preprocessor">#define GUAC_PROTOCOL_LIBRARY_SUFFIX ".so"</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="plugin_8h.html#a4ce2e3a2b6be66e9ab382fb8d2ab2621"> 64</a></span> <span class="preprocessor">#define GUAC_PROTOCOL_NAME_LIMIT 256</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="plugin_8h.html#a03c00580f4455d35c1ed33ed4dcfe2fe"> 72</a></span> <span class="preprocessor">#define GUAC_PROTOCOL_LIBRARY_LIMIT ( \</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> sizeof(GUAC_PROTOCOL_LIBRARY_PREFIX) - 1 </span><span class="comment">/* "libguac-client-" */</span><span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> + GUAC_PROTOCOL_NAME_LIMIT - 1 </span><span class="comment">/* [up to 256 chars] */</span><span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> + sizeof(GUAC_PROTOCOL_LIBRARY_SUFFIX) - 1 </span><span class="comment">/* ".so" */</span><span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"> + 1 </span><span class="comment">/* NULL terminator */</span><span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"> \</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">)</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" 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 class="code" 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>;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="structguac__client__plugin.html"> 88</a></span> <span class="keyword">struct </span><a class="code" 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> {</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span>* __client_plugin_handle;</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="structguac__client__plugin.html#af650493e50e6abd9b0bb33c917bd0b95"> 99</a></span>  <a class="code" href="client_8h.html#a803471317059958932af72f632928ff4" title="Handler which should initialize the given guac_client.">guac_client_init_handler</a>* <a class="code" href="structguac__client__plugin.html#af650493e50e6abd9b0bb33c917bd0b95" title="Reference to the init handler of this client plugin.">init_handler</a>;</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="structguac__client__plugin.html#afdcc20662bdf6e448ebe55967331b79a"> 106</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>** <a class="code" href="structguac__client__plugin.html#afdcc20662bdf6e448ebe55967331b79a" title="NULL-terminated array of all arguments accepted by this client plugin, in order.">args</a>;</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <a class="code" 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 class="code" href="plugin_8h.html#a5d95162caf28067b3e0c8552ad59f245" title="Open the plugin which provides support for the given protocol, if it exists.">guac_client_plugin_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* protocol);</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">int</span> <a class="code" href="plugin_8h.html#a76adff92e9932de247e3ab8347b534f9" title="Close the given plugin, releasing all associated resources.">guac_client_plugin_close</a>(<a class="code" 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>* plugin);</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">int</span> <a class="code" href="plugin_8h.html#a0285343fcb5a967b17b7ff39f05e96ce" title="Initializes the given guac_client using the initialization routine provided by the given guac_client_...">guac_client_plugin_init_client</a>(<a class="code" 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>* plugin, </div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a>* client, <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv);</div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Fri Mar 28 2014 21:41:58 for libguac by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.1.2 |
| </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> |
| <!-- End Google Analytics --> |
| </body> |
| </html> |
