PageRenderTime 40ms CodeModel.GetById 2ms app.highlight 31ms RepoModel.GetById 1ms app.codeStats 0ms

/src/middleware/enet/docs/struct__ENetCompressor.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 161 lines | 153 code | 6 blank | 2 comment | 0 complexity | d3719004fa20006a4b18a98a1581324f MD5 | raw file
  1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2<html xmlns="http://www.w3.org/1999/xhtml">
  3<head>
  4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5<title>enet: _ENetCompressor Struct Reference</title>
  6<link href="tabs.css" rel="stylesheet" type="text/css"/>
  7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8</head>
  9<body>
 10<!-- Generated by Doxygen 1.7.1 -->
 11<div class="navigation" id="top">
 12  <div class="tabs">
 13    <ul class="tablist">
 14      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 15      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 16      <li><a href="modules.html"><span>Modules</span></a></li>
 17      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 18      <li><a href="files.html"><span>Files</span></a></li>
 19    </ul>
 20  </div>
 21  <div class="tabs2">
 22    <ul class="tablist">
 23      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 24      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
 25      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
 26    </ul>
 27  </div>
 28</div>
 29<div class="header">
 30  <div class="summary">
 31<a href="#pub-methods">Public Member Functions</a> &#124;
 32<a href="#pub-attribs">Data Fields</a>  </div>
 33  <div class="headertitle">
 34<h1>_ENetCompressor Struct Reference</h1>  </div>
 35</div>
 36<div class="contents">
 37<!-- doxytag: class="_ENetCompressor" -->
 38<p>An ENet packet compressor for compressing UDP packets before socket sends or receives.  
 39</p>
 40
 41<p><code>#include &lt;<a class="el" href="enet_8h_source.html">enet.h</a>&gt;</code></p>
 42<table class="memberdecls">
 43<tr><td colspan="2"><h2><a name="pub-methods"></a>
 44Public Member Functions</h2></td></tr>
 45<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetCompressor.html#a9cb68aad5a5762d43a003176278a937f">size_t</a> (ENET_CALLBACK *compress)(void *<a class="el" href="struct__ENetCompressor.html#a2818b3832d2809386ff7659d057acdc6">context</a></td></tr>
 46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compresses from inBuffers[0:inBufferCount-1], containing inLimit bytes, to outData, outputting at most outLimit bytes.  <a href="#a9cb68aad5a5762d43a003176278a937f"></a><br/></td></tr>
 47<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetCompressor.html#adeb171a64ba1b6fa37ab16476e8f81be">size_t</a> (ENET_CALLBACK *decompress)(void *<a class="el" href="struct__ENetCompressor.html#a2818b3832d2809386ff7659d057acdc6">context</a></td></tr>
 48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decompresses from inData, containing inLimit bytes, to outData, outputting at most outLimit bytes.  <a href="#adeb171a64ba1b6fa37ab16476e8f81be"></a><br/></td></tr>
 49<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetCompressor.html#aecfdee2cfc56760079096d1528db389f">void</a> (ENET_CALLBACK *destroy)(void *<a class="el" href="struct__ENetCompressor.html#a2818b3832d2809386ff7659d057acdc6">context</a>)</td></tr>
 50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the context when compression is disabled or the host is destroyed.  <a href="#aecfdee2cfc56760079096d1528db389f"></a><br/></td></tr>
 51<tr><td colspan="2"><h2><a name="pub-attribs"></a>
 52Data Fields</h2></td></tr>
 53<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetCompressor.html#a2818b3832d2809386ff7659d057acdc6">context</a></td></tr>
 54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Context data for the compressor.  <a href="#a2818b3832d2809386ff7659d057acdc6"></a><br/></td></tr>
 55<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0eaec766964bfea0849888c4a4c0ede3"></a><!-- doxytag: member="_ENetCompressor::inBuffers" ref="a0eaec766964bfea0849888c4a4c0ede3" args="" -->
 56const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>inBuffers</b></td></tr>
 57<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec3db74ce46c6a335e4447281deb322"></a><!-- doxytag: member="_ENetCompressor::inBufferCount" ref="acec3db74ce46c6a335e4447281deb322" args="" -->
 58const <a class="el" href="structENetBuffer.html">ENetBuffer</a> size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>inBufferCount</b></td></tr>
 59<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af99374ec1345eaa9e3afa0c38e51a127"></a><!-- doxytag: member="_ENetCompressor::inLimit" ref="af99374ec1345eaa9e3afa0c38e51a127" args="" -->
 60const <a class="el" href="structENetBuffer.html">ENetBuffer</a> size_t size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>inLimit</b></td></tr>
 61<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7e100475c315209de76895c9a37154b"></a><!-- doxytag: member="_ENetCompressor::outData" ref="ae7e100475c315209de76895c9a37154b" args="" -->
 62const <a class="el" href="structENetBuffer.html">ENetBuffer</a> size_t size_t <br class="typebreak"/>
 63<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>outData</b></td></tr>
 64<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabd3e23d9dd52faab3c7bc46220b80af"></a><!-- doxytag: member="_ENetCompressor::outLimit" ref="aabd3e23d9dd52faab3c7bc46220b80af" args="" -->
 65const <a class="el" href="structENetBuffer.html">ENetBuffer</a> size_t size_t <br class="typebreak"/>
 66<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>outLimit</b></td></tr>
 67<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2eeed5daf6f1e2a708edf957eb92cc42"></a><!-- doxytag: member="_ENetCompressor::inData" ref="a2eeed5daf6f1e2a708edf957eb92cc42" args="" -->
 68const <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>inData</b></td></tr>
 69<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a884b429d5e9ba4ab54c08e684d11c34c"></a><!-- doxytag: member="_ENetCompressor::inLimit" ref="a884b429d5e9ba4ab54c08e684d11c34c" args="" -->
 70const <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>inLimit</b></td></tr>
 71<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dded30384aaf4cc478dacc797506a88"></a><!-- doxytag: member="_ENetCompressor::outData" ref="a1dded30384aaf4cc478dacc797506a88" args="" -->
 72const <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> size_t <br class="typebreak"/>
 73<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>outData</b></td></tr>
 74<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f923495fa38b2e28f48b2efece8a1fb"></a><!-- doxytag: member="_ENetCompressor::outLimit" ref="a9f923495fa38b2e28f48b2efece8a1fb" args="" -->
 75const <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> size_t <br class="typebreak"/>
 76<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>outLimit</b></td></tr>
 77</table>
 78<hr/><h2>Member Function Documentation</h2>
 79<a class="anchor" id="a9cb68aad5a5762d43a003176278a937f"></a><!-- doxytag: member="_ENetCompressor::size_t" ref="a9cb68aad5a5762d43a003176278a937f" args="(ENET_CALLBACK *compress)(void *context" -->
 80<div class="memitem">
 81<div class="memproto">
 82      <table class="memname">
 83        <tr>
 84          <td class="memname">_ENetCompressor::size_t </td>
 85          <td>(</td>
 86          <td class="paramtype">ENET_CALLBACK *&nbsp;</td>
 87          <td class="paramname"> <em>compress</em></td>
 88          <td>&nbsp;)&nbsp;</td>
 89          <td></td>
 90        </tr>
 91      </table>
 92</div>
 93<div class="memdoc">
 94<p>Should return 0 on failure. </p>
 95
 96</div>
 97</div>
 98<a class="anchor" id="adeb171a64ba1b6fa37ab16476e8f81be"></a><!-- doxytag: member="_ENetCompressor::size_t" ref="adeb171a64ba1b6fa37ab16476e8f81be" args="(ENET_CALLBACK *decompress)(void *context" -->
 99<div class="memitem">
100<div class="memproto">
101      <table class="memname">
102        <tr>
103          <td class="memname">_ENetCompressor::size_t </td>
104          <td>(</td>
105          <td class="paramtype">ENET_CALLBACK *&nbsp;</td>
106          <td class="paramname"> <em>decompress</em></td>
107          <td>&nbsp;)&nbsp;</td>
108          <td></td>
109        </tr>
110      </table>
111</div>
112<div class="memdoc">
113<p>Should return 0 on failure. </p>
114
115</div>
116</div>
117<a class="anchor" id="aecfdee2cfc56760079096d1528db389f"></a><!-- doxytag: member="_ENetCompressor::void" ref="aecfdee2cfc56760079096d1528db389f" args="(ENET_CALLBACK *destroy)(void *context)" -->
118<div class="memitem">
119<div class="memproto">
120      <table class="memname">
121        <tr>
122          <td class="memname">_ENetCompressor::void </td>
123          <td>(</td>
124          <td class="paramtype">ENET_CALLBACK *&nbsp;</td>
125          <td class="paramname"> <em>destroy</em></td>
126          <td>&nbsp;)&nbsp;</td>
127          <td></td>
128        </tr>
129      </table>
130</div>
131<div class="memdoc">
132<p>May be NULL. </p>
133
134</div>
135</div>
136<hr/><h2>Field Documentation</h2>
137<a class="anchor" id="a2818b3832d2809386ff7659d057acdc6"></a><!-- doxytag: member="_ENetCompressor::context" ref="a2818b3832d2809386ff7659d057acdc6" args="" -->
138<div class="memitem">
139<div class="memproto">
140      <table class="memname">
141        <tr>
142          <td class="memname">void* <a class="el" href="struct__ENetCompressor.html#a2818b3832d2809386ff7659d057acdc6">_ENetCompressor::context</a></td>
143        </tr>
144      </table>
145</div>
146<div class="memdoc">
147<p>Must be non-NULL. </p>
148
149<p>Referenced by <a class="el" href="group__host.html#gae9e23efdfc718dedaa349891dddf529b">enet_host_compress()</a>, and <a class="el" href="group__host.html#ga444b74e7b70d97e2abd02328419be3f4">enet_host_compress_with_range_coder()</a>.</p>
150
151</div>
152</div>
153<hr/>The documentation for this struct was generated from the following file:<ul>
154<li><a class="el" href="enet_8h_source.html">enet.h</a></li>
155</ul>
156</div>
157<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
158<a href="http://www.doxygen.org/index.html">
159<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
160</body>
161</html>