Главная Обзор Помощь
Регистрация Вход
samien
/
RakNet
1
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Дерево: 2c0d414eb5
Ветки Метки
RakNet
/
Help
/
Doxygen
/
html
/
classRakNet_1_1CommandParserInterface.html

classRakNet_1_1CommandParserInterface.html 29 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>RakNet: RakNet::CommandParserInterface Class Reference</title>
    7. 

  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td style="padding-left: 0.5em;">
    19. 

  19.    <div id="projectname">RakNet
    20. 

  20.    &#160;<span id="projectnumber">4.0</span>
    21. 

  21.    </div>
    22. 

  22.   </td>
    23. 

  23.  </tr>
    24. 

  24.  </tbody>
    25. 

  25. </table>
    26. 

  26. </div>
    27. 

  27. <!-- end header part -->
    28. 

  28. <!-- Generated by Doxygen 1.8.2 -->
    29. 

  29.   <div id="navrow1" class="tabs">
    30. 

  30.     <ul class="tablist">
    31. 

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    32. 

  32.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    35. 

  35.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.       <li><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39.   <div id="navrow2" class="tabs2">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
    42. 

  42.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
    43. 

  43.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    44. 

  44.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    45. 

  45.     </ul>
    46. 

  46.   </div>
    47. 

  47. <div id="nav-path" class="navpath">
    48. 

  48.   <ul>
    49. 

  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1CommandParserInterface.html">CommandParserInterface</a></li>  </ul>
    50. 

  50. </div>
    51. 

  51. </div><!-- top -->
    52. 

  52. <div class="header">
    53. 

  53.   <div class="summary">
    54. 

  54. <a href="#pub-methods">Public Member Functions</a> &#124;
    55. 

  55. <a href="classRakNet_1_1CommandParserInterface-members.html">List of all members</a>  </div>
    56. 

  56.   <div class="headertitle">
    57. 

  57. <div class="title">RakNet::CommandParserInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
    58. 

  58. </div><!--header-->
    59. 

  59. <div class="contents">
    60. 

  60. 

  61. <p>The interface used by command parsers.  
    62. 

  62.  <a href="classRakNet_1_1CommandParserInterface.html#details">More...</a></p>
    63. 

  63. 

  64. <p><code>#include &lt;CommandParserInterface.h&gt;</code></p>
    65. 

  65. <div class="dynheader">
    66. 

  66. Inheritance diagram for RakNet::CommandParserInterface:</div>
    67. 

  67. <div class="dyncontent">
    68. 

  68.  <div class="center">
    69. 

  69.   <img src="classRakNet_1_1CommandParserInterface.png" usemap="#RakNet::CommandParserInterface_map" alt=""/>
    70. 

  70.   <map id="RakNet::CommandParserInterface_map" name="RakNet::CommandParserInterface_map">
    71. 

  71. <area href="classRakNet_1_1LogCommandParser.html" title="Adds the ability to send logging output to a remote console." alt="RakNet::LogCommandParser" shape="rect" coords="0,56,201,80"/>
    72. 

  72. <area href="classRakNet_1_1RakNetCommandParser.html" title="This allows a console client to call most of the functions in RakPeer." alt="RakNet::RakNetCommandParser" shape="rect" coords="211,56,412,80"/>
    73. 

  73. </map>
    74. 

  74.  </div></div>
    75. 

  75. <table class="memberdecls">
    76. 

  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    77. 

  77. Public Member Functions</h2></td></tr>
    78. 

  78. <tr class="memitem:af9f1b817f383b52f9ad6451def11d35b"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#af9f1b817f383b52f9ad6451def11d35b">GetName</a> (void) const =0</td></tr>
    79. 

  79. <tr class="separator:af9f1b817f383b52f9ad6451def11d35b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:a98004a0af5237980fdc160f6c6fcdc79"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#a98004a0af5237980fdc160f6c6fcdc79">OnNewIncomingConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport)</td></tr>
    81. 

  81. <tr class="memdesc:a98004a0af5237980fdc160f6c6fcdc79"><td class="mdescLeft">&#160;</td><td class="mdescRight">A callback for when <em>systemAddress</em> has connected to us.  <a href="#a98004a0af5237980fdc160f6c6fcdc79"></a><br/></td></tr>
    82. 

  82. <tr class="separator:a98004a0af5237980fdc160f6c6fcdc79"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem:aa275db3922ed1c27fc5ee7ecd6913d4b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#aa275db3922ed1c27fc5ee7ecd6913d4b">OnConnectionLost</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport)</td></tr>
    84. 

  84. <tr class="memdesc:aa275db3922ed1c27fc5ee7ecd6913d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A callback for when <em>systemAddress</em> has disconnected, either gracefully or forcefully.  <a href="#aa275db3922ed1c27fc5ee7ecd6913d4b"></a><br/></td></tr>
    85. 

  85. <tr class="separator:aa275db3922ed1c27fc5ee7ecd6913d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:a6abf857d697bb11230ac0b153c17624a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#a6abf857d697bb11230ac0b153c17624a">SendHelp</a> (<a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport, const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress)=0</td></tr>
    87. 

  87. <tr class="memdesc:a6abf857d697bb11230ac0b153c17624a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A callback for when you are expected to send a brief description of your parser to <em>systemAddress</em>.  <a href="#a6abf857d697bb11230ac0b153c17624a"></a><br/></td></tr>
    88. 

  88. <tr class="separator:a6abf857d697bb11230ac0b153c17624a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    89. 

  89. <tr class="memitem:ac568282654986ad63d680d68a98cf757"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#ac568282654986ad63d680d68a98cf757">OnCommand</a> (const char *command, unsigned numParameters, char **parameterList, <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport, const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, const char *originalString)=0</td></tr>
    90. 

  90. <tr class="memdesc:ac568282654986ad63d680d68a98cf757"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given <em>command</em> with parameters <em>parameterList</em> , do whatever processing you wish.  <a href="#ac568282654986ad63d680d68a98cf757"></a><br/></td></tr>
    91. 

  91. <tr class="separator:ac568282654986ad63d680d68a98cf757"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. <tr class="memitem:a9bdc4fa618f324e8f3c0f188009e6958"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#a9bdc4fa618f324e8f3c0f188009e6958">OnTransportChange</a> (<a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport)</td></tr>
    93. 

  93. <tr class="memdesc:a9bdc4fa618f324e8f3c0f188009e6958"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is called every time transport interface is registered.  <a href="#a9bdc4fa618f324e8f3c0f188009e6958"></a><br/></td></tr>
    94. 

  94. <tr class="separator:a9bdc4fa618f324e8f3c0f188009e6958"><td class="memSeparator" colspan="2">&#160;</td></tr>
    95. 

  95. <tr class="memitem:abe62e54c5f3e0dde2f88b48ce479d4c6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#abe62e54c5f3e0dde2f88b48ce479d4c6">RegisterCommand</a> (unsigned char parameterCount, const char *command, const char *commandHelp)</td></tr>
    96. 

  96. <tr class="separator:abe62e54c5f3e0dde2f88b48ce479d4c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    97. 

  97. <tr class="memitem:a5b01f9370d1bffee84caf3da9fae5dfe"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#a5b01f9370d1bffee84caf3da9fae5dfe">ReturnResult</a> (bool res, const char *command, <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport, const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress)</td></tr>
    98. 

  98. <tr class="memdesc:a5b01f9370d1bffee84caf3da9fae5dfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Just writes a string to the remote system based on the result ( <em>res</em> ) of your operation.  <a href="#a5b01f9370d1bffee84caf3da9fae5dfe"></a><br/></td></tr>
    99. 

  99. <tr class="separator:a5b01f9370d1bffee84caf3da9fae5dfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
    100. 

  100. <tr class="memitem:a628e6ddfdeaecfb7d6120f7db3780d91"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1CommandParserInterface.html#a628e6ddfdeaecfb7d6120f7db3780d91">ReturnResult</a> (const char *command, <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport, const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress)</td></tr>
    101. 

  101. <tr class="memdesc:a628e6ddfdeaecfb7d6120f7db3780d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Just writes a string to the remote system when you are calling a function that has no return value.  <a href="#a628e6ddfdeaecfb7d6120f7db3780d91"></a><br/></td></tr>
    102. 

  102. <tr class="separator:a628e6ddfdeaecfb7d6120f7db3780d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. </table>
    104. 

  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    105. 

  105. <div class="textblock"><p>The interface used by command parsers. </p>
    106. 

  106. <p><a class="el" href="classRakNet_1_1CommandParserInterface.html" title="The interface used by command parsers.">CommandParserInterface</a> provides a set of functions and interfaces that plug into the <a class="el" href="classRakNet_1_1ConsoleServer.html" title="The main entry point for the server portion of your remote console application support.">ConsoleServer</a> class. Each <a class="el" href="classRakNet_1_1CommandParserInterface.html" title="The interface used by command parsers.">CommandParserInterface</a> works at the same time as other interfaces in the system. </p>
    107. 

  107. </div><h2 class="groupheader">Member Function Documentation</h2>
    108. 

  108. <a class="anchor" id="af9f1b817f383b52f9ad6451def11d35b"></a>
    109. 

  109. <div class="memitem">
    110. 

  110. <div class="memproto">
    111. 

  111. <table class="mlabels">
    112. 

  112.   <tr>
    113. 

  113.   <td class="mlabels-left">
    114. 

  114.       <table class="memname">
    115. 

  115.         <tr>
    116. 

  116.           <td class="memname">virtual const char* RakNet::CommandParserInterface::GetName </td>
    117. 

  117.           <td>(</td>
    118. 

  118.           <td class="paramtype">void&#160;</td>
    119. 

  119.           <td class="paramname"></td><td>)</td>
    120. 

  120.           <td> const</td>
    121. 

  121.         </tr>
    122. 

  122.       </table>
    123. 

  123.   </td>
    124. 

  124.   <td class="mlabels-right">
    125. 

  125. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
    126. 

  126.   </tr>
    127. 

  127. </table>
    128. 

  128. </div><div class="memdoc">
    129. 

  129. <p>You are responsible for overriding this function and returning a static string, which will identifier your parser. This should return a static string </p>
    130. 

  130. <dl class="section return"><dt>Returns</dt><dd>The name that you return. </dd></dl>
    131. 

  131. 

  132. <p>Implemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#a037b5b2323e7135c85bbcb3a271e4890">RakNet::LogCommandParser</a>, and <a class="el" href="classRakNet_1_1RakNetCommandParser.html#ab7529704693ad768ef769f5fe49911cd">RakNet::RakNetCommandParser</a>.</p>
    133. 

  133. 

  134. </div>
    135. 

  135. </div>
    136. 

  136. <a class="anchor" id="ac568282654986ad63d680d68a98cf757"></a>
    137. 

  137. <div class="memitem">
    138. 

  138. <div class="memproto">
    139. 

  139. <table class="mlabels">
    140. 

  140.   <tr>
    141. 

  141.   <td class="mlabels-left">
    142. 

  142.       <table class="memname">
    143. 

  143.         <tr>
    144. 

  144.           <td class="memname">virtual bool RakNet::CommandParserInterface::OnCommand </td>
    145. 

  145.           <td>(</td>
    146. 

  146.           <td class="paramtype">const char *&#160;</td>
    147. 

  147.           <td class="paramname"><em>command</em>, </td>
    148. 

  148.         </tr>
    149. 

  149.         <tr>
    150. 

  150.           <td class="paramkey"></td>
    151. 

  151.           <td></td>
    152. 

  152.           <td class="paramtype">unsigned&#160;</td>
    153. 

  153.           <td class="paramname"><em>numParameters</em>, </td>
    154. 

  154.         </tr>
    155. 

  155.         <tr>
    156. 

  156.           <td class="paramkey"></td>
    157. 

  157.           <td></td>
    158. 

  158.           <td class="paramtype">char **&#160;</td>
    159. 

  159.           <td class="paramname"><em>parameterList</em>, </td>
    160. 

  160.         </tr>
    161. 

  161.         <tr>
    162. 

  162.           <td class="paramkey"></td>
    163. 

  163.           <td></td>
    164. 

  164.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    165. 

  165.           <td class="paramname"><em>transport</em>, </td>
    166. 

  166.         </tr>
    167. 

  167.         <tr>
    168. 

  168.           <td class="paramkey"></td>
    169. 

  169.           <td></td>
    170. 

  170.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    171. 

  171.           <td class="paramname"><em>systemAddress</em>, </td>
    172. 

  172.         </tr>
    173. 

  173.         <tr>
    174. 

  174.           <td class="paramkey"></td>
    175. 

  175.           <td></td>
    176. 

  176.           <td class="paramtype">const char *&#160;</td>
    177. 

  177.           <td class="paramname"><em>originalString</em>&#160;</td>
    178. 

  178.         </tr>
    179. 

  179.         <tr>
    180. 

  180.           <td></td>
    181. 

  181.           <td>)</td>
    182. 

  182.           <td></td><td></td>
    183. 

  183.         </tr>
    184. 

  184.       </table>
    185. 

  185.   </td>
    186. 

  186.   <td class="mlabels-right">
    187. 

  187. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
    188. 

  188.   </tr>
    189. 

  189. </table>
    190. 

  190. </div><div class="memdoc">
    191. 

  191. 

  192. <p>Given <em>command</em> with parameters <em>parameterList</em> , do whatever processing you wish. </p>
    193. 

  193. <dl class="params"><dt>Parameters</dt><dd>
    194. 

  194.   <table class="params">
    195. 

  195.     <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>The command to process </td></tr>
    196. 

  196.     <tr><td class="paramdir">[in]</td><td class="paramname">numParameters</td><td>How many parameters were passed along with the command </td></tr>
    197. 

  197.     <tr><td class="paramdir">[in]</td><td class="paramname">parameterList</td><td>The list of parameters. parameterList[0] is the first parameter and so on. </td></tr>
    198. 

  198.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface we can use to write to </td></tr>
    199. 

  199.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that sent this command. </td></tr>
    200. 

  200.     <tr><td class="paramdir">[in]</td><td class="paramname">originalString</td><td>The string that was actually sent over the network, in case you want to do your own parsing </td></tr>
    201. 

  201.   </table>
    202. 

  202.   </dd>
    203. 

  203. </dl>
    204. 

  204. 

  205. <p>Implemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#aceb0d8004cef19e78cd630b68c680c63">RakNet::LogCommandParser</a>, and <a class="el" href="classRakNet_1_1RakNetCommandParser.html#a34a1aa5896a8d854cd7fc88675c45533">RakNet::RakNetCommandParser</a>.</p>
    206. 

  206. 

  207. </div>
    208. 

  208. </div>
    209. 

  209. <a class="anchor" id="aa275db3922ed1c27fc5ee7ecd6913d4b"></a>
    210. 

  210. <div class="memitem">
    211. 

  211. <div class="memproto">
    212. 

  212. <table class="mlabels">
    213. 

  213.   <tr>
    214. 

  214.   <td class="mlabels-left">
    215. 

  215.       <table class="memname">
    216. 

  216.         <tr>
    217. 

  217.           <td class="memname">virtual void RakNet::CommandParserInterface::OnConnectionLost </td>
    218. 

  218.           <td>(</td>
    219. 

  219.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    220. 

  220.           <td class="paramname"><em>systemAddress</em>, </td>
    221. 

  221.         </tr>
    222. 

  222.         <tr>
    223. 

  223.           <td class="paramkey"></td>
    224. 

  224.           <td></td>
    225. 

  225.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    226. 

  226.           <td class="paramname"><em>transport</em>&#160;</td>
    227. 

  227.         </tr>
    228. 

  228.         <tr>
    229. 

  229.           <td></td>
    230. 

  230.           <td>)</td>
    231. 

  231.           <td></td><td></td>
    232. 

  232.         </tr>
    233. 

  233.       </table>
    234. 

  234.   </td>
    235. 

  235.   <td class="mlabels-right">
    236. 

  236. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    237. 

  237.   </tr>
    238. 

  238. </table>
    239. 

  239. </div><div class="memdoc">
    240. 

  240. 

  241. <p>A callback for when <em>systemAddress</em> has disconnected, either gracefully or forcefully. </p>
    242. 

  242. <dl class="params"><dt>Parameters</dt><dd>
    243. 

  243.   <table class="params">
    244. 

  244.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that has disconnected. </td></tr>
    245. 

  245.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface that sent us this information. </td></tr>
    246. 

  246.   </table>
    247. 

  247.   </dd>
    248. 

  248. </dl>
    249. 

  249. 

  250. <p>Reimplemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#a8d46296b09f54817d0200e8a557bc802">RakNet::LogCommandParser</a>.</p>
    251. 

  251. 

  252. </div>
    253. 

  253. </div>
    254. 

  254. <a class="anchor" id="a98004a0af5237980fdc160f6c6fcdc79"></a>
    255. 

  255. <div class="memitem">
    256. 

  256. <div class="memproto">
    257. 

  257. <table class="mlabels">
    258. 

  258.   <tr>
    259. 

  259.   <td class="mlabels-left">
    260. 

  260.       <table class="memname">
    261. 

  261.         <tr>
    262. 

  262.           <td class="memname">virtual void RakNet::CommandParserInterface::OnNewIncomingConnection </td>
    263. 

  263.           <td>(</td>
    264. 

  264.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    265. 

  265.           <td class="paramname"><em>systemAddress</em>, </td>
    266. 

  266.         </tr>
    267. 

  267.         <tr>
    268. 

  268.           <td class="paramkey"></td>
    269. 

  269.           <td></td>
    270. 

  270.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    271. 

  271.           <td class="paramname"><em>transport</em>&#160;</td>
    272. 

  272.         </tr>
    273. 

  273.         <tr>
    274. 

  274.           <td></td>
    275. 

  275.           <td>)</td>
    276. 

  276.           <td></td><td></td>
    277. 

  277.         </tr>
    278. 

  278.       </table>
    279. 

  279.   </td>
    280. 

  280.   <td class="mlabels-right">
    281. 

  281. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    282. 

  282.   </tr>
    283. 

  283. </table>
    284. 

  284. </div><div class="memdoc">
    285. 

  285. 

  286. <p>A callback for when <em>systemAddress</em> has connected to us. </p>
    287. 

  287. <dl class="params"><dt>Parameters</dt><dd>
    288. 

  288.   <table class="params">
    289. 

  289.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that has connected. </td></tr>
    290. 

  290.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface that sent us this information. Can be used to send messages to this or other players. </td></tr>
    291. 

  291.   </table>
    292. 

  292.   </dd>
    293. 

  293. </dl>
    294. 

  294. 

  295. <p>Reimplemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#a399c67161aa82888fe2facf7bfda3c53">RakNet::LogCommandParser</a>.</p>
    296. 

  296. 

  297. </div>
    298. 

  298. </div>
    299. 

  299. <a class="anchor" id="a9bdc4fa618f324e8f3c0f188009e6958"></a>
    300. 

  300. <div class="memitem">
    301. 

  301. <div class="memproto">
    302. 

  302. <table class="mlabels">
    303. 

  303.   <tr>
    304. 

  304.   <td class="mlabels-left">
    305. 

  305.       <table class="memname">
    306. 

  306.         <tr>
    307. 

  307.           <td class="memname">virtual void RakNet::CommandParserInterface::OnTransportChange </td>
    308. 

  308.           <td>(</td>
    309. 

  309.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    310. 

  310.           <td class="paramname"><em>transport</em></td><td>)</td>
    311. 

  311.           <td></td>
    312. 

  312.         </tr>
    313. 

  313.       </table>
    314. 

  314.   </td>
    315. 

  315.   <td class="mlabels-right">
    316. 

  316. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    317. 

  317.   </tr>
    318. 

  318. </table>
    319. 

  319. </div><div class="memdoc">
    320. 

  320. 

  321. <p>This is called every time transport interface is registered. </p>
    322. 

  322. <p>If you want to save a copy of the <a class="el" href="classRakNet_1_1TransportInterface.html" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> pointer This is the place to do it </p>
    323. 

  323. <dl class="params"><dt>Parameters</dt><dd>
    324. 

  324.   <table class="params">
    325. 

  325.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The new <a class="el" href="classRakNet_1_1TransportInterface.html" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> </td></tr>
    326. 

  326.   </table>
    327. 

  327.   </dd>
    328. 

  328. </dl>
    329. 

  329. 

  330. <p>Reimplemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#a87fb1e549a73610575f8ec89077d9fdc">RakNet::LogCommandParser</a>.</p>
    331. 

  331. 

  332. </div>
    333. 

  333. </div>
    334. 

  334. <a class="anchor" id="abe62e54c5f3e0dde2f88b48ce479d4c6"></a>
    335. 

  335. <div class="memitem">
    336. 

  336. <div class="memproto">
    337. 

  337. <table class="mlabels">
    338. 

  338.   <tr>
    339. 

  339.   <td class="mlabels-left">
    340. 

  340.       <table class="memname">
    341. 

  341.         <tr>
    342. 

  342.           <td class="memname">virtual void RakNet::CommandParserInterface::RegisterCommand </td>
    343. 

  343.           <td>(</td>
    344. 

  344.           <td class="paramtype">unsigned char&#160;</td>
    345. 

  345.           <td class="paramname"><em>parameterCount</em>, </td>
    346. 

  346.         </tr>
    347. 

  347.         <tr>
    348. 

  348.           <td class="paramkey"></td>
    349. 

  349.           <td></td>
    350. 

  350.           <td class="paramtype">const char *&#160;</td>
    351. 

  351.           <td class="paramname"><em>command</em>, </td>
    352. 

  352.         </tr>
    353. 

  353.         <tr>
    354. 

  354.           <td class="paramkey"></td>
    355. 

  355.           <td></td>
    356. 

  356.           <td class="paramtype">const char *&#160;</td>
    357. 

  357.           <td class="paramname"><em>commandHelp</em>&#160;</td>
    358. 

  358.         </tr>
    359. 

  359.         <tr>
    360. 

  360.           <td></td>
    361. 

  361.           <td>)</td>
    362. 

  362.           <td></td><td></td>
    363. 

  363.         </tr>
    364. 

  364.       </table>
    365. 

  365.   </td>
    366. 

  366.   <td class="mlabels-right">
    367. 

  367. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    368. 

  368.   </tr>
    369. 

  369. </table>
    370. 

  370. </div><div class="memdoc">
    371. 

  371. <p>Registers a command. </p>
    372. 

  372. <dl class="params"><dt>Parameters</dt><dd>
    373. 

  373.   <table class="params">
    374. 

  374.     <tr><td class="paramdir">[in]</td><td class="paramname">parameterCount</td><td>How many parameters your command requires. If you want to accept a variable number of commands, pass CommandParserInterface::VARIABLE_NUMBER_OF_PARAMETERS </td></tr>
    375. 

  375.     <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>A pointer to a STATIC string that has your command. I keep a copy of the pointer here so don't deallocate the string. </td></tr>
    376. 

  376.     <tr><td class="paramdir">[in]</td><td class="paramname">commandHelp</td><td>A pointer to a STATIC string that has the help information for your command. I keep a copy of the pointer here so don't deallocate the string. </td></tr>
    377. 

  377.   </table>
    378. 

  378.   </dd>
    379. 

  379. </dl>
    380. 

  380. 

  381. </div>
    382. 

  382. </div>
    383. 

  383. <a class="anchor" id="a5b01f9370d1bffee84caf3da9fae5dfe"></a>
    384. 

  384. <div class="memitem">
    385. 

  385. <div class="memproto">
    386. 

  386. <table class="mlabels">
    387. 

  387.   <tr>
    388. 

  388.   <td class="mlabels-left">
    389. 

  389.       <table class="memname">
    390. 

  390.         <tr>
    391. 

  391.           <td class="memname">virtual void RakNet::CommandParserInterface::ReturnResult </td>
    392. 

  392.           <td>(</td>
    393. 

  393.           <td class="paramtype">bool&#160;</td>
    394. 

  394.           <td class="paramname"><em>res</em>, </td>
    395. 

  395.         </tr>
    396. 

  396.         <tr>
    397. 

  397.           <td class="paramkey"></td>
    398. 

  398.           <td></td>
    399. 

  399.           <td class="paramtype">const char *&#160;</td>
    400. 

  400.           <td class="paramname"><em>command</em>, </td>
    401. 

  401.         </tr>
    402. 

  402.         <tr>
    403. 

  403.           <td class="paramkey"></td>
    404. 

  404.           <td></td>
    405. 

  405.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    406. 

  406.           <td class="paramname"><em>transport</em>, </td>
    407. 

  407.         </tr>
    408. 

  408.         <tr>
    409. 

  409.           <td class="paramkey"></td>
    410. 

  410.           <td></td>
    411. 

  411.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    412. 

  412.           <td class="paramname"><em>systemAddress</em>&#160;</td>
    413. 

  413.         </tr>
    414. 

  414.         <tr>
    415. 

  415.           <td></td>
    416. 

  416.           <td>)</td>
    417. 

  417.           <td></td><td></td>
    418. 

  418.         </tr>
    419. 

  419.       </table>
    420. 

  420.   </td>
    421. 

  421.   <td class="mlabels-right">
    422. 

  422. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    423. 

  423.   </tr>
    424. 

  424. </table>
    425. 

  425. </div><div class="memdoc">
    426. 

  426. 

  427. <p>Just writes a string to the remote system based on the result ( <em>res</em> ) of your operation. </p>
    428. 

  428. <p>This is not necessary to call, but makes it easier to return results of function calls. </p>
    429. 

  429. <dl class="params"><dt>Parameters</dt><dd>
    430. 

  430.   <table class="params">
    431. 

  431.     <tr><td class="paramdir">[in]</td><td class="paramname">res</td><td>The result to write </td></tr>
    432. 

  432.     <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>The command that this result came from </td></tr>
    433. 

  433.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface that will be written to </td></tr>
    434. 

  434.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player this result will be sent to </td></tr>
    435. 

  435.   </table>
    436. 

  436.   </dd>
    437. 

  437. </dl>
    438. 

  438. 

  439. </div>
    440. 

  440. </div>
    441. 

  441. <a class="anchor" id="a628e6ddfdeaecfb7d6120f7db3780d91"></a>
    442. 

  442. <div class="memitem">
    443. 

  443. <div class="memproto">
    444. 

  444. <table class="mlabels">
    445. 

  445.   <tr>
    446. 

  446.   <td class="mlabels-left">
    447. 

  447.       <table class="memname">
    448. 

  448.         <tr>
    449. 

  449.           <td class="memname">virtual void RakNet::CommandParserInterface::ReturnResult </td>
    450. 

  450.           <td>(</td>
    451. 

  451.           <td class="paramtype">const char *&#160;</td>
    452. 

  452.           <td class="paramname"><em>command</em>, </td>
    453. 

  453.         </tr>
    454. 

  454.         <tr>
    455. 

  455.           <td class="paramkey"></td>
    456. 

  456.           <td></td>
    457. 

  457.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    458. 

  458.           <td class="paramname"><em>transport</em>, </td>
    459. 

  459.         </tr>
    460. 

  460.         <tr>
    461. 

  461.           <td class="paramkey"></td>
    462. 

  462.           <td></td>
    463. 

  463.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    464. 

  464.           <td class="paramname"><em>systemAddress</em>&#160;</td>
    465. 

  465.         </tr>
    466. 

  466.         <tr>
    467. 

  467.           <td></td>
    468. 

  468.           <td>)</td>
    469. 

  469.           <td></td><td></td>
    470. 

  470.         </tr>
    471. 

  471.       </table>
    472. 

  472.   </td>
    473. 

  473.   <td class="mlabels-right">
    474. 

  474. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    475. 

  475.   </tr>
    476. 

  476. </table>
    477. 

  477. </div><div class="memdoc">
    478. 

  478. 

  479. <p>Just writes a string to the remote system when you are calling a function that has no return value. </p>
    480. 

  480. <p>This is not necessary to call, but makes it easier to return results of function calls. </p>
    481. 

  481. <dl class="params"><dt>Parameters</dt><dd>
    482. 

  482.   <table class="params">
    483. 

  483.     <tr><td class="paramdir">[in]</td><td class="paramname">res</td><td>The result to write </td></tr>
    484. 

  484.     <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>The command that this result came from </td></tr>
    485. 

  485.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface that will be written to </td></tr>
    486. 

  486.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player this result will be sent to </td></tr>
    487. 

  487.   </table>
    488. 

  488.   </dd>
    489. 

  489. </dl>
    490. 

  490. 

  491. </div>
    492. 

  492. </div>
    493. 

  493. <a class="anchor" id="a6abf857d697bb11230ac0b153c17624a"></a>
    494. 

  494. <div class="memitem">
    495. 

  495. <div class="memproto">
    496. 

  496. <table class="mlabels">
    497. 

  497.   <tr>
    498. 

  498.   <td class="mlabels-left">
    499. 

  499.       <table class="memname">
    500. 

  500.         <tr>
    501. 

  501.           <td class="memname">virtual void RakNet::CommandParserInterface::SendHelp </td>
    502. 

  502.           <td>(</td>
    503. 

  503.           <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
    504. 

  504.           <td class="paramname"><em>transport</em>, </td>
    505. 

  505.         </tr>
    506. 

  506.         <tr>
    507. 

  507.           <td class="paramkey"></td>
    508. 

  508.           <td></td>
    509. 

  509.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    510. 

  510.           <td class="paramname"><em>systemAddress</em>&#160;</td>
    511. 

  511.         </tr>
    512. 

  512.         <tr>
    513. 

  513.           <td></td>
    514. 

  514.           <td>)</td>
    515. 

  515.           <td></td><td></td>
    516. 

  516.         </tr>
    517. 

  517.       </table>
    518. 

  518.   </td>
    519. 

  519.   <td class="mlabels-right">
    520. 

  520. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
    521. 

  521.   </tr>
    522. 

  522. </table>
    523. 

  523. </div><div class="memdoc">
    524. 

  524. 

  525. <p>A callback for when you are expected to send a brief description of your parser to <em>systemAddress</em>. </p>
    526. 

  526. <dl class="params"><dt>Parameters</dt><dd>
    527. 

  527.   <table class="params">
    528. 

  528.     <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface we can use to write to </td></tr>
    529. 

  529.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that requested help. </td></tr>
    530. 

  530.   </table>
    531. 

  531.   </dd>
    532. 

  532. </dl>
    533. 

  533. 

  534. <p>Implemented in <a class="el" href="classRakNet_1_1LogCommandParser.html#a6e7b04559fd0ba7e65d52f85a47b3819">RakNet::LogCommandParser</a>, and <a class="el" href="classRakNet_1_1RakNetCommandParser.html#ad7cff9f3086a6390fd72d4ca2826f271">RakNet::RakNetCommandParser</a>.</p>
    535. 

  535. 

  536. </div>
    537. 

  537. </div>
    538. 

  538. <hr/>The documentation for this class was generated from the following file:<ul>
    539. 

  539. <li>D:/temp/RakNet_PC/Source/<a class="el" href="CommandParserInterface_8h.html">CommandParserInterface.h</a></li>
    540. 

  540. </ul>
    541. 

  541. </div><!-- contents -->
    542. 

  542. <!-- start footer part -->
    543. 

  543. <hr class="footer"/><address class="footer"><small>
    544. 

  544. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
    545. 

  545. <img class="footer" src="doxygen.png" alt="doxygen"/>
    546. 

  546. </a> 1.8.2
    547. 

  547. </small></address>
    548. 

  548. </body>
    549. 

  549. </html>
    550.
粤ICP备19079148号