group__RPC__PLUGIN__GROUP.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  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: RPC</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><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><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#nested-classes">Classes</a> &#124;
  43. <a href="#enum-members">Enumerations</a> </div>
  44. <div class="headertitle">
  45. <div class="title">RPC</div> </div>
  46. <div class="ingroups"><a class="el" href="group__PLUGINS__GROUP.html">Plugins</a></div></div><!--header-->
  47. <div class="contents">
  48. <p>Remote procedure calls, without external dependencies.
  49. <a href="#details">More...</a></p>
  50. <table class="memberdecls">
  51. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  52. Classes</h2></td></tr>
  53. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RPC4.html">RakNet::RPC4</a></td></tr>
  54. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <a href="classRakNet_1_1RPC4.html#details">More...</a><br/></td></tr>
  55. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. </table><table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  58. Enumerations</h2></td></tr>
  59. <tr class="memitem:gac20c52e6dc585406689d52db29925bba"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__RPC__PLUGIN__GROUP.html#gac20c52e6dc585406689d52db29925bba">RakNet::RPCErrorCodes</a> { <br/>
  60. &#160;&#160;<a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaac7f3cae6bae5b9b8a015acd2c9f51bc4">RakNet::RPC_ERROR_FUNCTION_NOT_REGISTERED</a>,
  61. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaa545d6db16bfd3bc07fcb37931d0c9311">RakNet::RPC_ERROR_NETWORK_ID_MANAGER_UNAVAILABLE</a>,
  62. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaacfcc9f9c9ee2bc51c832ed784369c695">RakNet::RPC_ERROR_OBJECT_DOES_NOT_EXIST</a>,
  63. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaa82a7d8cd24989c20e60bd165daa90434">RakNet::RPC_ERROR_FUNCTION_INDEX_OUT_OF_RANGE</a>,
  64. <br/>
  65. &#160;&#160;<a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaac7f3cae6bae5b9b8a015acd2c9f51bc4">RakNet::RPC_ERROR_FUNCTION_NOT_REGISTERED</a>,
  66. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaa75e078ea6d81ea2770b1c5cc9c394063">RakNet::RPC_ERROR_FUNCTION_NO_LONGER_REGISTERED</a>,
  67. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaa6d46b2cdb480d360367f4b0dbf156544">RakNet::RPC_ERROR_CALLING_CPP_AS_C</a>,
  68. <a class="el" href="group__RPC__3__GROUP.html#ggac20c52e6dc585406689d52db29925bbaa416f73eb117111cfba98688053ce66ef">RakNet::RPC_ERROR_CALLING_C_AS_CPP</a>
  69. <br/>
  70. }</td></tr>
  71. <tr class="memdesc:gac20c52e6dc585406689d52db29925bba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error codes returned by a remote system as to why an RPC function call cannot execute. <a href="group__RPC__PLUGIN__GROUP.html#gac20c52e6dc585406689d52db29925bba">More...</a><br/></td></tr>
  72. <tr class="separator:gac20c52e6dc585406689d52db29925bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. </table>
  74. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75. <p>Remote procedure calls, without external dependencies. </p>
  76. <p>This should not be used at the same time as RPC3. This is a less functional version of RPC3, and is here for users that do not want the Boost dependency of RPC3. </p>
  77. <h2 class="groupheader">Enumeration Type Documentation</h2>
  78. <a class="anchor" id="gac20c52e6dc585406689d52db29925bba"></a>
  79. <div class="memitem">
  80. <div class="memproto">
  81. <table class="memname">
  82. <tr>
  83. <td class="memname">enum <a class="el" href="group__RPC__PLUGIN__GROUP.html#gac20c52e6dc585406689d52db29925bba">RakNet::RPCErrorCodes</a></td>
  84. </tr>
  85. </table>
  86. </div><div class="memdoc">
  87. <p>Error codes returned by a remote system as to why an RPC function call cannot execute. </p>
  88. <p>Error code follows packet ID ID_RPC_REMOTE_ERROR, that is packet-&gt;data[1]<br/>
  89. Name of the function will be appended starting at packet-&gt;data[2] </p>
  90. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  91. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaac7f3cae6bae5b9b8a015acd2c9f51bc4"></a>RPC_ERROR_FUNCTION_NOT_REGISTERED</em>&nbsp;</td><td>
  92. <p>Named function was not registered with RegisterFunction(). Check your spelling. </p>
  93. </td></tr>
  94. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaa545d6db16bfd3bc07fcb37931d0c9311"></a>RPC_ERROR_NETWORK_ID_MANAGER_UNAVAILABLE</em>&nbsp;</td><td>
  95. <p><a class="el" href="classRakNet_1_1RPC3.html#a95e591290dca6c7f218accdeb776481f">RPC3::SetNetworkIDManager()</a> was not called, and it must be called to call a C++ object member. </p>
  96. </td></tr>
  97. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaacfcc9f9c9ee2bc51c832ed784369c695"></a>RPC_ERROR_OBJECT_DOES_NOT_EXIST</em>&nbsp;</td><td>
  98. <p>Cannot execute C++ object member call because the object specified by SetRecipientObject() does not exist on this system. </p>
  99. </td></tr>
  100. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaa82a7d8cd24989c20e60bd165daa90434"></a>RPC_ERROR_FUNCTION_INDEX_OUT_OF_RANGE</em>&nbsp;</td><td>
  101. <p>Internal error, index optimization for function lookup does not exist. </p>
  102. </td></tr>
  103. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaac7f3cae6bae5b9b8a015acd2c9f51bc4"></a>RPC_ERROR_FUNCTION_NOT_REGISTERED</em>&nbsp;</td><td>
  104. <p>Named function was not registered with RegisterFunction(). Check your spelling. </p>
  105. </td></tr>
  106. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaa75e078ea6d81ea2770b1c5cc9c394063"></a>RPC_ERROR_FUNCTION_NO_LONGER_REGISTERED</em>&nbsp;</td><td>
  107. <p>Named function was registered, but later unregistered with UnregisterFunction() and can no longer be called. </p>
  108. </td></tr>
  109. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaa6d46b2cdb480d360367f4b0dbf156544"></a>RPC_ERROR_CALLING_CPP_AS_C</em>&nbsp;</td><td>
  110. <p>SetRecipientObject() was not called before Call(), but the registered pointer is a class member If you intended to call a class member function, call SetRecipientObject() with a valid object first. </p>
  111. </td></tr>
  112. <tr><td valign="top"><em><a class="anchor" id="ggac20c52e6dc585406689d52db29925bbaa416f73eb117111cfba98688053ce66ef"></a>RPC_ERROR_CALLING_C_AS_CPP</em>&nbsp;</td><td>
  113. <p>SetRecipientObject() was called before Call(), but RegisterFunction() was called with isObjectMember=false If you intended to call a C function, call SetRecipientObject(UNASSIGNED_NETWORK_ID) first. </p>
  114. </td></tr>
  115. </table>
  116. </dd>
  117. </dl>
  118. </div>
  119. </div>
  120. </div><!-- contents -->
  121. <!-- start footer part -->
  122. <hr class="footer"/><address class="footer"><small>
  123. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  124. <img class="footer" src="doxygen.png" alt="doxygen"/>
  125. </a> 1.8.2
  126. </small></address>
  127. </body>
  128. </html>
粤ICP备19079148号