📄 classphttpclient.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PHTTPClient class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PHTTPClient Class Reference</h1><code>#include <<a class="el" href="http_8h-source.html">http.h</a>></code><p><p>Inheritance diagram for PHTTPClient:<p><center><img src="classPHTTPClient.png" usemap="#PHTTPClient_map" border="0" alt=""></center><map name="PHTTPClient_map"><area href="classPHTTP.html" alt="PHTTP" shape="rect" coords="0,224,109,248"><area href="classPInternetProtocol.html" alt="PInternetProtocol" shape="rect" coords="0,168,109,192"><area href="classPIndirectChannel.html" alt="PIndirectChannel" shape="rect" coords="0,112,109,136"><area href="classPChannel.html" alt="PChannel" shape="rect" coords="0,56,109,80"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,109,24"></map><a href="classPHTTPClient-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a0">PHTTPClient</a> ()</td></tr><tr><td> </td><td><font size=-1><em>Create a new HTTP client channel.</em> <a href="#a0"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a1">PHTTPClient</a> (const <a class="el" href="classPString.html">PString</a> &<a class="el" href="classPHTTPClient.html#n0">userAgentName</a>)</td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a2">ExecuteCommand</a> (<a class="el" href="classPHTTP.html#s42">Commands</a> cmd, const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &dataBody, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMime, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a3">ExecuteCommand</a> (const <a class="el" href="classPString.html">PString</a> &cmdName, const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &dataBody, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMime, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a4">WriteCommand</a> (<a class="el" href="classPHTTP.html#s42">Commands</a> cmd, const <a class="el" href="classPString.html">PString</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &dataBody)</td></tr><tr><td> </td><td><font size=-1><em>Write a HTTP command to server.</em> <a href="#a4"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a5">WriteCommand</a> (const <a class="el" href="classPString.html">PString</a> &cmdName, const <a class="el" href="classPString.html">PString</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &dataBody)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a6">ReadResponse</a> (<a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME)</td></tr><tr><td> </td><td><font size=-1><em>Read a response from the server.</em> <a href="#a6"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a7">ReadContentBody</a> (<a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, <a class="el" href="classPBYTEArray.html">PBYTEArray</a> &body)</td></tr><tr><td> </td><td><font size=-1><em>Read the body of the HTTP command.</em> <a href="#a7"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a8">ReadContentBody</a> (<a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, <a class="el" href="classPString.html">PString</a> &body)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a9">GetTextDocument</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPString.html">PString</a> &document, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a10">GetDocument</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a11">GetHeader</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a12">PostData</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &data, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, BOOL persist=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#a13">PostData</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME, const <a class="el" href="classPString.html">PString</a> &data, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, <a class="el" href="classPString.html">PString</a> &replyBody, BOOL persist=TRUE)</td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#b0">AssureConnect</a> (const <a class="el" href="classPURL.html">PURL</a> &url, <a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &outMIME)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPHTTPClient.html#b1">InternalReadContentBody</a> (<a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> &replyMIME, <a class="el" href="classPAbstractArray.html">PAbstractArray</a> &body)</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPHTTPClient.html#n0">userAgentName</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>A TCP/IP socket for the HyperText Transfer Protocol version 1.0.<p>When acting as a client, the procedure is to make the connection to a remote server, then to retrieve a document using the following procedure: <pre><code> PHTTPSocket web("webserver"); if (web.IsOpen()) { PINDEX len; if (web.GetDocument("<a href="http://www.someone.com/somewhere/url">http://www.someone.com/somewhere/url</a>", len)) { <a class="el" href="classPString.html">PString</a> html = web.ReadString(len); if (!html.IsEmpty()) ProcessHTML(html); } else PError << "Could not get page." << endl; } else PError << "HTTP conection failed." << endl; </pre></code> <p><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="PHTTPClient::PHTTPClient"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PHTTPClient::PHTTPClient </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new HTTP client channel.<p> </td> </tr></table><a name="a1" doxytag="PHTTPClient::PHTTPClient"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PHTTPClient::PHTTPClient </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>userAgentName</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="b0" doxytag="PHTTPClient::AssureConnect"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> BOOL PHTTPClient::AssureConnect </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPURL.html">PURL</a> & </td> <td class="mdname" nowrap> <em>url</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> & </td> <td class="mdname" nowrap> <em>outMIME</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [protected]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="a3" doxytag="PHTTPClient::ExecuteCommand"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int PHTTPClient::ExecuteCommand </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>cmdName</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> & </td> <td class="mdname" nowrap> <em>url</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> & </td> <td class="mdname" nowrap> <em>outMIME</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>dataBody</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> & </td> <td class="mdname" nowrap> <em>replyMime</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>persist</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="a2" doxytag="PHTTPClient::ExecuteCommand"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int PHTTPClient::ExecuteCommand </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPHTTP.html#s42">Commands</a> </td> <td class="mdname" nowrap> <em>cmd</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPURL.html">PURL</a> & </td> <td class="mdname" nowrap> <em>url</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> & </td> <td class="mdname" nowrap> <em>outMIME</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>dataBody</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPMIMEInfo.html">PMIMEInfo</a> & </td> <td class="mdname" nowrap> <em>replyMime</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>BOOL </td> <td class="mdname" nowrap> <em>persist</em> = TRUE</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -