PageRenderTime 31ms CodeModel.GetById 21ms app.highlight 7ms RepoModel.GetById 1ms app.codeStats 0ms

/src/middleware/enet/docs/struct__ENetPacket.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 74 lines | 71 code | 1 blank | 2 comment | 0 complexity | 25629c05b3e3e50fbaf479c0dc51e040 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: _ENetPacket 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-attribs">Data Fields</a>  </div>
32  <div class="headertitle">
33<h1>_ENetPacket Struct Reference</h1>  </div>
34</div>
35<div class="contents">
36<!-- doxytag: class="_ENetPacket" -->
37<p>ENet packet structure.  
38<a href="#_details">More...</a></p>
39
40<p><code>#include &lt;<a class="el" href="enet_8h_source.html">enet.h</a>&gt;</code></p>
41<table class="memberdecls">
42<tr><td colspan="2"><h2><a name="pub-attribs"></a>
43Data Fields</h2></td></tr>
44<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad951d74263f23a529bbd57bf2316d950"></a><!-- doxytag: member="_ENetPacket::referenceCount" ref="ad951d74263f23a529bbd57bf2316d950" args="" -->
45size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#ad951d74263f23a529bbd57bf2316d950">referenceCount</a></td></tr>
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal use only <br/></td></tr>
47<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfdabe5885bc9695e2dabced27d5447a"></a><!-- doxytag: member="_ENetPacket::flags" ref="abfdabe5885bc9695e2dabced27d5447a" args="" -->
48<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#abfdabe5885bc9695e2dabced27d5447a">flags</a></td></tr>
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">bitwise-or of ENetPacketFlag constants <br/></td></tr>
50<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8b428cfa2c7a5ae9efbace5e1bded32"></a><!-- doxytag: member="_ENetPacket::data" ref="aa8b428cfa2c7a5ae9efbace5e1bded32" args="" -->
51<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#aa8b428cfa2c7a5ae9efbace5e1bded32">data</a></td></tr>
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">allocated data for packet <br/></td></tr>
53<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ba82e9b63e4d64fc06dcf113bb0ac77"></a><!-- doxytag: member="_ENetPacket::dataLength" ref="a1ba82e9b63e4d64fc06dcf113bb0ac77" args="" -->
54size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#a1ba82e9b63e4d64fc06dcf113bb0ac77">dataLength</a></td></tr>
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">length of data <br/></td></tr>
56<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa06949fd22cef654c7ef07b8d4865a9f"></a><!-- doxytag: member="_ENetPacket::freeCallback" ref="aa06949fd22cef654c7ef07b8d4865a9f" args="" -->
57ENetPacketFreeCallback&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#aa06949fd22cef654c7ef07b8d4865a9f">freeCallback</a></td></tr>
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function to be called when the packet is no longer in use <br/></td></tr>
59</table>
60<hr/><a name="_details"></a><h2>Detailed Description</h2>
61<p>An ENet data packet that may be sent to or received from a peer. The shown fields should only be read and never modified. The data field contains the allocated data for the packet. The dataLength fields specifies the length of the allocated data. The flags field is either 0 (specifying no flags), or a bitwise-or of any combination of the following flags:</p>
62<p>ENET_PACKET_FLAG_RELIABLE - packet must be received by the target peer and resend attempts should be made until the packet is delivered</p>
63<p>ENET_PACKET_FLAG_UNSEQUENCED - packet will not be sequenced with other packets (not supported for reliable packets)</p>
64<p>ENET_PACKET_FLAG_NO_ALLOCATE - packet will not allocate data, and user must supply it instead</p>
65<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#a8441ed0d3b01899c4b7c6e9c5d72aa41" title="Packet flag bit constants.">ENetPacketFlag</a> </dd></dl>
66<hr/>The documentation for this struct was generated from the following file:<ul>
67<li><a class="el" href="enet_8h_source.html">enet.h</a></li>
68</ul>
69</div>
70<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
71<a href="http://www.doxygen.org/index.html">
72<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
73</body>
74</html>