classRakNet_1_1LogCommandParser.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640
  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::LogCommandParser 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_1LogCommandParser.html">LogCommandParser</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#nested-classes">Classes</a> &#124;
  55. <a href="#pub-methods">Public Member Functions</a> &#124;
  56. <a href="#pro-methods">Protected Member Functions</a> &#124;
  57. <a href="#pro-attribs">Protected Attributes</a> &#124;
  58. <a href="classRakNet_1_1LogCommandParser-members.html">List of all members</a> </div>
  59. <div class="headertitle">
  60. <div class="title">RakNet::LogCommandParser Class Reference</div> </div>
  61. </div><!--header-->
  62. <div class="contents">
  63. <p>Adds the ability to send logging output to a remote console.
  64. <a href="classRakNet_1_1LogCommandParser.html#details">More...</a></p>
  65. <p><code>#include &lt;LogCommandParser.h&gt;</code></p>
  66. <div class="dynheader">
  67. Inheritance diagram for RakNet::LogCommandParser:</div>
  68. <div class="dyncontent">
  69. <div class="center">
  70. <img src="classRakNet_1_1LogCommandParser.png" usemap="#RakNet::LogCommandParser_map" alt=""/>
  71. <map id="RakNet::LogCommandParser_map" name="RakNet::LogCommandParser_map">
  72. <area href="classRakNet_1_1CommandParserInterface.html" title="The interface used by command parsers." alt="RakNet::CommandParserInterface" shape="rect" coords="0,0,201,24"/>
  73. </map>
  74. </div></div>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  77. Classes</h2></td></tr>
  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1LogCommandParser_1_1SystemAddressAndChannel.html">SystemAddressAndChannel</a></td></tr>
  79. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One of these structures is created per player. <a href="structRakNet_1_1LogCommandParser_1_1SystemAddressAndChannel.html#details">More...</a><br/></td></tr>
  80. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table><table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:aceb0d8004cef19e78cd630b68c680c63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#aceb0d8004cef19e78cd630b68c680c63">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)</td></tr>
  85. <tr class="separator:aceb0d8004cef19e78cd630b68c680c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a037b5b2323e7135c85bbcb3a271e4890"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a037b5b2323e7135c85bbcb3a271e4890">GetName</a> (void) const </td></tr>
  87. <tr class="separator:a037b5b2323e7135c85bbcb3a271e4890"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a6e7b04559fd0ba7e65d52f85a47b3819"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a6e7b04559fd0ba7e65d52f85a47b3819">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)</td></tr>
  89. <tr class="separator:a6e7b04559fd0ba7e65d52f85a47b3819"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a921eaa0b9ce3d59f265b19b015a65370"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a921eaa0b9ce3d59f265b19b015a65370">AddChannel</a> (const char *channelName)</td></tr>
  91. <tr class="memdesc:a921eaa0b9ce3d59f265b19b015a65370"><td class="mdescLeft">&#160;</td><td class="mdescRight">All logs must be associated with a channel. This is a filter so that remote clients only get logs for a system they care about. <a href="#a921eaa0b9ce3d59f265b19b015a65370"></a><br/></td></tr>
  92. <tr class="separator:a921eaa0b9ce3d59f265b19b015a65370"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a2811b62171be28fed86ce6e2477c8cf9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a2811b62171be28fed86ce6e2477c8cf9">WriteLog</a> (const char *channelName, const char *format,...)</td></tr>
  94. <tr class="separator:a2811b62171be28fed86ce6e2477c8cf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a399c67161aa82888fe2facf7bfda3c53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a399c67161aa82888fe2facf7bfda3c53">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>
  96. <tr class="separator:a399c67161aa82888fe2facf7bfda3c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a8d46296b09f54817d0200e8a557bc802"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a8d46296b09f54817d0200e8a557bc802">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>
  98. <tr class="separator:a8d46296b09f54817d0200e8a557bc802"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a87fb1e549a73610575f8ec89077d9fdc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a87fb1e549a73610575f8ec89077d9fdc">OnTransportChange</a> (<a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *transport)</td></tr>
  100. <tr class="separator:a87fb1e549a73610575f8ec89077d9fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="inherit_header pub_methods_classRakNet_1_1CommandParserInterface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classRakNet_1_1CommandParserInterface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classRakNet_1_1CommandParserInterface.html">RakNet::CommandParserInterface</a></td></tr>
  102. <tr class="memitem:abe62e54c5f3e0dde2f88b48ce479d4c6 inherit pub_methods_classRakNet_1_1CommandParserInterface"><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>
  103. <tr class="separator:abe62e54c5f3e0dde2f88b48ce479d4c6 inherit pub_methods_classRakNet_1_1CommandParserInterface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a5b01f9370d1bffee84caf3da9fae5dfe inherit pub_methods_classRakNet_1_1CommandParserInterface"><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>
  105. <tr class="memdesc:a5b01f9370d1bffee84caf3da9fae5dfe inherit pub_methods_classRakNet_1_1CommandParserInterface"><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>
  106. <tr class="separator:a5b01f9370d1bffee84caf3da9fae5dfe inherit pub_methods_classRakNet_1_1CommandParserInterface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a628e6ddfdeaecfb7d6120f7db3780d91 inherit pub_methods_classRakNet_1_1CommandParserInterface"><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>
  108. <tr class="memdesc:a628e6ddfdeaecfb7d6120f7db3780d91 inherit pub_methods_classRakNet_1_1CommandParserInterface"><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>
  109. <tr class="separator:a628e6ddfdeaecfb7d6120f7db3780d91 inherit pub_methods_classRakNet_1_1CommandParserInterface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  112. Protected Member Functions</h2></td></tr>
  113. <tr class="memitem:ae1cb6d17a66cfc18261d18b0964a9de7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#ae1cb6d17a66cfc18261d18b0964a9de7">PrintChannels</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) const </td></tr>
  114. <tr class="separator:ae1cb6d17a66cfc18261d18b0964a9de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a615d8f7044092dee6bdfd52066d3e6dc"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a615d8f7044092dee6bdfd52066d3e6dc">Unsubscribe</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, const char *channelName)</td></tr>
  116. <tr class="separator:a615d8f7044092dee6bdfd52066d3e6dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a3f479d9fb28698d197c6ac51c7b25b0b"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a3f479d9fb28698d197c6ac51c7b25b0b">Subscribe</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, const char *channelName)</td></tr>
  118. <tr class="separator:a3f479d9fb28698d197c6ac51c7b25b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a09d6177683edf34c5aa8dca6738805f6"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a09d6177683edf34c5aa8dca6738805f6">GetChannelIndexFromName</a> (const char *channelName)</td></tr>
  120. <tr class="separator:a09d6177683edf34c5aa8dca6738805f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  123. Protected Attributes</h2></td></tr>
  124. <tr class="memitem:a8ef3e9d5b4e224c326f6e67e90bd3be0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ef3e9d5b4e224c326f6e67e90bd3be0"></a>
  125. <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a><br class="typebreak"/>
  126. &lt; <a class="el" href="structRakNet_1_1LogCommandParser_1_1SystemAddressAndChannel.html">SystemAddressAndChannel</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a8ef3e9d5b4e224c326f6e67e90bd3be0">remoteUsers</a></td></tr>
  127. <tr class="memdesc:a8ef3e9d5b4e224c326f6e67e90bd3be0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of remote users. Added to when users subscribe, removed when they disconnect or unsubscribe. <br/></td></tr>
  128. <tr class="separator:a8ef3e9d5b4e224c326f6e67e90bd3be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:abd8c4f014554fb2b8bf01cb1da0c953d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd8c4f014554fb2b8bf01cb1da0c953d"></a>
  130. const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#abd8c4f014554fb2b8bf01cb1da0c953d">channelNames</a> [32]</td></tr>
  131. <tr class="memdesc:abd8c4f014554fb2b8bf01cb1da0c953d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Names of the channels at each bit, or 0 for an unused channel. <br/></td></tr>
  132. <tr class="separator:abd8c4f014554fb2b8bf01cb1da0c953d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a5cbd401239fd22a2902eb75ba51dbbc4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cbd401239fd22a2902eb75ba51dbbc4"></a>
  134. <a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1LogCommandParser.html#a5cbd401239fd22a2902eb75ba51dbbc4">trans</a></td></tr>
  135. <tr class="memdesc:a5cbd401239fd22a2902eb75ba51dbbc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is so I can save the current transport provider, solely so I can use it without having the user pass it to Log. <br/></td></tr>
  136. <tr class="separator:a5cbd401239fd22a2902eb75ba51dbbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  139. <div class="textblock"><p>Adds the ability to send logging output to a remote console. </p>
  140. </div><h2 class="groupheader">Member Function Documentation</h2>
  141. <a class="anchor" id="a921eaa0b9ce3d59f265b19b015a65370"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">void RakNet::LogCommandParser::AddChannel </td>
  147. <td>(</td>
  148. <td class="paramtype">const char *&#160;</td>
  149. <td class="paramname"><em>channelName</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>All logs must be associated with a channel. This is a filter so that remote clients only get logs for a system they care about. </p>
  155. <dl class="params"><dt>Parameters</dt><dd>
  156. <table class="params">
  157. <tr><td class="paramdir">[in]</td><td class="paramname">channelName</td><td>A persistent string naming the channel. Don't deallocate this string. </td></tr>
  158. </table>
  159. </dd>
  160. </dl>
  161. </div>
  162. </div>
  163. <a class="anchor" id="a09d6177683edf34c5aa8dca6738805f6"></a>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">unsigned RakNet::LogCommandParser::GetChannelIndexFromName </td>
  172. <td>(</td>
  173. <td class="paramtype">const char *&#160;</td>
  174. <td class="paramname"><em>channelName</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </td>
  179. <td class="mlabels-right">
  180. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Given the name of a channel, return the index into channelNames where it is located </p>
  185. <dl class="params"><dt>Parameters</dt><dd>
  186. <table class="params">
  187. <tr><td class="paramdir">[in]</td><td class="paramname">channelName</td><td>The name of the channel </td></tr>
  188. </table>
  189. </dd>
  190. </dl>
  191. </div>
  192. </div>
  193. <a class="anchor" id="a037b5b2323e7135c85bbcb3a271e4890"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">const char* RakNet::LogCommandParser::GetName </td>
  202. <td>(</td>
  203. <td class="paramtype">void&#160;</td>
  204. <td class="paramname"></td><td>)</td>
  205. <td> const</td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <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>
  215. <dl class="section return"><dt>Returns</dt><dd>The name that you return. </dd></dl>
  216. <p>Implements <a class="el" href="classRakNet_1_1CommandParserInterface.html#af9f1b817f383b52f9ad6451def11d35b">RakNet::CommandParserInterface</a>.</p>
  217. </div>
  218. </div>
  219. <a class="anchor" id="aceb0d8004cef19e78cd630b68c680c63"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">bool RakNet::LogCommandParser::OnCommand </td>
  228. <td>(</td>
  229. <td class="paramtype">const char *&#160;</td>
  230. <td class="paramname"><em>command</em>, </td>
  231. </tr>
  232. <tr>
  233. <td class="paramkey"></td>
  234. <td></td>
  235. <td class="paramtype">unsigned&#160;</td>
  236. <td class="paramname"><em>numParameters</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">char **&#160;</td>
  242. <td class="paramname"><em>parameterList</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  248. <td class="paramname"><em>transport</em>, </td>
  249. </tr>
  250. <tr>
  251. <td class="paramkey"></td>
  252. <td></td>
  253. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  254. <td class="paramname"><em>systemAddress</em>, </td>
  255. </tr>
  256. <tr>
  257. <td class="paramkey"></td>
  258. <td></td>
  259. <td class="paramtype">const char *&#160;</td>
  260. <td class="paramname"><em>originalString</em>&#160;</td>
  261. </tr>
  262. <tr>
  263. <td></td>
  264. <td>)</td>
  265. <td></td><td></td>
  266. </tr>
  267. </table>
  268. </td>
  269. <td class="mlabels-right">
  270. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Given <em>command</em> with parameters <em>parameterList</em> , do whatever processing you wish. </p>
  275. <dl class="params"><dt>Parameters</dt><dd>
  276. <table class="params">
  277. <tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>The command to process </td></tr>
  278. <tr><td class="paramdir">[in]</td><td class="paramname">numParameters</td><td>How many parameters were passed along with the command </td></tr>
  279. <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>
  280. <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface we can use to write to </td></tr>
  281. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that sent this command. </td></tr>
  282. <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>
  283. </table>
  284. </dd>
  285. </dl>
  286. <p>Implements <a class="el" href="classRakNet_1_1CommandParserInterface.html#ac568282654986ad63d680d68a98cf757">RakNet::CommandParserInterface</a>.</p>
  287. </div>
  288. </div>
  289. <a class="anchor" id="a8d46296b09f54817d0200e8a557bc802"></a>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="mlabels">
  293. <tr>
  294. <td class="mlabels-left">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void RakNet::LogCommandParser::OnConnectionLost </td>
  298. <td>(</td>
  299. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  300. <td class="paramname"><em>systemAddress</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  306. <td class="paramname"><em>transport</em>&#160;</td>
  307. </tr>
  308. <tr>
  309. <td></td>
  310. <td>)</td>
  311. <td></td><td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>A callback for when <em>systemAddress</em> has disconnected, either gracefully or forcefully </p>
  321. <dl class="params"><dt>Parameters</dt><dd>
  322. <table class="params">
  323. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that has disconnected. </td></tr>
  324. <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface that sent us this information. </td></tr>
  325. </table>
  326. </dd>
  327. </dl>
  328. <p>Reimplemented from <a class="el" href="classRakNet_1_1CommandParserInterface.html#aa275db3922ed1c27fc5ee7ecd6913d4b">RakNet::CommandParserInterface</a>.</p>
  329. </div>
  330. </div>
  331. <a class="anchor" id="a399c67161aa82888fe2facf7bfda3c53"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="mlabels">
  335. <tr>
  336. <td class="mlabels-left">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">void RakNet::LogCommandParser::OnNewIncomingConnection </td>
  340. <td>(</td>
  341. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  342. <td class="paramname"><em>systemAddress</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  348. <td class="paramname"><em>transport</em>&#160;</td>
  349. </tr>
  350. <tr>
  351. <td></td>
  352. <td>)</td>
  353. <td></td><td></td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>A callback for when <em>systemAddress</em> has connected to us. </p>
  363. <dl class="params"><dt>Parameters</dt><dd>
  364. <table class="params">
  365. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that has connected. </td></tr>
  366. <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>
  367. </table>
  368. </dd>
  369. </dl>
  370. <p>Reimplemented from <a class="el" href="classRakNet_1_1CommandParserInterface.html#a98004a0af5237980fdc160f6c6fcdc79">RakNet::CommandParserInterface</a>.</p>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a87fb1e549a73610575f8ec89077d9fdc"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="mlabels">
  377. <tr>
  378. <td class="mlabels-left">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">void RakNet::LogCommandParser::OnTransportChange </td>
  382. <td>(</td>
  383. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  384. <td class="paramname"><em>transport</em></td><td>)</td>
  385. <td></td>
  386. </tr>
  387. </table>
  388. </td>
  389. <td class="mlabels-right">
  390. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. <p>This is called every time transport interface is registered. 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>
  395. <dl class="params"><dt>Parameters</dt><dd>
  396. <table class="params">
  397. <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>
  398. </table>
  399. </dd>
  400. </dl>
  401. <p>Reimplemented from <a class="el" href="classRakNet_1_1CommandParserInterface.html#a9bdc4fa618f324e8f3c0f188009e6958">RakNet::CommandParserInterface</a>.</p>
  402. </div>
  403. </div>
  404. <a class="anchor" id="ae1cb6d17a66cfc18261d18b0964a9de7"></a>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="mlabels">
  408. <tr>
  409. <td class="mlabels-left">
  410. <table class="memname">
  411. <tr>
  412. <td class="memname">void RakNet::LogCommandParser::PrintChannels </td>
  413. <td>(</td>
  414. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  415. <td class="paramname"><em>systemAddress</em>, </td>
  416. </tr>
  417. <tr>
  418. <td class="paramkey"></td>
  419. <td></td>
  420. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  421. <td class="paramname"><em>transport</em>&#160;</td>
  422. </tr>
  423. <tr>
  424. <td></td>
  425. <td>)</td>
  426. <td></td><td> const</td>
  427. </tr>
  428. </table>
  429. </td>
  430. <td class="mlabels-right">
  431. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Sends the currently active channels to the user </p>
  436. <dl class="params"><dt>Parameters</dt><dd>
  437. <table class="params">
  438. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player to send to </td></tr>
  439. <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface to use to send the channels </td></tr>
  440. </table>
  441. </dd>
  442. </dl>
  443. </div>
  444. </div>
  445. <a class="anchor" id="a6e7b04559fd0ba7e65d52f85a47b3819"></a>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="mlabels">
  449. <tr>
  450. <td class="mlabels-left">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">void RakNet::LogCommandParser::SendHelp </td>
  454. <td>(</td>
  455. <td class="paramtype"><a class="el" href="classRakNet_1_1TransportInterface.html">TransportInterface</a> *&#160;</td>
  456. <td class="paramname"><em>transport</em>, </td>
  457. </tr>
  458. <tr>
  459. <td class="paramkey"></td>
  460. <td></td>
  461. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  462. <td class="paramname"><em>systemAddress</em>&#160;</td>
  463. </tr>
  464. <tr>
  465. <td></td>
  466. <td>)</td>
  467. <td></td><td></td>
  468. </tr>
  469. </table>
  470. </td>
  471. <td class="mlabels-right">
  472. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. <p>A callback for when you are expected to send a brief description of your parser to <em>systemAddress</em> </p>
  477. <dl class="params"><dt>Parameters</dt><dd>
  478. <table class="params">
  479. <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>The transport interface we can use to write to </td></tr>
  480. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player that requested help. </td></tr>
  481. </table>
  482. </dd>
  483. </dl>
  484. <p>Implements <a class="el" href="classRakNet_1_1CommandParserInterface.html#a6abf857d697bb11230ac0b153c17624a">RakNet::CommandParserInterface</a>.</p>
  485. </div>
  486. </div>
  487. <a class="anchor" id="a3f479d9fb28698d197c6ac51c7b25b0b"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="mlabels">
  491. <tr>
  492. <td class="mlabels-left">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">unsigned RakNet::LogCommandParser::Subscribe </td>
  496. <td>(</td>
  497. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  498. <td class="paramname"><em>systemAddress</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">const char *&#160;</td>
  504. <td class="paramname"><em>channelName</em>&#160;</td>
  505. </tr>
  506. <tr>
  507. <td></td>
  508. <td>)</td>
  509. <td></td><td></td>
  510. </tr>
  511. </table>
  512. </td>
  513. <td class="mlabels-right">
  514. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <p>Subscribe a user to a channel (or to all channels) </p>
  519. <dl class="params"><dt>Parameters</dt><dd>
  520. <table class="params">
  521. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player to subscribe to </td></tr>
  522. <tr><td class="paramdir">[in]</td><td class="paramname">channelName</td><td>If 0, then subscribe from all channels. Otherwise subscribe to the named channel </td></tr>
  523. </table>
  524. </dd>
  525. </dl>
  526. </div>
  527. </div>
  528. <a class="anchor" id="a615d8f7044092dee6bdfd52066d3e6dc"></a>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="mlabels">
  532. <tr>
  533. <td class="mlabels-left">
  534. <table class="memname">
  535. <tr>
  536. <td class="memname">unsigned RakNet::LogCommandParser::Unsubscribe </td>
  537. <td>(</td>
  538. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  539. <td class="paramname"><em>systemAddress</em>, </td>
  540. </tr>
  541. <tr>
  542. <td class="paramkey"></td>
  543. <td></td>
  544. <td class="paramtype">const char *&#160;</td>
  545. <td class="paramname"><em>channelName</em>&#160;</td>
  546. </tr>
  547. <tr>
  548. <td></td>
  549. <td>)</td>
  550. <td></td><td></td>
  551. </tr>
  552. </table>
  553. </td>
  554. <td class="mlabels-right">
  555. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  556. </tr>
  557. </table>
  558. </div><div class="memdoc">
  559. <p>Unsubscribe a user from a channel (or from all channels) </p>
  560. <dl class="params"><dt>Parameters</dt><dd>
  561. <table class="params">
  562. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The player to unsubscribe to </td></tr>
  563. <tr><td class="paramdir">[in]</td><td class="paramname">channelName</td><td>If 0, then unsubscribe from all channels. Otherwise unsubscribe from the named channel </td></tr>
  564. </table>
  565. </dd>
  566. </dl>
  567. </div>
  568. </div>
  569. <a class="anchor" id="a2811b62171be28fed86ce6e2477c8cf9"></a>
  570. <div class="memitem">
  571. <div class="memproto">
  572. <table class="memname">
  573. <tr>
  574. <td class="memname">void RakNet::LogCommandParser::WriteLog </td>
  575. <td>(</td>
  576. <td class="paramtype">const char *&#160;</td>
  577. <td class="paramname"><em>channelName</em>, </td>
  578. </tr>
  579. <tr>
  580. <td class="paramkey"></td>
  581. <td></td>
  582. <td class="paramtype">const char *&#160;</td>
  583. <td class="paramname"><em>format</em>, </td>
  584. </tr>
  585. <tr>
  586. <td class="paramkey"></td>
  587. <td></td>
  588. <td class="paramtype">&#160;</td>
  589. <td class="paramname"><em>...</em>&#160;</td>
  590. </tr>
  591. <tr>
  592. <td></td>
  593. <td>)</td>
  594. <td></td><td></td>
  595. </tr>
  596. </table>
  597. </div><div class="memdoc">
  598. <p>Write a log to a channel. Logs are not buffered, so only remote consoles connected and subscribing at the time you write will get the output. </p>
  599. <dl class="params"><dt>Parameters</dt><dd>
  600. <table class="params">
  601. <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Same as RAKNET_DEBUG_PRINTF() </td></tr>
  602. <tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Same as RAKNET_DEBUG_PRINTF() </td></tr>
  603. </table>
  604. </dd>
  605. </dl>
  606. </div>
  607. </div>
  608. <hr/>The documentation for this class was generated from the following file:<ul>
  609. <li>D:/temp/RakNet_PC/Source/<a class="el" href="LogCommandParser_8h.html">LogCommandParser.h</a></li>
  610. </ul>
  611. </div><!-- contents -->
  612. <!-- start footer part -->
  613. <hr class="footer"/><address class="footer"><small>
  614. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  615. <img class="footer" src="doxygen.png" alt="doxygen"/>
  616. </a> 1.8.2
  617. </small></address>
  618. </body>
  619. </html>
粤ICP备19079148号