Domovská stránka Prehľadávať Pomoc
Registrovať Prihlásiť sa
samien
/
RakNet
1
0
Fork 0
Súbory Issues 0 Pull requesty 0 Wiki
Branch: master
Branche Tagy
RakNet
/
Help
/
Doxygen
/
html
/
classRakNet_1_1UDPForwarder.html

classRakNet_1_1UDPForwarder.html 15 KB
Permanentný odkaz História Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>RakNet: RakNet::UDPForwarder Class Reference</title>
    7. 

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

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td style="padding-left: 0.5em;">
    19. 

  19.    <div id="projectname">RakNet
    20. 

  20.    &#160;<span id="projectnumber">4.0</span>
    21. 

  21.    </div>
    22. 

  22.   </td>
    23. 

  23.  </tr>
    24. 

  24.  </tbody>
    25. 

  25. </table>
    26. 

  26. </div>
    27. 

  27. <!-- end header part -->
    28. 

  28. <!-- Generated by Doxygen 1.8.2 -->
    29. 

  29.   <div id="navrow1" class="tabs">
    30. 

  30.     <ul class="tablist">
    31. 

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    32. 

  32.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    35. 

  35.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.       <li><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39.   <div id="navrow2" class="tabs2">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
    42. 

  42.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
    43. 

  43.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    44. 

  44.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    45. 

  45.     </ul>
    46. 

  46.   </div>
    47. 

  47. <div id="nav-path" class="navpath">
    48. 

  48.   <ul>
    49. 

  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1UDPForwarder.html">UDPForwarder</a></li>  </ul>
    50. 

  50. </div>
    51. 

  51. </div><!-- top -->
    52. 

  52. <div class="header">
    53. 

  53.   <div class="summary">
    54. 

  54. <a href="#pub-methods">Public Member Functions</a> &#124;
    55. 

  55. <a href="classRakNet_1_1UDPForwarder-members.html">List of all members</a>  </div>
    56. 

  56.   <div class="headertitle">
    57. 

  57. <div class="title">RakNet::UDPForwarder Class Reference<div class="ingroups"><a class="el" href="group__NAT__PUNCHTHROUGH__GROUP.html">NatPunchthrough</a></div></div>  </div>
    58. 

  58. </div><!--header-->
    59. 

  59. <div class="contents">
    60. 

  60. 

  61. <p>Forwards UDP datagrams. Independent of <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>'s protocol.  
    62. 

  62.  <a href="classRakNet_1_1UDPForwarder.html#details">More...</a></p>
    63. 

  63. 

  64. <p><code>#include &lt;UDPForwarder.h&gt;</code></p>
    65. 

  65. <table class="memberdecls">
    66. 

  66. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    67. 

  67. Public Member Functions</h2></td></tr>
    68. 

  68. <tr class="memitem:a33db580779b6bc0c52e82c18c9f82e0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a33db580779b6bc0c52e82c18c9f82e0e">Startup</a> (void)</td></tr>
    69. 

  69. <tr class="separator:a33db580779b6bc0c52e82c18c9f82e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    70. 

  70. <tr class="memitem:a601f4783a6c32353a99c26d0996f0500"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a601f4783a6c32353a99c26d0996f0500"></a>
    71. 

  71. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a601f4783a6c32353a99c26d0996f0500">Shutdown</a> (void)</td></tr>
    72. 

  72. <tr class="memdesc:a601f4783a6c32353a99c26d0996f0500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the system, and frees all sockets. <br/></td></tr>
    73. 

  73. <tr class="separator:a601f4783a6c32353a99c26d0996f0500"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:a59d01c307683affb6ecf8c6a2e18d7ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a59d01c307683affb6ecf8c6a2e18d7ca">SetMaxForwardEntries</a> (unsigned short maxEntries)</td></tr>
    75. 

  75. <tr class="separator:a59d01c307683affb6ecf8c6a2e18d7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:a48432aa3792333a7372748b10e085b03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a48432aa3792333a7372748b10e085b03">GetMaxForwardEntries</a> (void) const </td></tr>
    77. 

  77. <tr class="separator:a48432aa3792333a7372748b10e085b03"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:a905a55dfed3c5580971c1324cf014fbf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a905a55dfed3c5580971c1324cf014fbf">GetUsedForwardEntries</a> (void) const </td></tr>
    79. 

  79. <tr class="separator:a905a55dfed3c5580971c1324cf014fbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ab7f8cd50c56845a8822c3ba0fbf3ab92"><td class="memItemLeft" align="right" valign="top">UDPForwarderResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#ab7f8cd50c56845a8822c3ba0fbf3ab92">StartForwarding</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> source, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> destination, RakNet::TimeMS timeoutOnNoDataMS, const char *forceHostAddress, unsigned short socketFamily, unsigned short *forwardingPort, __UDPSOCKET__ *forwardingSocket)</td></tr>
    81. 

  81. <tr class="separator:ab7f8cd50c56845a8822c3ba0fbf3ab92"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. <tr class="memitem:a4611e9e3408e73980c5978e972a2dbd8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1UDPForwarder.html#a4611e9e3408e73980c5978e972a2dbd8">StopForwarding</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> source, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> destination)</td></tr>
    83. 

  83. <tr class="separator:a4611e9e3408e73980c5978e972a2dbd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    84. 

  84. </table>
    85. 

  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    86. 

  86. <div class="textblock"><p>Forwards UDP datagrams. Independent of <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>'s protocol. </p>
    87. 

  87. </div><h2 class="groupheader">Member Function Documentation</h2>
    88. 

  88. <a class="anchor" id="a48432aa3792333a7372748b10e085b03"></a>
    89. 

  89. <div class="memitem">
    90. 

  90. <div class="memproto">
    91. 

  91.       <table class="memname">
    92. 

  92.         <tr>
    93. 

  93.           <td class="memname">int RakNet::UDPForwarder::GetMaxForwardEntries </td>
    94. 

  94.           <td>(</td>
    95. 

  95.           <td class="paramtype">void&#160;</td>
    96. 

  96.           <td class="paramname"></td><td>)</td>
    97. 

  97.           <td> const</td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

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

  101. <dl class="section return"><dt>Returns</dt><dd>The <em>maxEntries</em> parameter passed to <a class="el" href="classRakNet_1_1UDPForwarder.html#a59d01c307683affb6ecf8c6a2e18d7ca">SetMaxForwardEntries()</a>, or the default if it was never called </dd></dl>
    102. 

  102. 

  103. </div>
    104. 

  104. </div>
    105. 

  105. <a class="anchor" id="a905a55dfed3c5580971c1324cf014fbf"></a>
    106. 

  106. <div class="memitem">
    107. 

  107. <div class="memproto">
    108. 

  108.       <table class="memname">
    109. 

  109.         <tr>
    110. 

  110.           <td class="memname">int RakNet::UDPForwarder::GetUsedForwardEntries </td>
    111. 

  111.           <td>(</td>
    112. 

  112.           <td class="paramtype">void&#160;</td>
    113. 

  113.           <td class="paramname"></td><td>)</td>
    114. 

  114.           <td> const</td>
    115. 

  115.         </tr>
    116. 

  116.       </table>
    117. 

  117. </div><div class="memdoc">
    118. 

  118. <dl class="section return"><dt>Returns</dt><dd>How many entries have been used </dd></dl>
    119. 

  119. 

  120. </div>
    121. 

  121. </div>
    122. 

  122. <a class="anchor" id="a59d01c307683affb6ecf8c6a2e18d7ca"></a>
    123. 

  123. <div class="memitem">
    124. 

  124. <div class="memproto">
    125. 

  125.       <table class="memname">
    126. 

  126.         <tr>
    127. 

  127.           <td class="memname">void RakNet::UDPForwarder::SetMaxForwardEntries </td>
    128. 

  128.           <td>(</td>
    129. 

  129.           <td class="paramtype">unsigned short&#160;</td>
    130. 

  130.           <td class="paramname"><em>maxEntries</em></td><td>)</td>
    131. 

  131.           <td></td>
    132. 

  132.         </tr>
    133. 

  133.       </table>
    134. 

  134. </div><div class="memdoc">
    135. 

  135. <p>Sets the maximum number of forwarding entries allowed Set according to your available bandwidth and the estimated average bandwidth per forwarded address. </p>
    136. 

  136. <dl class="params"><dt>Parameters</dt><dd>
    137. 

  137.   <table class="params">
    138. 

  138.     <tr><td class="paramdir">[in]</td><td class="paramname">maxEntries</td><td>The maximum number of simultaneous forwarding entries. Defaults to 64 (32 connections) </td></tr>
    139. 

  139.   </table>
    140. 

  140.   </dd>
    141. 

  141. </dl>
    142. 

  142. 

  143. </div>
    144. 

  144. </div>
    145. 

  145. <a class="anchor" id="ab7f8cd50c56845a8822c3ba0fbf3ab92"></a>
    146. 

  146. <div class="memitem">
    147. 

  147. <div class="memproto">
    148. 

  148.       <table class="memname">
    149. 

  149.         <tr>
    150. 

  150.           <td class="memname">UDPForwarderResult RakNet::UDPForwarder::StartForwarding </td>
    151. 

  151.           <td>(</td>
    152. 

  152.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    153. 

  153.           <td class="paramname"><em>source</em>, </td>
    154. 

  154.         </tr>
    155. 

  155.         <tr>
    156. 

  156.           <td class="paramkey"></td>
    157. 

  157.           <td></td>
    158. 

  158.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    159. 

  159.           <td class="paramname"><em>destination</em>, </td>
    160. 

  160.         </tr>
    161. 

  161.         <tr>
    162. 

  162.           <td class="paramkey"></td>
    163. 

  163.           <td></td>
    164. 

  164.           <td class="paramtype">RakNet::TimeMS&#160;</td>
    165. 

  165.           <td class="paramname"><em>timeoutOnNoDataMS</em>, </td>
    166. 

  166.         </tr>
    167. 

  167.         <tr>
    168. 

  168.           <td class="paramkey"></td>
    169. 

  169.           <td></td>
    170. 

  170.           <td class="paramtype">const char *&#160;</td>
    171. 

  171.           <td class="paramname"><em>forceHostAddress</em>, </td>
    172. 

  172.         </tr>
    173. 

  173.         <tr>
    174. 

  174.           <td class="paramkey"></td>
    175. 

  175.           <td></td>
    176. 

  176.           <td class="paramtype">unsigned short&#160;</td>
    177. 

  177.           <td class="paramname"><em>socketFamily</em>, </td>
    178. 

  178.         </tr>
    179. 

  179.         <tr>
    180. 

  180.           <td class="paramkey"></td>
    181. 

  181.           <td></td>
    182. 

  182.           <td class="paramtype">unsigned short *&#160;</td>
    183. 

  183.           <td class="paramname"><em>forwardingPort</em>, </td>
    184. 

  184.         </tr>
    185. 

  185.         <tr>
    186. 

  186.           <td class="paramkey"></td>
    187. 

  187.           <td></td>
    188. 

  188.           <td class="paramtype">__UDPSOCKET__ *&#160;</td>
    189. 

  189.           <td class="paramname"><em>forwardingSocket</em>&#160;</td>
    190. 

  190.         </tr>
    191. 

  191.         <tr>
    192. 

  192.           <td></td>
    193. 

  193.           <td>)</td>
    194. 

  194.           <td></td><td></td>
    195. 

  195.         </tr>
    196. 

  196.       </table>
    197. 

  197. </div><div class="memdoc">
    198. 

  198. <p>Forwards datagrams from source to destination, and vice-versa Does nothing if this forward entry already exists via a previous call </p>
    199. 

  199. <dl class="section pre"><dt>Precondition</dt><dd>Call <a class="el" href="classRakNet_1_1UDPForwarder.html#a33db580779b6bc0c52e82c18c9f82e0e">Startup()</a> </dd></dl>
    200. 

  200. <dl class="section note"><dt>Note</dt><dd><a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a>'s protocol will ensure a message is sent at least every 15 seconds, so if routing <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> messages, it is a reasonable value for timeoutOnNoDataMS, plus an some extra seconds for latency </dd></dl>
    201. 

  201. <dl class="params"><dt>Parameters</dt><dd>
    202. 

  202.   <table class="params">
    203. 

  203.     <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>The source IP and port </td></tr>
    204. 

  204.     <tr><td class="paramdir">[in]</td><td class="paramname">destination</td><td>Where to forward to (and vice-versa) </td></tr>
    205. 

  205.     <tr><td class="paramdir">[in]</td><td class="paramname">timeoutOnNoDataMS</td><td>If no messages are forwarded for this many MS, then automatically remove this entry. </td></tr>
    206. 

  206.     <tr><td class="paramdir">[in]</td><td class="paramname">forceHostAddress</td><td>Force binding on a particular address. 0 to use any. </td></tr>
    207. 

  207.     <tr><td class="paramdir">[in]</td><td class="paramname">socketFamily</td><td>IP version: For IPV4, use AF_INET (default). For IPV6, use AF_INET6. To autoselect, use AF_UNSPEC. </td></tr>
    208. 

  208.     <tr><td class="paramdir">[out]</td><td class="paramname">forwardingPort</td><td>New opened port for forwarding </td></tr>
    209. 

  209.     <tr><td class="paramdir">[out]</td><td class="paramname">forwardingSocket</td><td>New opened socket for forwarding </td></tr>
    210. 

  210.   </table>
    211. 

  211.   </dd>
    212. 

  212. </dl>
    213. 

  213. <dl class="section return"><dt>Returns</dt><dd>UDPForwarderResult </dd></dl>
    214. 

  214. 

  215. </div>
    216. 

  216. </div>
    217. 

  217. <a class="anchor" id="a33db580779b6bc0c52e82c18c9f82e0e"></a>
    218. 

  218. <div class="memitem">
    219. 

  219. <div class="memproto">
    220. 

  220.       <table class="memname">
    221. 

  221.         <tr>
    222. 

  222.           <td class="memname">void RakNet::UDPForwarder::Startup </td>
    223. 

  223.           <td>(</td>
    224. 

  224.           <td class="paramtype">void&#160;</td>
    225. 

  225.           <td class="paramname"></td><td>)</td>
    226. 

  226.           <td></td>
    227. 

  227.         </tr>
    228. 

  228.       </table>
    229. 

  229. </div><div class="memdoc">
    230. 

  230. <p>Starts the system. Required to call before StartForwarding </p>
    231. 

  231. 

  232. </div>
    233. 

  233. </div>
    234. 

  234. <a class="anchor" id="a4611e9e3408e73980c5978e972a2dbd8"></a>
    235. 

  235. <div class="memitem">
    236. 

  236. <div class="memproto">
    237. 

  237.       <table class="memname">
    238. 

  238.         <tr>
    239. 

  239.           <td class="memname">void RakNet::UDPForwarder::StopForwarding </td>
    240. 

  240.           <td>(</td>
    241. 

  241.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    242. 

  242.           <td class="paramname"><em>source</em>, </td>
    243. 

  243.         </tr>
    244. 

  244.         <tr>
    245. 

  245.           <td class="paramkey"></td>
    246. 

  246.           <td></td>
    247. 

  247.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    248. 

  248.           <td class="paramname"><em>destination</em>&#160;</td>
    249. 

  249.         </tr>
    250. 

  250.         <tr>
    251. 

  251.           <td></td>
    252. 

  252.           <td>)</td>
    253. 

  253.           <td></td><td></td>
    254. 

  254.         </tr>
    255. 

  255.       </table>
    256. 

  256. </div><div class="memdoc">
    257. 

  257. <p>No longer forward datagrams from source to destination </p>
    258. 

  258. <dl class="params"><dt>Parameters</dt><dd>
    259. 

  259.   <table class="params">
    260. 

  260.     <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>The source IP and port </td></tr>
    261. 

  261.     <tr><td class="paramdir">[in]</td><td class="paramname">destination</td><td>Where to forward to </td></tr>
    262. 

  262.   </table>
    263. 

  263.   </dd>
    264. 

  264. </dl>
    265. 

  265. 

  266. </div>
    267. 

  267. </div>
    268. 

  268. <hr/>The documentation for this class was generated from the following file:<ul>
    269. 

  269. <li>D:/temp/RakNet_PC/Source/<a class="el" href="UDPForwarder_8h.html">UDPForwarder.h</a></li>
    270. 

  270. </ul>
    271. 

  271. </div><!-- contents -->
    272. 

  272. <!-- start footer part -->
    273. 

  273. <hr class="footer"/><address class="footer"><small>
    274. 

  274. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
    275. 

  275. <img class="footer" src="doxygen.png" alt="doxygen"/>
    276. 

  276. </a> 1.8.2
    277. 

  277. </small></address>
    278. 

  278. </body>
    279. 

  279. </html>
    280.
粤ICP备19079148号