classRakNet_1_1RPC3.html 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  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::RPC3 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_1RPC3.html">RPC3</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="#pro-methods">Protected Member Functions</a> &#124;
  56. <a href="#pro-attribs">Protected Attributes</a> &#124;
  57. <a href="classRakNet_1_1RPC3-members.html">List of all members</a> </div>
  58. <div class="headertitle">
  59. <div class="title">RakNet::RPC3 Class Reference<div class="ingroups"><a class="el" href="group__RPC__3__GROUP.html">RPC3</a></div></div> </div>
  60. </div><!--header-->
  61. <div class="contents">
  62. <p>The <a class="el" href="classRakNet_1_1RPC3.html" title="The RPC3 plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.">RPC3</a> plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.
  63. <a href="classRakNet_1_1RPC3.html#details">More...</a></p>
  64. <p><code>#include &lt;RPC3.h&gt;</code></p>
  65. <div class="dynheader">
  66. Inheritance diagram for RakNet::RPC3:</div>
  67. <div class="dyncontent">
  68. <div class="center">
  69. <img src="classRakNet_1_1RPC3.png" usemap="#RakNet::RPC3_map" alt=""/>
  70. <map id="RakNet::RPC3_map" name="RakNet::RPC3_map">
  71. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="0,0,150,24"/>
  72. </map>
  73. </div></div>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a95e591290dca6c7f218accdeb776481f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a95e591290dca6c7f218accdeb776481f">SetNetworkIDManager</a> (<a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a> *idMan)</td></tr>
  78. <tr class="separator:a95e591290dca6c7f218accdeb776481f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ab20f6b1a67a772d7a0bc2f8bfe6cd5ee"><td class="memTemplParams" colspan="2">template&lt;typename Function &gt; </td></tr>
  80. <tr class="memitem:ab20f6b1a67a772d7a0bc2f8bfe6cd5ee"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ab20f6b1a67a772d7a0bc2f8bfe6cd5ee">RegisterFunction</a> (const char *uniqueIdentifier, Function functionPtr)</td></tr>
  81. <tr class="separator:ab20f6b1a67a772d7a0bc2f8bfe6cd5ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ad74674aaf4a1d0a5b63799123d7c0cb8"><td class="memTemplParams" colspan="2">template&lt;typename Function &gt; </td></tr>
  83. <tr class="memitem:ad74674aaf4a1d0a5b63799123d7c0cb8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ad74674aaf4a1d0a5b63799123d7c0cb8">RegisterSlot</a> (const char *sharedIdentifier, Function functionPtr, NetworkID objectInstanceId, int callPriority)</td></tr>
  84. <tr class="separator:ad74674aaf4a1d0a5b63799123d7c0cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a35526d9abb503c56d30b5ac4b59a11ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a35526d9abb503c56d30b5ac4b59a11ac">UnregisterFunction</a> (const char *uniqueIdentifier)</td></tr>
  86. <tr class="separator:a35526d9abb503c56d30b5ac4b59a11ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a11fba9354a908f790170a882b19ce078"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a11fba9354a908f790170a882b19ce078">IsFunctionRegistered</a> (const char *uniqueIdentifier)</td></tr>
  88. <tr class="separator:a11fba9354a908f790170a882b19ce078"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a53d8e3bbce51fafe986530ea3340274e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a53d8e3bbce51fafe986530ea3340274e">SetTimestamp</a> (RakNet::Time timeStamp)</td></tr>
  90. <tr class="separator:a53d8e3bbce51fafe986530ea3340274e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a45965705d026ad3f694091dc87e9ec3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams</a> (<a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel)</td></tr>
  92. <tr class="separator:a45965705d026ad3f694091dc87e9ec3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:aaa4ee68113b755c490ab3a780a8d0b02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, bool broadcast)</td></tr>
  94. <tr class="separator:aaa4ee68113b755c490ab3a780a8d0b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a9d008c1ce2c713e15acc3bef644b5770"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject</a> (NetworkID networkID)</td></tr>
  96. <tr class="separator:a9d008c1ce2c713e15acc3bef644b5770"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a315bda0fddf03b56e279e4c0dbcd66f9"><td class="memItemLeft" align="right" valign="top">RakNet::Time&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a315bda0fddf03b56e279e4c0dbcd66f9">GetLastSenderTimestamp</a> (void) const </td></tr>
  98. <tr class="separator:a315bda0fddf03b56e279e4c0dbcd66f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:aa5f82787f992562b2c7f093adec693b2"><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_1RPC3.html#aa5f82787f992562b2c7f093adec693b2">GetLastSenderAddress</a> (void) const </td></tr>
  100. <tr class="separator:aa5f82787f992562b2c7f093adec693b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a671c8fccf445baba0aef05c10a4bc19d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a671c8fccf445baba0aef05c10a4bc19d"></a>
  102. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a671c8fccf445baba0aef05c10a4bc19d">InterruptSignal</a> (void)</td></tr>
  103. <tr class="memdesc:a671c8fccf445baba0aef05c10a4bc19d"><td class="mdescLeft">&#160;</td><td class="mdescRight">If called while processing a slot, no further slots for the currently executing signal will be executed. <br/></td></tr>
  104. <tr class="separator:a671c8fccf445baba0aef05c10a4bc19d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:af91f170de71c934c8b79f5e941c372cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af91f170de71c934c8b79f5e941c372cd"></a>
  106. <a class="el" href="classRakNet_1_1RakPeerInterface.html">RakPeerInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#af91f170de71c934c8b79f5e941c372cd">GetRakPeer</a> (void) const </td></tr>
  107. <tr class="memdesc:af91f170de71c934c8b79f5e941c372cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> this plugin was attached to. <br/></td></tr>
  108. <tr class="separator:af91f170de71c934c8b79f5e941c372cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ad2479662844dde75ec63bcbf90b7f9cc"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ad2479662844dde75ec63bcbf90b7f9cc">GetCurrentExecution</a> (void) const </td></tr>
  110. <tr class="separator:ad2479662844dde75ec63bcbf90b7f9cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a78fc5dd5e2e325cfbac3feb7cdcf5fcb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call</a> (const char *uniqueIdentifier)</td></tr>
  112. <tr class="separator:a78fc5dd5e2e325cfbac3feb7cdcf5fcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ac13a953871b07e55594bd49582652b80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ac13a953871b07e55594bd49582652b80">CallExplicit</a> (const char *uniqueIdentifier, const CallExplicitParameters *const callExplicitParameters)</td></tr>
  114. <tr class="separator:ac13a953871b07e55594bd49582652b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ab6e866b090b01c7189055b5fb3c98419"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ab6e866b090b01c7189055b5fb3c98419">Signal</a> (const char *sharedIdentifier)</td></tr>
  116. <tr class="separator:ab6e866b090b01c7189055b5fb3c98419"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ab72b8c0511458e337dc6df57e849748c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab72b8c0511458e337dc6df57e849748c"></a>
  118. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ab72b8c0511458e337dc6df57e849748c">SignalExplicit</a> (const char *sharedIdentifier, const SignalExplicitParameters *const signalExplicitParameters)</td></tr>
  119. <tr class="memdesc:ab72b8c0511458e337dc6df57e849748c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="classRakNet_1_1RPC3.html#ab6e866b090b01c7189055b5fb3c98419">Signal()</a>, but you are forced to specify the remote system parameters. <br/></td></tr>
  120. <tr class="separator:ab72b8c0511458e337dc6df57e849748c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a27e8f4b09caa67d4bbcbbd4e639b6b77"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27e8f4b09caa67d4bbcbbd4e639b6b77"></a>
  122. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a27e8f4b09caa67d4bbcbbd4e639b6b77">InvokeSignal</a> (DataStructures::HashIndex functionIndex, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *serializedParameters, bool temporarilySetUSA)</td></tr>
  123. <tr class="memdesc:a27e8f4b09caa67d4bbcbbd4e639b6b77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call a given signal with a bitstream representing the parameter list. <br/></td></tr>
  124. <tr class="separator:a27e8f4b09caa67d4bbcbbd4e639b6b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
  127. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
  128. <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>
  129. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
  131. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
  132. <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>
  133. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
  135. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
  136. <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>
  137. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
  139. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
  140. <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>
  141. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:abf13327cc10f772ba06dff8f2687f8ae 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#abf13327cc10f772ba06dff8f2687f8ae">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>
  143. <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table><table class="memberdecls">
  161. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  162. Protected Member Functions</h2></td></tr>
  163. <tr class="memitem:a6167cabe64641b8737465caaae8b8d13"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6167cabe64641b8737465caaae8b8d13"></a>
  164. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a6167cabe64641b8737465caaae8b8d13">OnAttach</a> (void)</td></tr>
  165. <tr class="memdesc:a6167cabe64641b8737465caaae8b8d13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
  166. <tr class="separator:a6167cabe64641b8737465caaae8b8d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:af3124837c8700edcb202c3244531228e"><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_1RPC3.html#af3124837c8700edcb202c3244531228e">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  168. <tr class="separator:af3124837c8700edcb202c3244531228e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a38629f8313e294fba524f941fcb09e09"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#a38629f8313e294fba524f941fcb09e09">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>
  170. <tr class="separator:a38629f8313e294fba524f941fcb09e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. </table><table class="memberdecls">
  172. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  173. Protected Attributes</h2></td></tr>
  174. <tr class="memitem:ad0300cf1ce772c72ad51893786d580bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0300cf1ce772c72ad51893786d580bb"></a>
  175. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC3.html#ad0300cf1ce772c72ad51893786d580bb">nextSlotRegistrationCount</a></td></tr>
  176. <tr class="memdesc:ad0300cf1ce772c72ad51893786d580bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used so slots are called in the order they are registered. <br/></td></tr>
  177. <tr class="separator:ad0300cf1ce772c72ad51893786d580bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. </table>
  179. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  180. <div class="textblock"><p>The <a class="el" href="classRakNet_1_1RPC3.html" title="The RPC3 plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.">RPC3</a> plugin allows you to call remote functions as if they were local functions, using the standard function call syntax. </p>
  181. <p>No serialization or deserialization is needed.<br/>
  182. As of this writing, the system is not threadsafe.<br/>
  183. Features:<br/>
  184. Pointers to classes that derive from NetworkID are automatically looked up using <a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a> Types are written to <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a>, meaning built-in serialization operations are performed, including endian swapping Types can customize autoserialization by providing an implementation of operator &lt;&lt; and operator &gt;&gt; to and from <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> </p>
  185. <dl class="section note"><dt>Note</dt><dd>You cannot use <a class="el" href="classRakNet_1_1RPC4.html" title="The RPC4 plugin is just an association between a C function pointer and a string.">RPC4</a> at the same time as <a class="el" href="classRakNet_1_1RPC3.html" title="The RPC3 plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.">RPC3</a> </dd></dl>
  186. </div><h2 class="groupheader">Member Function Documentation</h2>
  187. <a class="anchor" id="a78fc5dd5e2e325cfbac3feb7cdcf5fcb"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="mlabels">
  191. <tr>
  192. <td class="mlabels-left">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">bool RakNet::RPC3::Call </td>
  196. <td>(</td>
  197. <td class="paramtype">const char *&#160;</td>
  198. <td class="paramname"><em>uniqueIdentifier</em></td><td>)</td>
  199. <td></td>
  200. </tr>
  201. </table>
  202. </td>
  203. <td class="mlabels-right">
  204. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Calls a remote function, using as send parameters whatever was last passed to <a class="el" href="classRakNet_1_1RPC3.html#a53d8e3bbce51fafe986530ea3340274e">SetTimestamp()</a>, <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a>, <a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress()</a>, and <a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject()</a> If you call a C++ class member function, don't forget to first call <a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject()</a>. You can use <a class="el" href="classRakNet_1_1RPC3.html#ac13a953871b07e55594bd49582652b80">CallExplicit()</a> instead of <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> to force yourself not to forget.</p>
  209. <p>Parameters passed to Call are processed as follows:</p>
  210. <ol type="1">
  211. <li>If the parameter is not a pointer</li>
  212. <li>- And you overloaded <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a>&amp; operator&lt;&lt;(RakNet::BitStream&amp; out, MyClass&amp; in) then that will be used to do the serialization</li>
  213. <li>- Otherwise, it will use bitStream.Write(myClass); <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> already defines specializations for <a class="el" href="classRakNet_1_1NetworkIDObject.html" title="Unique shared ids for each object instance.">NetworkIDObject</a>, <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a>, other BitStreams</li>
  214. <li>If the parameter is a pointer</li>
  215. <li>- And the pointer can be converted to <a class="el" href="classRakNet_1_1NetworkIDObject.html" title="Unique shared ids for each object instance.">NetworkIDObject</a>, then it will write bitStream.Write(myClass-&gt;GetNetworkID()); To make it also dereference the pointer, use RakNet::_RPC3::Deref(myClass)</li>
  216. <li>- And the pointer can not be converted to NetworkID, but it is a pointer to <a class="el" href="classRakNet_1_1RPC3.html" title="The RPC3 plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.">RakNet::RPC3</a>, then it is skipped</li>
  217. <li>Otherwise, the pointer is dereferenced and written as in step 2 and 3.</li>
  218. </ol>
  219. <dl class="section note"><dt>Note</dt><dd>If you need endian swapping (Mac talking to PC for example), you pretty much need to define operator &lt;&lt; and operator &gt;&gt; for all classes you want to serialize. Otherwise the member variables will not be endian swapped. </dd>
  220. <dd>
  221. If the call fails on the remote system, you will get back ID_RPC_REMOTE_ERROR. packet-&gt;data[1] will contain one of the values of RPCErrorCodes. packet-&gt;data[2] and on will contain the name of the function.</dd></dl>
  222. <dl class="params"><dt>Parameters</dt><dd>
  223. <table class="params">
  224. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueIdentifier</td><td>parameter of the same name passed to <a class="el" href="classRakNet_1_1RPC3.html#ab20f6b1a67a772d7a0bc2f8bfe6cd5ee">RegisterFunction()</a> on the remote system </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. </div>
  229. </div>
  230. <a class="anchor" id="ac13a953871b07e55594bd49582652b80"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="mlabels">
  234. <tr>
  235. <td class="mlabels-left">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">bool RakNet::RPC3::CallExplicit </td>
  239. <td>(</td>
  240. <td class="paramtype">const char *&#160;</td>
  241. <td class="paramname"><em>uniqueIdentifier</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">const CallExplicitParameters *const&#160;</td>
  247. <td class="paramname"><em>callExplicitParameters</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Calls a remote function, using whatever was last passed to <a class="el" href="classRakNet_1_1RPC3.html#a53d8e3bbce51fafe986530ea3340274e">SetTimestamp()</a>, <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a>, <a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress()</a>, and <a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject()</a> Passed parameter(s), if any, are serialized using operator &lt;&lt; with <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a>. If you provide an overload it will be used, otherwise the seriailzation is equivalent to memcpy except for native <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> types (<a class="el" href="classRakNet_1_1NetworkIDObject.html" title="Unique shared ids for each object instance.">NetworkIDObject</a>, <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a>, etc.) If the type is a pointer to a type deriving from <a class="el" href="classRakNet_1_1NetworkIDObject.html" title="Unique shared ids for each object instance.">NetworkIDObject</a>, then only the NetworkID is sent, and the object looked up on the remote system. Otherwise, the pointer is dereferenced and the contents serialized as usual. </p>
  262. <dl class="section note"><dt>Note</dt><dd>The this pointer, for this instance of <a class="el" href="classRakNet_1_1RPC3.html" title="The RPC3 plugin allows you to call remote functions as if they were local functions, using the standard function call syntax.">RPC3</a>, is pushed as the last parameter on the stack. See RPC3Sample.cpp for an example of this </dd>
  263. <dd>
  264. If the call fails on the remote system, you will get back ID_RPC_REMOTE_ERROR. packet-&gt;data[1] will contain one of the values of RPCErrorCodes. packet-&gt;data[2] and on will contain the name of the function. </dd></dl>
  265. <dl class="params"><dt>Parameters</dt><dd>
  266. <table class="params">
  267. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueIdentifier</td><td>parameter of the same name passed to <a class="el" href="classRakNet_1_1RPC3.html#ab20f6b1a67a772d7a0bc2f8bfe6cd5ee">RegisterFunction()</a> on the remote system </td></tr>
  268. <tr><td class="paramdir">[in]</td><td class="paramname">timeStamp</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#a53d8e3bbce51fafe986530ea3340274e">SetTimestamp()</a> </td></tr>
  269. <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a> </td></tr>
  270. <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a> </td></tr>
  271. <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a> </td></tr>
  272. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress()</a> </td></tr>
  273. <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress()</a> </td></tr>
  274. <tr><td class="paramdir">[in]</td><td class="paramname">networkID</td><td>See <a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject()</a> </td></tr>
  275. </table>
  276. </dd>
  277. </dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="ad2479662844dde75ec63bcbf90b7f9cc"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">const char* RakNet::RPC3::GetCurrentExecution </td>
  286. <td>(</td>
  287. <td class="paramtype">void&#160;</td>
  288. <td class="paramname"></td><td>)</td>
  289. <td> const</td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Returns the currently running RPC call identifier, set from RegisterFunction::uniqueIdentifier Returns an empty string "" if none </p>
  294. <dl class="section return"><dt>Returns</dt><dd>which RPC call is currently running </dd></dl>
  295. </div>
  296. </div>
  297. <a class="anchor" id="aa5f82787f992562b2c7f093adec693b2"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> RakNet::RPC3::GetLastSenderAddress </td>
  303. <td>(</td>
  304. <td class="paramtype">void&#160;</td>
  305. <td class="paramname"></td><td>)</td>
  306. <td> const</td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>Returns the system address of the last system to send us a received function call Equivalent to the old system RPCParameters::sender </p>
  311. <dl class="section return"><dt>Returns</dt><dd>Last system to send an RPC call using this system </dd></dl>
  312. </div>
  313. </div>
  314. <a class="anchor" id="a315bda0fddf03b56e279e4c0dbcd66f9"></a>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">RakNet::Time RakNet::RPC3::GetLastSenderTimestamp </td>
  320. <td>(</td>
  321. <td class="paramtype">void&#160;</td>
  322. <td class="paramname"></td><td>)</td>
  323. <td> const</td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>If the last received function call has a timestamp included, it is stored and can be retrieved with this function. </p>
  328. <dl class="section return"><dt>Returns</dt><dd>0 if the last call did not have a timestamp, else non-zero </dd></dl>
  329. </div>
  330. </div>
  331. <a class="anchor" id="a11fba9354a908f790170a882b19ce078"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">bool RakNet::RPC3::IsFunctionRegistered </td>
  337. <td>(</td>
  338. <td class="paramtype">const char *&#160;</td>
  339. <td class="paramname"><em>uniqueIdentifier</em></td><td>)</td>
  340. <td></td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Returns if a function identifier was previously registered on this system with <a class="el" href="classRakNet_1_1RPC3.html#ab20f6b1a67a772d7a0bc2f8bfe6cd5ee">RegisterFunction()</a>, and not unregistered with <a class="el" href="classRakNet_1_1RPC3.html#a35526d9abb503c56d30b5ac4b59a11ac">UnregisterFunction()</a> </p>
  345. <dl class="params"><dt>Parameters</dt><dd>
  346. <table class="params">
  347. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueIdentifier</td><td>String identifying the function. </td></tr>
  348. </table>
  349. </dd>
  350. </dl>
  351. <dl class="section return"><dt>Returns</dt><dd>True if the function was registered, false otherwise </dd></dl>
  352. </div>
  353. </div>
  354. <a class="anchor" id="a38629f8313e294fba524f941fcb09e09"></a>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="mlabels">
  358. <tr>
  359. <td class="mlabels-left">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">virtual void RakNet::RPC3::OnClosedConnection </td>
  363. <td>(</td>
  364. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  365. <td class="paramname"><em>systemAddress</em>, </td>
  366. </tr>
  367. <tr>
  368. <td class="paramkey"></td>
  369. <td></td>
  370. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  371. <td class="paramname"><em>rakNetGUID</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a>&#160;</td>
  377. <td class="paramname"><em>lostConnectionReason</em>&#160;</td>
  378. </tr>
  379. <tr>
  380. <td></td>
  381. <td>)</td>
  382. <td></td><td></td>
  383. </tr>
  384. </table>
  385. </td>
  386. <td class="mlabels-right">
  387. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. <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>
  392. <dl class="params"><dt>Parameters</dt><dd>
  393. <table class="params">
  394. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
  395. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
  396. <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>
  397. </table>
  398. </dd>
  399. </dl>
  400. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
  401. </div>
  402. </div>
  403. <a class="anchor" id="af3124837c8700edcb202c3244531228e"></a>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="mlabels">
  407. <tr>
  408. <td class="mlabels-left">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::RPC3::OnReceive </td>
  412. <td>(</td>
  413. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  414. <td class="paramname"><em>packet</em></td><td>)</td>
  415. <td></td>
  416. </tr>
  417. </table>
  418. </td>
  419. <td class="mlabels-right">
  420. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  421. </tr>
  422. </table>
  423. </div><div class="memdoc">
  424. <p>OnReceive is called for every packet. </p>
  425. <dl class="params"><dt>Parameters</dt><dd>
  426. <table class="params">
  427. <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
  428. </table>
  429. </dd>
  430. </dl>
  431. <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>
  432. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
  433. </div>
  434. </div>
  435. <a class="anchor" id="ab20f6b1a67a772d7a0bc2f8bfe6cd5ee"></a>
  436. <div class="memitem">
  437. <div class="memproto">
  438. <div class="memtemplate">
  439. template&lt;typename Function &gt; </div>
  440. <table class="mlabels">
  441. <tr>
  442. <td class="mlabels-left">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname">bool RakNet::RPC3::RegisterFunction </td>
  446. <td>(</td>
  447. <td class="paramtype">const char *&#160;</td>
  448. <td class="paramname"><em>uniqueIdentifier</em>, </td>
  449. </tr>
  450. <tr>
  451. <td class="paramkey"></td>
  452. <td></td>
  453. <td class="paramtype">Function&#160;</td>
  454. <td class="paramname"><em>functionPtr</em>&#160;</td>
  455. </tr>
  456. <tr>
  457. <td></td>
  458. <td>)</td>
  459. <td></td><td></td>
  460. </tr>
  461. </table>
  462. </td>
  463. <td class="mlabels-right">
  464. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. <p>Register a function pointer as callable using RPC() </p>
  469. <dl class="params"><dt>Parameters</dt><dd>
  470. <table class="params">
  471. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueIdentifier</td><td>String identifying the function. Recommended that this is the name of the function </td></tr>
  472. <tr><td class="paramdir">[in]</td><td class="paramname">functionPtr</td><td>Pointer to the function. For C, just pass the name of the function. For C++, use ARPC_REGISTER_CPP_FUNCTION </td></tr>
  473. </table>
  474. </dd>
  475. </dl>
  476. <dl class="section return"><dt>Returns</dt><dd>True on success, false on uniqueIdentifier already used </dd></dl>
  477. </div>
  478. </div>
  479. <a class="anchor" id="ad74674aaf4a1d0a5b63799123d7c0cb8"></a>
  480. <div class="memitem">
  481. <div class="memproto">
  482. <div class="memtemplate">
  483. template&lt;typename Function &gt; </div>
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">void RakNet::RPC3::RegisterSlot </td>
  490. <td>(</td>
  491. <td class="paramtype">const char *&#160;</td>
  492. <td class="paramname"><em>sharedIdentifier</em>, </td>
  493. </tr>
  494. <tr>
  495. <td class="paramkey"></td>
  496. <td></td>
  497. <td class="paramtype">Function&#160;</td>
  498. <td class="paramname"><em>functionPtr</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">NetworkID&#160;</td>
  504. <td class="paramname"><em>objectInstanceId</em>, </td>
  505. </tr>
  506. <tr>
  507. <td class="paramkey"></td>
  508. <td></td>
  509. <td class="paramtype">int&#160;</td>
  510. <td class="paramname"><em>callPriority</em>&#160;</td>
  511. </tr>
  512. <tr>
  513. <td></td>
  514. <td>)</td>
  515. <td></td><td></td>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p>Register a slot, which is a function pointer to one or more instances of a class that supports this function signature When a signal occurs, all slots with the same identifier are called. </p>
  525. <dl class="params"><dt>Parameters</dt><dd>
  526. <table class="params">
  527. <tr><td class="paramdir">[in]</td><td class="paramname">sharedIdentifier</td><td>A string to identify the slot. Recommended to be the same as the name of the function. </td></tr>
  528. <tr><td class="paramdir">[in]</td><td class="paramname">functionPtr</td><td>Pointer to the function. For C, just pass the name of the function. For C++, use ARPC_REGISTER_CPP_FUNCTION </td></tr>
  529. <tr><td class="paramdir">[in]</td><td class="paramname">objectInstance</td><td>If 0, then this slot is just a regular C function. Otherwise, this is a member of the given class instance. </td></tr>
  530. <tr><td class="paramdir">[in]</td><td class="paramname">callPriority</td><td>Slots are called by order of the highest callPriority first. For slots with the same priority, they are called in the order they are registered </td></tr>
  531. </table>
  532. </dd>
  533. </dl>
  534. </div>
  535. </div>
  536. <a class="anchor" id="a95e591290dca6c7f218accdeb776481f"></a>
  537. <div class="memitem">
  538. <div class="memproto">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname">void RakNet::RPC3::SetNetworkIDManager </td>
  542. <td>(</td>
  543. <td class="paramtype"><a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a> *&#160;</td>
  544. <td class="paramname"><em>idMan</em></td><td>)</td>
  545. <td></td>
  546. </tr>
  547. </table>
  548. </div><div class="memdoc">
  549. <p>Sets the network ID manager to use for object lookup Required to call C++ object member functions via <a class="el" href="classRakNet_1_1RPC3.html#a9d008c1ce2c713e15acc3bef644b5770">SetRecipientObject()</a> </p>
  550. <dl class="params"><dt>Parameters</dt><dd>
  551. <table class="params">
  552. <tr><td class="paramdir">[in]</td><td class="paramname">idMan</td><td>Pointer to the network ID manager to use </td></tr>
  553. </table>
  554. </dd>
  555. </dl>
  556. </div>
  557. </div>
  558. <a class="anchor" id="aaa4ee68113b755c490ab3a780a8d0b02"></a>
  559. <div class="memitem">
  560. <div class="memproto">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">void RakNet::RPC3::SetRecipientAddress </td>
  564. <td>(</td>
  565. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  566. <td class="paramname"><em>systemAddress</em>, </td>
  567. </tr>
  568. <tr>
  569. <td class="paramkey"></td>
  570. <td></td>
  571. <td class="paramtype">bool&#160;</td>
  572. <td class="paramname"><em>broadcast</em>&#160;</td>
  573. </tr>
  574. <tr>
  575. <td></td>
  576. <td>)</td>
  577. <td></td><td></td>
  578. </tr>
  579. </table>
  580. </div><div class="memdoc">
  581. <p>Set system to send to for all following calls to <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> Defaults to <a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf" title="Index of an invalid SystemAddress.">RakNet::UNASSIGNED_SYSTEM_ADDRESS</a>, broadcast=true </p>
  582. <dl class="params"><dt>Parameters</dt><dd>
  583. <table class="params">
  584. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>See <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> </td></tr>
  585. <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>See <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> </td></tr>
  586. </table>
  587. </dd>
  588. </dl>
  589. </div>
  590. </div>
  591. <a class="anchor" id="a9d008c1ce2c713e15acc3bef644b5770"></a>
  592. <div class="memitem">
  593. <div class="memproto">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">void RakNet::RPC3::SetRecipientObject </td>
  597. <td>(</td>
  598. <td class="paramtype">NetworkID&#160;</td>
  599. <td class="paramname"><em>networkID</em></td><td>)</td>
  600. <td></td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. <p>Set the NetworkID to pass for all following calls to <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> Defaults to UNASSIGNED_NETWORK_ID (none) If set, the remote function will be considered a C++ function, e.g. an object member function If set to UNASSIGNED_NETWORK_ID (none), the remote function will be considered a C function If this is set incorrectly, you will get back either RPC_ERROR_CALLING_C_AS_CPP or RPC_ERROR_CALLING_CPP_AS_C </p>
  605. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a> </dd></dl>
  606. <dl class="params"><dt>Parameters</dt><dd>
  607. <table class="params">
  608. <tr><td class="paramdir">[in]</td><td class="paramname">networkID</td><td>Returned from <a class="el" href="classRakNet_1_1NetworkIDObject.html#a4e2454899578ba16379491fc0aa45bb6">NetworkIDObject::GetNetworkID()</a> </td></tr>
  609. </table>
  610. </dd>
  611. </dl>
  612. </div>
  613. </div>
  614. <a class="anchor" id="a45965705d026ad3f694091dc87e9ec3a"></a>
  615. <div class="memitem">
  616. <div class="memproto">
  617. <table class="memname">
  618. <tr>
  619. <td class="memname">void RakNet::RPC3::SetSendParams </td>
  620. <td>(</td>
  621. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a>&#160;</td>
  622. <td class="paramname"><em>priority</em>, </td>
  623. </tr>
  624. <tr>
  625. <td class="paramkey"></td>
  626. <td></td>
  627. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a>&#160;</td>
  628. <td class="paramname"><em>reliability</em>, </td>
  629. </tr>
  630. <tr>
  631. <td class="paramkey"></td>
  632. <td></td>
  633. <td class="paramtype">char&#160;</td>
  634. <td class="paramname"><em>orderingChannel</em>&#160;</td>
  635. </tr>
  636. <tr>
  637. <td></td>
  638. <td>)</td>
  639. <td></td><td></td>
  640. </tr>
  641. </table>
  642. </div><div class="memdoc">
  643. <p>Set parameters to pass to <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> for all following calls to <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> Deafults to HIGH_PRIORITY, RELIABLE_ORDERED, ordering channel 0 </p>
  644. <dl class="params"><dt>Parameters</dt><dd>
  645. <table class="params">
  646. <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>See <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> </td></tr>
  647. <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>See <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> </td></tr>
  648. <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>See <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send()</a> </td></tr>
  649. </table>
  650. </dd>
  651. </dl>
  652. </div>
  653. </div>
  654. <a class="anchor" id="a53d8e3bbce51fafe986530ea3340274e"></a>
  655. <div class="memitem">
  656. <div class="memproto">
  657. <table class="memname">
  658. <tr>
  659. <td class="memname">void RakNet::RPC3::SetTimestamp </td>
  660. <td>(</td>
  661. <td class="paramtype">RakNet::Time&#160;</td>
  662. <td class="paramname"><em>timeStamp</em></td><td>)</td>
  663. <td></td>
  664. </tr>
  665. </table>
  666. </div><div class="memdoc">
  667. <p>Send or stop sending a timestamp with all following calls to <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> Use <a class="el" href="classRakNet_1_1RPC3.html#a315bda0fddf03b56e279e4c0dbcd66f9">GetLastSenderTimestamp()</a> to read the timestamp. </p>
  668. <dl class="params"><dt>Parameters</dt><dd>
  669. <table class="params">
  670. <tr><td class="paramdir">[in]</td><td class="paramname">timeStamp</td><td>Non-zero to pass this timestamp using the ID_TIMESTAMP system. 0 to clear passing a timestamp. </td></tr>
  671. </table>
  672. </dd>
  673. </dl>
  674. </div>
  675. </div>
  676. <a class="anchor" id="ab6e866b090b01c7189055b5fb3c98419"></a>
  677. <div class="memitem">
  678. <div class="memproto">
  679. <table class="mlabels">
  680. <tr>
  681. <td class="mlabels-left">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname">bool RakNet::RPC3::Signal </td>
  685. <td>(</td>
  686. <td class="paramtype">const char *&#160;</td>
  687. <td class="paramname"><em>sharedIdentifier</em></td><td>)</td>
  688. <td></td>
  689. </tr>
  690. </table>
  691. </td>
  692. <td class="mlabels-right">
  693. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  694. </tr>
  695. </table>
  696. </div><div class="memdoc">
  697. <p>Calls zero or more functions identified by sharedIdentifier. Uses as send parameters whatever was last passed to <a class="el" href="classRakNet_1_1RPC3.html#a53d8e3bbce51fafe986530ea3340274e">SetTimestamp()</a>, <a class="el" href="classRakNet_1_1RPC3.html#a45965705d026ad3f694091dc87e9ec3a">SetSendParams()</a>, and <a class="el" href="classRakNet_1_1RPC3.html#aaa4ee68113b755c490ab3a780a8d0b02">SetRecipientAddress()</a> You can use <a class="el" href="classRakNet_1_1RPC3.html#ac13a953871b07e55594bd49582652b80">CallExplicit()</a> instead of <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> to force yourself not to forget to set parameters</p>
  698. <p>See the <a class="el" href="classRakNet_1_1RPC3.html#a78fc5dd5e2e325cfbac3feb7cdcf5fcb">Call()</a> function for a description of parameters</p>
  699. <dl class="params"><dt>Parameters</dt><dd>
  700. <table class="params">
  701. <tr><td class="paramdir">[in]</td><td class="paramname">sharedIdentifier</td><td>parameter of the same name passed to <a class="el" href="classRakNet_1_1RPC3.html#ad74674aaf4a1d0a5b63799123d7c0cb8">RegisterSlot()</a> on the remote system </td></tr>
  702. </table>
  703. </dd>
  704. </dl>
  705. </div>
  706. </div>
  707. <a class="anchor" id="a35526d9abb503c56d30b5ac4b59a11ac"></a>
  708. <div class="memitem">
  709. <div class="memproto">
  710. <table class="memname">
  711. <tr>
  712. <td class="memname">bool RakNet::RPC3::UnregisterFunction </td>
  713. <td>(</td>
  714. <td class="paramtype">const char *&#160;</td>
  715. <td class="paramname"><em>uniqueIdentifier</em></td><td>)</td>
  716. <td></td>
  717. </tr>
  718. </table>
  719. </div><div class="memdoc">
  720. <p>Unregisters a function pointer to be callable given an identifier for the pointer </p>
  721. <dl class="params"><dt>Parameters</dt><dd>
  722. <table class="params">
  723. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueIdentifier</td><td>String identifying the function. </td></tr>
  724. </table>
  725. </dd>
  726. </dl>
  727. <dl class="section return"><dt>Returns</dt><dd>True on success, false on function was not previously or is not currently registered. </dd></dl>
  728. </div>
  729. </div>
  730. <hr/>The documentation for this class was generated from the following file:<ul>
  731. <li>D:/temp/RakNet_PC/DependentExtensions/RPC3/<a class="el" href="RPC3_8h.html">RPC3.h</a></li>
  732. </ul>
  733. </div><!-- contents -->
  734. <!-- start footer part -->
  735. <hr class="footer"/><address class="footer"><small>
  736. Generated on Mon Jun 2 2014 20:10:30 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  737. <img class="footer" src="doxygen.png" alt="doxygen"/>
  738. </a> 1.8.2
  739. </small></address>
  740. </body>
  741. </html>
粤ICP备19079148号