source: NonGTP/Xerces/xerces/doc/html/apiDocs/XMLNetAccessor_8hpp-source.html @ 358

Revision 358, 21.7 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>XMLNetAccessor.hpp Source File</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>XMLNetAccessor.hpp</h1><a href="XMLNetAccessor_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
4500002 <font class="comment"> * Copyright 1999-2000,2004 The Apache Software Foundation.</font>
4600003 <font class="comment"> * </font>
4700004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
4800005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
4900006 <font class="comment"> * You may obtain a copy of the License at</font>
5000007 <font class="comment"> * </font>
5100008 <font class="comment"> *      http://www.apache.org/licenses/LICENSE-2.0</font>
5200009 <font class="comment"> * </font>
5300010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
5400011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
5500012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
5600013 <font class="comment"> * See the License for the specific language governing permissions and</font>
5700014 <font class="comment"> * limitations under the License.</font>
5800015 <font class="comment"> */</font>
5900016
6000017 <font class="comment">/*</font>
6100018 <font class="comment"> * $Id: XMLNetAccessor.hpp,v 1.8 2004/09/08 13:56:24 peiyongz Exp $</font>
6200019 <font class="comment"> */</font>
6300020
6400021 <font class="preprocessor">#if !defined(XMLNETACCESSOR_HPP)</font>
65<a name="l00022"></a><a class="code" href="XMLNetAccessor_8hpp.html#a0">00022</a> <font class="preprocessor"></font><font class="preprocessor">#define XMLNETACCESSOR_HPP</font>
6600023 <font class="preprocessor"></font>
6700024 <font class="preprocessor">#include &lt;<a class="code" href="XMLURL_8hpp.html">xercesc/util/XMLURL.hpp</a>&gt;</font>
6800025 <font class="preprocessor">#include &lt;<a class="code" href="XMLException_8hpp.html">xercesc/util/XMLException.hpp</a>&gt;</font>
6900026
7000027 <a class="code" href="XercesDefs_8hpp.html#a2">XERCES_CPP_NAMESPACE_BEGIN</a>
7100028
72<a name="l00029"></a><a class="code" href="XMLNetAccessor_8hpp.html#a1">00029</a> <font class="keyword">class </font><a class="code" href="classBinInputStream.html">BinInputStream</a>;
7300030
7400031 <font class="comment">//  This class holds advanced informations about the HTTP connection</font>
75<a name="l00032"></a><a class="code" href="classXMLNetHTTPInfo.html">00032</a> <font class="keyword">class </font><a class="code" href="XercesDefs_8hpp.html#a8"></a> <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>
7600033 {
7700034 <font class="keyword">public</font>:
7800035     <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>();
7900036
80<a name="l00037"></a><a class="code" href="classXMLNetHTTPInfo.html#s3">00037</a>     <font class="keyword">typedef</font> <font class="keyword">enum</font> {
8100038         GET,
8200039         PUT,
8300040         POST
8400041     } HTTPMethod;
8500042
8600043     <font class="comment">// -----------------------------------------------------------------------</font>
8700044     <font class="comment">//  Data members</font>
8800045     <font class="comment">//</font>
8900046     <font class="comment">//  fHTTPMethod</font>
9000047     <font class="comment">//      The type of the HTTP request</font>
9100048     <font class="comment">//</font>
9200049     <font class="comment">//  fHeaders</font>
9300050     <font class="comment">//      The extra headers that will be sent as part of the request; the format is</font>
9400051     <font class="comment">//      Header1: Value\r\nHeader2: Value\r\n</font>
9500052     <font class="comment">//</font>
9600053     <font class="comment">//  fHeadersLen</font>
9700054     <font class="comment">//      The length of the string pointed by fHeaders, in bytes</font>
9800055     <font class="comment">//</font>
9900056     <font class="comment">//  fPayload</font>
10000057     <font class="comment">//      The extra data that will be sent after the headers; in the case of a PUT</font>
10100058     <font class="comment">//      operation, this is the content of the resource being posted. It can be binary data</font>
10200059     <font class="comment">//</font>
10300060     <font class="comment">//  fPayloadLen</font>
10400061     <font class="comment">//      The length of the binary buffer pointed by fPayload, in bytes</font>
10500062     <font class="comment">//</font>
106<a name="l00063"></a><a class="code" href="classXMLNetHTTPInfo.html#m0">00063</a>     HTTPMethod      fHTTPMethod;
107<a name="l00064"></a><a class="code" href="classXMLNetHTTPInfo.html#m1">00064</a>     <font class="keyword">const</font> <font class="keywordtype">char</font>*     fHeaders;
108<a name="l00065"></a><a class="code" href="classXMLNetHTTPInfo.html#m2">00065</a>     <font class="keywordtype">int</font>             fHeadersLen;
109<a name="l00066"></a><a class="code" href="classXMLNetHTTPInfo.html#m3">00066</a>     <font class="keyword">const</font> <font class="keywordtype">char</font>*     fPayload;
110<a name="l00067"></a><a class="code" href="classXMLNetHTTPInfo.html#m4">00067</a>     <font class="keywordtype">int</font>             fPayloadLen;
11100068 };
11200069
113<a name="l00070"></a><a class="code" href="classXMLNetHTTPInfo.html#a0">00070</a> <font class="keyword">inline</font> <a class="code" href="classXMLNetHTTPInfo.html#a0">XMLNetHTTPInfo::XMLNetHTTPInfo</a>()
11400071 :fHTTPMethod(<a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>::GET),
11500072  fHeaders(0),
11600073  fHeadersLen(0),
11700074  fPayload(0),
11800075  fPayloadLen(0)
11900076 {
12000077 }
12100078
12200079
12300080 <font class="comment">//</font>
12400081 <font class="comment">//  This class is an abstract interface via which the URL class accesses</font>
12500082 <font class="comment">//  net access services. When any source URL is not in effect a local file</font>
12600083 <font class="comment">//  path, then the URL class is used to look at it. Then the URL class can</font>
12700084 <font class="comment">//  be asked to make a binary input stream via which the referenced resource</font>
12800085 <font class="comment">//  can be read in.</font>
12900086 <font class="comment">//</font>
13000087 <font class="comment">//  The URL class will use an object derived from this class to create a</font>
13100088 <font class="comment">//  binary stream for the URL to return. The object it uses is provided by</font>
13200089 <font class="comment">//  the platform utils, and is actually provided by the per-platform init</font>
13300090 <font class="comment">//  code so each platform can decide what actual implementation it wants to</font>
13400091 <font class="comment">//  use.</font>
13500092 <font class="comment">//</font>
136<a name="l00093"></a><a class="code" href="classXMLNetAccessor.html">00093</a> <font class="keyword">class </font><a class="code" href="XercesDefs_8hpp.html#a8"></a> XMLNetAccessor : <font class="keyword">public</font> <a class="code" href="classXMemory.html">XMemory</a>
13700094 {
13800095 <font class="keyword">public</font> :
13900096     <font class="comment">// -----------------------------------------------------------------------</font>
14000097     <font class="comment">//  Virtual destructor</font>
14100098     <font class="comment">// -----------------------------------------------------------------------</font>
142<a name="l00099"></a><a class="code" href="classXMLNetAccessor.html#a0">00099</a>     <font class="keyword">virtual</font> ~XMLNetAccessor()
14300100     {
14400101     }
14500102
14600103
14700104     <font class="comment">// -----------------------------------------------------------------------</font>
14800105     <font class="comment">//  The virtual net accessor interface</font>
14900106     <font class="comment">// -----------------------------------------------------------------------</font>
15000107     <font class="keyword">virtual</font> <font class="keyword">const</font> XMLCh* getId() <font class="keyword">const</font> = 0;
15100108
15200109     <font class="keyword">virtual</font> <a class="code" href="classBinInputStream.html">BinInputStream</a>* makeNew
15300110     (
15400111         <font class="keyword">const</font>   <a class="code" href="classXMLURL.html">XMLURL</a>&amp;                 urlSrc,
15500112         <font class="keyword">const</font>   <a class="code" href="classXMLNetHTTPInfo.html">XMLNetHTTPInfo</a>*         httpInfo=0
15600113     ) = 0;
15700114
15800115
15900116 <font class="keyword">protected</font> :
16000117     <font class="comment">// -----------------------------------------------------------------------</font>
16100118     <font class="comment">//  Hidden constructors</font>
16200119     <font class="comment">// -----------------------------------------------------------------------</font>
163<a name="l00120"></a><a class="code" href="classXMLNetAccessor.html#b0">00120</a>     XMLNetAccessor()
16400121     {
16500122     }
16600123
16700124
16800125 <font class="keyword">private</font> :
16900126     <font class="comment">// -----------------------------------------------------------------------</font>
17000127     <font class="comment">//  Unimplemented constructors and operators</font>
17100128     <font class="comment">// -----------------------------------------------------------------------</font>
17200129     XMLNetAccessor(<font class="keyword">const</font> XMLNetAccessor&amp;);
17300130     XMLNetAccessor&amp; operator=(<font class="keyword">const</font> XMLNetAccessor&amp;);
17400131 };
17500132
17600133 <a class="code" href="XMLException_8hpp.html#a1">MakeXMLException</a>(NetAccessorException, <a class="code" href="XercesDefs_8hpp.html#a8"></a>)
17700134
17800135 <a class="code" href="XercesDefs_8hpp.html#a3">XERCES_CPP_NAMESPACE_END</a>
17900136
18000137 <font class="preprocessor">#endif</font>
181</pre></div>    </FONT></TD></TR></TABLE><BR>
182</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
183              Copyright &copy; 1994-2004 The Apache Software Foundation.
184              All Rights Reserved.
185            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.