classRakNet_1_1HTTPConnection2.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
  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::HTTPConnection2 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_1HTTPConnection2.html">HTTPConnection2</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="classRakNet_1_1HTTPConnection2-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::HTTPConnection2 Class Reference</div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Use <a class="el" href="classRakNet_1_1HTTPConnection2.html" title="Use HTTPConnection2 to communicate with a web server.">HTTPConnection2</a> to communicate with a web server.
  61. <a href="classRakNet_1_1HTTPConnection2.html#details">More...</a></p>
  62. <p><code>#include &lt;HTTPConnection2.h&gt;</code></p>
  63. <div class="dynheader">
  64. Inheritance diagram for RakNet::HTTPConnection2:</div>
  65. <div class="dyncontent">
  66. <div class="center">
  67. <img src="classRakNet_1_1HTTPConnection2.png" usemap="#RakNet::HTTPConnection2_map" alt=""/>
  68. <map id="RakNet::HTTPConnection2_map" name="RakNet::HTTPConnection2_map">
  69. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="0,0,160,24"/>
  70. </map>
  71. </div></div>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:a04d73fc6491301a2c6110fba7731b70e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a04d73fc6491301a2c6110fba7731b70e">TransmitRequest</a> (const char *stringToTransmit, const char *host, unsigned short port=80, bool useSSL=false, int ipVersion=4, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> useAddress=<a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf">UNASSIGNED_SYSTEM_ADDRESS</a>, void *userData=0)</td></tr>
  76. <tr class="memdesc:a04d73fc6491301a2c6110fba7731b70e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to, then transmit a request to a TCP based server. <a href="#a04d73fc6491301a2c6110fba7731b70e"></a><br/></td></tr>
  77. <tr class="separator:a04d73fc6491301a2c6110fba7731b70e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a5c8097c8724bde53b2747db7e95d34fa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a5c8097c8724bde53b2747db7e95d34fa">GetResponse</a> (<a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;stringTransmitted, <a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;hostTransmitted, <a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;responseReceived, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;hostReceived, int &amp;contentOffset, void **userData)</td></tr>
  79. <tr class="memdesc:a5c8097c8724bde53b2747db7e95d34fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check for and return a response from a prior call to <a class="el" href="classRakNet_1_1HTTPConnection2.html#a04d73fc6491301a2c6110fba7731b70e" title="Connect to, then transmit a request to a TCP based server.">TransmitRequest()</a> As TCP is stream based, you may get a webserver reply over several calls to TCPInterface::Receive() <a class="el" href="classRakNet_1_1HTTPConnection2.html" title="Use HTTPConnection2 to communicate with a web server.">HTTPConnection2</a> will store <a class="el" href="structRakNet_1_1Packet.html#a63e46b85c8ca156b205a124e54659614" title="The data from the sender.">Packet::data</a> and return the response to you either when the connection to the webserver is lost, or enough data has been received() This will only potentially return true after a call to ProcessTCPPacket() or OnLostConnection() <a href="#a5c8097c8724bde53b2747db7e95d34fa"></a><br/></td></tr>
  80. <tr class="separator:a5c8097c8724bde53b2747db7e95d34fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a24b49b7b334a9ccca97b3400bd1d274f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b49b7b334a9ccca97b3400bd1d274f"></a>
  82. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a24b49b7b334a9ccca97b3400bd1d274f">IsBusy</a> (void) const </td></tr>
  83. <tr class="memdesc:a24b49b7b334a9ccca97b3400bd1d274f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return if any requests are pending. <br/></td></tr>
  84. <tr class="separator:a24b49b7b334a9ccca97b3400bd1d274f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ac80bcebbf1bcf1af228ab8c681f323c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac80bcebbf1bcf1af228ab8c681f323c8"></a>
  86. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#ac80bcebbf1bcf1af228ab8c681f323c8">HasResponse</a> (void) const </td></tr>
  87. <tr class="memdesc:ac80bcebbf1bcf1af228ab8c681f323c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return if any requests are waiting to be read by the user. <br/></td></tr>
  88. <tr class="separator:ac80bcebbf1bcf1af228ab8c681f323c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a3cc77b3be727d87abb8434b01a842445"><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_1HTTPConnection2.html#a3cc77b3be727d87abb8434b01a842445">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
  90. <tr class="separator:a3cc77b3be727d87abb8434b01a842445"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a12113e000659a90d54680e8c18cfc61e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a12113e000659a90d54680e8c18cfc61e">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>
  92. <tr class="separator:a12113e000659a90d54680e8c18cfc61e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a0326c1416cbbe7d488950a190b7e6e7f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a0326c1416cbbe7d488950a190b7e6e7f">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>
  94. <tr class="separator:a0326c1416cbbe7d488950a190b7e6e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a150039bb124bdb840dfc3aa37787a1fa"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1HTTPConnection2.html#a150039bb124bdb840dfc3aa37787a1fa">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>
  96. <tr class="separator:a150039bb124bdb840dfc3aa37787a1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
  99. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
  100. <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>
  101. <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73d686ffe9a04a74e5a0ce78422c60f2"></a>
  103. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a73d686ffe9a04a74e5a0ce78422c60f2">OnDetach</a> (void)</td></tr>
  104. <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>
  105. <tr class="separator:a73d686ffe9a04a74e5a0ce78422c60f2 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9587824d39ac045173442dbbc32051da"></a>
  107. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9587824d39ac045173442dbbc32051da">Update</a> (void)</td></tr>
  108. <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>
  109. <tr class="separator:a9587824d39ac045173442dbbc32051da inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
  111. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
  112. <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>
  113. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
  115. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
  116. <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>
  117. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table>
  133. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  134. <div class="textblock"><p>Use <a class="el" href="classRakNet_1_1HTTPConnection2.html" title="Use HTTPConnection2 to communicate with a web server.">HTTPConnection2</a> to communicate with a web server. </p>
  135. <p>Start an instance of TCPInterface via the Start() command. This class will handle connecting to transmit a request </p>
  136. </div><h2 class="groupheader">Member Function Documentation</h2>
  137. <a class="anchor" id="a5c8097c8724bde53b2747db7e95d34fa"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">bool RakNet::HTTPConnection2::GetResponse </td>
  143. <td>(</td>
  144. <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;&#160;</td>
  145. <td class="paramname"><em>stringTransmitted</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;&#160;</td>
  151. <td class="paramname"><em>hostTransmitted</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakString</a> &amp;&#160;</td>
  157. <td class="paramname"><em>responseReceived</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  163. <td class="paramname"><em>hostReceived</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">int &amp;&#160;</td>
  169. <td class="paramname"><em>contentOffset</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">void **&#160;</td>
  175. <td class="paramname"><em>userData</em>&#160;</td>
  176. </tr>
  177. <tr>
  178. <td></td>
  179. <td>)</td>
  180. <td></td><td></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Check for and return a response from a prior call to <a class="el" href="classRakNet_1_1HTTPConnection2.html#a04d73fc6491301a2c6110fba7731b70e" title="Connect to, then transmit a request to a TCP based server.">TransmitRequest()</a> As TCP is stream based, you may get a webserver reply over several calls to TCPInterface::Receive() <a class="el" href="classRakNet_1_1HTTPConnection2.html" title="Use HTTPConnection2 to communicate with a web server.">HTTPConnection2</a> will store <a class="el" href="structRakNet_1_1Packet.html#a63e46b85c8ca156b205a124e54659614" title="The data from the sender.">Packet::data</a> and return the response to you either when the connection to the webserver is lost, or enough data has been received() This will only potentially return true after a call to ProcessTCPPacket() or OnLostConnection() </p>
  185. <dl class="params"><dt>Parameters</dt><dd>
  186. <table class="params">
  187. <tr><td class="paramdir">[out]</td><td class="paramname">stringTransmitted</td><td>The original string transmitted </td></tr>
  188. <tr><td class="paramdir">[out]</td><td class="paramname">hostTransmitted</td><td>The parameter of the same name passed to <a class="el" href="classRakNet_1_1HTTPConnection2.html#a04d73fc6491301a2c6110fba7731b70e" title="Connect to, then transmit a request to a TCP based server.">TransmitRequest()</a> </td></tr>
  189. <tr><td class="paramdir">[out]</td><td class="paramname">responseReceived</td><td>The response, if any </td></tr>
  190. <tr><td class="paramdir">[out]</td><td class="paramname">hostReceived</td><td>The <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> from ProcessTCPPacket() or OnLostConnection() </td></tr>
  191. <tr><td class="paramdir">[out]</td><td class="paramname">contentOffset</td><td>The offset from the start of responseReceived to the data body. Equivalent to searching for <br/>
  192. <br/>
  193. in responseReceived. </td></tr>
  194. <tr><td class="paramdir">[out]</td><td class="paramname">userData</td><td>Whatever you passed to TransmitRequest </td></tr>
  195. </table>
  196. </dd>
  197. </dl>
  198. <dl class="section return"><dt>Returns</dt><dd>true if there was a response. false if not. </dd></dl>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a12113e000659a90d54680e8c18cfc61e"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">virtual void RakNet::HTTPConnection2::OnClosedConnection </td>
  210. <td>(</td>
  211. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  212. <td class="paramname"><em>systemAddress</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  218. <td class="paramname"><em>rakNetGUID</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a>&#160;</td>
  224. <td class="paramname"><em>lostConnectionReason</em>&#160;</td>
  225. </tr>
  226. <tr>
  227. <td></td>
  228. <td>)</td>
  229. <td></td><td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <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>
  239. <dl class="params"><dt>Parameters</dt><dd>
  240. <table class="params">
  241. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
  242. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
  243. <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>
  244. </table>
  245. </dd>
  246. </dl>
  247. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
  248. </div>
  249. </div>
  250. <a class="anchor" id="a150039bb124bdb840dfc3aa37787a1fa"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">virtual void RakNet::HTTPConnection2::OnFailedConnectionAttempt </td>
  259. <td>(</td>
  260. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  261. <td class="paramname"><em>packet</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga3e92f686bace869b78c10508c58e0825">PI2_FailedConnectionAttemptReason</a>&#160;</td>
  267. <td class="paramname"><em>failedConnectionAttemptReason</em>&#160;</td>
  268. </tr>
  269. <tr>
  270. <td></td>
  271. <td>)</td>
  272. <td></td><td></td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Called when a connection attempt fails </p>
  282. <dl class="params"><dt>Parameters</dt><dd>
  283. <table class="params">
  284. <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td><a class="el" href="structRakNet_1_1Packet.html" title="This represents a user message from another system.">Packet</a> to be returned to the user </td></tr>
  285. <tr><td class="paramdir">[in]</td><td class="paramname">failedConnectionReason</td><td>Why the connection failed </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a9504489498df14b6efa5ca9bd39aede4">RakNet::PluginInterface2</a>.</p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="a0326c1416cbbe7d488950a190b7e6e7f"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">virtual void RakNet::HTTPConnection2::OnNewConnection </td>
  301. <td>(</td>
  302. <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
  303. <td class="paramname"><em>systemAddress</em>, </td>
  304. </tr>
  305. <tr>
  306. <td class="paramkey"></td>
  307. <td></td>
  308. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  309. <td class="paramname"><em>rakNetGUID</em>, </td>
  310. </tr>
  311. <tr>
  312. <td class="paramkey"></td>
  313. <td></td>
  314. <td class="paramtype">bool&#160;</td>
  315. <td class="paramname"><em>isIncoming</em>&#160;</td>
  316. </tr>
  317. <tr>
  318. <td></td>
  319. <td>)</td>
  320. <td></td><td></td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>Called when we got a new connection </p>
  330. <dl class="params"><dt>Parameters</dt><dd>
  331. <table class="params">
  332. <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>Address of the new connection </td></tr>
  333. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
  334. <tr><td class="paramdir">[in]</td><td class="paramname">isIncoming</td><td>If true, this is ID_NEW_INCOMING_CONNECTION, or the equivalent </td></tr>
  335. </table>
  336. </dd>
  337. </dl>
  338. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#abf13327cc10f772ba06dff8f2687f8ae">RakNet::PluginInterface2</a>.</p>
  339. </div>
  340. </div>
  341. <a class="anchor" id="a3cc77b3be727d87abb8434b01a842445"></a>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::HTTPConnection2::OnReceive </td>
  350. <td>(</td>
  351. <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
  352. <td class="paramname"><em>packet</em></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>OnReceive is called for every packet. </p>
  363. <dl class="params"><dt>Parameters</dt><dd>
  364. <table class="params">
  365. <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. <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>
  370. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a04d73fc6491301a2c6110fba7731b70e"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname">bool RakNet::HTTPConnection2::TransmitRequest </td>
  379. <td>(</td>
  380. <td class="paramtype">const char *&#160;</td>
  381. <td class="paramname"><em>stringToTransmit</em>, </td>
  382. </tr>
  383. <tr>
  384. <td class="paramkey"></td>
  385. <td></td>
  386. <td class="paramtype">const char *&#160;</td>
  387. <td class="paramname"><em>host</em>, </td>
  388. </tr>
  389. <tr>
  390. <td class="paramkey"></td>
  391. <td></td>
  392. <td class="paramtype">unsigned short&#160;</td>
  393. <td class="paramname"><em>port</em> = <code>80</code>, </td>
  394. </tr>
  395. <tr>
  396. <td class="paramkey"></td>
  397. <td></td>
  398. <td class="paramtype">bool&#160;</td>
  399. <td class="paramname"><em>useSSL</em> = <code>false</code>, </td>
  400. </tr>
  401. <tr>
  402. <td class="paramkey"></td>
  403. <td></td>
  404. <td class="paramtype">int&#160;</td>
  405. <td class="paramname"><em>ipVersion</em> = <code>4</code>, </td>
  406. </tr>
  407. <tr>
  408. <td class="paramkey"></td>
  409. <td></td>
  410. <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
  411. <td class="paramname"><em>useAddress</em> = <code><a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf">UNASSIGNED_SYSTEM_ADDRESS</a></code>, </td>
  412. </tr>
  413. <tr>
  414. <td class="paramkey"></td>
  415. <td></td>
  416. <td class="paramtype">void *&#160;</td>
  417. <td class="paramname"><em>userData</em> = <code>0</code>&#160;</td>
  418. </tr>
  419. <tr>
  420. <td></td>
  421. <td>)</td>
  422. <td></td><td></td>
  423. </tr>
  424. </table>
  425. </div><div class="memdoc">
  426. <p>Connect to, then transmit a request to a TCP based server. </p>
  427. <dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramdir">[in]</td><td class="paramname">tcp</td><td>An instance of TCPInterface that previously had TCPInterface::Start() called </td></tr>
  430. <tr><td class="paramdir">[in]</td><td class="paramname">stringToTransmit</td><td>What string to transmit. See <a class="el" href="classRakNet_1_1RakString.html#a579954736686dae1626bf7d882554e73">RakString::FormatForPOST()</a>, <a class="el" href="classRakNet_1_1RakString.html#aff1544a8a50d06edecbc61073d88a3c6">RakString::FormatForGET()</a>, <a class="el" href="classRakNet_1_1RakString.html#ae4df821fd3d2759c66f204f301269aa4">RakString::FormatForDELETE()</a> </td></tr>
  431. <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The IP address to connect to </td></tr>
  432. <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The port to connect to </td></tr>
  433. <tr><td class="paramdir">[in]</td><td class="paramname">useSSL</td><td>If to use SSL to connect. OPEN_SSL_CLIENT_SUPPORT must be defined to 1 in RakNetDefines.h or RakNetDefinesOverrides.h </td></tr>
  434. <tr><td class="paramdir">[in]</td><td class="paramname">ipVersion</td><td>4 for IPV4, 6 for IPV6 </td></tr>
  435. <tr><td class="paramdir">[in]</td><td class="paramname">useAddress</td><td>Assume we are connected to this address and send to it, rather than do a lookup </td></tr>
  436. <tr><td class="paramdir">[in]</td><td class="paramname">userData</td><td></td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <dl class="section return"><dt>Returns</dt><dd>false if host is not a valid IP address or domain name </dd></dl>
  441. </div>
  442. </div>
  443. <hr/>The documentation for this class was generated from the following file:<ul>
  444. <li>D:/temp/RakNet_PC/Source/<a class="el" href="HTTPConnection2_8h.html">HTTPConnection2.h</a></li>
  445. </ul>
  446. </div><!-- contents -->
  447. <!-- start footer part -->
  448. <hr class="footer"/><address class="footer"><small>
  449. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  450. <img class="footer" src="doxygen.png" alt="doxygen"/>
  451. </a> 1.8.2
  452. </small></address>
  453. </body>
  454. </html>
粤ICP备19079148号