Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > f149f58f4a75af135bdb24f5dfe94165 > files > 254

libdap-doc-3.9.3-3mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libdap++: HTTPConnect.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</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>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>HTTPConnect.h</h1><a href="HTTPConnect_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">// -*- mode: c++; c-basic-offset:4 -*-</span>
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="comment">// This file is part of libdap, A C++ implementation of the OPeNDAP Data</span>
<a name="l00005"></a>00005 <span class="comment">// Access Protocol.</span>
<a name="l00006"></a>00006 
<a name="l00007"></a>00007 <span class="comment">// Copyright (c) 2002,2003 OPeNDAP, Inc.</span>
<a name="l00008"></a>00008 <span class="comment">// Author: James Gallagher &lt;jgallagher@opendap.org&gt;</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// This library is free software; you can redistribute it and/or</span>
<a name="l00011"></a>00011 <span class="comment">// modify it under the terms of the GNU Lesser General Public</span>
<a name="l00012"></a>00012 <span class="comment">// License as published by the Free Software Foundation; either</span>
<a name="l00013"></a>00013 <span class="comment">// version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// This library is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00018"></a>00018 <span class="comment">// Lesser General Public License for more details.</span>
<a name="l00019"></a>00019 <span class="comment">//</span>
<a name="l00020"></a>00020 <span class="comment">// You should have received a copy of the GNU Lesser General Public</span>
<a name="l00021"></a>00021 <span class="comment">// License along with this library; if not, write to the Free Software</span>
<a name="l00022"></a>00022 <span class="comment">// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00023"></a>00023 <span class="comment">//</span>
<a name="l00024"></a>00024 <span class="comment">// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef _httpconnect_h</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define _httpconnect_h</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;curl/curl.h&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;curl/types.h&gt;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;curl/easy.h&gt;</span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef _rc_reader_h_</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="RCReader_8h.html">RCReader.h</a>"</span>
<a name="l00038"></a>00038 <span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef _object_type_h</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="ObjectType_8h.html">ObjectType.h</a>"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#endif</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a>00044 <span class="preprocessor">#ifndef _http_cache_h</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="HTTPCache_8h.html">HTTPCache.h</a>"</span>
<a name="l00046"></a>00046 <span class="preprocessor">#endif</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a>00048 <span class="preprocessor">#ifndef http_response_h</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="HTTPResponse_8h.html">HTTPResponse.h</a>"</span>
<a name="l00050"></a>00050 <span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052 <span class="preprocessor">#ifndef _util_h</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="util_8h.html">util.h</a>"</span>
<a name="l00054"></a>00054 <span class="preprocessor">#endif</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span>
<a name="l00056"></a>00056 <span class="keyword">using</span> std::string;
<a name="l00057"></a>00057 <span class="keyword">using</span> std::vector;
<a name="l00058"></a>00058 
<a name="l00059"></a>00059 <span class="keyword">namespace </span>libdap
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 
<a name="l00074"></a><a class="code" href="classlibdap_1_1HTTPConnect.html">00074</a> <span class="keyword">class </span><a class="code" href="classlibdap_1_1HTTPConnect.html">HTTPConnect</a>
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 <span class="keyword">private</span>:
<a name="l00077"></a>00077     CURL *d_curl;
<a name="l00078"></a>00078     <a class="code" href="classlibdap_1_1RCReader.html">RCReader</a> *d_rcr;
<a name="l00079"></a>00079     <a class="code" href="classlibdap_1_1HTTPCache.html">HTTPCache</a> *d_http_cache;
<a name="l00080"></a>00080 
<a name="l00081"></a>00081     <span class="keywordtype">char</span> d_error_buffer[CURL_ERROR_SIZE]; <span class="comment">// A human-readable message.</span>
<a name="l00082"></a>00082 
<a name="l00083"></a>00083     <span class="keywordtype">bool</span> d_accept_deflate;
<a name="l00084"></a>00084 
<a name="l00085"></a>00085     <span class="keywordtype">string</span> d_username;  <span class="comment">// extracted from URL</span>
<a name="l00086"></a>00086     <span class="keywordtype">string</span> d_password;  <span class="comment">// extracted from URL</span>
<a name="l00087"></a>00087     <span class="keywordtype">string</span> d_upstring;  <span class="comment">// used to pass info into curl</span>
<a name="l00088"></a>00088 
<a name="l00089"></a>00089     <span class="keywordtype">string</span> d_cookie_jar;
<a name="l00090"></a>00090 
<a name="l00091"></a>00091     vector&lt;string&gt; d_request_headers; <span class="comment">// Request headers</span>
<a name="l00092"></a>00092 
<a name="l00093"></a>00093     <span class="keywordtype">int</span> d_dap_client_protocol_major;
<a name="l00094"></a>00094     <span class="keywordtype">int</span> d_dap_client_protocol_minor;
<a name="l00095"></a>00095 
<a name="l00096"></a>00096     <span class="keywordtype">void</span> www_lib_init();
<a name="l00097"></a>00097     <span class="keywordtype">long</span> read_url(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url, FILE *stream, vector&lt;string&gt; *resp_hdrs,
<a name="l00098"></a>00098                   <span class="keyword">const</span> vector&lt;string&gt; *headers = 0);
<a name="l00099"></a>00099     <span class="comment">// string get_temp_file(FILE *&amp;stream) throw(InternalErr);</span>
<a name="l00100"></a>00100     <a class="code" href="classlibdap_1_1HTTPResponse.html">HTTPResponse</a> *plain_fetch_url(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url);
<a name="l00101"></a>00101     <a class="code" href="classlibdap_1_1HTTPResponse.html">HTTPResponse</a> *caching_fetch_url(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url);
<a name="l00102"></a>00102 
<a name="l00103"></a>00103     <span class="keywordtype">bool</span> url_uses_proxy_for(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url) <span class="keywordflow">throw</span>();
<a name="l00104"></a>00104     <span class="keywordtype">bool</span> url_uses_no_proxy_for(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url) <span class="keywordflow">throw</span>();
<a name="l00105"></a>00105 
<a name="l00106"></a>00106     <span class="keywordtype">void</span> extract_auth_info(<span class="keywordtype">string</span> &amp;url);
<a name="l00107"></a>00107 
<a name="l00108"></a>00108     <span class="keyword">friend</span> <span class="keywordtype">size_t</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#f4392e8b4c78632ef10da4542127388a">save_raw_http_header</a>(<span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> nmemb,
<a name="l00109"></a>00109                                        <span class="keywordtype">void</span> *http_connect);
<a name="l00110"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#9aed79b4a282abc0feb24f3e28234f13">00110</a>     <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlibdap_1_1HTTPConnect.html#9aed79b4a282abc0feb24f3e28234f13">HTTPConnectTest</a>;
<a name="l00111"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#6cf7d84a8b4cb42b8503948b6c5973cc">00111</a>     <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlibdap_1_1HTTPConnect.html#6cf7d84a8b4cb42b8503948b6c5973cc">ParseHeader</a>;
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <span class="keyword">protected</span>:
<a name="l00119"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#6648957e9aa38739b953e61241fdb162">00119</a>     <a class="code" href="classlibdap_1_1HTTPConnect.html#6648957e9aa38739b953e61241fdb162">HTTPConnect</a>() {
<a name="l00120"></a>00120                 <span class="keywordflow">throw</span> <a class="code" href="classlibdap_1_1InternalErr.html" title="A class for software fault reporting.">InternalErr</a>(__FILE__, __LINE__, <span class="stringliteral">"Unimplemented method"</span>);
<a name="l00121"></a>00121         }
<a name="l00122"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#510d3277f37839b275aca7f26a82d082">00122</a>         <a class="code" href="classlibdap_1_1HTTPConnect.html#510d3277f37839b275aca7f26a82d082">HTTPConnect</a>(<span class="keyword">const</span> <a class="code" href="classlibdap_1_1HTTPConnect.html">HTTPConnect</a> &amp;) {
<a name="l00123"></a>00123                 <span class="keywordflow">throw</span> <a class="code" href="classlibdap_1_1InternalErr.html" title="A class for software fault reporting.">InternalErr</a>(__FILE__, __LINE__, <span class="stringliteral">"Unimplemented method"</span>);
<a name="l00124"></a>00124         }
<a name="l00125"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#ad5c634ebb6237e8449e76d83abde372">00125</a>         <a class="code" href="classlibdap_1_1HTTPConnect.html">HTTPConnect</a> &amp;<a class="code" href="classlibdap_1_1HTTPConnect.html#ad5c634ebb6237e8449e76d83abde372">operator=</a>(<span class="keyword">const</span> <a class="code" href="classlibdap_1_1HTTPConnect.html">HTTPConnect</a> &amp;) {
<a name="l00126"></a>00126                 <span class="keywordflow">throw</span> <a class="code" href="classlibdap_1_1InternalErr.html" title="A class for software fault reporting.">InternalErr</a>(__FILE__, __LINE__, <span class="stringliteral">"Unimplemented assignment"</span>);
<a name="l00127"></a>00127         }
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 <span class="keyword">public</span>:
<a name="l00131"></a>00131     <a class="code" href="classlibdap_1_1HTTPConnect.html#6648957e9aa38739b953e61241fdb162">HTTPConnect</a>(<a class="code" href="classlibdap_1_1RCReader.html">RCReader</a> *rcr);
<a name="l00132"></a>00132 
<a name="l00133"></a>00133     <span class="keyword">virtual</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#daecf86117db43a3d4d78971d897252e">~HTTPConnect</a>();
<a name="l00134"></a>00134 
<a name="l00135"></a>00135     <span class="keywordtype">void</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#84190d0d80154943ee997c4982a7c96a">set_credentials</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;u, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;p);
<a name="l00136"></a>00136     <span class="keywordtype">void</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#01d67a5afa18a84ef744b8f222094260">set_accept_deflate</a>(<span class="keywordtype">bool</span> defalte);
<a name="l00137"></a>00137     <span class="keywordtype">void</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#c232e85c5d2448c66c1a24f62dcbf89a">set_xdap_protocol</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor);
<a name="l00138"></a>00138 
<a name="l00145"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#c6641c75c291e2908be9caade2eb5547">00145</a>     <span class="keywordtype">void</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#c6641c75c291e2908be9caade2eb5547">set_cookie_jar</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;cookie_jar)
<a name="l00146"></a>00146     {
<a name="l00147"></a>00147         d_cookie_jar = cookie_jar;
<a name="l00148"></a>00148     }
<a name="l00149"></a>00149 
<a name="l00155"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#af200f19c2a64adc4b17887372dcc595">00155</a>     <span class="keywordtype">void</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#af200f19c2a64adc4b17887372dcc595">set_cache_enabled</a>(<span class="keywordtype">bool</span> enabled)
<a name="l00156"></a>00156     {
<a name="l00157"></a>00157         <span class="keywordflow">if</span> (d_http_cache)
<a name="l00158"></a>00158             d_http_cache-&gt;<a class="code" href="classlibdap_1_1HTTPCache.html#71aa835c2b38bc0e891f40b5a77c53ce">set_cache_enabled</a>(enabled);
<a name="l00159"></a>00159     }
<a name="l00160"></a>00160 
<a name="l00162"></a><a class="code" href="classlibdap_1_1HTTPConnect.html#1e9a7b25527264a342dbe9c2aff59f2f">00162</a>     <span class="keywordtype">bool</span> <a class="code" href="classlibdap_1_1HTTPConnect.html#1e9a7b25527264a342dbe9c2aff59f2f">is_cache_enabled</a>()
<a name="l00163"></a>00163     {
<a name="l00164"></a>00164         <span class="keywordflow">return</span> (d_http_cache) ? d_http_cache-&gt;<a class="code" href="classlibdap_1_1HTTPCache.html#4492276bc732605cef02a146a657811f">is_cache_enabled</a>() : <span class="keyword">false</span>;
<a name="l00165"></a>00165     }
<a name="l00166"></a>00166 
<a name="l00167"></a>00167     <a class="code" href="classlibdap_1_1HTTPResponse.html">HTTPResponse</a> *<a class="code" href="classlibdap_1_1HTTPConnect.html#5e3558838e245a96c9392b33ef4ba298">fetch_url</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;url);
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169 
<a name="l00170"></a>00170 <a class="code" href="namespacelibdap.html#e7466ed8496f06654ec276eac907c06a" title="The type of object in the stream coming from the data server.">ObjectType</a> get_type(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;value); <span class="comment">// deprecated</span>
<a name="l00171"></a>00171 <a class="code" href="namespacelibdap.html#e7466ed8496f06654ec276eac907c06a" title="The type of object in the stream coming from the data server.">ObjectType</a> <a class="code" href="namespacelibdap.html#284c1c548cbcea75bb1b7c8374dc04e9">get_description_type</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;value);
<a name="l00172"></a>00172 
<a name="l00173"></a>00173 } <span class="comment">// namespace libdap</span>
<a name="l00174"></a>00174 
<a name="l00175"></a>00175 <span class="preprocessor">#endif // _httpconnect_h</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 19:57:07 2009 for libdap++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>