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