classRakNet_1_1RakNetTransport2.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>RakNet: RakNet::RakNetTransport2 Class Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td style="padding-left: 0.5em;">
  19. <div id="projectname">RakNet
  20. &#160;<span id="projectnumber">4.0</span>
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.2 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. <div id="navrow2" class="tabs2">
  40. <ul class="tablist">
  41. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  42. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  43. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  44. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  45. </ul>
  46. </div>
  47. <div id="nav-path" class="navpath">
  48. <ul>
  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1RakNetTransport2.html">RakNetTransport2</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#pub-methods">Public Member Functions</a> &#124;
  55. <a href="classRakNet_1_1RakNetTransport2-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::RakNetTransport2 Class Reference<div class="ingroups"><a class="el" href="group__RAKNET__TRANSPORT__GROUP.html">RakNetTransport</a></div></div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Use RakNetTransport if you need a secure connection between the client and the console server.
  61. <a href="classRakNet_1_1RakNetTransport2.html#details">More...</a></p>
  62. <p><code>#include &lt;RakNetTransport2.h&gt;</code></p>
  63. <div class="dynheader">
  64. Inheritance diagram for RakNet::RakNetTransport2:</div>
  65. <div class="dyncontent">
  66. <div class="center">
  67. <img src="classRakNet_1_1RakNetTransport2.png" usemap="#RakNet::RakNetTransport2_map" alt=""/>
  68. <map id="RakNet::RakNetTransport2_map" name="RakNet::RakNetTransport2_map">
  69. <area href="classRakNet_1_1TransportInterface.html" title="Defines an interface that is used to send and receive null-terminated strings." alt="RakNet::TransportInterface" shape="rect" coords="0,0,162,24"/>
  70. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="172,0,334,24"/>
  71. </map>
  72. </div></div>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:abb58cb4fd2ea3250c389b8ef277dad95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#abb58cb4fd2ea3250c389b8ef277dad95">Start</a> (unsigned short port, bool serverMode)</td></tr>
  77. <tr class="separator:abb58cb4fd2ea3250c389b8ef277dad95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a3de211dcbde531971013a237ebebbc4c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3de211dcbde531971013a237ebebbc4c"></a>
  79. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a3de211dcbde531971013a237ebebbc4c">Stop</a> (void)</td></tr>
  80. <tr class="memdesc:a3de211dcbde531971013a237ebebbc4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the transport provider. You can clear memory and shutdown threads here. <br/></td></tr>
  81. <tr class="separator:a3de211dcbde531971013a237ebebbc4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a7ec569657d7add40b0cee7278bc04c35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a7ec569657d7add40b0cee7278bc04c35">Send</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress, const char *data,...)</td></tr>
  83. <tr class="separator:a7ec569657d7add40b0cee7278bc04c35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a73d6c3178bfc051d9a143e855fd7ace9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a73d6c3178bfc051d9a143e855fd7ace9">CloseConnection</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress)</td></tr>
  85. <tr class="separator:a73d6c3178bfc051d9a143e855fd7ace9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a1f51afa7fad8d03ffc3b814af206b7d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a1f51afa7fad8d03ffc3b814af206b7d3">Receive</a> (void)</td></tr>
  87. <tr class="separator:a1f51afa7fad8d03ffc3b814af206b7d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:af87746cec490429fe1332cc1e6a6b40e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#af87746cec490429fe1332cc1e6a6b40e">DeallocatePacket</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  89. <tr class="separator:af87746cec490429fe1332cc1e6a6b40e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a964e1e7302513fc9aa878980473cd782"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a964e1e7302513fc9aa878980473cd782">HasNewIncomingConnection</a> (void)</td></tr>
  91. <tr class="separator:a964e1e7302513fc9aa878980473cd782"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a4a80043c5d0395af7fa07a0dc5fd24c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a4a80043c5d0395af7fa07a0dc5fd24c8">HasLostConnection</a> (void)</td></tr>
  93. <tr class="separator:a4a80043c5d0395af7fa07a0dc5fd24c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a7f8567ba431056ef96da1536d0cf01d7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRakNet_1_1CommandParserInterface.html">CommandParserInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a7f8567ba431056ef96da1536d0cf01d7">GetCommandParser</a> (void)</td></tr>
  95. <tr class="separator:a7f8567ba431056ef96da1536d0cf01d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ad5607edbc41109fa3ab901c8eb47616d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#ad5607edbc41109fa3ab901c8eb47616d">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  97. <tr class="separator:ad5607edbc41109fa3ab901c8eb47616d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a43bdc270a02f5584c5190b902ac243d9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a43bdc270a02f5584c5190b902ac243d9">OnClosedConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID, <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a> lostConnectionReason)</td></tr>
  99. <tr class="separator:a43bdc270a02f5584c5190b902ac243d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a55d99bb7a6993f5e4d4ef564dea5e487"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RakNetTransport2.html#a55d99bb7a6993f5e4d4ef564dea5e487">OnNewConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID, bool isIncoming)</td></tr>
  101. <tr class="separator:a55d99bb7a6993f5e4d4ef564dea5e487"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="inherit_header pub_methods_classRakNet_1_1PluginInterface2"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classRakNet_1_1PluginInterface2')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classRakNet_1_1PluginInterface2.html">RakNet::PluginInterface2</a></td></tr>
  103. <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
  104. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
  105. <tr class="memdesc:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
  106. <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
  108. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
  109. <tr class="memdesc:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is detached. <br/></td></tr>
  110. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
  112. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
  113. <tr class="memdesc:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update is called every time a packet is checked for . <br/></td></tr>
  114. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
  116. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
  117. <tr class="memdesc:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is initialized. <br/></td></tr>
  118. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
  120. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
  121. <tr class="memdesc:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is shutdown. <br/></td></tr>
  122. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9504489498df14b6efa5ca9bd39aede4">OnFailedConnectionAttempt</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet, <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga3e92f686bace869b78c10508c58e0825">PI2_FailedConnectionAttemptReason</a> failedConnectionAttemptReason)</td></tr>
  124. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#accfca7d25262c48a87a30114383284aa">UsesReliabilityLayer</a> (void) const </td></tr>
  126. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a7a6f69c6fc3a121e3676298a63a9ef78">OnDirectSocketSend</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  128. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9aac1101ad58e8443516588e96e066ec">OnDirectSocketReceive</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  130. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#abf51e60546bd74d21c91dc0d6f9f3a4b">OnReliabilityLayerNotification</a> (const char *errorMessage, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, bool isError)</td></tr>
  132. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a399b8c93daa0236599961e754742e2f7">OnInternalPacket</a> (<a class="el" href="structRakNet_1_1InternalPacket.html">InternalPacket</a> *internalPacket, unsigned frameNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time, int isSend)</td></tr>
  134. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#ae0b0cad31cfc209c48197c77d6b46345">OnAck</a> (unsigned int messageNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time)</td></tr>
  136. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a5c976aea56ed85055a17c19d91b90727">OnPushBackPacket</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  138. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  141. <div class="textblock"><p>Use RakNetTransport if you need a secure connection between the client and the console server. </p>
  142. <p>RakNetTransport automatically initializes security for the system. Use the project CommandConsoleClient to connect To the <a class="el" href="classRakNet_1_1ConsoleServer.html" title="The main entry point for the server portion of your remote console application support.">ConsoleServer</a> if you use RakNetTransport </p>
  143. </div><h2 class="groupheader">Member Function Documentation</h2>
  144. <a class="anchor" id="a73d6c3178bfc051d9a143e855fd7ace9"></a>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="mlabels">
  148. <tr>
  149. <td class="mlabels-left">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">void RakNet::RakNetTransport2::CloseConnection </td>
  153. <td>(</td>
  154. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  155. <td class="paramname"><em>systemAddress</em></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </td>
  160. <td class="mlabels-right">
  161. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Disconnect <em>systemAddress</em> . The binary address and port defines the <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> structure. </p>
  166. <dl class="params"><dt>Parameters</dt><dd>
  167. <table class="params">
  168. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player/address to disconnect </td></tr>
  169. </table>
  170. </dd>
  171. </dl>
  172. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a089cdab96f00d399988c3a23db039201">RakNet::TransportInterface</a>.</p>
  173. </div>
  174. </div>
  175. <a class="anchor" id="af87746cec490429fe1332cc1e6a6b40e"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">void RakNet::RakNetTransport2::DeallocatePacket </td>
  184. <td>(</td>
  185. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  186. <td class="paramname"><em>packet</em></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Deallocate the <a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> structure returned by Receive </p>
  197. <dl class="params"><dt>Parameters</dt><dd>
  198. <table class="params">
  199. <tr><td class="paramdir">[in]</td><td class="paramname">The</td><td>packet to deallocate </td></tr>
  200. </table>
  201. </dd>
  202. </dl>
  203. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a889932d752ad7a3e14108cd0b5371b7a">RakNet::TransportInterface</a>.</p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="a7f8567ba431056ef96da1536d0cf01d7"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="mlabels">
  210. <tr>
  211. <td class="mlabels-left">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">virtual <a class="el" href="classRakNet_1_1CommandParserInterface.html">CommandParserInterface</a>* RakNet::RakNetTransport2::GetCommandParser </td>
  215. <td>(</td>
  216. <td class="paramtype">void&#160;</td>
  217. <td class="paramname"></td><td>)</td>
  218. <td></td>
  219. </tr>
  220. </table>
  221. </td>
  222. <td class="mlabels-right">
  223. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Your transport provider can itself have command parsers if the transport layer has user-modifiable features For example, your transport layer may have a password which you want remote users to be able to set or you may want to allow remote users to turn on or off command echo </p>
  228. <dl class="section return"><dt>Returns</dt><dd>0 if you do not need a command parser - otherwise the desired derivation of <a class="el" href="classRakNet_1_1CommandParserInterface.html" title="The interface used by command parsers.">CommandParserInterface</a> </dd></dl>
  229. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#ad96ea3ff016ad1a7590e1f63d5efd6b0">RakNet::TransportInterface</a>.</p>
  230. </div>
  231. </div>
  232. <a class="anchor" id="a4a80043c5d0395af7fa07a0dc5fd24c8"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="mlabels">
  236. <tr>
  237. <td class="mlabels-left">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakNetTransport2::HasLostConnection </td>
  241. <td>(</td>
  242. <td class="paramtype">void&#160;</td>
  243. <td class="paramname"></td><td>)</td>
  244. <td></td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>If a system loses the connection, you should queue that event and return the systemAddress/address of that player in this function. </p>
  254. <dl class="section return"><dt>Returns</dt><dd>The SystemAddress/address of the system </dd></dl>
  255. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a7ee1400724af8c3d94555c4c5ca189c5">RakNet::TransportInterface</a>.</p>
  256. </div>
  257. </div>
  258. <a class="anchor" id="a964e1e7302513fc9aa878980473cd782"></a>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RakNetTransport2::HasNewIncomingConnection </td>
  267. <td>(</td>
  268. <td class="paramtype">void&#160;</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </td>
  274. <td class="mlabels-right">
  275. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>If a new system connects to you, you should queue that event and return the systemAddress/address of that player in this function. </p>
  280. <dl class="section return"><dt>Returns</dt><dd>The SystemAddress/address of the system </dd></dl>
  281. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a78f3977421deabf57046773112d07626">RakNet::TransportInterface</a>.</p>
  282. </div>
  283. </div>
  284. <a class="anchor" id="a43bdc270a02f5584c5190b902ac243d9"></a>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">virtual void RakNet::RakNetTransport2::OnClosedConnection </td>
  293. <td>(</td>
  294. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  295. <td class="paramname"><em>systemAddress</em>, </td>
  296. </tr>
  297. <tr>
  298. <td class="paramkey"></td>
  299. <td></td>
  300. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  301. <td class="paramname"><em>rakNetGUID</em>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a>&#160;</td>
  307. <td class="paramname"><em>lostConnectionReason</em>&#160;</td>
  308. </tr>
  309. <tr>
  310. <td></td>
  311. <td>)</td>
  312. <td></td><td></td>
  313. </tr>
  314. </table>
  315. </td>
  316. <td class="mlabels-right">
  317. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <p>Called when a connection is dropped because the user called <a class="el" href="classRakNet_1_1RakPeer.html#a95e3806fce8552e322236abcf105cbf9" title="Close the connection to another host (if we initiated the connection it will disconnect, if they did it will kick them out).">RakPeer::CloseConnection()</a> for a particular system </p>
  322. <dl class="params"><dt>Parameters</dt><dd>
  323. <table class="params">
  324. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
  325. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
  326. <tr><td class="paramdir">[in]</td><td class="paramname">lostConnectionReason</td><td>How the connection was closed: manually, connection lost, or notification of disconnection </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
  331. </div>
  332. </div>
  333. <a class="anchor" id="a55d99bb7a6993f5e4d4ef564dea5e487"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="mlabels">
  337. <tr>
  338. <td class="mlabels-left">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">virtual void RakNet::RakNetTransport2::OnNewConnection </td>
  342. <td>(</td>
  343. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  344. <td class="paramname"><em>systemAddress</em>, </td>
  345. </tr>
  346. <tr>
  347. <td class="paramkey"></td>
  348. <td></td>
  349. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  350. <td class="paramname"><em>rakNetGUID</em>, </td>
  351. </tr>
  352. <tr>
  353. <td class="paramkey"></td>
  354. <td></td>
  355. <td class="paramtype">bool&#160;</td>
  356. <td class="paramname"><em>isIncoming</em>&#160;</td>
  357. </tr>
  358. <tr>
  359. <td></td>
  360. <td>)</td>
  361. <td></td><td></td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Called when we got a new connection </p>
  371. <dl class="params"><dt>Parameters</dt><dd>
  372. <table class="params">
  373. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Address of the new connection </td></tr>
  374. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
  375. <tr><td class="paramdir">[in]</td><td class="paramname">isIncoming</td><td>If true, this is ID_NEW_INCOMING_CONNECTION, or the equivalent </td></tr>
  376. </table>
  377. </dd>
  378. </dl>
  379. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#abf13327cc10f772ba06dff8f2687f8ae">RakNet::PluginInterface2</a>.</p>
  380. </div>
  381. </div>
  382. <a class="anchor" id="ad5607edbc41109fa3ab901c8eb47616d"></a>
  383. <div class="memitem">
  384. <div class="memproto">
  385. <table class="mlabels">
  386. <tr>
  387. <td class="mlabels-left">
  388. <table class="memname">
  389. <tr>
  390. <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::RakNetTransport2::OnReceive </td>
  391. <td>(</td>
  392. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  393. <td class="paramname"><em>packet</em></td><td>)</td>
  394. <td></td>
  395. </tr>
  396. </table>
  397. </td>
  398. <td class="mlabels-right">
  399. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>OnReceive is called for every packet. </p>
  404. <dl class="params"><dt>Parameters</dt><dd>
  405. <table class="params">
  406. <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
  407. </table>
  408. </dd>
  409. </dl>
  410. <dl class="section return"><dt>Returns</dt><dd>True to allow the game and other plugins to get this message, false to absorb it </dd></dl>
  411. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
  412. </div>
  413. </div>
  414. <a class="anchor" id="a1f51afa7fad8d03ffc3b814af206b7d3"></a>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <table class="mlabels">
  418. <tr>
  419. <td class="mlabels-left">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname"><a class="el" href="structRakNet_1_1Packet.html">Packet</a>* RakNet::RakNetTransport2::Receive </td>
  423. <td>(</td>
  424. <td class="paramtype">void&#160;</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </td>
  430. <td class="mlabels-right">
  431. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Return a string. The string should be allocated and written to <a class="el" href="structRakNet_1_1Packet.html#a63e46b85c8ca156b205a124e54659614" title="The data from the sender.">Packet::data</a> . The byte length should be written to <a class="el" href="structRakNet_1_1Packet.html#a114883d23f7133c77808651a33420d0f" title="The length of the data in bytes.">Packet::length</a> . The player/address should be written to <a class="el" href="structRakNet_1_1Packet.html#abf432112847cb3ce458935b8a5ae4089" title="The system that send this packet.">Packet::systemAddress</a> If your transport protocol adds special formatting to the data stream you should parse it out before returning it in the packet and thus only return a string in <a class="el" href="structRakNet_1_1Packet.html#a63e46b85c8ca156b205a124e54659614" title="The data from the sender.">Packet::data</a> </p>
  436. <dl class="section return"><dt>Returns</dt><dd>The packet structure containing the result of Receive, or 0 if no data is available </dd></dl>
  437. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a2d458e6e575f700f292c42b7566d15c9">RakNet::TransportInterface</a>.</p>
  438. </div>
  439. </div>
  440. <a class="anchor" id="a7ec569657d7add40b0cee7278bc04c35"></a>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="mlabels">
  444. <tr>
  445. <td class="mlabels-left">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">void RakNet::RakNetTransport2::Send </td>
  449. <td>(</td>
  450. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  451. <td class="paramname"><em>systemAddress</em>, </td>
  452. </tr>
  453. <tr>
  454. <td class="paramkey"></td>
  455. <td></td>
  456. <td class="paramtype">const char *&#160;</td>
  457. <td class="paramname"><em>data</em>, </td>
  458. </tr>
  459. <tr>
  460. <td class="paramkey"></td>
  461. <td></td>
  462. <td class="paramtype">&#160;</td>
  463. <td class="paramname"><em>...</em>&#160;</td>
  464. </tr>
  465. <tr>
  466. <td></td>
  467. <td>)</td>
  468. <td></td><td></td>
  469. </tr>
  470. </table>
  471. </td>
  472. <td class="mlabels-right">
  473. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  474. </tr>
  475. </table>
  476. </div><div class="memdoc">
  477. <p>Send a null-terminated string to <em>systemAddress</em> If your transport method requires particular formatting of the outgoing data (e.g. you don't just send strings) you can do it here and parse it out in <a class="el" href="classRakNet_1_1RakNetTransport2.html#a1f51afa7fad8d03ffc3b814af206b7d3">Receive()</a>. </p>
  478. <dl class="params"><dt>Parameters</dt><dd>
  479. <table class="params">
  480. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player to send the string to </td></tr>
  481. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>format specifier - same as RAKNET_DEBUG_PRINTF </td></tr>
  482. <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>format specification arguments - same as RAKNET_DEBUG_PRINTF </td></tr>
  483. </table>
  484. </dd>
  485. </dl>
  486. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#ab77f9c90719f38340bdbcb4ffdbf192a">RakNet::TransportInterface</a>.</p>
  487. </div>
  488. </div>
  489. <a class="anchor" id="abb58cb4fd2ea3250c389b8ef277dad95"></a>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="mlabels">
  493. <tr>
  494. <td class="mlabels-left">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">bool RakNet::RakNetTransport2::Start </td>
  498. <td>(</td>
  499. <td class="paramtype">unsigned short&#160;</td>
  500. <td class="paramname"><em>port</em>, </td>
  501. </tr>
  502. <tr>
  503. <td class="paramkey"></td>
  504. <td></td>
  505. <td class="paramtype">bool&#160;</td>
  506. <td class="paramname"><em>serverMode</em>&#160;</td>
  507. </tr>
  508. <tr>
  509. <td></td>
  510. <td>)</td>
  511. <td></td><td></td>
  512. </tr>
  513. </table>
  514. </td>
  515. <td class="mlabels-right">
  516. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  517. </tr>
  518. </table>
  519. </div><div class="memdoc">
  520. <p>Start the transport provider on the indicated port. </p>
  521. <dl class="params"><dt>Parameters</dt><dd>
  522. <table class="params">
  523. <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The port to start the transport provider on </td></tr>
  524. <tr><td class="paramdir">[in]</td><td class="paramname">serverMode</td><td>If true, you should allow incoming connections (I don't actually use this anywhere) </td></tr>
  525. </table>
  526. </dd>
  527. </dl>
  528. <dl class="section return"><dt>Returns</dt><dd>Return true on success, false on failure. </dd></dl>
  529. <p>Implements <a class="el" href="classRakNet_1_1TransportInterface.html#a309a38aa455b6b72f1c760276f3fb6a8">RakNet::TransportInterface</a>.</p>
  530. </div>
  531. </div>
  532. <hr/>The documentation for this class was generated from the following file:<ul>
  533. <li>D:/temp/RakNet_PC/Source/<a class="el" href="RakNetTransport2_8h.html">RakNetTransport2.h</a></li>
  534. </ul>
  535. </div><!-- contents -->
  536. <!-- start footer part -->
  537. <hr class="footer"/><address class="footer"><small>
  538. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  539. <img class="footer" src="doxygen.png" alt="doxygen"/>
  540. </a> 1.8.2
  541. </small></address>
  542. </body>
  543. </html>
粤ICP备19079148号