| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <title>RakNet: RakNet::Router2 Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">RakNet
-  <span id="projectnumber">4.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.2 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1Router2.html">Router2</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classRakNet_1_1Router2-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">RakNet::Router2 Class Reference<div class="ingroups"><a class="el" href="group__ROUTER__2__GROUP.html">Router2</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Class interface for the <a class="el" href="classRakNet_1_1Router2.html" title="Class interface for the Router2 system.">Router2</a> system.
- <a href="classRakNet_1_1Router2.html#details">More...</a></p>
- <p><code>#include <Router2.h></code></p>
- <div class="dynheader">
- Inheritance diagram for RakNet::Router2:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classRakNet_1_1Router2.png" usemap="#RakNet::Router2_map" alt=""/>
- <map id="RakNet::Router2_map" name="RakNet::Router2_map">
- <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="0,0,150,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aef586b4fc73d446119225e05384c8515"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#aef586b4fc73d446119225e05384c8515">SetSocketFamily</a> (unsigned short _socketFamily)</td></tr>
- <tr class="separator:aef586b4fc73d446119225e05384c8515"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8d86939663f286f21a8aefeea615565b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a8d86939663f286f21a8aefeea615565b">EstablishRouting</a> (<a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> endpointGuid)</td></tr>
- <tr class="memdesc:a8d86939663f286f21a8aefeea615565b"><td class="mdescLeft"> </td><td class="mdescRight">Query all connected systems to connect through them to a third system. System will return ID_ROUTER_2_FORWARDING_NO_PATH if unable to connect. Else you will get ID_ROUTER_2_FORWARDING_ESTABLISHED. <a href="#a8d86939663f286f21a8aefeea615565b"></a><br/></td></tr>
- <tr class="separator:a8d86939663f286f21a8aefeea615565b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a60d0f2bffeed81aabcde1daa6d0cd79d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a60d0f2bffeed81aabcde1daa6d0cd79d">SetMaximumForwardingRequests</a> (int max)</td></tr>
- <tr class="separator:a60d0f2bffeed81aabcde1daa6d0cd79d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ada3cd3f17fadd1466d0ad0ed693fbf69"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada3cd3f17fadd1466d0ad0ed693fbf69"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#ada3cd3f17fadd1466d0ad0ed693fbf69">SetDebugInterface</a> (Router2DebugInterface *_debugInterface)</td></tr>
- <tr class="memdesc:ada3cd3f17fadd1466d0ad0ed693fbf69"><td class="mdescLeft"> </td><td class="mdescRight">For testing and debugging. <br/></td></tr>
- <tr class="separator:ada3cd3f17fadd1466d0ad0ed693fbf69"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f096833e216ffb5c3c79a45fa26fc3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f096833e216ffb5c3c79a45fa26fc3b"></a>
- Router2DebugInterface * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a3f096833e216ffb5c3c79a45fa26fc3b">GetDebugInterface</a> (void) const </td></tr>
- <tr class="memdesc:a3f096833e216ffb5c3c79a45fa26fc3b"><td class="mdescLeft"> </td><td class="mdescRight">Get the pointer passed to <a class="el" href="classRakNet_1_1Router2.html#ada3cd3f17fadd1466d0ad0ed693fbf69" title="For testing and debugging.">SetDebugInterface()</a> <br/></td></tr>
- <tr class="separator:a3f096833e216ffb5c3c79a45fa26fc3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a825d62c2f01def72c58815b609cf4bbf"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a825d62c2f01def72c58815b609cf4bbf">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
- <tr class="separator:a825d62c2f01def72c58815b609cf4bbf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d06f99cdd31fabd9e0dc1f0e19d0f39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d06f99cdd31fabd9e0dc1f0e19d0f39"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a6d06f99cdd31fabd9e0dc1f0e19d0f39">Update</a> (void)</td></tr>
- <tr class="memdesc:a6d06f99cdd31fabd9e0dc1f0e19d0f39"><td class="mdescLeft"> </td><td class="mdescRight">Update is called every time a packet is checked for . <br/></td></tr>
- <tr class="separator:a6d06f99cdd31fabd9e0dc1f0e19d0f39"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a428635762452b03a115043e4628837b9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a428635762452b03a115043e4628837b9">OnClosedConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &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>
- <tr class="separator:a428635762452b03a115043e4628837b9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac3be692d08e4ccce030c201038346f1d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#ac3be692d08e4ccce030c201038346f1d">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>
- <tr class="separator:ac3be692d08e4ccce030c201038346f1d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59bb4fa9ae67bdc0c3761c2bd5bce6b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59bb4fa9ae67bdc0c3761c2bd5bce6b7"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1Router2.html#a59bb4fa9ae67bdc0c3761c2bd5bce6b7">OnRakPeerShutdown</a> (void)</td></tr>
- <tr class="memdesc:a59bb4fa9ae67bdc0c3761c2bd5bce6b7"><td class="mdescLeft"> </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>
- <tr class="separator:a59bb4fa9ae67bdc0c3761c2bd5bce6b7"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Public Member Functions inherited from <a class="el" href="classRakNet_1_1PluginInterface2.html">RakNet::PluginInterface2</a></td></tr>
- <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
- <tr class="memdesc:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft"> </td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
- <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
- <tr class="memdesc:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft"> </td><td class="mdescRight">Called when the interface is detached. <br/></td></tr>
- <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
- virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
- <tr class="memdesc:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft"> </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>
- <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#abf13327cc10f772ba06dff8f2687f8ae">OnNewConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &systemAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID, bool isIncoming)</td></tr>
- <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#accfca7d25262c48a87a30114383284aa">UsesReliabilityLayer</a> (void) const </td></tr>
- <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Class interface for the <a class="el" href="classRakNet_1_1Router2.html" title="Class interface for the Router2 system.">Router2</a> system. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a8d86939663f286f21a8aefeea615565b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void RakNet::Router2::EstablishRouting </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </td>
- <td class="paramname"><em>endpointGuid</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Query all connected systems to connect through them to a third system. System will return ID_ROUTER_2_FORWARDING_NO_PATH if unable to connect. Else you will get ID_ROUTER_2_FORWARDING_ESTABLISHED. </p>
- <p>On ID_ROUTER_2_FORWARDING_ESTABLISHED, EstablishRouting as follows:</p>
- <p><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> bs(packet->data, packet->length, false); bs.IgnoreBytes(sizeof(MessageID)); <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> endpointGuid; bs.Read(endpointGuid); unsigned short sourceToDestPort; bs.Read(sourceToDestPort); char ipAddressString[32]; packet->systemAddress.ToString(false, ipAddressString); rakPeerInterface->EstablishRouting(ipAddressString, sourceToDestPort, 0,0);</p>
- <dl class="section note"><dt>Note</dt><dd>The <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> for a connection should not be used - always use RakNetGuid as the address can change at any time. When the address changes, you will get ID_ROUTER_2_REROUTED </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a428635762452b03a115043e4628837b9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::Router2::OnClosedConnection </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> & </td>
- <td class="paramname"><em>systemAddress</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> </td>
- <td class="paramname"><em>rakNetGUID</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a> </td>
- <td class="paramname"><em>lostConnectionReason</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ac3be692d08e4ccce030c201038346f1d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void RakNet::Router2::OnFailedConnectionAttempt </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td>
- <td class="paramname"><em>packet</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga3e92f686bace869b78c10508c58e0825">PI2_FailedConnectionAttemptReason</a> </td>
- <td class="paramname"><em>failedConnectionAttemptReason</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when a connection attempt fails </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td><a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> to be returned to the user </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">failedConnectionReason</td><td>Why the connection failed </td></tr>
- </table>
- </dd>
- </dl>
- <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a9504489498df14b6efa5ca9bd39aede4">RakNet::PluginInterface2</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a825d62c2f01def72c58815b609cf4bbf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::Router2::OnReceive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> * </td>
- <td class="paramname"><em>packet</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>OnReceive is called for every packet. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a60d0f2bffeed81aabcde1daa6d0cd79d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void RakNet::Router2::SetMaximumForwardingRequests </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>max</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the maximum number of bidirectional connections this system will support Defaults to 0 </p>
- </div>
- </div>
- <a class="anchor" id="aef586b4fc73d446119225e05384c8515"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void RakNet::Router2::SetSocketFamily </td>
- <td>(</td>
- <td class="paramtype">unsigned short </td>
- <td class="paramname"><em>_socketFamily</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the socket family to use, either IPV4 or IPV6 </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">socketFamily</td><td>For IPV4, use AF_INET (default). For IPV6, use AF_INET6. To autoselect, use AF_UNSPEC. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>D:/temp/RakNet_PC/Source/<a class="el" href="Router2_8h.html">Router2.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Mon Jun 2 2014 20:10:29 for RakNet by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.2
- </small></address>
- </body>
- </html>
|