/src/middleware/enet/docs/group__Packet.html

https://bitbucket.org/vivkin/gam3b00bs/ · HTML · 156 lines · 148 code · 7 blank · 1 comment · 0 complexity · 0f1d4e259a7c2f56d5970bb509c39aa5 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. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>enet: ENet packet functions</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.7.1 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul class="tablist">
    14. 

  14.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.       <li><a href="modules.html"><span>Modules</span></a></li>
    17. 

  17.       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    18. 

  18.       <li><a href="files.html"><span>Files</span></a></li>
    19. 

  19.     </ul>
    20. 

  20.   </div>
    21. 

  21. </div>
    22. 

  22. <div class="header">
    23. 

  23.   <div class="summary">
    24. 

  24. <a href="#func-members">Functions</a>  </div>
    25. 

  25.   <div class="headertitle">
    26. 

  26. <h1>ENet packet functions</h1>  </div>
    27. 

  27. </div>
    28. 

  28. <div class="contents">
    29. 

  29. <table class="memberdecls">
    30. 

  30. <tr><td colspan="2"><h2><a name="func-members"></a>
    31. 

  31. Functions</h2></td></tr>
    32. 

  32. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#gaac61b251aebbf9f5e5e313eca51339ea">enet_packet_create</a> (const void *data, size_t dataLength, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> flags)</td></tr>
    33. 

  33. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a packet that may be sent to a peer.  <a href="#gaac61b251aebbf9f5e5e313eca51339ea"></a><br/></td></tr>
    34. 

  34. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#gab58895376ee4ade8f4e13761a44ba263">enet_packet_destroy</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *packet)</td></tr>
    35. 

  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the packet and deallocates its data.  <a href="#gab58895376ee4ade8f4e13761a44ba263"></a><br/></td></tr>
    36. 

  36. <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#ga0aee7f8c7e2d2c4b64f6d68d930155a8">enet_packet_resize</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *packet, size_t dataLength)</td></tr>
    37. 

  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to resize the data in the packet to length specified in the dataLength parameter.  <a href="#ga0aee7f8c7e2d2c4b64f6d68d930155a8"></a><br/></td></tr>
    38. 

  38. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga015ce0307049901852c54dd2def532e2"></a><!-- doxytag: member="Packet::enet_crc32" ref="ga015ce0307049901852c54dd2def532e2" args="(const ENetBuffer *buffers, size_t bufferCount)" -->
    39. 

  39. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_crc32</b> (const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *buffers, size_t bufferCount)</td></tr>
    40. 

  40. </table>
    41. 

  41. <hr/><h2>Function Documentation</h2>
    42. 

  42. <a class="anchor" id="gaac61b251aebbf9f5e5e313eca51339ea"></a><!-- doxytag: member="packet.c::enet_packet_create" ref="gaac61b251aebbf9f5e5e313eca51339ea" args="(const void *data, size_t dataLength, enet_uint32 flags)" -->
    43. 

  43. <div class="memitem">
    44. 

  44. <div class="memproto">
    45. 

  45.       <table class="memname">
    46. 

  46.         <tr>
    47. 

  47.           <td class="memname"><a class="el" href="struct__ENetPacket.html">ENetPacket</a>* enet_packet_create </td>
    48. 

  48.           <td>(</td>
    49. 

  49.           <td class="paramtype">const void *&nbsp;</td>
    50. 

  50.           <td class="paramname"> <em>data</em>, </td>
    51. 

  51.         </tr>
    52. 

  52.         <tr>
    53. 

  53.           <td class="paramkey"></td>
    54. 

  54.           <td></td>
    55. 

  55.           <td class="paramtype">size_t&nbsp;</td>
    56. 

  56.           <td class="paramname"> <em>dataLength</em>, </td>
    57. 

  57.         </tr>
    58. 

  58.         <tr>
    59. 

  59.           <td class="paramkey"></td>
    60. 

  60.           <td></td>
    61. 

  61.           <td class="paramtype"><a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td>
    62. 

  62.           <td class="paramname"> <em>flags</em></td><td>&nbsp;</td>
    63. 

  63.         </tr>
    64. 

  64.         <tr>
    65. 

  65.           <td></td>
    66. 

  66.           <td>)</td>
    67. 

  67.           <td></td><td></td><td></td>
    68. 

  68.         </tr>
    69. 

  69.       </table>
    70. 

  70. </div>
    71. 

  71. <div class="memdoc">
    72. 

  72. <dl><dt><b>Parameters:</b></dt><dd>
    73. 

  73.   <table border="0" cellspacing="2" cellpadding="0">
    74. 

  74.     <tr><td valign="top"></td><td valign="top"><em>dataContents</em>&nbsp;</td><td>initial contents of the packet's data; the packet's data will remain uninitialized if dataContents is NULL. </td></tr>
    75. 

  75.     <tr><td valign="top"></td><td valign="top"><em>dataLength</em>&nbsp;</td><td>size of the data allocated for this packet </td></tr>
    76. 

  76.     <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>flags for this packet as described for the ENetPacket structure. </td></tr>
    77. 

  77.   </table>
    78. 

  78.   </dd>
    79. 

  79. </dl>
    80. 

  80. <dl class="return"><dt><b>Returns:</b></dt><dd>the packet on success, NULL on failure </dd></dl>
    81. 

  81. 

  82. <p>References <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c">ENET_PACKET_FLAG_NO_ALLOCATE</a>.</p>
    83. 

  83. 

  84. </div>
    85. 

  85. </div>
    86. 

  86. <a class="anchor" id="gab58895376ee4ade8f4e13761a44ba263"></a><!-- doxytag: member="packet.c::enet_packet_destroy" ref="gab58895376ee4ade8f4e13761a44ba263" args="(ENetPacket *packet)" -->
    87. 

  87. <div class="memitem">
    88. 

  88. <div class="memproto">
    89. 

  89.       <table class="memname">
    90. 

  90.         <tr>
    91. 

  91.           <td class="memname">void enet_packet_destroy </td>
    92. 

  92.           <td>(</td>
    93. 

  93.           <td class="paramtype"><a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td>
    94. 

  94.           <td class="paramname"> <em>packet</em></td>
    95. 

  95.           <td>&nbsp;)&nbsp;</td>
    96. 

  96.           <td></td>
    97. 

  97.         </tr>
    98. 

  98.       </table>
    99. 

  99. </div>
    100. 

  100. <div class="memdoc">
    101. 

  101. <dl><dt><b>Parameters:</b></dt><dd>
    102. 

  102.   <table border="0" cellspacing="2" cellpadding="0">
    103. 

  103.     <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>packet to be destroyed </td></tr>
    104. 

  104.   </table>
    105. 

  105.   </dd>
    106. 

  106. </dl>
    107. 

  107. 

  108. <p>References <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c">ENET_PACKET_FLAG_NO_ALLOCATE</a>.</p>
    109. 

  109. 

  110. <p>Referenced by <a class="el" href="group__host.html#ga5190a63f78eb0c15bd96cda44bf423c6">enet_host_broadcast()</a>.</p>
    111. 

  111. 

  112. </div>
    113. 

  113. </div>
    114. 

  114. <a class="anchor" id="ga0aee7f8c7e2d2c4b64f6d68d930155a8"></a><!-- doxytag: member="packet.c::enet_packet_resize" ref="ga0aee7f8c7e2d2c4b64f6d68d930155a8" args="(ENetPacket *packet, size_t dataLength)" -->
    115. 

  115. <div class="memitem">
    116. 

  116. <div class="memproto">
    117. 

  117.       <table class="memname">
    118. 

  118.         <tr>
    119. 

  119.           <td class="memname">int enet_packet_resize </td>
    120. 

  120.           <td>(</td>
    121. 

  121.           <td class="paramtype"><a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td>
    122. 

  122.           <td class="paramname"> <em>packet</em>, </td>
    123. 

  123.         </tr>
    124. 

  124.         <tr>
    125. 

  125.           <td class="paramkey"></td>
    126. 

  126.           <td></td>
    127. 

  127.           <td class="paramtype">size_t&nbsp;</td>
    128. 

  128.           <td class="paramname"> <em>dataLength</em></td><td>&nbsp;</td>
    129. 

  129.         </tr>
    130. 

  130.         <tr>
    131. 

  131.           <td></td>
    132. 

  132.           <td>)</td>
    133. 

  133.           <td></td><td></td><td></td>
    134. 

  134.         </tr>
    135. 

  135.       </table>
    136. 

  136. </div>
    137. 

  137. <div class="memdoc">
    138. 

  138. <dl><dt><b>Parameters:</b></dt><dd>
    139. 

  139.   <table border="0" cellspacing="2" cellpadding="0">
    140. 

  140.     <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>packet to resize </td></tr>
    141. 

  141.     <tr><td valign="top"></td><td valign="top"><em>dataLength</em>&nbsp;</td><td>new size for the packet data </td></tr>
    142. 

  142.   </table>
    143. 

  143.   </dd>
    144. 

  144. </dl>
    145. 

  145. <dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, &lt; 0 on failure </dd></dl>
    146. 

  146. 

  147. <p>References <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c">ENET_PACKET_FLAG_NO_ALLOCATE</a>.</p>
    148. 

  148. 

  149. </div>
    150. 

  150. </div>
    151. 

  151. </div>
    152. 

  152. <hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
    153. 

  153. <a href="http://www.doxygen.org/index.html">
    154. 

  154. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
    155. 

  155. </body>
    156. 

  156. </html>
    157.