<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Xerces-C++: XMLNetAccessor.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.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>XMLNetAccessor.hpp</h1><a href="XMLNetAccessor_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span> <a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span> <a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span> <a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> <a name="l00006"></a>00006 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span> <a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00010"></a>00010 <span class="comment"> *</span> <a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> <a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span> <a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span> <a name="l00016"></a>00016 <span class="comment"> */</span> <a name="l00017"></a>00017 <a name="l00018"></a>00018 <span class="comment">/*</span> <a name="l00019"></a>00019 <span class="comment"> * $Id: XMLNetAccessor.hpp 673960 2008-07-04 08:50:12Z borisk $</span> <a name="l00020"></a>00020 <span class="comment"> */</span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_XMLNETACCESSOR_HPP)</span> <a name="l00023"></a><a class="code" href="XMLNetAccessor_8hpp.html#64b50e72d88293be84962baec17902b5">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_XMLNETACCESSOR_HPP</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="XercesDefs_8hpp.html">xercesc/util/XercesDefs.hpp</a>></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="XMLURL_8hpp.html">xercesc/util/XMLURL.hpp</a>></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="XMLException_8hpp.html">xercesc/util/XMLException.hpp</a>></span> <a name="l00028"></a>00028 <a name="l00029"></a>00029 <a class="code" href="XercesDefs_8hpp.html#43d74fa53d868d978f3e97cbb78b194d">XERCES_CPP_NAMESPACE_BEGIN</a> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classBinInputStream.html">BinInputStream</a>; <a name="l00032"></a>00032 <a name="l00033"></a>00033 <span class="comment">// This class holds advanced informations about the HTTP connection</span> <a name="l00034"></a><a class="code" href="classXMLNetHTTPInfo.html">00034</a> <span class="keyword">class </span><a class="code" href="XercesDefs_8hpp.html#97a524372e218133a8eb0aca39b4bd21">XMLUTIL_EXPORT</a> <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a> <a name="l00035"></a>00035 { <a name="l00036"></a>00036 <span class="keyword">public</span>: <a name="l00037"></a>00037 <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>(); <a name="l00038"></a>00038 <a name="l00039"></a><a class="code" href="classXMLNetHTTPInfo.html#e66949d1255a66a71a87b2b56f74b970">00039</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> { <a name="l00040"></a><a class="code" href="classXMLNetHTTPInfo.html#e66949d1255a66a71a87b2b56f74b970a96dc580a6480638d5419823141a631d">00040</a> GET, <a name="l00041"></a><a class="code" href="classXMLNetHTTPInfo.html#e66949d1255a66a71a87b2b56f74b970f4dc1c6f42129bb62e05212ab3185a6f">00041</a> PUT, <a name="l00042"></a><a class="code" href="classXMLNetHTTPInfo.html#e66949d1255a66a71a87b2b56f74b970deef1c9a8b2c5c5dc2768a8bc4bdd0f1">00042</a> POST <a name="l00043"></a>00043 } HTTPMethod; <a name="l00044"></a>00044 <a name="l00045"></a>00045 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00046"></a>00046 <span class="comment">// Data members</span> <a name="l00047"></a>00047 <span class="comment">//</span> <a name="l00048"></a>00048 <span class="comment">// fHTTPMethod</span> <a name="l00049"></a>00049 <span class="comment">// The type of the HTTP request</span> <a name="l00050"></a>00050 <span class="comment">//</span> <a name="l00051"></a>00051 <span class="comment">// fHeaders</span> <a name="l00052"></a>00052 <span class="comment">// The extra headers that will be sent as part of the request; the format is</span> <a name="l00053"></a>00053 <span class="comment">// Header1: Value\r\nHeader2: Value\r\n</span> <a name="l00054"></a>00054 <span class="comment">//</span> <a name="l00055"></a>00055 <span class="comment">// fHeadersLen</span> <a name="l00056"></a>00056 <span class="comment">// The length of the string pointed by fHeaders, in bytes</span> <a name="l00057"></a>00057 <span class="comment">//</span> <a name="l00058"></a>00058 <span class="comment">// fPayload</span> <a name="l00059"></a>00059 <span class="comment">// The extra data that will be sent after the headers; in the case of a PUT</span> <a name="l00060"></a>00060 <span class="comment">// operation, this is the content of the resource being posted. It can be binary data</span> <a name="l00061"></a>00061 <span class="comment">//</span> <a name="l00062"></a>00062 <span class="comment">// fPayloadLen</span> <a name="l00063"></a>00063 <span class="comment">// The length of the binary buffer pointed by fPayload, in bytes</span> <a name="l00064"></a>00064 <span class="comment">//</span> <a name="l00065"></a><a class="code" href="classXMLNetHTTPInfo.html#ae654f3972c4303832b11baf6a57a523">00065</a> <a class="code" href="classXMLNetHTTPInfo.html#e66949d1255a66a71a87b2b56f74b970">HTTPMethod</a> fHTTPMethod; <a name="l00066"></a><a class="code" href="classXMLNetHTTPInfo.html#552a806a7cf3547fbbfd091942a0ada4">00066</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* fHeaders; <a name="l00067"></a><a class="code" href="classXMLNetHTTPInfo.html#82d4c96e330448021c2f79002c598bf1">00067</a> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> fHeadersLen; <a name="l00068"></a><a class="code" href="classXMLNetHTTPInfo.html#ddaf66177f6186979b7aadf62d2cd748">00068</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* fPayload; <a name="l00069"></a><a class="code" href="classXMLNetHTTPInfo.html#a5a211dc187823fbe61e6975f49ca66e">00069</a> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> fPayloadLen; <a name="l00070"></a>00070 }; <a name="l00071"></a>00071 <a name="l00072"></a><a class="code" href="classXMLNetHTTPInfo.html#5a6d789d37e9e9a2a1a3cfe6f2a0454e">00072</a> <span class="keyword">inline</span> <a class="code" href="classXMLNetHTTPInfo.html#5a6d789d37e9e9a2a1a3cfe6f2a0454e">XMLNetHTTPInfo::XMLNetHTTPInfo</a>() <a name="l00073"></a>00073 :fHTTPMethod(<a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>::GET), <a name="l00074"></a>00074 fHeaders(0), <a name="l00075"></a>00075 fHeadersLen(0), <a name="l00076"></a>00076 fPayload(0), <a name="l00077"></a>00077 fPayloadLen(0) <a name="l00078"></a>00078 { <a name="l00079"></a>00079 } <a name="l00080"></a>00080 <a name="l00081"></a>00081 <a name="l00082"></a>00082 <span class="comment">//</span> <a name="l00083"></a>00083 <span class="comment">// This class is an abstract interface via which the URL class accesses</span> <a name="l00084"></a>00084 <span class="comment">// net access services. When any source URL is not in effect a local file</span> <a name="l00085"></a>00085 <span class="comment">// path, then the URL class is used to look at it. Then the URL class can</span> <a name="l00086"></a>00086 <span class="comment">// be asked to make a binary input stream via which the referenced resource</span> <a name="l00087"></a>00087 <span class="comment">// can be read in.</span> <a name="l00088"></a>00088 <span class="comment">//</span> <a name="l00089"></a>00089 <span class="comment">// The URL class will use an object derived from this class to create a</span> <a name="l00090"></a>00090 <span class="comment">// binary stream for the URL to return. The object it uses is provided by</span> <a name="l00091"></a>00091 <span class="comment">// the platform utils, and is actually provided by the per-platform init</span> <a name="l00092"></a>00092 <span class="comment">// code so each platform can decide what actual implementation it wants to</span> <a name="l00093"></a>00093 <span class="comment">// use.</span> <a name="l00094"></a>00094 <span class="comment">//</span> <a name="l00095"></a><a class="code" href="classXMLNetAccessor.html">00095</a> <span class="keyword">class </span><a class="code" href="XercesDefs_8hpp.html#97a524372e218133a8eb0aca39b4bd21">XMLUTIL_EXPORT</a> <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a> : <span class="keyword">public</span> <a class="code" href="classXMemory.html" title="This class makes it possible to override the C++ memory management by adding new/delete...">XMemory</a> <a name="l00096"></a>00096 { <a name="l00097"></a>00097 <span class="keyword">public</span> : <a name="l00098"></a>00098 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00099"></a>00099 <span class="comment">// Virtual destructor</span> <a name="l00100"></a>00100 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00101"></a><a class="code" href="classXMLNetAccessor.html#3ff963d075bcddd488bee9a112fb9bce">00101</a> <span class="keyword">virtual</span> ~<a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>() <a name="l00102"></a>00102 { <a name="l00103"></a>00103 } <a name="l00104"></a>00104 <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00107"></a>00107 <span class="comment">// The virtual net accessor interface</span> <a name="l00108"></a>00108 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="Xerces__autoconf__config_8borland_8hpp.html#8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* getId() <span class="keyword">const</span> = 0; <a name="l00110"></a>00110 <a name="l00111"></a>00111 <span class="keyword">virtual</span> <a class="code" href="classBinInputStream.html">BinInputStream</a>* makeNew <a name="l00112"></a>00112 ( <a name="l00113"></a>00113 <span class="keyword">const</span> <a class="code" href="classXMLURL.html">XMLURL</a>& urlSrc, <a name="l00114"></a>00114 <span class="keyword">const</span> <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>* httpInfo=0 <a name="l00115"></a>00115 ) = 0; <a name="l00116"></a>00116 <a name="l00117"></a>00117 <a name="l00118"></a>00118 <span class="keyword">protected</span> : <a name="l00119"></a>00119 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00120"></a>00120 <span class="comment">// Hidden constructors</span> <a name="l00121"></a>00121 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00122"></a><a class="code" href="classXMLNetAccessor.html#c4542c6884a25d6ce7abe9591d81c1cf">00122</a> <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>() <a name="l00123"></a>00123 { <a name="l00124"></a>00124 } <a name="l00125"></a>00125 <a name="l00126"></a>00126 <a name="l00127"></a>00127 <span class="keyword">private</span> : <a name="l00128"></a>00128 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00129"></a>00129 <span class="comment">// Unimplemented constructors and operators</span> <a name="l00130"></a>00130 <span class="comment">// -----------------------------------------------------------------------</span> <a name="l00131"></a>00131 <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>(<span class="keyword">const</span> <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>&); <a name="l00132"></a>00132 <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>& operator=(<span class="keyword">const</span> <a class="code" href="classXMLNetAccessor.html">XMLNetAccessor</a>&); <a name="l00133"></a>00133 }; <a name="l00134"></a>00134 <a name="l00135"></a>00135 <a class="code" href="XMLException_8hpp.html#57c0a8cea5d525b6091454d6a387e050">MakeXMLException</a>(NetAccessorException, <a class="code" href="XercesDefs_8hpp.html#97a524372e218133a8eb0aca39b4bd21">XMLUTIL_EXPORT</a>) <a name="l00136"></a>00136 <a name="l00137"></a>00137 <a class="code" href="XercesDefs_8hpp.html#f03d5cb905763ef7a7bd22ab82718285">XERCES_CPP_NAMESPACE_END</a> <a name="l00138"></a>00138 <a name="l00139"></a>00139 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 29 15:30:48 2010 for Xerces-C++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>