1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
|
<!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++: BinMemInputStream 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.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 class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<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>
<div class="contents">
<h1>BinMemInputStream Class Reference</h1><!-- doxytag: class="BinMemInputStream" --><!-- doxytag: inherits="BinInputStream" --><div class="dynheader">
Inheritance diagram for BinMemInputStream:</div>
<div class="dynsection">
<p><center><img src="classBinMemInputStream.png" usemap="#BinMemInputStream_map" border="0" alt=""></center>
<map name="BinMemInputStream_map">
<area href="classBinInputStream.html" alt="BinInputStream" shape="rect" coords="0,56,123,80">
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="0,0,123,24">
</map>
</div>
<p>
<a href="classBinMemInputStream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a> { <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d">BufOpt_Adopt</a>,
<a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a">BufOpt_Copy</a>,
<a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b">BufOpt_Reference</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#7ce2673aed61cb2c053f2a14b7ad276a">BinMemInputStream</a> (const <a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const initData, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> capacity, const <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a> bufOpt=BufOpt_Copy, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#9923322cccd88acb966b93ae804490dd">~BinMemInputStream</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#071b3c5877e19a8191f59e6c69d271fc">reset</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#16de7f8cb3aa38ad7233fb310c63929d">curPos</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#fe5316fc9aa18d3cd581f016fbdbda7c">readBytes</a> (<a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const toFill, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> maxToRead)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#43ef21224f83f5c76c18d10dfb147d7b">getContentType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification. <a href="#43ef21224f83f5c76c18d10dfb147d7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBinMemInputStream.html#ae9e8521d07aaf5a12efbea97c969938">getSize</a> () const </td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69"></a><!-- doxytag: member="BinMemInputStream::BufOpts" ref="939fb86f3143d1857e1134ad4d73bc69" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BinMemInputStream::BufOpts</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d"></a><!-- doxytag: member="BufOpt_Adopt" ref="939fb86f3143d1857e1134ad4d73bc69ff743c094e973cdafa2744802a6cf65d" args="" -->BufOpt_Adopt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a"></a><!-- doxytag: member="BufOpt_Copy" ref="939fb86f3143d1857e1134ad4d73bc69cbdda4802b432945da802e36bae8e92a" args="" -->BufOpt_Copy</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b"></a><!-- doxytag: member="BufOpt_Reference" ref="939fb86f3143d1857e1134ad4d73bc6945242b1d53371ccbc3d62f2f9c5ef72b" args="" -->BufOpt_Reference</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7ce2673aed61cb2c053f2a14b7ad276a"></a><!-- doxytag: member="BinMemInputStream::BinMemInputStream" ref="7ce2673aed61cb2c053f2a14b7ad276a" args="(const XMLByte *const initData, const XMLSize_t capacity, const BufOpts bufOpt=BufOpt_Copy, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BinMemInputStream::BinMemInputStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const </td>
<td class="paramname"> <em>initData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
<td class="paramname"> <em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBinMemInputStream.html#939fb86f3143d1857e1134ad4d73bc69">BufOpts</a> </td>
<td class="paramname"> <em>bufOpt</em> = <code>BufOpt_Copy</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const </td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9923322cccd88acb966b93ae804490dd"></a><!-- doxytag: member="BinMemInputStream::~BinMemInputStream" ref="9923322cccd88acb966b93ae804490dd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual BinMemInputStream::~BinMemInputStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="071b3c5877e19a8191f59e6c69d271fc"></a><!-- doxytag: member="BinMemInputStream::reset" ref="071b3c5877e19a8191f59e6c69d271fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BinMemInputStream::reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="16de7f8cb3aa38ad7233fb310c63929d"></a><!-- doxytag: member="BinMemInputStream::curPos" ref="16de7f8cb3aa38ad7233fb310c63929d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#7647261a546ac47bda863a51d24ad898">XMLFilePos</a> BinMemInputStream::curPos </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implements <a class="el" href="classBinInputStream.html#959a030c22785e3bcee6e7dd6800df71">BinInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="fe5316fc9aa18d3cd581f016fbdbda7c"></a><!-- doxytag: member="BinMemInputStream::readBytes" ref="fe5316fc9aa18d3cd581f016fbdbda7c" args="(XMLByte *const toFill, const XMLSize_t maxToRead)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinMemInputStream::readBytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="XercesDefs_8hpp.html#7470c7a32c59355685ebcd878a33f126">XMLByte</a> *const </td>
<td class="paramname"> <em>toFill</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
<td class="paramname"> <em>maxToRead</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implements <a class="el" href="classBinInputStream.html#2245666a5058c666d0238ea5e5b5334b">BinInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="43ef21224f83f5c76c18d10dfb147d7b"></a><!-- doxytag: member="BinMemInputStream::getContentType" ref="43ef21224f83f5c76c18d10dfb147d7b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a>* BinMemInputStream::getContentType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the "out-of-band" content type for the data supplied by this input stream in the form of the media-type production (mime type with optional parameters such as encoding) as defined by the HTTP 1.1 specification.
<p>
If no such content type is provided for the data, 0 is returned. This function is expected to return the correct value at any time after the construction of the stream.<p>
An example of the stream that may return non-0 from this function is an HTTP stream with the value returned taken from the "Content-Type" HTTP header. Note also that if the encoding of the data is known to the application by some other means then the setEncoding function in the <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> object should be used instead. The getContentType function should only be used to return information that is intrinsic to the stream.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The content type, or 0 if one is not available. </dd></dl>
<p>Implements <a class="el" href="classBinInputStream.html#cb658844f9600ad353604bc403e74ff4">BinInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="ae9e8521d07aaf5a12efbea97c969938"></a><!-- doxytag: member="BinMemInputStream::getSize" ref="ae9e8521d07aaf5a12efbea97c969938" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> BinMemInputStream::getSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BinMemInputStream_8hpp-source.html">BinMemInputStream.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 21 17:55:49 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>
|