structRakNet_1_1RakNetStatistics.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  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::RakNetStatistics Struct 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="structRakNet_1_1RakNetStatistics.html">RakNetStatistics</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#pub-attribs">Public Attributes</a> &#124;
  55. <a href="structRakNet_1_1RakNetStatistics-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::RakNetStatistics Struct Reference</div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Network Statisics Usage.
  61. <a href="structRakNet_1_1RakNetStatistics.html#details">More...</a></p>
  62. <p><code>#include &lt;RakNetStatistics.h&gt;</code></p>
  63. <table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  65. Public Attributes</h2></td></tr>
  66. <tr class="memitem:a4197b81e3222a38189543f6148f9419a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4197b81e3222a38189543f6148f9419a"></a>
  67. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a4197b81e3222a38189543f6148f9419a">valueOverLastSecond</a> [RNS_PER_SECOND_METRICS_COUNT]</td></tr>
  68. <tr class="memdesc:a4197b81e3222a38189543f6148f9419a"><td class="mdescLeft">&#160;</td><td class="mdescRight">For each type in RNSPerSecondMetrics, what is the value over the last 1 second? <br/></td></tr>
  69. <tr class="separator:a4197b81e3222a38189543f6148f9419a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:ae67e3487f97e23a4d7ca72f4a55b0912"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae67e3487f97e23a4d7ca72f4a55b0912"></a>
  71. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#ae67e3487f97e23a4d7ca72f4a55b0912">runningTotal</a> [RNS_PER_SECOND_METRICS_COUNT]</td></tr>
  72. <tr class="memdesc:ae67e3487f97e23a4d7ca72f4a55b0912"><td class="mdescLeft">&#160;</td><td class="mdescRight">For each type in RNSPerSecondMetrics, what is the total value over the lifetime of the connection? <br/></td></tr>
  73. <tr class="separator:ae67e3487f97e23a4d7ca72f4a55b0912"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:aa4de4877ca5c69f70c4176e6d50b69ce"><td class="memItemLeft" align="right" valign="top">RakNet::TimeUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#aa4de4877ca5c69f70c4176e6d50b69ce">connectionStartTime</a></td></tr>
  75. <tr class="separator:aa4de4877ca5c69f70c4176e6d50b69ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a7e8881dd2f72099037a69ba3cd0b989d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a7e8881dd2f72099037a69ba3cd0b989d">isLimitedByCongestionControl</a></td></tr>
  77. <tr class="separator:a7e8881dd2f72099037a69ba3cd0b989d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:aa83e53ef2fc8353a8111929fa869eb5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa83e53ef2fc8353a8111929fa869eb5e"></a>
  79. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#aa83e53ef2fc8353a8111929fa869eb5e">BPSLimitByCongestionControl</a></td></tr>
  80. <tr class="memdesc:aa83e53ef2fc8353a8111929fa869eb5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">If <em>isLimitedByCongestionControl</em> is true, what is the limit, in bytes per second? <br/></td></tr>
  81. <tr class="separator:aa83e53ef2fc8353a8111929fa869eb5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:acea90f1f18f76fdc30d9debc45f1ccb4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acea90f1f18f76fdc30d9debc45f1ccb4"></a>
  83. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#acea90f1f18f76fdc30d9debc45f1ccb4">isLimitedByOutgoingBandwidthLimit</a></td></tr>
  84. <tr class="memdesc:acea90f1f18f76fdc30d9debc45f1ccb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is our current send rate throttled by a call to <a class="el" href="classRakNet_1_1RakPeer.html#a9c67c61c6eebed7a4ed8bc2ea2813b56">RakPeer::SetPerConnectionOutgoingBandwidthLimit()</a>? <br/></td></tr>
  85. <tr class="separator:acea90f1f18f76fdc30d9debc45f1ccb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ac26fb5ed5e4352d958d6a06ddbb82138"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac26fb5ed5e4352d958d6a06ddbb82138"></a>
  87. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#ac26fb5ed5e4352d958d6a06ddbb82138">BPSLimitByOutgoingBandwidthLimit</a></td></tr>
  88. <tr class="memdesc:ac26fb5ed5e4352d958d6a06ddbb82138"><td class="mdescLeft">&#160;</td><td class="mdescRight">If <em>isLimitedByOutgoingBandwidthLimit</em> is true, what is the limit, in bytes per second? <br/></td></tr>
  89. <tr class="separator:ac26fb5ed5e4352d958d6a06ddbb82138"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a437086be4e5d907f72de273aa8d50e0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a437086be4e5d907f72de273aa8d50e0f"></a>
  91. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a437086be4e5d907f72de273aa8d50e0f">messageInSendBuffer</a> [NUMBER_OF_PRIORITIES]</td></tr>
  92. <tr class="memdesc:a437086be4e5d907f72de273aa8d50e0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">For each priority level, how many messages are waiting to be sent out? <br/></td></tr>
  93. <tr class="separator:a437086be4e5d907f72de273aa8d50e0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:aaba55c95f5ea9698068f3fdae9ec7604"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaba55c95f5ea9698068f3fdae9ec7604"></a>
  95. double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#aaba55c95f5ea9698068f3fdae9ec7604">bytesInSendBuffer</a> [NUMBER_OF_PRIORITIES]</td></tr>
  96. <tr class="memdesc:aaba55c95f5ea9698068f3fdae9ec7604"><td class="mdescLeft">&#160;</td><td class="mdescRight">For each priority level, how many bytes are waiting to be sent out? <br/></td></tr>
  97. <tr class="separator:aaba55c95f5ea9698068f3fdae9ec7604"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a6afad117322d397a65bccf2475e42d04"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a6afad117322d397a65bccf2475e42d04">messagesInResendBuffer</a></td></tr>
  99. <tr class="separator:a6afad117322d397a65bccf2475e42d04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a58f50bb872e04f31946b3571ab548446"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58f50bb872e04f31946b3571ab548446"></a>
  101. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a58f50bb872e04f31946b3571ab548446">bytesInResendBuffer</a></td></tr>
  102. <tr class="memdesc:a58f50bb872e04f31946b3571ab548446"><td class="mdescLeft">&#160;</td><td class="mdescRight">How many bytes are waiting in the resend buffer. See also messagesInResendBuffer. <br/></td></tr>
  103. <tr class="separator:a58f50bb872e04f31946b3571ab548446"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a9b089df46c6c965c68fe5eabb00dfb75"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b089df46c6c965c68fe5eabb00dfb75"></a>
  105. float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a9b089df46c6c965c68fe5eabb00dfb75">packetlossLastSecond</a></td></tr>
  106. <tr class="memdesc:a9b089df46c6c965c68fe5eabb00dfb75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Over the last second, what was our packetloss? This number will range from 0.0 (for none) to 1.0 (for 100%) <br/></td></tr>
  107. <tr class="separator:a9b089df46c6c965c68fe5eabb00dfb75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a4b86428f78da4893ca8b270508db328a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b86428f78da4893ca8b270508db328a"></a>
  109. float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1RakNetStatistics.html#a4b86428f78da4893ca8b270508db328a">packetlossTotal</a></td></tr>
  110. <tr class="memdesc:a4b86428f78da4893ca8b270508db328a"><td class="mdescLeft">&#160;</td><td class="mdescRight">What is the average total packetloss over the lifetime of the connection? <br/></td></tr>
  111. <tr class="separator:a4b86428f78da4893ca8b270508db328a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>Network Statisics Usage. </p>
  115. <p>Store Statistics information related to network usage </p>
  116. </div><h2 class="groupheader">Member Data Documentation</h2>
  117. <a class="anchor" id="aa4de4877ca5c69f70c4176e6d50b69ce"></a>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">RakNet::TimeUS RakNet::RakNetStatistics::connectionStartTime</td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>When did the connection start? </p>
  127. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceRakNet.html#a0eb59672707865b233dd68a54db6c59f">RakNet::GetTimeUS()</a> </dd></dl>
  128. </div>
  129. </div>
  130. <a class="anchor" id="a7e8881dd2f72099037a69ba3cd0b989d"></a>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">bool RakNet::RakNetStatistics::isLimitedByCongestionControl</td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. <p>Is our current send rate throttled by congestion control? This value should be true if you send more data per second than your bandwidth capacity </p>
  140. </div>
  141. </div>
  142. <a class="anchor" id="a6afad117322d397a65bccf2475e42d04"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">unsigned int RakNet::RakNetStatistics::messagesInResendBuffer</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>How many messages are waiting in the resend buffer? This includes messages waiting for an ack, so should normally be a small value If the value is rising over time, you are exceeding the bandwidth capacity. See BPSLimitByCongestionControl </p>
  152. </div>
  153. </div>
  154. <hr/>The documentation for this struct was generated from the following file:<ul>
  155. <li>D:/temp/RakNet_PC/Source/<a class="el" href="RakNetStatistics_8h.html">RakNetStatistics.h</a></li>
  156. </ul>
  157. </div><!-- contents -->
  158. <!-- start footer part -->
  159. <hr class="footer"/><address class="footer"><small>
  160. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  161. <img class="footer" src="doxygen.png" alt="doxygen"/>
  162. </a> 1.8.2
  163. </small></address>
  164. </body>
  165. </html>
粤ICP备19079148号