📄 _h_t_t_p_request_8hpp-source.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: /Users/mdickey/code/libpion-export/include/libpion/HTTPRequest.hpp Source File</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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul></div><h1>/Users/mdickey/code/libpion-export/include/libpion/HTTPRequest.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -----------------------------------------------------------------</span><a name="l00002"></a>00002 <span class="comment">// libpion: a C++ framework for building lightweight HTTP interfaces</span><a name="l00003"></a>00003 <span class="comment">// -----------------------------------------------------------------</span><a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007 Atomic Labs, Inc. (http://www.atomiclabs.com)</span><a name="l00005"></a>00005 <span class="comment">//</span><a name="l00006"></a>00006 <span class="comment">// Distributed under the Boost Software License, Version 1.0.</span><a name="l00007"></a>00007 <span class="comment">// See accompanying file COPYING or copy at http://www.boost.org/LICENSE_1_0.txt</span><a name="l00008"></a>00008 <span class="comment">//</span><a name="l00009"></a>00009 <a name="l00010"></a>00010 <span class="preprocessor">#ifndef __PION_HTTPREQUEST_HEADER__</span><a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define __PION_HTTPREQUEST_HEADER__</span><a name="l00012"></a>00012 <span class="preprocessor"></span><a name="l00013"></a>00013 <span class="preprocessor">#include <libpion/PionConfig.hpp></span><a name="l00014"></a>00014 <span class="preprocessor">#include <libpion/HTTPTypes.hpp></span><a name="l00015"></a>00015 <span class="preprocessor">#include <boost/noncopyable.hpp></span><a name="l00016"></a>00016 <span class="preprocessor">#include <boost/shared_ptr.hpp></span><a name="l00017"></a>00017 <span class="preprocessor">#include <boost/scoped_array.hpp></span><a name="l00018"></a>00018 <span class="preprocessor">#include <string></span><a name="l00019"></a>00019 <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="keyword">namespace </span>pion { <span class="comment">// begin namespace pion</span><a name="l00022"></a>00022 <a name="l00026"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html">00026</a> <span class="keyword">class </span><a class="code" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a> :<a name="l00027"></a>00027 <span class="keyword">private</span> boost::noncopyable<a name="l00028"></a>00028 {<a name="l00029"></a>00029 <span class="keyword">public</span>:<a name="l00030"></a>00030 <a name="l00032"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#6d89e972604fa748fccd31531761d1e7">00032</a> <span class="keyword">static</span> <span class="keyword">inline</span> boost::shared_ptr<HTTPRequest> <a class="code" href="classpion_1_1_h_t_t_p_request.html#6d89e972604fa748fccd31531761d1e7" title="creates new HTTPRequest objects">create</a>(<span class="keywordtype">void</span>) {<a name="l00033"></a>00033 <span class="keywordflow">return</span> boost::shared_ptr<HTTPRequest>(<span class="keyword">new</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html">HTTPRequest</a>);<a name="l00034"></a>00034 }<a name="l00035"></a>00035 <a name="l00037"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#c53b5631b432d00013b92fe3067083f4">00037</a> <span class="keyword">virtual</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#c53b5631b432d00013b92fe3067083f4" title="virtual destructor">~HTTPRequest</a>() {}<a name="l00038"></a>00038 <a name="l00039"></a>00039 <a name="l00041"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#bf864205c9e7b20782eaaba727169fe7">00041</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#bf864205c9e7b20782eaaba727169fe7" title="returns the request method (i.e. GET, POST, PUT)">getMethod</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_method; }<a name="l00042"></a>00042 <a name="l00044"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#83a06412d1964da204a3aa79e3c47d69">00044</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#83a06412d1964da204a3aa79e3c47d69" title="returns the resource uri-stem requested">getResource</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_resource; }<a name="l00045"></a>00045 <a name="l00047"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#34b9b383dfdbba5095e9ac2fa205f192">00047</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#34b9b383dfdbba5095e9ac2fa205f192" title="returns the uri-query or query string requested">getQueryString</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_query_string; }<a name="l00048"></a>00048 <a name="l00050"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#b25a2cba3f009d101e0d0104e5d5c2ab">00050</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#b25a2cba3f009d101e0d0104e5d5c2ab" title="returns the request's major HTTP version number">getVersionMajor</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_version_major; }<a name="l00051"></a>00051 <a name="l00053"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#ff4ce1dcd203aeb6ff30332aac309583">00053</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#ff4ce1dcd203aeb6ff30332aac309583" title="returns the request's minor HTTP version number">getVersionMinor</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_version_minor; }<a name="l00054"></a>00054 <a name="l00056"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#0fee4867962fa7fefbc90042474e34d0">00056</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#0fee4867962fa7fefbc90042474e34d0" title="returns the length of the POST content (in bytes)">getContentLength</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_content_length; }<a name="l00057"></a>00057 <a name="l00060"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#c991eccda91ef150e9ca04dac39ac2db">00060</a> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classpion_1_1_h_t_t_p_request.html#c991eccda91ef150e9ca04dac39ac2db">getPostContent</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_post_content.get(); }<a name="l00061"></a>00061 <a name="l00063"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#fed7a4e767c2d5a087ae505532930bf0">00063</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#fed7a4e767c2d5a087ae505532930bf0" title="returns a value for the header if any are defined; otherwise, an empty string">getHeader</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00064"></a>00064 <span class="keywordflow">return</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#3a204b37ac0fba5b30c0ee3e1d2d1170">getValue</a>(m_headers, key);<a name="l00065"></a>00065 }<a name="l00066"></a>00066 <a name="l00068"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#a39588937eb77370aaa1f8ceaf50385f">00068</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#a39588937eb77370aaa1f8ceaf50385f" title="returns a value for the query key if any are defined; otherwise, an empty string">getQuery</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00069"></a>00069 <span class="keywordflow">return</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#3a204b37ac0fba5b30c0ee3e1d2d1170">getValue</a>(m_query_params, key);<a name="l00070"></a>00070 }<a name="l00071"></a>00071 <a name="l00074"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#a211a6b511a24dfb13196effc96483b9">00074</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classpion_1_1_h_t_t_p_request.html#a211a6b511a24dfb13196effc96483b9">getCookie</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00075"></a>00075 <span class="keywordflow">return</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#3a204b37ac0fba5b30c0ee3e1d2d1170">getValue</a>(m_cookie_params, key);<a name="l00076"></a>00076 }<a name="l00077"></a>00077 <a name="l00079"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#eb32619c02effae2c0f4df0f0230566c">00079</a> <span class="keyword">inline</span> <a class="code" href="structpion_1_1_h_t_t_p_types.html#04764395d3025e0c796c4b328e886d03" title="data type for HTTP headers">HTTPTypes::Headers</a>& <a class="code" href="classpion_1_1_h_t_t_p_request.html#eb32619c02effae2c0f4df0f0230566c" title="returns the HTTP request headers">getHeaders</a>(<span class="keywordtype">void</span>) {<a name="l00080"></a>00080 <span class="keywordflow">return</span> m_headers;<a name="l00081"></a>00081 }<a name="l00082"></a>00082 <a name="l00084"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#742751d93afae00a30138528734cb8bd">00084</a> <span class="keyword">inline</span> <a class="code" href="structpion_1_1_h_t_t_p_types.html#76461bc9a17ce90abb016c3a5b7d7bee" title="data type for HTTP query parameters">HTTPTypes::QueryParams</a>& <a class="code" href="classpion_1_1_h_t_t_p_request.html#742751d93afae00a30138528734cb8bd" title="returns the query parameters">getQueryParams</a>(<span class="keywordtype">void</span>) {<a name="l00085"></a>00085 <span class="keywordflow">return</span> m_query_params;<a name="l00086"></a>00086 }<a name="l00087"></a>00087 <a name="l00089"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#737c8054d90b071d008fedf485c37919">00089</a> <span class="keyword">inline</span> <a class="code" href="structpion_1_1_h_t_t_p_types.html#ce1e6366bc601e16a0a10d61f5d690f9" title="data type for HTTP cookie parameters">HTTPTypes::CookieParams</a>& <a class="code" href="classpion_1_1_h_t_t_p_request.html#737c8054d90b071d008fedf485c37919" title="returns the cookie parameters">getCookieParams</a>(<span class="keywordtype">void</span>) {<a name="l00090"></a>00090 <span class="keywordflow">return</span> m_cookie_params;<a name="l00091"></a>00091 }<a name="l00092"></a>00092 <a name="l00094"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#3158c7de53f3a25baf0b3b30fd5da32e">00094</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#3158c7de53f3a25baf0b3b30fd5da32e" title="returns true if at least one value for the header is defined">hasHeader</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00095"></a>00095 <span class="keywordflow">return</span>(m_headers.find(key) != m_headers.end());<a name="l00096"></a>00096 }<a name="l00097"></a>00097 <a name="l00099"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#0aae9030d060c83c4284d4b3cf6dbddf">00099</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#0aae9030d060c83c4284d4b3cf6dbddf" title="returns true if at least one value for the query key is defined">hasQuery</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00100"></a>00100 <span class="keywordflow">return</span>(m_query_params.find(key) != m_query_params.end());<a name="l00101"></a>00101 }<a name="l00102"></a>00102 <a name="l00105"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#b8dd3d1c0b81d7a9c2e59c597adddf3c">00105</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#b8dd3d1c0b81d7a9c2e59c597adddf3c">hasCookie</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const </span>{<a name="l00106"></a>00106 <span class="keywordflow">return</span>(m_cookie_params.find(key) != m_cookie_params.end());<a name="l00107"></a>00107 }<a name="l00108"></a>00108 <a name="l00110"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#05246258ac225ad41abd4df99e62bef6">00110</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#05246258ac225ad41abd4df99e62bef6" title="returns true if the request is valid">isValid</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_is_valid; }<a name="l00111"></a>00111 <a name="l00112"></a>00112 <a name="l00114"></a><a class="code" href="classpion_1_1_h_t_t_p_request.html#bc3c4ebf220c9cad96d29b85afda8c5d">00114</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1_h_t_t_p_request.html#bc3c4ebf220c9cad96d29b85afda8c5d" title="sets the HTTP request method (i.e. GET, POST, PUT)">setMethod</a>(<span class="keyword">const</span> std::string& str) { m_method = str; }⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -