<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::XMLStream Class Reference</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.6.3 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_x_m_l_stream.html">XMLStream</a>
</div>
</div>
<div class="contents">
<h1>ost::XMLStream Class Reference</h1><!-- doxytag: class="ost::XMLStream" -->
<p>This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="xml_8h_source.html">xml.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::XMLStream:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_x_m_l_stream.png" usemap="#ost::XMLStream_map" alt=""/>
<map id="ost::XMLStream_map" name="ost::XMLStream_map">
<area href="classost_1_1_x_m_l_r_p_c.html" alt="ost::XMLRPC" shape="rect" coords="0,56,100,80"/>
</map>
</div>
</div>
<p><a href="classost_1_1_x_m_l_stream-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a499e60e5b1b0e88d2f856e4bc8c63db8">open</a> (const char *resource)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">May perform an open operation on behalf of a parsed resource. <a href="#a499e60e5b1b0e88d2f856e4bc8c63db8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a5a581fb0b2875b0714a893837e2e5d11">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">May perform a close operation of an i/o source when the parser has completed operation. <a href="#a5a581fb0b2875b0714a893837e2e5d11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_slog.html#a47ef36225607dba90b4be5012daccd7a">Slog::Level</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a1981d1aa643f5aad965693c7a4132502">getLogging</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get error logging level. <a href="#a1981d1aa643f5aad965693c7a4132502"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#ad0dce01d08f35d642960867c0f5ccfbd">comment</a> (const unsigned char *text, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual to receive embedded comments in an XML document being parsed. <a href="#ad0dce01d08f35d642960867c0f5ccfbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a64e401b6b98c28523719d021f11acd52">read</a> (unsigned char *buffer, size_t len)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read method to aquire data for the parser. <a href="#a64e401b6b98c28523719d021f11acd52"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#af0962a8d37d7a17d8aff75c9409bf72f">characters</a> (const unsigned char *text, size_t len)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual to receive character text extracted from the document in the current element. <a href="#af0962a8d37d7a17d8aff75c9409bf72f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a4a4305dffd6b1eb7cdb6afd373fec8ef">startDocument</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identify start of document event. <a href="#a4a4305dffd6b1eb7cdb6afd373fec8ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#abc1e0f16c8100aadfde6acec56c2029e">endDocument</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identify end of document event. <a href="#abc1e0f16c8100aadfde6acec56c2029e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#aa2ccb9652149b6e461902c102b8ccde6">startElement</a> (const unsigned char *name, const unsigned char **attr)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identify start of an element in the document. <a href="#aa2ccb9652149b6e461902c102b8ccde6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a74d63a5adf80d81d61888aad632f2b7d">endElement</a> (const unsigned char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identify end of an element in the document. <a href="#a74d63a5adf80d81d61888aad632f2b7d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a98568a87c3d747583f8851f6d3f9fb1d">parse</a> (const char *resource=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a resource as a stream thru the virtual read method. <a href="#a98568a87c3d747583f8851f6d3f9fb1d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_x_m_l_stream.html#a71e5d08fcb8ef8a5a91c7aec12111d32">~XMLStream</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. </p>
<p>This class must be derived into one that can impliment the physical I/O required to parse actual data. A mixer class using <a class="el" href="classost_1_1_x_m_l_stream.html" title="This class impliments a basic XML stream parser that can be used to examine an XML...">XMLStream</a> and <a class="el" href="classost_1_1_u_r_l_stream.html" title="A URL processing version of TCPStream.">URLStream</a> would seem a likely combination for this purpose.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> XML Stream Parser (SAX) </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="xmlfetch_8cpp-example.html#_a1">xmlfetch.cpp</a>.</p>
</dd>
</dl><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a71e5d08fcb8ef8a5a91c7aec12111d32"></a><!-- doxytag: member="ost::XMLStream::~XMLStream" ref="a71e5d08fcb8ef8a5a91c7aec12111d32" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::XMLStream::~XMLStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af0962a8d37d7a17d8aff75c9409bf72f"></a><!-- doxytag: member="ost::XMLStream::characters" ref="af0962a8d37d7a17d8aff75c9409bf72f" args="(const unsigned char *text, size_t len)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::characters </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual to receive character text extracted from the document in the current element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>received. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of text received. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a6">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5a581fb0b2875b0714a893837e2e5d11"></a><!-- doxytag: member="ost::XMLStream::close" ref="a5a581fb0b2875b0714a893837e2e5d11" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::close </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>May perform a close operation of an i/o source when the parser has completed operation. </p>
</div>
</div>
<a class="anchor" id="ad0dce01d08f35d642960867c0f5ccfbd"></a><!-- doxytag: member="ost::XMLStream::comment" ref="ad0dce01d08f35d642960867c0f5ccfbd" args="(const unsigned char *text, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::comment </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</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>Virtual to receive embedded comments in an XML document being parsed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>text comment extracted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of comment. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a7">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="abc1e0f16c8100aadfde6acec56c2029e"></a><!-- doxytag: member="ost::XMLStream::endDocument" ref="abc1e0f16c8100aadfde6acec56c2029e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::endDocument </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identify end of document event. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a5">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a74d63a5adf80d81d61888aad632f2b7d"></a><!-- doxytag: member="ost::XMLStream::endElement" ref="a74d63a5adf80d81d61888aad632f2b7d" args="(const unsigned char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::endElement </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identify end of an element in the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of element found. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a9">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1981d1aa643f5aad965693c7a4132502"></a><!-- doxytag: member="ost::XMLStream::getLogging" ref="a1981d1aa643f5aad965693c7a4132502" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_slog.html#a47ef36225607dba90b4be5012daccd7a">Slog::Level</a> ost::XMLStream::getLogging </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get error logging level. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>error logging level. </dd></dl>
</div>
</div>
<a class="anchor" id="a499e60e5b1b0e88d2f856e4bc8c63db8"></a><!-- doxytag: member="ost::XMLStream::open" ref="a499e60e5b1b0e88d2f856e4bc8c63db8" args="(const char *resource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::XMLStream::open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>resource</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>May perform an open operation on behalf of a parsed resource. </p>
<p>In some cases, the parser may be merged with a class that already has performed some kind of open, and this method can then be ignored.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if open is successful. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resource</em> </td><td>passed to Parse methods. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a98568a87c3d747583f8851f6d3f9fb1d"></a><!-- doxytag: member="ost::XMLStream::parse" ref="a98568a87c3d747583f8851f6d3f9fb1d" args="(const char *resource=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::XMLStream::parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>resource</em> = <code>NULL</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a resource as a stream thru the virtual read method. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if well formed document has been fully parsed. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>resource</em> </td><td>optional name of resource. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a64e401b6b98c28523719d021f11acd52"></a><!-- doxytag: member="ost::XMLStream::read" ref="a64e401b6b98c28523719d021f11acd52" args="(unsigned char *buffer, size_t len)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int ost::XMLStream::read </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read method to aquire data for the parser. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>to read data into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>number of bytes to read. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a3">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4a4305dffd6b1eb7cdb6afd373fec8ef"></a><!-- doxytag: member="ost::XMLStream::startDocument" ref="a4a4305dffd6b1eb7cdb6afd373fec8ef" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::startDocument </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identify start of document event. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a4">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa2ccb9652149b6e461902c102b8ccde6"></a><!-- doxytag: member="ost::XMLStream::startElement" ref="aa2ccb9652149b6e461902c102b8ccde6" args="(const unsigned char *name, const unsigned char **attr)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::XMLStream::startElement </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char ** </td>
<td class="paramname"> <em>attr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identify start of an element in the document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of element found. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>list of attributes extracted. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xmlfetch_8cpp-example.html#a8">xmlfetch.cpp</a>.</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="xml_8h_source.html">xml.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:48 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
447
