📄 classpion_1_1_h_t_t_p_request.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>libpion: pion::HTTPRequest Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><div class="nav"><a class="el" href="namespacepion.html">pion</a>::<a class="el" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a></div><h1>pion::HTTPRequest Class Reference</h1><!-- doxytag: class="pion::HTTPRequest" --><code>#include <<a class="el" href="_h_t_t_p_request_8hpp-source.html">HTTPRequest.hpp</a>></code><p><a href="classpion_1_1_h_t_t_p_request-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><a class="el" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a>: container for HTTP request information <p><p>Definition at line <a class="el" href="_h_t_t_p_request_8hpp-source.html#l00026">26</a> of file <a class="el" href="_h_t_t_p_request_8hpp-source.html">HTTPRequest.hpp</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c53b5631b432d00013b92fe3067083f4"></a><!-- doxytag: member="pion::HTTPRequest::~HTTPRequest" ref="c53b5631b432d00013b92fe3067083f4" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#c53b5631b432d00013b92fe3067083f4">~HTTPRequest</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf864205c9e7b20782eaaba727169fe7"></a><!-- doxytag: member="pion::HTTPRequest::getMethod" ref="bf864205c9e7b20782eaaba727169fe7" args="(void) const " -->const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#bf864205c9e7b20782eaaba727169fe7">getMethod</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the request method (i.e. GET, POST, PUT) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83a06412d1964da204a3aa79e3c47d69"></a><!-- doxytag: member="pion::HTTPRequest::getResource" ref="83a06412d1964da204a3aa79e3c47d69" args="(void) const " -->const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#83a06412d1964da204a3aa79e3c47d69">getResource</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the resource uri-stem requested <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34b9b383dfdbba5095e9ac2fa205f192"></a><!-- doxytag: member="pion::HTTPRequest::getQueryString" ref="34b9b383dfdbba5095e9ac2fa205f192" args="(void) const " -->const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#34b9b383dfdbba5095e9ac2fa205f192">getQueryString</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the uri-query or query string requested <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b25a2cba3f009d101e0d0104e5d5c2ab"></a><!-- doxytag: member="pion::HTTPRequest::getVersionMajor" ref="b25a2cba3f009d101e0d0104e5d5c2ab" args="(void) const " -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#b25a2cba3f009d101e0d0104e5d5c2ab">getVersionMajor</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the request's major HTTP version number <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff4ce1dcd203aeb6ff30332aac309583"></a><!-- doxytag: member="pion::HTTPRequest::getVersionMinor" ref="ff4ce1dcd203aeb6ff30332aac309583" args="(void) const " -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#ff4ce1dcd203aeb6ff30332aac309583">getVersionMinor</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the request's minor HTTP version number <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0fee4867962fa7fefbc90042474e34d0"></a><!-- doxytag: member="pion::HTTPRequest::getContentLength" ref="0fee4867962fa7fefbc90042474e34d0" args="(void) const " -->unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#0fee4867962fa7fefbc90042474e34d0">getContentLength</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the length of the POST content (in bytes) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#c991eccda91ef150e9ca04dac39ac2db">getPostContent</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fed7a4e767c2d5a087ae505532930bf0"></a><!-- doxytag: member="pion::HTTPRequest::getHeader" ref="fed7a4e767c2d5a087ae505532930bf0" args="(const std::string &key) const " -->const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#fed7a4e767c2d5a087ae505532930bf0">getHeader</a> (const std::string &key) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns a value for the header if any are defined; otherwise, an empty string <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a39588937eb77370aaa1f8ceaf50385f"></a><!-- doxytag: member="pion::HTTPRequest::getQuery" ref="a39588937eb77370aaa1f8ceaf50385f" args="(const std::string &key) const " -->const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#a39588937eb77370aaa1f8ceaf50385f">getQuery</a> (const std::string &key) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns a value for the query key if any are defined; otherwise, an empty string <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#a211a6b511a24dfb13196effc96483b9">getCookie</a> (const std::string &key) const </td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb32619c02effae2c0f4df0f0230566c"></a><!-- doxytag: member="pion::HTTPRequest::getHeaders" ref="eb32619c02effae2c0f4df0f0230566c" args="(void)" --><a class="el" href="structpion_1_1_h_t_t_p_types.html#04764395d3025e0c796c4b328e886d03">HTTPTypes::Headers</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#eb32619c02effae2c0f4df0f0230566c">getHeaders</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the HTTP request headers <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="742751d93afae00a30138528734cb8bd"></a><!-- doxytag: member="pion::HTTPRequest::getQueryParams" ref="742751d93afae00a30138528734cb8bd" args="(void)" --><a class="el" href="structpion_1_1_h_t_t_p_types.html#76461bc9a17ce90abb016c3a5b7d7bee">HTTPTypes::QueryParams</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#742751d93afae00a30138528734cb8bd">getQueryParams</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the query parameters <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="737c8054d90b071d008fedf485c37919"></a><!-- doxytag: member="pion::HTTPRequest::getCookieParams" ref="737c8054d90b071d008fedf485c37919" args="(void)" --><a class="el" href="structpion_1_1_h_t_t_p_types.html#ce1e6366bc601e16a0a10d61f5d690f9">HTTPTypes::CookieParams</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#737c8054d90b071d008fedf485c37919">getCookieParams</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the cookie parameters <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3158c7de53f3a25baf0b3b30fd5da32e"></a><!-- doxytag: member="pion::HTTPRequest::hasHeader" ref="3158c7de53f3a25baf0b3b30fd5da32e" args="(const std::string &key) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#3158c7de53f3a25baf0b3b30fd5da32e">hasHeader</a> (const std::string &key) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if at least one value for the header is defined <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aae9030d060c83c4284d4b3cf6dbddf"></a><!-- doxytag: member="pion::HTTPRequest::hasQuery" ref="0aae9030d060c83c4284d4b3cf6dbddf" args="(const std::string &key) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#0aae9030d060c83c4284d4b3cf6dbddf">hasQuery</a> (const std::string &key) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if at least one value for the query key is defined <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#b8dd3d1c0b81d7a9c2e59c597adddf3c">hasCookie</a> (const std::string &key) const </td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05246258ac225ad41abd4df99e62bef6"></a><!-- doxytag: member="pion::HTTPRequest::isValid" ref="05246258ac225ad41abd4df99e62bef6" args="(void) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#05246258ac225ad41abd4df99e62bef6">isValid</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the request is valid <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc3c4ebf220c9cad96d29b85afda8c5d"></a><!-- doxytag: member="pion::HTTPRequest::setMethod" ref="bc3c4ebf220c9cad96d29b85afda8c5d" args="(const std::string &str)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#bc3c4ebf220c9cad96d29b85afda8c5d">setMethod</a> (const std::string &str)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the HTTP request method (i.e. GET, POST, PUT) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac7d927b4f3f0041f278a3ea43e4708e"></a><!-- doxytag: member="pion::HTTPRequest::setResource" ref="ac7d927b4f3f0041f278a3ea43e4708e" args="(const std::string &str)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#ac7d927b4f3f0041f278a3ea43e4708e">setResource</a> (const std::string &str)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the resource or uri-stem requested <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30eb2a25bee0aa302e741d6f28d2c5d7"></a><!-- doxytag: member="pion::HTTPRequest::setQueryString" ref="30eb2a25bee0aa302e741d6f28d2c5d7" args="(const std::string &str)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#30eb2a25bee0aa302e741d6f28d2c5d7">setQueryString</a> (const std::string &str)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the uri-query or query string requested <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c5f7e7d15adf7e89ab876bff6ae13ba"></a><!-- doxytag: member="pion::HTTPRequest::setVersionMajor" ref="5c5f7e7d15adf7e89ab876bff6ae13ba" args="(const unsigned int n)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#5c5f7e7d15adf7e89ab876bff6ae13ba">setVersionMajor</a> (const unsigned int n)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the request's major HTTP version number <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82cef1243dc60730885862234c4ff8d5"></a><!-- doxytag: member="pion::HTTPRequest::setVersionMinor" ref="82cef1243dc60730885862234c4ff8d5" args="(const unsigned int n)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#82cef1243dc60730885862234c4ff8d5">setVersionMinor</a> (const unsigned int n)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the request's minor HTTP version number <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b98f0cb5f7baedd16336e3910b24e99"></a><!-- doxytag: member="pion::HTTPRequest::setContentLength" ref="0b98f0cb5f7baedd16336e3910b24e99" args="(const unsigned long n)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#0b98f0cb5f7baedd16336e3910b24e99">setContentLength</a> (const unsigned long n)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the length of the POST content (in bytes) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#43f248f347da567673b3b9dcb73987d9">createPostContentBuffer</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63e028609f74b47b51b3574ed02074fe"></a><!-- doxytag: member="pion::HTTPRequest::addHeader" ref="63e028609f74b47b51b3574ed02074fe" args="(const std::string &key, const std::string &value)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#63e028609f74b47b51b3574ed02074fe">addHeader</a> (const std::string &key, const std::string &value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">adds a value for the HTTP request header key <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c601e624bd3e7c0ec0c1fff015bc4ab5"></a><!-- doxytag: member="pion::HTTPRequest::addQuery" ref="c601e624bd3e7c0ec0c1fff015bc4ab5" args="(const std::string &key, const std::string &value)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#c601e624bd3e7c0ec0c1fff015bc4ab5">addQuery</a> (const std::string &key, const std::string &value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">adds a value for the query key <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#fafad43f3c39689eb5dbe39217304a2e">addCookie</a> (const std::string &key, const std::string &value)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c84845e80724c972eb0cf01b2ca85b10"></a><!-- doxytag: member="pion::HTTPRequest::setIsValid" ref="c84845e80724c972eb0cf01b2ca85b10" args="(bool b=true)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#c84845e80724c972eb0cf01b2ca85b10">setIsValid</a> (bool b=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets whether or not the request is valid <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ba13ad759e2c087e6892140fae74622"></a><!-- doxytag: member="pion::HTTPRequest::clear" ref="4ba13ad759e2c087e6892140fae74622" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#4ba13ad759e2c087e6892140fae74622">clear</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">clears all request data <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85253674700ca08346f842aec51d75f2"></a><!-- doxytag: member="pion::HTTPRequest::checkKeepAlive" ref="85253674700ca08346f842aec51d75f2" args="(void) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#85253674700ca08346f842aec51d75f2">checkKeepAlive</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the HTTP connection may be kept alive <br></td></tr><tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d89e972604fa748fccd31531761d1e7"></a><!-- doxytag: member="pion::HTTPRequest::create" ref="6d89e972604fa748fccd31531761d1e7" args="(void)" -->static boost::shared_ptr<<br> <a class="el" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#6d89e972604fa748fccd31531761d1e7">create</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">creates new <a class="el" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a> objects <br></td></tr><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bf9d44a45725029975a00e365ea2e34"></a><!-- doxytag: member="pion::HTTPRequest::HTTPRequest" ref="2bf9d44a45725029975a00e365ea2e34" args="(void)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#2bf9d44a45725029975a00e365ea2e34">HTTPRequest</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">protected constructor restricts creation of objects (use <a class="el" href="classpion_1_1_h_t_t_p_request.html#6d89e972604fa748fccd31531761d1e7" title="creates new HTTPRequest objects">create()</a>) <br></td></tr><tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_h_t_t_p_request.html#3a204b37ac0fba5b30c0ee3e1d2d1170">getValue</a> (const <a class="el" href="structpion_1_1_h_t_t_p_types.html#c860abe7b994d3c0311318f2e335086e">HTTPTypes::StringDictionary</a> &dict, const std::string &key)</td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="c991eccda91ef150e9ca04dac39ac2db"></a><!-- doxytag: member="pion::HTTPRequest::getPostContent" ref="c991eccda91ef150e9ca04dac39ac2db" args="(void)" --><div class="memitem"><div class="memproto"> <table class="memname">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -