Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/enet-1.1/docs/html/struct__ENetPacket.html @ 13

Last change on this file since 13 was 13, checked in by landauf, 17 years ago

added enet
File size: 5.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>enet: _ENetPacket Struct Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li id="current"><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15  </ul></div>
16<div class="tabs">
17  <ul>
18    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
19    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
20    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
21  </ul></div>
22<h1>_ENetPacket Struct Reference</h1><!-- doxytag: class="_ENetPacket" --><code>#include &lt;<a class="el" href="enet_8h-source.html">enet.h</a>&gt;</code>
23<p>
24<hr><a name="_details"></a><h2>Detailed Description</h2>
25An 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>
26ENET_PACKET_FLAG_RELIABLE - packet must be received by the target peer and resend attempts should be made until the packet is delivered<p>
27ENET_PACKET_FLAG_UNSEQUENCED - packet will not be sequenced with other packets (not supported for reliable packets)<p>
28ENET_PACKET_FLAG_NO_ALLOCATE - packet will not allocate data, and user must supply it instead<p>
29<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98">ENetPacketFlag</a> </dd></dl>
30
31<p>
32<table border="0" cellpadding="0" cellspacing="0">
33<tr><td></td></tr>
34<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d951d74263f23a529bbd57bf2316d950"></a><!-- doxytag: member="_ENetPacket::referenceCount" ref="d951d74263f23a529bbd57bf2316d950" args="" -->
36size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#d951d74263f23a529bbd57bf2316d950">referenceCount</a></td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal use only <br></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfdabe5885bc9695e2dabced27d5447a"></a><!-- doxytag: member="_ENetPacket::flags" ref="bfdabe5885bc9695e2dabced27d5447a" args="" -->
40<a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#bfdabe5885bc9695e2dabced27d5447a">flags</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">bitwise-or of ENetPacketFlag constants <br></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8b428cfa2c7a5ae9efbace5e1bded32"></a><!-- doxytag: member="_ENetPacket::data" ref="a8b428cfa2c7a5ae9efbace5e1bded32" args="" -->
44<a class="el" href="types_8h.html#34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#a8b428cfa2c7a5ae9efbace5e1bded32">data</a></td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">allocated data for packet <br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ba82e9b63e4d64fc06dcf113bb0ac77"></a><!-- doxytag: member="_ENetPacket::dataLength" ref="1ba82e9b63e4d64fc06dcf113bb0ac77" args="" -->
48size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#1ba82e9b63e4d64fc06dcf113bb0ac77">dataLength</a></td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">length of data <br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a06949fd22cef654c7ef07b8d4865a9f"></a><!-- doxytag: member="_ENetPacket::freeCallback" ref="a06949fd22cef654c7ef07b8d4865a9f" args="" -->
52ENetPacketFreeCallback&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html#a06949fd22cef654c7ef07b8d4865a9f">freeCallback</a></td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function to be called when the packet is no longer in use <br></td></tr>
55</table>
56<hr>The documentation for this struct was generated from the following file:<ul>
57<li><a class="el" href="enet_8h-source.html">enet.h</a></ul>
58<hr size="1"><address style="align: right;"><small>Generated on Wed Jun 6 14:33:50 2007 for enet by&nbsp;
59<a href="http://www.doxygen.org/index.html">
60<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
61</body>
62</html>
Note: See TracBrowser for help on using the repository browser.