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

classRakNet_1_1ReadyEvent.html 47 KB
Постоянная ссылка История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702 
  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::ReadyEvent 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_1ReadyEvent.html">ReadyEvent</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="#pro-methods">Protected Member Functions</a> &#124;
    56. 

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

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

  58. <div class="title">RakNet::ReadyEvent Class Reference<div class="ingroups"><a class="el" href="group__READY__EVENT__GROUP.html">ReadyEvent</a></div></div>  </div>
    59. 

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

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

  61. 

  62. <p>Peer to peer synchronized ready and unready events.  
    63. 

  63.  <a href="classRakNet_1_1ReadyEvent.html#details">More...</a></p>
    64. 

  64. 

  65. <p><code>#include &lt;ReadyEvent.h&gt;</code></p>
    66. 

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

  67. Inheritance diagram for RakNet::ReadyEvent:</div>
    68. 

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

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

  70.   <img src="classRakNet_1_1ReadyEvent.png" usemap="#RakNet::ReadyEvent_map" alt=""/>
    71. 

  71.   <map id="RakNet::ReadyEvent_map" name="RakNet::ReadyEvent_map">
    72. 

  72. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="0,0,150,24"/>
    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:af7caed0bdee19e21bdd91ff34ff73b31"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent</a> (int eventId, bool isReady)</td></tr>
    79. 

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

  80. <tr class="memitem:abc3c01527d0faf6b47e43ce0e3a0159c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#abc3c01527d0faf6b47e43ce0e3a0159c">ForceCompletion</a> (int eventId)</td></tr>
    81. 

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

  82. <tr class="memitem:ab8b4e32689f5c54d0ce7c6deed2eb7e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#ab8b4e32689f5c54d0ce7c6deed2eb7e6">DeleteEvent</a> (int eventId)</td></tr>
    83. 

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

  84. <tr class="memitem:a3e316ae7568001e5c2d9624f156a2ee8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a3e316ae7568001e5c2d9624f156a2ee8">IsEventSet</a> (int eventId)</td></tr>
    85. 

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

  86. <tr class="memitem:a90747ab26a89d426317dfa1d4f414fde"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a90747ab26a89d426317dfa1d4f414fde">IsEventCompletionProcessing</a> (int eventId) const </td></tr>
    87. 

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

  88. <tr class="memitem:a8c4600be8271b798ea0158cef9261462"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a8c4600be8271b798ea0158cef9261462">IsEventCompleted</a> (int eventId) const </td></tr>
    89. 

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

  90. <tr class="memitem:ad10f179c0565882651ca2bde5bf50a45"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#ad10f179c0565882651ca2bde5bf50a45">HasEvent</a> (int eventId)</td></tr>
    91. 

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

  92. <tr class="memitem:ad56242dec80dd75f05c1eb96458e0bf8"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#ad56242dec80dd75f05c1eb96458e0bf8">GetEventListSize</a> (void) const </td></tr>
    93. 

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

  94. <tr class="memitem:adb53c9c21d8e88b1a5fbb3e241fe5f91"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#adb53c9c21d8e88b1a5fbb3e241fe5f91">GetEventAtIndex</a> (unsigned index) const </td></tr>
    95. 

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

  96. <tr class="memitem:aaf6bfa53f4be43cb4d9fe40911faefdf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#aaf6bfa53f4be43cb4d9fe40911faefdf">AddToWaitList</a> (int eventId, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid)</td></tr>
    97. 

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

  98. <tr class="memitem:ae7cb534890f2ab044f2b81e9b3205bc8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#ae7cb534890f2ab044f2b81e9b3205bc8">RemoveFromWaitList</a> (int eventId, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid)</td></tr>
    99. 

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

  100. <tr class="memitem:a1b1d658e1be6b128b013c20eed2bf580"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a1b1d658e1be6b128b013c20eed2bf580">IsInWaitList</a> (int eventId, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid)</td></tr>
    101. 

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

  102. <tr class="memitem:ab620a94cd56f7a6a82aa5e680322cb89"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#ab620a94cd56f7a6a82aa5e680322cb89">GetRemoteWaitListSize</a> (int eventId) const </td></tr>
    103. 

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

  104. <tr class="memitem:af38ea2b77651a37774e31bdbf5d663de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#af38ea2b77651a37774e31bdbf5d663de">GetFromWaitListAtIndex</a> (int eventId, unsigned index) const </td></tr>
    105. 

  105. <tr class="separator:af38ea2b77651a37774e31bdbf5d663de"><td class="memSeparator" colspan="2">&#160;</td></tr>
    106. 

  106. <tr class="memitem:a43a6b3450223af740ef2a66bb3db6f87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__READY__EVENT__GROUP.html#gaf87e91389822570de07c01ccb37b0bbf">ReadyEventSystemStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a43a6b3450223af740ef2a66bb3db6f87">GetReadyStatus</a> (int eventId, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid)</td></tr>
    107. 

  107. <tr class="separator:a43a6b3450223af740ef2a66bb3db6f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
    108. 

  108. <tr class="memitem:a6355b9958259b6e645bb335a1b7b34a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a6355b9958259b6e645bb335a1b7b34a1">SetSendChannel</a> (unsigned char newChannel)</td></tr>
    109. 

  109. <tr class="separator:a6355b9958259b6e645bb335a1b7b34a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    110. 

  110. <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>
    111. 

  111. <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
    112. 

  112. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
    113. 

  113. <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>
    114. 

  114. <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    115. 

  115. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
    116. 

  116. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
    117. 

  117. <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>
    118. 

  118. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    119. 

  119. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
    120. 

  120. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
    121. 

  121. <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>
    122. 

  122. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    123. 

  123. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
    124. 

  124. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
    125. 

  125. <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>
    126. 

  126. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    127. 

  127. <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>
    128. 

  128. <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129. 

  129. <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>
    130. 

  130. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131. 

  131. <tr class="memitem:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#accfca7d25262c48a87a30114383284aa">UsesReliabilityLayer</a> (void) const </td></tr>
    132. 

  132. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133. 

  133. <tr class="memitem:a7a6f69c6fc3a121e3676298a63a9ef78 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#a7a6f69c6fc3a121e3676298a63a9ef78">OnDirectSocketSend</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    134. 

  134. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    135. 

  135. <tr class="memitem:a9aac1101ad58e8443516588e96e066ec 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#a9aac1101ad58e8443516588e96e066ec">OnDirectSocketReceive</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    136. 

  136. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137. 

  137. <tr class="memitem:abf51e60546bd74d21c91dc0d6f9f3a4b 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#abf51e60546bd74d21c91dc0d6f9f3a4b">OnReliabilityLayerNotification</a> (const char *errorMessage, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, bool isError)</td></tr>
    138. 

  138. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139. 

  139. <tr class="memitem:a399b8c93daa0236599961e754742e2f7 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#a399b8c93daa0236599961e754742e2f7">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>
    140. 

  140. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. <tr class="memitem:ae0b0cad31cfc209c48197c77d6b46345 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#ae0b0cad31cfc209c48197c77d6b46345">OnAck</a> (unsigned int messageNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time)</td></tr>
    142. 

  142. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143. 

  143. <tr class="memitem:a5c976aea56ed85055a17c19d91b90727 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#a5c976aea56ed85055a17c19d91b90727">OnPushBackPacket</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    144. 

  144. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    145. 

  145. </table><table class="memberdecls">
    146. 

  146. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
    147. 

  147. Protected Member Functions</h2></td></tr>
    148. 

  148. <tr class="memitem:a2dd5308b4ee75a877c53404477a3c637"><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_1ReadyEvent.html#a2dd5308b4ee75a877c53404477a3c637">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
    149. 

  149. <tr class="separator:a2dd5308b4ee75a877c53404477a3c637"><td class="memSeparator" colspan="2">&#160;</td></tr>
    150. 

  150. <tr class="memitem:acf26f69ce62bcbfe5077c61aa2c40f45"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#acf26f69ce62bcbfe5077c61aa2c40f45">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>
    151. 

  151. <tr class="separator:acf26f69ce62bcbfe5077c61aa2c40f45"><td class="memSeparator" colspan="2">&#160;</td></tr>
    152. 

  152. <tr class="memitem:a26a546e1fad47a20aee022aad42446df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26a546e1fad47a20aee022aad42446df"></a>
    153. 

  153. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1ReadyEvent.html#a26a546e1fad47a20aee022aad42446df">OnRakPeerShutdown</a> (void)</td></tr>
    154. 

  154. <tr class="memdesc:a26a546e1fad47a20aee022aad42446df"><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>
    155. 

  155. <tr class="separator:a26a546e1fad47a20aee022aad42446df"><td class="memSeparator" colspan="2">&#160;</td></tr>
    156. 

  156. </table>
    157. 

  157. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    158. 

  158. <div class="textblock"><p>Peer to peer synchronized ready and unready events. </p>
    159. 

  159. <p>For peer to peer networks in a fully connected mesh.<br/>
    160. 

  160.  Solves the problem of how to tell if all peers, relative to all other peers, are in a certain ready state.<br/>
    161. 

  161.  For example, if A is connected to B and C, A may see that B and C are ready, but does not know if B is ready to C, or vice-versa.<br/>
    162. 

  162.  This plugin uses two stages to solve that problem, first, everyone I know about is ready. Second, everyone I know about is ready to everyone they know about.<br/>
    163. 

  163.  The user will get ID_READY_EVENT_SET and ID_READY_EVENT_UNSET as the signal flag is set or unset<br/>
    164. 

  164.  The user will get ID_READY_EVENT_ALL_SET when all systems are done waiting for all other systems, in which case the event is considered complete, and no longer tracked.<br/>
    165. 

  165.  </p>
    166. 

  166. <dl class="section see"><dt>See Also</dt><dd>FullyConnectedMesh2 </dd></dl>
    167. 

  167. </div><h2 class="groupheader">Member Function Documentation</h2>
    168. 

  168. <a class="anchor" id="aaf6bfa53f4be43cb4d9fe40911faefdf"></a>
    169. 

  169. <div class="memitem">
    170. 

  170. <div class="memproto">
    171. 

  171.       <table class="memname">
    172. 

  172.         <tr>
    173. 

  173.           <td class="memname">bool RakNet::ReadyEvent::AddToWaitList </td>
    174. 

  174.           <td>(</td>
    175. 

  175.           <td class="paramtype">int&#160;</td>
    176. 

  176.           <td class="paramname"><em>eventId</em>, </td>
    177. 

  177.         </tr>
    178. 

  178.         <tr>
    179. 

  179.           <td class="paramkey"></td>
    180. 

  180.           <td></td>
    181. 

  181.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    182. 

  182.           <td class="paramname"><em>guid</em>&#160;</td>
    183. 

  183.         </tr>
    184. 

  184.         <tr>
    185. 

  185.           <td></td>
    186. 

  186.           <td>)</td>
    187. 

  187.           <td></td><td></td>
    188. 

  188.         </tr>
    189. 

  189.       </table>
    190. 

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

  191. <p>Adds a system to wait for to signal an event before considering the event complete and returning ID_READY_EVENT_ALL_SET. As we add systems, if this event was previously set to true with SetEvent, these systems will get ID_READY_EVENT_SET. As these systems disconnect (directly or indirectly through the router) they are removed. </p>
    192. 

  192. <dl class="section note"><dt>Note</dt><dd>If the event completion process has already started, you cannot add more systems, as this would cause the completion process to fail </dd></dl>
    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">eventId</td><td>A user-defined number previously passed to SetEvent that has not yet completed </td></tr>
    196. 

  196.     <tr><td class="paramdir">[in]</td><td class="paramname">guid</td><td>An address to wait for event replies from. Pass UNASSIGNED_SYSTEM_ADDRESS for all currently connected systems. Until all systems in this list have called SetEvent with this ID and true, and have this system in the list, we won't get ID_READY_EVENT_COMPLETE </td></tr>
    197. 

  197.   </table>
    198. 

  198.   </dd>
    199. 

  199. </dl>
    200. 

  200. <dl class="section return"><dt>Returns</dt><dd>True on success, false on unknown eventId (this should be considered an error) </dd></dl>
    201. 

  201. 

  202. </div>
    203. 

  203. </div>
    204. 

  204. <a class="anchor" id="ab8b4e32689f5c54d0ce7c6deed2eb7e6"></a>
    205. 

  205. <div class="memitem">
    206. 

  206. <div class="memproto">
    207. 

  207.       <table class="memname">
    208. 

  208.         <tr>
    209. 

  209.           <td class="memname">bool RakNet::ReadyEvent::DeleteEvent </td>
    210. 

  210.           <td>(</td>
    211. 

  211.           <td class="paramtype">int&#160;</td>
    212. 

  212.           <td class="paramname"><em>eventId</em></td><td>)</td>
    213. 

  213.           <td></td>
    214. 

  214.         </tr>
    215. 

  215.       </table>
    216. 

  216. </div><div class="memdoc">
    217. 

  217. <p>Deletes an event. We will no longer wait for this event, and any systems that we know have set the event will be forgotten. Call this to clear memory when events are completed and you know you will never need them again. </p>
    218. 

  218. <dl class="params"><dt>Parameters</dt><dd>
    219. 

  219.   <table class="params">
    220. 

  220.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    221. 

  221.   </table>
    222. 

  222.   </dd>
    223. 

  223. </dl>
    224. 

  224. <dl class="section return"><dt>Returns</dt><dd>True on success. False (failure) on unknown eventId </dd></dl>
    225. 

  225. 

  226. </div>
    227. 

  227. </div>
    228. 

  228. <a class="anchor" id="abc3c01527d0faf6b47e43ce0e3a0159c"></a>
    229. 

  229. <div class="memitem">
    230. 

  230. <div class="memproto">
    231. 

  231.       <table class="memname">
    232. 

  232.         <tr>
    233. 

  233.           <td class="memname">void RakNet::ReadyEvent::ForceCompletion </td>
    234. 

  234.           <td>(</td>
    235. 

  235.           <td class="paramtype">int&#160;</td>
    236. 

  236.           <td class="paramname"><em>eventId</em></td><td>)</td>
    237. 

  237.           <td></td>
    238. 

  238.         </tr>
    239. 

  239.       </table>
    240. 

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

  241. <p>When systems can call <a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent()</a> with isReady==false, it is possible for one system to return true from <a class="el" href="classRakNet_1_1ReadyEvent.html#a8c4600be8271b798ea0158cef9261462">IsEventCompleted()</a> while the other systems return false This can occur if a system <a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent()</a> with isReady==false while the completion message is still being transmitted. If your game has the situation where some action should be taken on all systems when <a class="el" href="classRakNet_1_1ReadyEvent.html#a8c4600be8271b798ea0158cef9261462">IsEventCompleted()</a> is true for any system, then call <a class="el" href="classRakNet_1_1ReadyEvent.html#abc3c01527d0faf6b47e43ce0e3a0159c">ForceCompletion()</a> when the action begins. This will force all systems to return true from <a class="el" href="classRakNet_1_1ReadyEvent.html#a8c4600be8271b798ea0158cef9261462">IsEventCompleted()</a>. </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">eventId</td><td>A user-defined identifier to immediately set as completed </td></tr>
    245. 

  245.   </table>
    246. 

  246.   </dd>
    247. 

  247. </dl>
    248. 

  248. 

  249. </div>
    250. 

  250. </div>
    251. 

  251. <a class="anchor" id="adb53c9c21d8e88b1a5fbb3e241fe5f91"></a>
    252. 

  252. <div class="memitem">
    253. 

  253. <div class="memproto">
    254. 

  254.       <table class="memname">
    255. 

  255.         <tr>
    256. 

  256.           <td class="memname">int RakNet::ReadyEvent::GetEventAtIndex </td>
    257. 

  257.           <td>(</td>
    258. 

  258.           <td class="paramtype">unsigned&#160;</td>
    259. 

  259.           <td class="paramname"><em>index</em></td><td>)</td>
    260. 

  260.           <td> const</td>
    261. 

  261.         </tr>
    262. 

  262.       </table>
    263. 

  263. </div><div class="memdoc">
    264. 

  264. <p>Returns the event ID stored at a particular index. EventIDs are stored sorted from least to greatest. </p>
    265. 

  265. <dl class="params"><dt>Parameters</dt><dd>
    266. 

  266.   <table class="params">
    267. 

  267.     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index into the array, from 0 to <a class="el" href="classRakNet_1_1ReadyEvent.html#ad56242dec80dd75f05c1eb96458e0bf8">GetEventListSize()</a> </td></tr>
    268. 

  268.   </table>
    269. 

  269.   </dd>
    270. 

  270. </dl>
    271. 

  271. <dl class="section return"><dt>Returns</dt><dd>The event ID stored at a particular index </dd></dl>
    272. 

  272. 

  273. </div>
    274. 

  274. </div>
    275. 

  275. <a class="anchor" id="ad56242dec80dd75f05c1eb96458e0bf8"></a>
    276. 

  276. <div class="memitem">
    277. 

  277. <div class="memproto">
    278. 

  278.       <table class="memname">
    279. 

  279.         <tr>
    280. 

  280.           <td class="memname">unsigned RakNet::ReadyEvent::GetEventListSize </td>
    281. 

  281.           <td>(</td>
    282. 

  282.           <td class="paramtype">void&#160;</td>
    283. 

  283.           <td class="paramname"></td><td>)</td>
    284. 

  284.           <td> const</td>
    285. 

  285.         </tr>
    286. 

  286.       </table>
    287. 

  287. </div><div class="memdoc">
    288. 

  288. <p>Returns the total number of events stored in the system. </p>
    289. 

  289. <dl class="section return"><dt>Returns</dt><dd>The total number of events stored in the system. </dd></dl>
    290. 

  290. 

  291. </div>
    292. 

  292. </div>
    293. 

  293. <a class="anchor" id="af38ea2b77651a37774e31bdbf5d663de"></a>
    294. 

  294. <div class="memitem">
    295. 

  295. <div class="memproto">
    296. 

  296.       <table class="memname">
    297. 

  297.         <tr>
    298. 

  298.           <td class="memname"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> RakNet::ReadyEvent::GetFromWaitListAtIndex </td>
    299. 

  299.           <td>(</td>
    300. 

  300.           <td class="paramtype">int&#160;</td>
    301. 

  301.           <td class="paramname"><em>eventId</em>, </td>
    302. 

  302.         </tr>
    303. 

  303.         <tr>
    304. 

  304.           <td class="paramkey"></td>
    305. 

  305.           <td></td>
    306. 

  306.           <td class="paramtype">unsigned&#160;</td>
    307. 

  307.           <td class="paramname"><em>index</em>&#160;</td>
    308. 

  308.         </tr>
    309. 

  309.         <tr>
    310. 

  310.           <td></td>
    311. 

  311.           <td>)</td>
    312. 

  312.           <td></td><td> const</td>
    313. 

  313.         </tr>
    314. 

  314.       </table>
    315. 

  315. </div><div class="memdoc">
    316. 

  316. <p>Returns the system address of a system at a particular index, for this event. </p>
    317. 

  317. <dl class="params"><dt>Parameters</dt><dd>
    318. 

  318.   <table class="params">
    319. 

  319.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    320. 

  320.     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index into the array, from 0 to GetWaitListSize() </td></tr>
    321. 

  321.   </table>
    322. 

  322.   </dd>
    323. 

  323. </dl>
    324. 

  324. <dl class="section return"><dt>Returns</dt><dd>The system address of a system at a particular index, for this event. </dd></dl>
    325. 

  325. 

  326. </div>
    327. 

  327. </div>
    328. 

  328. <a class="anchor" id="a43a6b3450223af740ef2a66bb3db6f87"></a>
    329. 

  329. <div class="memitem">
    330. 

  330. <div class="memproto">
    331. 

  331.       <table class="memname">
    332. 

  332.         <tr>
    333. 

  333.           <td class="memname"><a class="el" href="group__READY__EVENT__GROUP.html#gaf87e91389822570de07c01ccb37b0bbf">ReadyEventSystemStatus</a> RakNet::ReadyEvent::GetReadyStatus </td>
    334. 

  334.           <td>(</td>
    335. 

  335.           <td class="paramtype">int&#160;</td>
    336. 

  336.           <td class="paramname"><em>eventId</em>, </td>
    337. 

  337.         </tr>
    338. 

  338.         <tr>
    339. 

  339.           <td class="paramkey"></td>
    340. 

  340.           <td></td>
    341. 

  341.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    342. 

  342.           <td class="paramname"><em>guid</em>&#160;</td>
    343. 

  343.         </tr>
    344. 

  344.         <tr>
    345. 

  345.           <td></td>
    346. 

  346.           <td>)</td>
    347. 

  347.           <td></td><td></td>
    348. 

  348.         </tr>
    349. 

  349.       </table>
    350. 

  350. </div><div class="memdoc">
    351. 

  351. <p>For a remote system, find out what their ready status is (waiting, signaled, complete). </p>
    352. 

  352. <dl class="params"><dt>Parameters</dt><dd>
    353. 

  353.   <table class="params">
    354. 

  354.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    355. 

  355.     <tr><td class="paramdir">[in]</td><td class="paramname">guid</td><td>Which system we are checking up on </td></tr>
    356. 

  356.   </table>
    357. 

  357.   </dd>
    358. 

  358. </dl>
    359. 

  359. <dl class="section return"><dt>Returns</dt><dd>The status of this system, for this particular event. </dd></dl>
    360. 

  360. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__READY__EVENT__GROUP.html#gaf87e91389822570de07c01ccb37b0bbf">ReadyEventSystemStatus</a> </dd></dl>
    361. 

  361. 

  362. </div>
    363. 

  363. </div>
    364. 

  364. <a class="anchor" id="ab620a94cd56f7a6a82aa5e680322cb89"></a>
    365. 

  365. <div class="memitem">
    366. 

  366. <div class="memproto">
    367. 

  367.       <table class="memname">
    368. 

  368.         <tr>
    369. 

  369.           <td class="memname">unsigned RakNet::ReadyEvent::GetRemoteWaitListSize </td>
    370. 

  370.           <td>(</td>
    371. 

  371.           <td class="paramtype">int&#160;</td>
    372. 

  372.           <td class="paramname"><em>eventId</em></td><td>)</td>
    373. 

  373.           <td> const</td>
    374. 

  374.         </tr>
    375. 

  375.       </table>
    376. 

  376. </div><div class="memdoc">
    377. 

  377. <p>Returns the total number of systems we are waiting on for this event. Does not include yourself </p>
    378. 

  378. <dl class="params"><dt>Parameters</dt><dd>
    379. 

  379.   <table class="params">
    380. 

  380.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    381. 

  381.   </table>
    382. 

  382.   </dd>
    383. 

  383. </dl>
    384. 

  384. <dl class="section return"><dt>Returns</dt><dd>The total number of systems we are waiting on for this event. </dd></dl>
    385. 

  385. 

  386. </div>
    387. 

  387. </div>
    388. 

  388. <a class="anchor" id="ad10f179c0565882651ca2bde5bf50a45"></a>
    389. 

  389. <div class="memitem">
    390. 

  390. <div class="memproto">
    391. 

  391.       <table class="memname">
    392. 

  392.         <tr>
    393. 

  393.           <td class="memname">bool RakNet::ReadyEvent::HasEvent </td>
    394. 

  394.           <td>(</td>
    395. 

  395.           <td class="paramtype">int&#160;</td>
    396. 

  396.           <td class="paramname"><em>eventId</em></td><td>)</td>
    397. 

  397.           <td></td>
    398. 

  398.         </tr>
    399. 

  399.       </table>
    400. 

  400. </div><div class="memdoc">
    401. 

  401. <p>Returns if this is a known event. Events may be known even if we never ourselves referenced them with SetEvent, because other systems created them via ID_READY_EVENT_SET. </p>
    402. 

  402. <dl class="params"><dt>Parameters</dt><dd>
    403. 

  403.   <table class="params">
    404. 

  404.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    405. 

  405.   </table>
    406. 

  406.   </dd>
    407. 

  407. </dl>
    408. 

  408. <dl class="section return"><dt>Returns</dt><dd>true if we have this event, false otherwise </dd></dl>
    409. 

  409. 

  410. </div>
    411. 

  411. </div>
    412. 

  412. <a class="anchor" id="a8c4600be8271b798ea0158cef9261462"></a>
    413. 

  413. <div class="memitem">
    414. 

  414. <div class="memproto">
    415. 

  415.       <table class="memname">
    416. 

  416.         <tr>
    417. 

  417.           <td class="memname">bool RakNet::ReadyEvent::IsEventCompleted </td>
    418. 

  418.           <td>(</td>
    419. 

  419.           <td class="paramtype">int&#160;</td>
    420. 

  420.           <td class="paramname"><em>eventId</em></td><td>)</td>
    421. 

  421.           <td> const</td>
    422. 

  422.         </tr>
    423. 

  423.       </table>
    424. 

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

  425. <p>Returns if the wait list is a subset of the completion list. Call this after all systems you want to wait for have been added with AddToWaitList If you are waiting for a specific number of systems (such as players later connecting), also check GetRemoteWaitListSize(eventId) to be equal to 1 less than the total number of participants. </p>
    426. 

  426. <dl class="params"><dt>Parameters</dt><dd>
    427. 

  427.   <table class="params">
    428. 

  428.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    429. 

  429.   </table>
    430. 

  430.   </dd>
    431. 

  431. </dl>
    432. 

  432. <dl class="section return"><dt>Returns</dt><dd>True on completion. False (failure) on unknown eventId, or the set is not completed. </dd></dl>
    433. 

  433. 

  434. </div>
    435. 

  435. </div>
    436. 

  436. <a class="anchor" id="a90747ab26a89d426317dfa1d4f414fde"></a>
    437. 

  437. <div class="memitem">
    438. 

  438. <div class="memproto">
    439. 

  439.       <table class="memname">
    440. 

  440.         <tr>
    441. 

  441.           <td class="memname">bool RakNet::ReadyEvent::IsEventCompletionProcessing </td>
    442. 

  442.           <td>(</td>
    443. 

  443.           <td class="paramtype">int&#160;</td>
    444. 

  444.           <td class="paramname"><em>eventId</em></td><td>)</td>
    445. 

  445.           <td> const</td>
    446. 

  446.         </tr>
    447. 

  447.       </table>
    448. 

  448. </div><div class="memdoc">
    449. 

  449. <p>Returns if the event is about to be ready and we are negotiating the final packets. This will usually only be true for a very short time, after which IsEventCompleted should return true. While this is true you cannot add to the wait list, or <a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent()</a> isReady to false anymore. </p>
    450. 

  450. <dl class="params"><dt>Parameters</dt><dd>
    451. 

  451.   <table class="params">
    452. 

  452.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    453. 

  453.   </table>
    454. 

  454.   </dd>
    455. 

  455. </dl>
    456. 

  456. <dl class="section return"><dt>Returns</dt><dd>True if any other system has completed processing. Will always be true if <a class="el" href="classRakNet_1_1ReadyEvent.html#a8c4600be8271b798ea0158cef9261462">IsEventCompleted()</a> is true </dd></dl>
    457. 

  457. 

  458. </div>
    459. 

  459. </div>
    460. 

  460. <a class="anchor" id="a3e316ae7568001e5c2d9624f156a2ee8"></a>
    461. 

  461. <div class="memitem">
    462. 

  462. <div class="memproto">
    463. 

  463.       <table class="memname">
    464. 

  464.         <tr>
    465. 

  465.           <td class="memname">bool RakNet::ReadyEvent::IsEventSet </td>
    466. 

  466.           <td>(</td>
    467. 

  467.           <td class="paramtype">int&#160;</td>
    468. 

  468.           <td class="paramname"><em>eventId</em></td><td>)</td>
    469. 

  469.           <td></td>
    470. 

  470.         </tr>
    471. 

  471.       </table>
    472. 

  472. </div><div class="memdoc">
    473. 

  473. <p>Returns what was passed to <a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent()</a> </p>
    474. 

  474. <dl class="section return"><dt>Returns</dt><dd>The value of isReady passed to <a class="el" href="classRakNet_1_1ReadyEvent.html#af7caed0bdee19e21bdd91ff34ff73b31">SetEvent()</a>. Also returns false on unknown event. </dd></dl>
    475. 

  475. 

  476. </div>
    477. 

  477. </div>
    478. 

  478. <a class="anchor" id="a1b1d658e1be6b128b013c20eed2bf580"></a>
    479. 

  479. <div class="memitem">
    480. 

  480. <div class="memproto">
    481. 

  481.       <table class="memname">
    482. 

  482.         <tr>
    483. 

  483.           <td class="memname">bool RakNet::ReadyEvent::IsInWaitList </td>
    484. 

  484.           <td>(</td>
    485. 

  485.           <td class="paramtype">int&#160;</td>
    486. 

  486.           <td class="paramname"><em>eventId</em>, </td>
    487. 

  487.         </tr>
    488. 

  488.         <tr>
    489. 

  489.           <td class="paramkey"></td>
    490. 

  490.           <td></td>
    491. 

  491.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    492. 

  492.           <td class="paramname"><em>guid</em>&#160;</td>
    493. 

  493.         </tr>
    494. 

  494.         <tr>
    495. 

  495.           <td></td>
    496. 

  496.           <td>)</td>
    497. 

  497.           <td></td><td></td>
    498. 

  498.         </tr>
    499. 

  499.       </table>
    500. 

  500. </div><div class="memdoc">
    501. 

  501. <p>Returns if a particular system is waiting on a particular event. </p>
    502. 

  502. <dl class="params"><dt>Parameters</dt><dd>
    503. 

  503.   <table class="params">
    504. 

  504.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier </td></tr>
    505. 

  505.     <tr><td class="paramdir">[in]</td><td class="paramname">guid</td><td>The system we are checking up on </td></tr>
    506. 

  506.   </table>
    507. 

  507.   </dd>
    508. 

  508. </dl>
    509. 

  509. <dl class="section return"><dt>Returns</dt><dd>True if this system is waiting on this event, false otherwise. </dd></dl>
    510. 

  510. 

  511. </div>
    512. 

  512. </div>
    513. 

  513. <a class="anchor" id="acf26f69ce62bcbfe5077c61aa2c40f45"></a>
    514. 

  514. <div class="memitem">
    515. 

  515. <div class="memproto">
    516. 

  516. <table class="mlabels">
    517. 

  517.   <tr>
    518. 

  518.   <td class="mlabels-left">
    519. 

  519.       <table class="memname">
    520. 

  520.         <tr>
    521. 

  521.           <td class="memname">virtual void RakNet::ReadyEvent::OnClosedConnection </td>
    522. 

  522.           <td>(</td>
    523. 

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

  524.           <td class="paramname"><em>systemAddress</em>, </td>
    525. 

  525.         </tr>
    526. 

  526.         <tr>
    527. 

  527.           <td class="paramkey"></td>
    528. 

  528.           <td></td>
    529. 

  529.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    530. 

  530.           <td class="paramname"><em>rakNetGUID</em>, </td>
    531. 

  531.         </tr>
    532. 

  532.         <tr>
    533. 

  533.           <td class="paramkey"></td>
    534. 

  534.           <td></td>
    535. 

  535.           <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a>&#160;</td>
    536. 

  536.           <td class="paramname"><em>lostConnectionReason</em>&#160;</td>
    537. 

  537.         </tr>
    538. 

  538.         <tr>
    539. 

  539.           <td></td>
    540. 

  540.           <td>)</td>
    541. 

  541.           <td></td><td></td>
    542. 

  542.         </tr>
    543. 

  543.       </table>
    544. 

  544.   </td>
    545. 

  545.   <td class="mlabels-right">
    546. 

  546. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
    547. 

  547.   </tr>
    548. 

  548. </table>
    549. 

  549. </div><div class="memdoc">
    550. 

  550. <p>Called when a connection is dropped because the user called <a class="el" href="classRakNet_1_1RakPeer.html#a95e3806fce8552e322236abcf105cbf9" title="Close the connection to another host (if we initiated the connection it will disconnect, if they did it will kick them out).">RakPeer::CloseConnection()</a> for a particular system </p>
    551. 

  551. <dl class="params"><dt>Parameters</dt><dd>
    552. 

  552.   <table class="params">
    553. 

  553.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
    554. 

  554.     <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
    555. 

  555.     <tr><td class="paramdir">[in]</td><td class="paramname">lostConnectionReason</td><td>How the connection was closed: manually, connection lost, or notification of disconnection </td></tr>
    556. 

  556.   </table>
    557. 

  557.   </dd>
    558. 

  558. </dl>
    559. 

  559. 

  560. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
    561. 

  561. 

  562. </div>
    563. 

  563. </div>
    564. 

  564. <a class="anchor" id="a2dd5308b4ee75a877c53404477a3c637"></a>
    565. 

  565. <div class="memitem">
    566. 

  566. <div class="memproto">
    567. 

  567. <table class="mlabels">
    568. 

  568.   <tr>
    569. 

  569.   <td class="mlabels-left">
    570. 

  570.       <table class="memname">
    571. 

  571.         <tr>
    572. 

  572.           <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::ReadyEvent::OnReceive </td>
    573. 

  573.           <td>(</td>
    574. 

  574.           <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
    575. 

  575.           <td class="paramname"><em>packet</em></td><td>)</td>
    576. 

  576.           <td></td>
    577. 

  577.         </tr>
    578. 

  578.       </table>
    579. 

  579.   </td>
    580. 

  580.   <td class="mlabels-right">
    581. 

  581. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
    582. 

  582.   </tr>
    583. 

  583. </table>
    584. 

  584. </div><div class="memdoc">
    585. 

  585. <p>OnReceive is called for every packet. </p>
    586. 

  586. <dl class="params"><dt>Parameters</dt><dd>
    587. 

  587.   <table class="params">
    588. 

  588.     <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
    589. 

  589.   </table>
    590. 

  590.   </dd>
    591. 

  591. </dl>
    592. 

  592. <dl class="section return"><dt>Returns</dt><dd>True to allow the game and other plugins to get this message, false to absorb it </dd></dl>
    593. 

  593. 

  594. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
    595. 

  595. 

  596. </div>
    597. 

  597. </div>
    598. 

  598. <a class="anchor" id="ae7cb534890f2ab044f2b81e9b3205bc8"></a>
    599. 

  599. <div class="memitem">
    600. 

  600. <div class="memproto">
    601. 

  601.       <table class="memname">
    602. 

  602.         <tr>
    603. 

  603.           <td class="memname">bool RakNet::ReadyEvent::RemoveFromWaitList </td>
    604. 

  604.           <td>(</td>
    605. 

  605.           <td class="paramtype">int&#160;</td>
    606. 

  606.           <td class="paramname"><em>eventId</em>, </td>
    607. 

  607.         </tr>
    608. 

  608.         <tr>
    609. 

  609.           <td class="paramkey"></td>
    610. 

  610.           <td></td>
    611. 

  611.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    612. 

  612.           <td class="paramname"><em>guid</em>&#160;</td>
    613. 

  613.         </tr>
    614. 

  614.         <tr>
    615. 

  615.           <td></td>
    616. 

  616.           <td>)</td>
    617. 

  617.           <td></td><td></td>
    618. 

  618.         </tr>
    619. 

  619.       </table>
    620. 

  620. </div><div class="memdoc">
    621. 

  621. <p>Removes systems from the wait list, which should have been previously added with AddToWaitList </p>
    622. 

  622. <dl class="section note"><dt>Note</dt><dd>Systems that directly or indirectly disconnect from us are automatically removed from the wait list </dd></dl>
    623. 

  623. <dl class="params"><dt>Parameters</dt><dd>
    624. 

  624.   <table class="params">
    625. 

  625.     <tr><td class="paramdir">[in]</td><td class="paramname">guid</td><td>The system to remove from the wait list. Pass UNASSIGNED_RAKNET_GUID for all currently connected systems. </td></tr>
    626. 

  626.   </table>
    627. 

  627.   </dd>
    628. 

  628. </dl>
    629. 

  629. <dl class="section return"><dt>Returns</dt><dd>True on success, false on unknown eventId (this should be considered an error) </dd></dl>
    630. 

  630. 

  631. </div>
    632. 

  632. </div>
    633. 

  633. <a class="anchor" id="af7caed0bdee19e21bdd91ff34ff73b31"></a>
    634. 

  634. <div class="memitem">
    635. 

  635. <div class="memproto">
    636. 

  636.       <table class="memname">
    637. 

  637.         <tr>
    638. 

  638.           <td class="memname">bool RakNet::ReadyEvent::SetEvent </td>
    639. 

  639.           <td>(</td>
    640. 

  640.           <td class="paramtype">int&#160;</td>
    641. 

  641.           <td class="paramname"><em>eventId</em>, </td>
    642. 

  642.         </tr>
    643. 

  643.         <tr>
    644. 

  644.           <td class="paramkey"></td>
    645. 

  645.           <td></td>
    646. 

  646.           <td class="paramtype">bool&#160;</td>
    647. 

  647.           <td class="paramname"><em>isReady</em>&#160;</td>
    648. 

  648.         </tr>
    649. 

  649.         <tr>
    650. 

  650.           <td></td>
    651. 

  651.           <td>)</td>
    652. 

  652.           <td></td><td></td>
    653. 

  653.         </tr>
    654. 

  654.       </table>
    655. 

  655. </div><div class="memdoc">
    656. 

  656. <p>Sets or updates the initial ready state for our local system. If eventId is an unknown event the event is created. If eventId was previously used and you want to reuse it, call DeleteEvent first, or else you will keep the same event signals from before Systems previously or later added through <a class="el" href="classRakNet_1_1ReadyEvent.html#aaf6bfa53f4be43cb4d9fe40911faefdf">AddToWaitList()</a> with the same <em>eventId</em> when isReady=true will get ID_READY_EVENT_SET Systems previously added through AddToWaitList with the same <em>eventId</em> will get ID_READY_EVENT_UNSET For both ID_READY_EVENT_SET and ID_READY_EVENT_UNSET, eventId is encoded in bytes 1 through 1+sizeof(int) </p>
    657. 

  657. <dl class="params"><dt>Parameters</dt><dd>
    658. 

  658.   <table class="params">
    659. 

  659.     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>A user-defined identifier to wait on. This can be a sequence counter, an event identifier, or anything else you want. </td></tr>
    660. 

  660.     <tr><td class="paramdir">[in]</td><td class="paramname">isReady</td><td>True to signal we are ready to proceed with this event, false to unsignal </td></tr>
    661. 

  661.   </table>
    662. 

  662.   </dd>
    663. 

  663. </dl>
    664. 

  664. <dl class="section return"><dt>Returns</dt><dd>False if event status is ID_READY_EVENT_FORCE_ALL_SET, or if we are setting to a status we are already in (no change). Otherwise true </dd></dl>
    665. 

  665. 

  666. </div>
    667. 

  667. </div>
    668. 

  668. <a class="anchor" id="a6355b9958259b6e645bb335a1b7b34a1"></a>
    669. 

  669. <div class="memitem">
    670. 

  670. <div class="memproto">
    671. 

  671.       <table class="memname">
    672. 

  672.         <tr>
    673. 

  673.           <td class="memname">void RakNet::ReadyEvent::SetSendChannel </td>
    674. 

  674.           <td>(</td>
    675. 

  675.           <td class="paramtype">unsigned char&#160;</td>
    676. 

  676.           <td class="paramname"><em>newChannel</em></td><td>)</td>
    677. 

  677.           <td></td>
    678. 

  678.         </tr>
    679. 

  679.       </table>
    680. 

  680. </div><div class="memdoc">
    681. 

  681. <p>This channel will be used for all <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send</a> calls </p>
    682. 

  682. <dl class="params"><dt>Parameters</dt><dd>
    683. 

  683.   <table class="params">
    684. 

  684.     <tr><td class="paramdir">[in]</td><td class="paramname">newChannel</td><td>The channel to use for internal <a class="el" href="classRakNet_1_1RakPeer.html#a1ee7422f744ab606c92b4ed4b28db40e" title="Sends a block of data to the specified system that you are connected to.">RakPeer::Send</a> calls from this system. Defaults to 0. </td></tr>
    685. 

  685.   </table>
    686. 

  686.   </dd>
    687. 

  687. </dl>
    688. 

  688. 

  689. </div>
    690. 

  690. </div>
    691. 

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

  692. <li>D:/temp/RakNet_PC/Source/<a class="el" href="ReadyEvent_8h.html">ReadyEvent.h</a></li>
    693. 

  693. </ul>
    694. 

  694. </div><!-- contents -->
    695. 

  695. <!-- start footer part -->
    696. 

  696. <hr class="footer"/><address class="footer"><small>
    697. 

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

  698. <img class="footer" src="doxygen.png" alt="doxygen"/>
    699. 

  699. </a> 1.8.2
    700. 

  700. </small></address>
    701. 

  701. </body>
    702. 

  702. </html>
    703.
粤ICP备19079148号