classRakNet_1_1RPC4.html 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  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::RPC4 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_1RPC4.html">RPC4</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_1RPC4-members.html">List of all members</a> </div>
  58. <div class="headertitle">
  59. <div class="title">RakNet::RPC4 Class Reference<div class="ingroups"><a class="el" href="group__RPC__PLUGIN__GROUP.html">RPC</a></div></div> </div>
  60. </div><!--header-->
  61. <div class="contents">
  62. <p>The <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> plugin is just an association between a C function pointer and a string.
  63. <a href="classRakNet_1_1RPC4.html#details">More...</a></p>
  64. <p><code>#include &lt;RPC4Plugin.h&gt;</code></p>
  65. <div class="dynheader">
  66. Inheritance diagram for RakNet::RPC4:</div>
  67. <div class="dyncontent">
  68. <div class="center">
  69. <img src="classRakNet_1_1RPC4.png" usemap="#RakNet::RPC4_map" alt=""/>
  70. <map id="RakNet::RPC4_map" name="RakNet::RPC4_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:a62122f90344dbfc064f9b14e0f565b23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23">RegisterFunction</a> (const char *uniqueID, void(*functionPointer)(<a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *userData, <a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet))</td></tr>
  78. <tr class="memdesc:a62122f90344dbfc064f9b14e0f565b23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a function pointer to be callable from a remote system. <a href="#a62122f90344dbfc064f9b14e0f565b23"></a><br/></td></tr>
  79. <tr class="separator:a62122f90344dbfc064f9b14e0f565b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a923fe77794363d8ec6094da98fd40d03"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot</a> (const char *sharedIdentifier, void(*functionPointer)(<a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *userData, <a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet), int callPriority)</td></tr>
  81. <tr class="separator:a923fe77794363d8ec6094da98fd40d03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a274362402c9476feb9575d06b75a5263"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a274362402c9476feb9575d06b75a5263"></a>
  83. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a274362402c9476feb9575d06b75a5263">RegisterBlockingFunction</a> (const char *uniqueID, void(*functionPointer)(<a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *userData, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *returnData, <a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet))</td></tr>
  84. <tr class="memdesc:a274362402c9476feb9575d06b75a5263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <em>RegisterFunction</em>, but is called with <a class="el" href="classRakNet_1_1RPC4.html#ac224d0d8b1f23817488c14b9fe2d2d36" title="Same as call, but don&#39;t return until the remote system replies. Broadcasting parameter does not exist...">CallBlocking()</a> instead of <a class="el" href="classRakNet_1_1RPC4.html#afcf702778c734ec2cd0a0513e77fb380">Call()</a> and returns a value to the caller. <br/></td></tr>
  85. <tr class="separator:a274362402c9476feb9575d06b75a5263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a71f5f6d32e12adf3715d9c5faea25439"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a71f5f6d32e12adf3715d9c5faea25439">RegisterLocalCallback</a> (const char *uniqueID, <a class="el" href="namespaceRakNet.html#a1b2f3bf4bad2bb6a8360a12295fbed0c">MessageID</a> messageId)</td></tr>
  87. <tr class="separator:a71f5f6d32e12adf3715d9c5faea25439"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ac2fe5e7ffa410c7203e15e1885c72e73"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#ac2fe5e7ffa410c7203e15e1885c72e73">UnregisterFunction</a> (const char *uniqueID)</td></tr>
  89. <tr class="memdesc:ac2fe5e7ffa410c7203e15e1885c72e73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a function pointer previously registered with <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> <a href="#ac2fe5e7ffa410c7203e15e1885c72e73"></a><br/></td></tr>
  90. <tr class="separator:ac2fe5e7ffa410c7203e15e1885c72e73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a423aadb8573fe7a91fdc3bd2dacd3bf8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a423aadb8573fe7a91fdc3bd2dacd3bf8"></a>
  92. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a423aadb8573fe7a91fdc3bd2dacd3bf8">UnregisterBlockingFunction</a> (const char *uniqueID)</td></tr>
  93. <tr class="memdesc:a423aadb8573fe7a91fdc3bd2dacd3bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as UnregisterFunction, except for a blocking function. <br/></td></tr>
  94. <tr class="separator:a423aadb8573fe7a91fdc3bd2dacd3bf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:acf39698d278c8d05d199086fe846ca6a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#acf39698d278c8d05d199086fe846ca6a">UnregisterLocalCallback</a> (const char *uniqueID, <a class="el" href="namespaceRakNet.html#a1b2f3bf4bad2bb6a8360a12295fbed0c">MessageID</a> messageId)</td></tr>
  96. <tr class="separator:acf39698d278c8d05d199086fe846ca6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:af9ff734939d0ae4e2dbf0ab2e16f6ca5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#af9ff734939d0ae4e2dbf0ab2e16f6ca5">UnregisterSlot</a> (const char *sharedIdentifier)</td></tr>
  98. <tr class="separator:af9ff734939d0ae4e2dbf0ab2e16f6ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a94a6c4503e9639d65e052a685d458878"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a94a6c4503e9639d65e052a685d458878">CallLoopback</a> (const char *uniqueID, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bitStream)</td></tr>
  100. <tr class="separator:a94a6c4503e9639d65e052a685d458878"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:afcf702778c734ec2cd0a0513e77fb380"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#afcf702778c734ec2cd0a0513e77fb380">Call</a> (const char *uniqueID, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bitStream, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast)</td></tr>
  102. <tr class="separator:afcf702778c734ec2cd0a0513e77fb380"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ac224d0d8b1f23817488c14b9fe2d2d36"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#ac224d0d8b1f23817488c14b9fe2d2d36">CallBlocking</a> (const char *uniqueID, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bitStream, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *returnData)</td></tr>
  104. <tr class="memdesc:ac224d0d8b1f23817488c14b9fe2d2d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as call, but don't return until the remote system replies. Broadcasting parameter does not exist, this can only call one remote system. <a href="#ac224d0d8b1f23817488c14b9fe2d2d36"></a><br/></td></tr>
  105. <tr class="separator:ac224d0d8b1f23817488c14b9fe2d2d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:afd3487232245b9d7d7d9e332bf09155d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#afd3487232245b9d7d7d9e332bf09155d">Signal</a> (const char *sharedIdentifier, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bitStream, <a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> priority, <a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a> reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast, bool invokeLocal)</td></tr>
  107. <tr class="separator:afd3487232245b9d7d7d9e332bf09155d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:af0e31a1377408727bfa0afe19dda4261"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0e31a1377408727bfa0afe19dda4261"></a>
  109. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#af0e31a1377408727bfa0afe19dda4261">InterruptSignal</a> (void)</td></tr>
  110. <tr class="memdesc:af0e31a1377408727bfa0afe19dda4261"><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>
  111. <tr class="separator:af0e31a1377408727bfa0afe19dda4261"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
  114. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
  115. <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>
  116. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
  118. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
  119. <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>
  120. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
  122. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
  123. <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>
  124. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
  126. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
  127. <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>
  128. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a80c7612ca1a5dcfeec0b52d8049a71ea 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#a80c7612ca1a5dcfeec0b52d8049a71ea">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>
  130. <tr class="separator:a80c7612ca1a5dcfeec0b52d8049a71ea inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table><table class="memberdecls">
  150. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  151. Protected Member Functions</h2></td></tr>
  152. <tr class="memitem:a9ca07d17100a98cb05037ee496745e62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca07d17100a98cb05037ee496745e62"></a>
  153. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#a9ca07d17100a98cb05037ee496745e62">OnAttach</a> (void)</td></tr>
  154. <tr class="memdesc:a9ca07d17100a98cb05037ee496745e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
  155. <tr class="separator:a9ca07d17100a98cb05037ee496745e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:aa2df727ed0ef203a017e198a94dc8841"><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_1RPC4.html#aa2df727ed0ef203a017e198a94dc8841">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  157. <tr class="separator:aa2df727ed0ef203a017e198a94dc8841"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  160. Protected Attributes</h2></td></tr>
  161. <tr class="memitem:af8b977746f6e1f0d11f6119a847fd9c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8b977746f6e1f0d11f6119a847fd9c5"></a>
  162. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html#af8b977746f6e1f0d11f6119a847fd9c5">nextSlotRegistrationCount</a></td></tr>
  163. <tr class="memdesc:af8b977746f6e1f0d11f6119a847fd9c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used so slots are called in the order they are registered. <br/></td></tr>
  164. <tr class="separator:af8b977746f6e1f0d11f6119a847fd9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. </table>
  166. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  167. <div class="textblock"><p>The <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> plugin is just an association between a C function pointer and a string. </p>
  168. <p>It is for users that want to use RPC, but do not want to use boost. You do not have the automatic serialization or other features 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>, and C++ member calls are not supported. </p>
  169. <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 RPC3Plugin </dd></dl>
  170. </div><h2 class="groupheader">Member Function Documentation</h2>
  171. <a class="anchor" id="afcf702778c734ec2cd0a0513e77fb380"></a>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">void RakNet::RPC4::Call </td>
  177. <td>(</td>
  178. <td class="paramtype">const char *&#160;</td>
  179. <td class="paramname"><em>uniqueID</em>, </td>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *&#160;</td>
  185. <td class="paramname"><em>bitStream</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a>&#160;</td>
  191. <td class="paramname"><em>priority</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a>&#160;</td>
  197. <td class="paramname"><em>reliability</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype">char&#160;</td>
  203. <td class="paramname"><em>orderingChannel</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">const AddressOrGUID&#160;</td>
  209. <td class="paramname"><em>systemIdentifier</em>, </td>
  210. </tr>
  211. <tr>
  212. <td class="paramkey"></td>
  213. <td></td>
  214. <td class="paramtype">bool&#160;</td>
  215. <td class="paramname"><em>broadcast</em>&#160;</td>
  216. </tr>
  217. <tr>
  218. <td></td>
  219. <td>)</td>
  220. <td></td><td></td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>, use <a class="el" href="classRakNet_1_1RPC4.html#afd3487232245b9d7d7d9e332bf09155d">Signal()</a> Send to the specified remote instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>. </dd></dl>
  225. <dl class="params"><dt>Parameters</dt><dd>
  226. <table class="params">
  227. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueID</td><td>Identifier originally passed to <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> on the remote system(s) </td></tr>
  228. <tr><td class="paramdir">[in]</td><td class="paramname">bitStream</td><td>bitStream encoded data to send to the function callback </td></tr>
  229. <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  230. <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  231. <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  232. <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  233. <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  234. </table>
  235. </dd>
  236. </dl>
  237. </div>
  238. </div>
  239. <a class="anchor" id="ac224d0d8b1f23817488c14b9fe2d2d36"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">bool RakNet::RPC4::CallBlocking </td>
  245. <td>(</td>
  246. <td class="paramtype">const char *&#160;</td>
  247. <td class="paramname"><em>uniqueID</em>, </td>
  248. </tr>
  249. <tr>
  250. <td class="paramkey"></td>
  251. <td></td>
  252. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *&#160;</td>
  253. <td class="paramname"><em>bitStream</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a>&#160;</td>
  259. <td class="paramname"><em>priority</em>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a>&#160;</td>
  265. <td class="paramname"><em>reliability</em>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype">char&#160;</td>
  271. <td class="paramname"><em>orderingChannel</em>, </td>
  272. </tr>
  273. <tr>
  274. <td class="paramkey"></td>
  275. <td></td>
  276. <td class="paramtype">const AddressOrGUID&#160;</td>
  277. <td class="paramname"><em>systemIdentifier</em>, </td>
  278. </tr>
  279. <tr>
  280. <td class="paramkey"></td>
  281. <td></td>
  282. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *&#160;</td>
  283. <td class="paramname"><em>returnData</em>&#160;</td>
  284. </tr>
  285. <tr>
  286. <td></td>
  287. <td>)</td>
  288. <td></td><td></td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>Same as call, but don't return until the remote system replies. Broadcasting parameter does not exist, this can only call one remote system. </p>
  293. <dl class="section note"><dt>Note</dt><dd>This function does not return until the remote system responds, disconnects, or was never connected to begin with </dd></dl>
  294. <dl class="params"><dt>Parameters</dt><dd>
  295. <table class="params">
  296. <tr><td class="paramdir">[in]</td><td class="paramname">Identifier</td><td>originally passed to <a class="el" href="classRakNet_1_1RPC4.html#a274362402c9476feb9575d06b75a5263" title="Same as RegisterFunction, but is called with CallBlocking() instead of Call() and returns a value to ...">RegisterBlockingFunction()</a> on the remote system(s) </td></tr>
  297. <tr><td class="paramdir">[in]</td><td class="paramname">bitStream</td><td>bitStream encoded data to send to the function callback </td></tr>
  298. <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  299. <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  300. <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  301. <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  302. <tr><td class="paramdir">[out]</td><td class="paramname">returnData</td><td>Written to by the function registered with RegisterBlockingFunction. </td></tr>
  303. </table>
  304. </dd>
  305. </dl>
  306. <dl class="section return"><dt>Returns</dt><dd>true if successfully called. False on disconnect, function not registered, or not connected to begin with </dd></dl>
  307. </div>
  308. </div>
  309. <a class="anchor" id="a94a6c4503e9639d65e052a685d458878"></a>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">void RakNet::RPC4::CallLoopback </td>
  315. <td>(</td>
  316. <td class="paramtype">const char *&#160;</td>
  317. <td class="paramname"><em>uniqueID</em>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *&#160;</td>
  323. <td class="paramname"><em>bitStream</em>&#160;</td>
  324. </tr>
  325. <tr>
  326. <td></td>
  327. <td>)</td>
  328. <td></td><td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>Use <a class="el" href="classRakNet_1_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot()</a> and <a class="el" href="classRakNet_1_1RPC4.html#afd3487232245b9d7d7d9e332bf09155d">Signal()</a> with your own <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> as the send target Send to the attached instance of <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a>. See <a class="el" href="classRakNet_1_1RakPeerInterface.html#ab8e39273dd7fb89d4b29a01bca32f82c">RakPeerInterface::SendLoopback()</a> </dd></dl>
  333. <dl class="params"><dt>Parameters</dt><dd>
  334. <table class="params">
  335. <tr><td class="paramdir">[in]</td><td class="paramname">Identifier</td><td>originally passed to <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> on the local system </td></tr>
  336. <tr><td class="paramdir">[in]</td><td class="paramname">bitStream</td><td>bitStream encoded data to send to the function callback </td></tr>
  337. </table>
  338. </dd>
  339. </dl>
  340. </div>
  341. </div>
  342. <a class="anchor" id="aa2df727ed0ef203a017e198a94dc8841"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::RPC4::OnReceive </td>
  351. <td>(</td>
  352. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  353. <td class="paramname"><em>packet</em></td><td>)</td>
  354. <td></td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>OnReceive is called for every packet. </p>
  364. <dl class="params"><dt>Parameters</dt><dd>
  365. <table class="params">
  366. <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
  367. </table>
  368. </dd>
  369. </dl>
  370. <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>
  371. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
  372. </div>
  373. </div>
  374. <a class="anchor" id="a62122f90344dbfc064f9b14e0f565b23"></a>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="memname">
  378. <tr>
  379. <td class="memname">bool RakNet::RPC4::RegisterFunction </td>
  380. <td>(</td>
  381. <td class="paramtype">const char *&#160;</td>
  382. <td class="paramname"><em>uniqueID</em>, </td>
  383. </tr>
  384. <tr>
  385. <td class="paramkey"></td>
  386. <td></td>
  387. <td class="paramtype">void(*)(<a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *userData, <a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)&#160;</td>
  388. <td class="paramname"><em>functionPointer</em>&#160;</td>
  389. </tr>
  390. <tr>
  391. <td></td>
  392. <td>)</td>
  393. <td></td><td></td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Register a function pointer to be callable from a remote system. </p>
  398. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Use RegisterSlot </dd></dl>
  399. <p>The hash of the function name will be stored as an association with the function pointer When a call is made to call this function from the <em><a class="el" href="classRakNet_1_1RPC4.html#afcf702778c734ec2cd0a0513e77fb380">Call()</a></em> or <a class="el" href="classRakNet_1_1RPC4.html#a94a6c4503e9639d65e052a685d458878">CallLoopback()</a> function, the function pointer will be invoked with the passed bitStream to <a class="el" href="classRakNet_1_1RPC4.html#afcf702778c734ec2cd0a0513e77fb380">Call()</a> and the actual <a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> that <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> got. </p>
  400. <dl class="section see"><dt>See Also</dt><dd>RegisterPacketCallback() </dd></dl>
  401. <dl class="params"><dt>Parameters</dt><dd>
  402. <table class="params">
  403. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueID</td><td>Identifier to be associated with <em>functionPointer</em>. If this identifier is already in use, the call will return false. </td></tr>
  404. <tr><td class="paramdir">[in]</td><td class="paramname">functionPointer</td><td>C function pointer to be called </td></tr>
  405. </table>
  406. </dd>
  407. </dl>
  408. <dl class="section return"><dt>Returns</dt><dd>True if the hash of uniqueID is not in use, false otherwise. </dd></dl>
  409. </div>
  410. </div>
  411. <a class="anchor" id="a71f5f6d32e12adf3715d9c5faea25439"></a>
  412. <div class="memitem">
  413. <div class="memproto">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">void RakNet::RPC4::RegisterLocalCallback </td>
  417. <td>(</td>
  418. <td class="paramtype">const char *&#160;</td>
  419. <td class="paramname"><em>uniqueID</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype"><a class="el" href="namespaceRakNet.html#a1b2f3bf4bad2bb6a8360a12295fbed0c">MessageID</a>&#160;</td>
  425. <td class="paramname"><em>messageId</em>&#160;</td>
  426. </tr>
  427. <tr>
  428. <td></td>
  429. <td>)</td>
  430. <td></td><td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Use RegisterSlot and invoke on self only when the packet you want arrives When a <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> <a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> with the specified identifier is returned, execute <a class="el" href="classRakNet_1_1RPC4.html#a94a6c4503e9639d65e052a685d458878">CallLoopback()</a> on a function previously registered with <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> For example, you could call "OnClosedConnection" whenever you get ID_DISCONNECTION_NOTIFICATION or ID_CONNECTION_LOST </dd></dl>
  435. <dl class="params"><dt>Parameters</dt><dd>
  436. <table class="params">
  437. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueID</td><td>Identifier passed to <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> </td></tr>
  438. <tr><td class="paramdir">[in]</td><td class="paramname">messageId</td><td>What <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> packet ID to call on, for example ID_DISCONNECTION_NOTIFICATION or ID_CONNECTION_LOST </td></tr>
  439. </table>
  440. </dd>
  441. </dl>
  442. </div>
  443. </div>
  444. <a class="anchor" id="a923fe77794363d8ec6094da98fd40d03"></a>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">void RakNet::RPC4::RegisterSlot </td>
  450. <td>(</td>
  451. <td class="paramtype">const char *&#160;</td>
  452. <td class="paramname"><em>sharedIdentifier</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">void(*)(<a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *userData, <a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)&#160;</td>
  458. <td class="paramname"><em>functionPointer</em>, </td>
  459. </tr>
  460. <tr>
  461. <td class="paramkey"></td>
  462. <td></td>
  463. <td class="paramtype">int&#160;</td>
  464. <td class="paramname"><em>callPriority</em>&#160;</td>
  465. </tr>
  466. <tr>
  467. <td></td>
  468. <td>)</td>
  469. <td></td><td></td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <p>Register a slot, which is a function pointer to one or more implementations that supports this function signature When a signal occurs, all slots with the same identifier are called. </p>
  474. <dl class="params"><dt>Parameters</dt><dd>
  475. <table class="params">
  476. <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>
  477. <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>
  478. <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>
  479. </table>
  480. </dd>
  481. </dl>
  482. </div>
  483. </div>
  484. <a class="anchor" id="afd3487232245b9d7d7d9e332bf09155d"></a>
  485. <div class="memitem">
  486. <div class="memproto">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">void RakNet::RPC4::Signal </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"><a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *&#160;</td>
  498. <td class="paramname"><em>bitStream</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a>&#160;</td>
  504. <td class="paramname"><em>priority</em>, </td>
  505. </tr>
  506. <tr>
  507. <td class="paramkey"></td>
  508. <td></td>
  509. <td class="paramtype"><a class="el" href="PacketPriority_8h.html#ae41fa01235e99dced384d137fa874a7e">PacketReliability</a>&#160;</td>
  510. <td class="paramname"><em>reliability</em>, </td>
  511. </tr>
  512. <tr>
  513. <td class="paramkey"></td>
  514. <td></td>
  515. <td class="paramtype">char&#160;</td>
  516. <td class="paramname"><em>orderingChannel</em>, </td>
  517. </tr>
  518. <tr>
  519. <td class="paramkey"></td>
  520. <td></td>
  521. <td class="paramtype">const AddressOrGUID&#160;</td>
  522. <td class="paramname"><em>systemIdentifier</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">bool&#160;</td>
  528. <td class="paramname"><em>broadcast</em>, </td>
  529. </tr>
  530. <tr>
  531. <td class="paramkey"></td>
  532. <td></td>
  533. <td class="paramtype">bool&#160;</td>
  534. <td class="paramname"><em>invokeLocal</em>&#160;</td>
  535. </tr>
  536. <tr>
  537. <td></td>
  538. <td>)</td>
  539. <td></td><td></td>
  540. </tr>
  541. </table>
  542. </div><div class="memdoc">
  543. <p>Calls zero or more functions identified by sharedIdentifier registered with <a class="el" href="classRakNet_1_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot()</a> </p>
  544. <dl class="params"><dt>Parameters</dt><dd>
  545. <table class="params">
  546. <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_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot()</a> on the remote system </td></tr>
  547. <tr><td class="paramdir">[in]</td><td class="paramname">bitStream</td><td>bitStream encoded data to send to the function callback </td></tr>
  548. <tr><td class="paramdir">[in]</td><td class="paramname">priority</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  549. <tr><td class="paramdir">[in]</td><td class="paramname">reliability</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  550. <tr><td class="paramdir">[in]</td><td class="paramname">orderingChannel</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  551. <tr><td class="paramdir">[in]</td><td class="paramname">systemIdentifier</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  552. <tr><td class="paramdir">[in]</td><td class="paramname">broadcast</td><td>See <a class="el" href="classRakNet_1_1RakPeerInterface.html#a543ec5be9cf5f73f5c8733d1829789f9">RakPeerInterface::Send()</a> </td></tr>
  553. <tr><td class="paramdir">[in]</td><td class="paramname">invokeLocal</td><td>If true, also sends to self. </td></tr>
  554. </table>
  555. </dd>
  556. </dl>
  557. </div>
  558. </div>
  559. <a class="anchor" id="ac2fe5e7ffa410c7203e15e1885c72e73"></a>
  560. <div class="memitem">
  561. <div class="memproto">
  562. <table class="memname">
  563. <tr>
  564. <td class="memname">bool RakNet::RPC4::UnregisterFunction </td>
  565. <td>(</td>
  566. <td class="paramtype">const char *&#160;</td>
  567. <td class="paramname"><em>uniqueID</em></td><td>)</td>
  568. <td></td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <p>Unregister a function pointer previously registered with <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> </p>
  573. <dl class="params"><dt>Parameters</dt><dd>
  574. <table class="params">
  575. <tr><td class="paramdir">[in]</td><td class="paramname">Identifier</td><td>originally passed to <a class="el" href="classRakNet_1_1RPC4.html#a62122f90344dbfc064f9b14e0f565b23" title="Register a function pointer to be callable from a remote system.">RegisterFunction()</a> </td></tr>
  576. </table>
  577. </dd>
  578. </dl>
  579. <dl class="section return"><dt>Returns</dt><dd>True if the hash of uniqueID was in use, and hence removed. false otherwise. </dd></dl>
  580. </div>
  581. </div>
  582. <a class="anchor" id="acf39698d278c8d05d199086fe846ca6a"></a>
  583. <div class="memitem">
  584. <div class="memproto">
  585. <table class="memname">
  586. <tr>
  587. <td class="memname">bool RakNet::RPC4::UnregisterLocalCallback </td>
  588. <td>(</td>
  589. <td class="paramtype">const char *&#160;</td>
  590. <td class="paramname"><em>uniqueID</em>, </td>
  591. </tr>
  592. <tr>
  593. <td class="paramkey"></td>
  594. <td></td>
  595. <td class="paramtype"><a class="el" href="namespaceRakNet.html#a1b2f3bf4bad2bb6a8360a12295fbed0c">MessageID</a>&#160;</td>
  596. <td class="paramname"><em>messageId</em>&#160;</td>
  597. </tr>
  598. <tr>
  599. <td></td>
  600. <td>)</td>
  601. <td></td><td></td>
  602. </tr>
  603. </table>
  604. </div><div class="memdoc">
  605. <p>Remove the association created with RegisterPacketCallback() </p>
  606. <dl class="params"><dt>Parameters</dt><dd>
  607. <table class="params">
  608. <tr><td class="paramdir">[in]</td><td class="paramname">uniqueID</td><td>Identifier passed as uniqueID to <a class="el" href="classRakNet_1_1RPC4.html#a71f5f6d32e12adf3715d9c5faea25439">RegisterLocalCallback()</a> </td></tr>
  609. <tr><td class="paramdir">[in]</td><td class="paramname">messageId</td><td>Identifier passed as messageId to <a class="el" href="classRakNet_1_1RPC4.html#a71f5f6d32e12adf3715d9c5faea25439">RegisterLocalCallback()</a> </td></tr>
  610. </table>
  611. </dd>
  612. </dl>
  613. <dl class="section return"><dt>Returns</dt><dd>True if the combination of uniqueID and messageId was in use, and hence removed </dd></dl>
  614. </div>
  615. </div>
  616. <a class="anchor" id="af9ff734939d0ae4e2dbf0ab2e16f6ca5"></a>
  617. <div class="memitem">
  618. <div class="memproto">
  619. <table class="memname">
  620. <tr>
  621. <td class="memname">bool RakNet::RPC4::UnregisterSlot </td>
  622. <td>(</td>
  623. <td class="paramtype">const char *&#160;</td>
  624. <td class="paramname"><em>sharedIdentifier</em></td><td>)</td>
  625. <td></td>
  626. </tr>
  627. </table>
  628. </div><div class="memdoc">
  629. <p>Remove the association created with <a class="el" href="classRakNet_1_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot()</a> </p>
  630. <dl class="params"><dt>Parameters</dt><dd>
  631. <table class="params">
  632. <tr><td class="paramdir">[in]</td><td class="paramname">sharedIdentifier</td><td>Identifier passed as sharedIdentifier to <a class="el" href="classRakNet_1_1RPC4.html#a923fe77794363d8ec6094da98fd40d03">RegisterSlot()</a> </td></tr>
  633. </table>
  634. </dd>
  635. </dl>
  636. </div>
  637. </div>
  638. <hr/>The documentation for this class was generated from the following file:<ul>
  639. <li>D:/temp/RakNet_PC/Source/<a class="el" href="RPC4Plugin_8h.html">RPC4Plugin.h</a></li>
  640. </ul>
  641. </div><!-- contents -->
  642. <!-- start footer part -->
  643. <hr class="footer"/><address class="footer"><small>
  644. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  645. <img class="footer" src="doxygen.png" alt="doxygen"/>
  646. </a> 1.8.2
  647. </small></address>
  648. </body>
  649. </html>
粤ICP备19079148号