classRakNet_1_1PacketLogger.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  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::PacketLogger 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_1PacketLogger.html">PacketLogger</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="classRakNet_1_1PacketLogger-members.html">List of all members</a> </div>
  57. <div class="headertitle">
  58. <div class="title">RakNet::PacketLogger Class Reference<div class="ingroups"><a class="el" href="group__PACKETLOGGER__GROUP.html">PacketLogger</a></div></div> </div>
  59. </div><!--header-->
  60. <div class="contents">
  61. <p>Writes incoming and outgoing messages to the screen. This will write all incoming and outgoing messages to the console window, or to a file if you override it and give it this functionality.
  62. <a href="classRakNet_1_1PacketLogger.html#details">More...</a></p>
  63. <p><code>#include &lt;PacketLogger.h&gt;</code></p>
  64. <div class="dynheader">
  65. Inheritance diagram for RakNet::PacketLogger:</div>
  66. <div class="dyncontent">
  67. <div class="center">
  68. <img src="classRakNet_1_1PacketLogger.png" usemap="#RakNet::PacketLogger_map" alt=""/>
  69. <map id="RakNet::PacketLogger_map" name="RakNet::PacketLogger_map">
  70. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="340,0,557,24"/>
  71. <area href="classRakNet_1_1PacketConsoleLogger.html" title="Packetlogger that logs to a remote command console." alt="RakNet::PacketConsoleLogger" shape="rect" coords="0,112,217,136"/>
  72. <area href="classRakNet_1_1PacketFileLogger.html" title="Packetlogger that outputs to a file." alt="RakNet::PacketFileLogger" shape="rect" coords="227,112,444,136"/>
  73. <area href="classRakNet_1_1PacketOutputWindowLogger.html" title="Packetlogger that outputs to the output window in the debugger. Windows only." alt="RakNet::PacketOutputWindowLogger" shape="rect" coords="454,112,671,136"/>
  74. <area href="classRakNet_1_1ThreadsafePacketLogger.html" title="Same as PacketLogger, but writes output in the user thread." alt="RakNet::ThreadsafePacketLogger" shape="rect" coords="681,112,898,136"/>
  75. </map>
  76. </div></div>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a574e24adec497ee567f5ea7a1aaa2d26"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a574e24adec497ee567f5ea7a1aaa2d26"></a>
  81. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a574e24adec497ee567f5ea7a1aaa2d26">OnDirectSocketSend</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  82. <tr class="memdesc:a574e24adec497ee567f5ea7a1aaa2d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Events on low level sends and receives. These functions may be called from different threads at the same time. <br/></td></tr>
  83. <tr class="separator:a574e24adec497ee567f5ea7a1aaa2d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a94dd0e79e3e51933166180f3391a9387"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a94dd0e79e3e51933166180f3391a9387">OnDirectSocketReceive</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  85. <tr class="separator:a94dd0e79e3e51933166180f3391a9387"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:aba0d74f42ad8b50ed50e439d4d13fafb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#aba0d74f42ad8b50ed50e439d4d13fafb">OnReliabilityLayerNotification</a> (const char *errorMessage, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, bool isError)</td></tr>
  87. <tr class="separator:aba0d74f42ad8b50ed50e439d4d13fafb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a96775f5fb8fa1be7c55b78628ec1ae94"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a96775f5fb8fa1be7c55b78628ec1ae94">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>
  89. <tr class="separator:a96775f5fb8fa1be7c55b78628ec1ae94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a28c18d70969acf2857fde1c7a1b443fd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a28c18d70969acf2857fde1c7a1b443fd">OnAck</a> (unsigned int messageNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time)</td></tr>
  91. <tr class="separator:a28c18d70969acf2857fde1c7a1b443fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:aff91d53f25ba43df5778aa04bd01cc4f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#aff91d53f25ba43df5778aa04bd01cc4f">OnPushBackPacket</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
  93. <tr class="separator:aff91d53f25ba43df5778aa04bd01cc4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a615fbb0945d97f8d9b940f079ed45645"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a615fbb0945d97f8d9b940f079ed45645"></a>
  95. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a615fbb0945d97f8d9b940f079ed45645">LogHeader</a> (void)</td></tr>
  96. <tr class="memdesc:a615fbb0945d97f8d9b940f079ed45645"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logs out a header for all the data. <br/></td></tr>
  97. <tr class="separator:a615fbb0945d97f8d9b940f079ed45645"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a25e1e0c6122cfa708d98be6799a54926"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25e1e0c6122cfa708d98be6799a54926"></a>
  99. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a25e1e0c6122cfa708d98be6799a54926">WriteLog</a> (const char *str)</td></tr>
  100. <tr class="memdesc:a25e1e0c6122cfa708d98be6799a54926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override this to log strings to wherever. Log should be threadsafe. <br/></td></tr>
  101. <tr class="separator:a25e1e0c6122cfa708d98be6799a54926"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a0819da3879136df1a26b24844fb6abee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0819da3879136df1a26b24844fb6abee"></a>
  103. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a0819da3879136df1a26b24844fb6abee">SetPrefix</a> (const char *_prefix)</td></tr>
  104. <tr class="memdesc:a0819da3879136df1a26b24844fb6abee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepend this string to output logs. <br/></td></tr>
  105. <tr class="separator:a0819da3879136df1a26b24844fb6abee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a7b8f7d4767ddb445d2fdb344538278f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b8f7d4767ddb445d2fdb344538278f5"></a>
  107. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a7b8f7d4767ddb445d2fdb344538278f5">SetSuffix</a> (const char *_suffix)</td></tr>
  108. <tr class="memdesc:a7b8f7d4767ddb445d2fdb344538278f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append this string to output logs. (newline is useful here) <br/></td></tr>
  109. <tr class="separator:a7b8f7d4767ddb445d2fdb344538278f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a1ca13332359a83158095b52ab686303e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ca13332359a83158095b52ab686303e"></a>
  111. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#a1ca13332359a83158095b52ab686303e">SetLogDirectMessages</a> (bool send)</td></tr>
  112. <tr class="memdesc:a1ca13332359a83158095b52ab686303e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log the direct sends and receives or not. Default true. <br/></td></tr>
  113. <tr class="separator:a1ca13332359a83158095b52ab686303e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
  116. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
  117. <tr class="memdesc:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
  118. <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
  120. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
  121. <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>
  122. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
  124. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
  125. <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>
  126. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aa86f33263c1648f11b8a006469272639 inherit pub_methods_classRakNet_1_1PluginInterface2"><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_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  128. <tr class="separator:aa86f33263c1648f11b8a006469272639 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
  130. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
  131. <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>
  132. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
  134. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
  135. <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>
  136. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a80c7612ca1a5dcfeec0b52d8049a71ea inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table><table class="memberdecls">
  144. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  145. Protected Member Functions</h2></td></tr>
  146. <tr class="memitem:ab486d35c408ffee7d1732678143d4a81"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PacketLogger.html#ab486d35c408ffee7d1732678143d4a81">UsesReliabilityLayer</a> (void) const </td></tr>
  147. <tr class="separator:ab486d35c408ffee7d1732678143d4a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table>
  149. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  150. <div class="textblock"><p>Writes incoming and outgoing messages to the screen. This will write all incoming and outgoing messages to the console window, or to a file if you override it and give it this functionality. </p>
  151. </div><h2 class="groupheader">Member Function Documentation</h2>
  152. <a class="anchor" id="a28c18d70969acf2857fde1c7a1b443fd"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">virtual void RakNet::PacketLogger::OnAck </td>
  161. <td>(</td>
  162. <td class="paramtype">unsigned int&#160;</td>
  163. <td class="paramname"><em>messageNumber</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  169. <td class="paramname"><em>remoteSystemAddress</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">RakNet::TimeMS&#160;</td>
  175. <td class="paramname"><em>time</em>&#160;</td>
  176. </tr>
  177. <tr>
  178. <td></td>
  179. <td>)</td>
  180. <td></td><td></td>
  181. </tr>
  182. </table>
  183. </td>
  184. <td class="mlabels-right">
  185. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>Called when we get an ack for a message we reliably sent </p>
  190. <dl class="section pre"><dt>Precondition</dt><dd>To be called, <a class="el" href="classRakNet_1_1PacketLogger.html#ab486d35c408ffee7d1732678143d4a81">UsesReliabilityLayer()</a> must return true </dd></dl>
  191. <dl class="params"><dt>Parameters</dt><dd>
  192. <table class="params">
  193. <tr><td class="paramdir">[in]</td><td class="paramname">messageNumber</td><td>The numerical identifier for which message this is </td></tr>
  194. <tr><td class="paramdir">[in]</td><td class="paramname">remoteSystemAddress</td><td>The player we sent or got this packet from </td></tr>
  195. <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The current time as returned by <a class="el" href="namespaceRakNet.html#ada73d8160aa36bffbba9e3eb092147cc">RakNet::GetTimeMS()</a> </td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#ae0b0cad31cfc209c48197c77d6b46345">RakNet::PluginInterface2</a>.</p>
  200. </div>
  201. </div>
  202. <a class="anchor" id="a94dd0e79e3e51933166180f3391a9387"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="mlabels">
  206. <tr>
  207. <td class="mlabels-left">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">virtual void RakNet::PacketLogger::OnDirectSocketReceive </td>
  211. <td>(</td>
  212. <td class="paramtype">const char *&#160;</td>
  213. <td class="paramname"><em>data</em>, </td>
  214. </tr>
  215. <tr>
  216. <td class="paramkey"></td>
  217. <td></td>
  218. <td class="paramtype">const BitSize_t&#160;</td>
  219. <td class="paramname"><em>bitsUsed</em>, </td>
  220. </tr>
  221. <tr>
  222. <td class="paramkey"></td>
  223. <td></td>
  224. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  225. <td class="paramname"><em>remoteSystemAddress</em>&#160;</td>
  226. </tr>
  227. <tr>
  228. <td></td>
  229. <td>)</td>
  230. <td></td><td></td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Called on a receive from the socket, per datagram, that does not go through the reliability layer </p>
  240. <dl class="section pre"><dt>Precondition</dt><dd>To be called, <a class="el" href="classRakNet_1_1PacketLogger.html#ab486d35c408ffee7d1732678143d4a81">UsesReliabilityLayer()</a> must return true </dd></dl>
  241. <dl class="params"><dt>Parameters</dt><dd>
  242. <table class="params">
  243. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data being sent </td></tr>
  244. <tr><td class="paramdir">[in]</td><td class="paramname">bitsUsed</td><td>How many bits long <em>data</em> is </td></tr>
  245. <tr><td class="paramdir">[in]</td><td class="paramname">remoteSystemAddress</td><td>Which system this message is being sent to </td></tr>
  246. </table>
  247. </dd>
  248. </dl>
  249. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a9aac1101ad58e8443516588e96e066ec">RakNet::PluginInterface2</a>.</p>
  250. </div>
  251. </div>
  252. <a class="anchor" id="a96775f5fb8fa1be7c55b78628ec1ae94"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">virtual void RakNet::PacketLogger::OnInternalPacket </td>
  261. <td>(</td>
  262. <td class="paramtype"><a class="el" href="structRakNet_1_1InternalPacket.html">InternalPacket</a> *&#160;</td>
  263. <td class="paramname"><em>internalPacket</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">unsigned&#160;</td>
  269. <td class="paramname"><em>frameNumber</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  275. <td class="paramname"><em>remoteSystemAddress</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">RakNet::TimeMS&#160;</td>
  281. <td class="paramname"><em>time</em>, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype">int&#160;</td>
  287. <td class="paramname"><em>isSend</em>&#160;</td>
  288. </tr>
  289. <tr>
  290. <td></td>
  291. <td>)</td>
  292. <td></td><td></td>
  293. </tr>
  294. </table>
  295. </td>
  296. <td class="mlabels-right">
  297. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Called on a send or receive of a message within the reliability layer </p>
  302. <dl class="section pre"><dt>Precondition</dt><dd>To be called, <a class="el" href="classRakNet_1_1PacketLogger.html#ab486d35c408ffee7d1732678143d4a81">UsesReliabilityLayer()</a> must return true </dd></dl>
  303. <dl class="params"><dt>Parameters</dt><dd>
  304. <table class="params">
  305. <tr><td class="paramdir">[in]</td><td class="paramname">internalPacket</td><td>The user message, along with all send data. </td></tr>
  306. <tr><td class="paramdir">[in]</td><td class="paramname">frameNumber</td><td>The number of frames sent or received so far for this player depending on <em>isSend</em> . Indicates the frame of this user message. </td></tr>
  307. <tr><td class="paramdir">[in]</td><td class="paramname">remoteSystemAddress</td><td>The player we sent or got this packet from </td></tr>
  308. <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The current time as returned by <a class="el" href="namespaceRakNet.html#ada73d8160aa36bffbba9e3eb092147cc">RakNet::GetTimeMS()</a> </td></tr>
  309. <tr><td class="paramdir">[in]</td><td class="paramname">isSend</td><td>Is this callback representing a send event or receive event? </td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a399b8c93daa0236599961e754742e2f7">RakNet::PluginInterface2</a>.</p>
  314. </div>
  315. </div>
  316. <a class="anchor" id="aff91d53f25ba43df5778aa04bd01cc4f"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">virtual void RakNet::PacketLogger::OnPushBackPacket </td>
  325. <td>(</td>
  326. <td class="paramtype">const char *&#160;</td>
  327. <td class="paramname"><em>data</em>, </td>
  328. </tr>
  329. <tr>
  330. <td class="paramkey"></td>
  331. <td></td>
  332. <td class="paramtype">const BitSize_t&#160;</td>
  333. <td class="paramname"><em>bitsUsed</em>, </td>
  334. </tr>
  335. <tr>
  336. <td class="paramkey"></td>
  337. <td></td>
  338. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  339. <td class="paramname"><em>remoteSystemAddress</em>&#160;</td>
  340. </tr>
  341. <tr>
  342. <td></td>
  343. <td>)</td>
  344. <td></td><td></td>
  345. </tr>
  346. </table>
  347. </td>
  348. <td class="mlabels-right">
  349. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>System called <a class="el" href="classRakNet_1_1RakPeerInterface.html#a29c5527b07a3ddc32083d8ec1e24318b">RakPeerInterface::PushBackPacket</a> </p>
  354. <dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The data being sent </td></tr>
  357. <tr><td class="paramdir">[in]</td><td class="paramname">bitsUsed</td><td>How many bits long <em>data</em> is </td></tr>
  358. <tr><td class="paramdir">[in]</td><td class="paramname">remoteSystemAddress</td><td>The player we sent or got this packet from </td></tr>
  359. </table>
  360. </dd>
  361. </dl>
  362. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a5c976aea56ed85055a17c19d91b90727">RakNet::PluginInterface2</a>.</p>
  363. </div>
  364. </div>
  365. <a class="anchor" id="aba0d74f42ad8b50ed50e439d4d13fafb"></a>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="mlabels">
  369. <tr>
  370. <td class="mlabels-left">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">virtual void RakNet::PacketLogger::OnReliabilityLayerNotification </td>
  374. <td>(</td>
  375. <td class="paramtype">const char *&#160;</td>
  376. <td class="paramname"><em>errorMessage</em>, </td>
  377. </tr>
  378. <tr>
  379. <td class="paramkey"></td>
  380. <td></td>
  381. <td class="paramtype">const BitSize_t&#160;</td>
  382. <td class="paramname"><em>bitsUsed</em>, </td>
  383. </tr>
  384. <tr>
  385. <td class="paramkey"></td>
  386. <td></td>
  387. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  388. <td class="paramname"><em>remoteSystemAddress</em>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">bool&#160;</td>
  394. <td class="paramname"><em>isError</em>&#160;</td>
  395. </tr>
  396. <tr>
  397. <td></td>
  398. <td>)</td>
  399. <td></td><td></td>
  400. </tr>
  401. </table>
  402. </td>
  403. <td class="mlabels-right">
  404. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>Called when the reliability layer rejects a send or receive </p>
  409. <dl class="section pre"><dt>Precondition</dt><dd>To be called, <a class="el" href="classRakNet_1_1PacketLogger.html#ab486d35c408ffee7d1732678143d4a81">UsesReliabilityLayer()</a> must return true </dd></dl>
  410. <dl class="params"><dt>Parameters</dt><dd>
  411. <table class="params">
  412. <tr><td class="paramdir">[in]</td><td class="paramname">bitsUsed</td><td>How many bits long <em>data</em> is </td></tr>
  413. <tr><td class="paramdir">[in]</td><td class="paramname">remoteSystemAddress</td><td>Which system this message is being sent to </td></tr>
  414. </table>
  415. </dd>
  416. </dl>
  417. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#abf51e60546bd74d21c91dc0d6f9f3a4b">RakNet::PluginInterface2</a>.</p>
  418. </div>
  419. </div>
  420. <a class="anchor" id="ab486d35c408ffee7d1732678143d4a81"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="mlabels">
  424. <tr>
  425. <td class="mlabels-left">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">virtual bool RakNet::PacketLogger::UsesReliabilityLayer </td>
  429. <td>(</td>
  430. <td class="paramtype">void&#160;</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td> const</td>
  433. </tr>
  434. </table>
  435. </td>
  436. <td class="mlabels-right">
  437. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Queried when attached to <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> Return true to call <a class="el" href="classRakNet_1_1PacketLogger.html#a574e24adec497ee567f5ea7a1aaa2d26" title="Events on low level sends and receives. These functions may be called from different threads at the s...">OnDirectSocketSend()</a>, <a class="el" href="classRakNet_1_1PacketLogger.html#a94dd0e79e3e51933166180f3391a9387">OnDirectSocketReceive()</a>, <a class="el" href="classRakNet_1_1PacketLogger.html#aba0d74f42ad8b50ed50e439d4d13fafb">OnReliabilityLayerNotification()</a>, <a class="el" href="classRakNet_1_1PacketLogger.html#a96775f5fb8fa1be7c55b78628ec1ae94">OnInternalPacket()</a>, and <a class="el" href="classRakNet_1_1PacketLogger.html#a28c18d70969acf2857fde1c7a1b443fd">OnAck()</a> If true, then you cannot call <a class="el" href="classRakNet_1_1RakPeer.html#a4ceacd63ae51089a2e36287c54f07ffe" title="Attaches a Plugin interface to an instance of the base class (RakPeer or PacketizedTCP) to run code a...">RakPeer::AttachPlugin()</a> or <a class="el" href="classRakNet_1_1RakPeer.html#a9f29151642a0ad0abdddc6d9a8f25239" title="Detaches a Plugin interface from the instance of the base class (RakPeer or PacketizedTCP) it is atta...">RakPeer::DetachPlugin()</a> for this plugin, while <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is active </p>
  442. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#accfca7d25262c48a87a30114383284aa">RakNet::PluginInterface2</a>.</p>
  443. </div>
  444. </div>
  445. <hr/>The documentation for this class was generated from the following file:<ul>
  446. <li>D:/temp/RakNet_PC/Source/<a class="el" href="PacketLogger_8h.html">PacketLogger.h</a></li>
  447. </ul>
  448. </div><!-- contents -->
  449. <!-- start footer part -->
  450. <hr class="footer"/><address class="footer"><small>
  451. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  452. <img class="footer" src="doxygen.png" alt="doxygen"/>
  453. </a> 1.8.2
  454. </small></address>
  455. </body>
  456. </html>
粤ICP备19079148号