<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: pipe.h 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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>pipe.h</h1><a href="pipe_8h.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"></span><span class="comment">/// \file pipe.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Connector class to join parsers and builders together</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2010-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_PIPE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PIPE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="builder_8h.html" title="Virtual protocol packet builder wrapper.">builder.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="parser_8h.html" title="Virtual parser wrapper.">parser.h</a>"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>Barry {
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">//</span>
<a name="l00032"></a>00032 <span class="comment">// class Pipe</span>
<a name="l00033"></a>00033 <span class="comment">//</span><span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/// Reads data from a builder and feeds it into a parser.</span>
<a name="l00035"></a>00035 <span class="comment">///</span>
<a name="l00036"></a><a class="code" href="classBarry_1_1Pipe.html">00036</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Pipe.html" title="Reads data from a builder and feeds it into a parser.">Pipe</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &m_builder;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> m_buffer;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a>00043 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1Pipe.html" title="Reads data from a builder and feeds it into a parser.">Pipe</a>(<a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &builder);
<a name="l00044"></a>00044 ~<a class="code" href="classBarry_1_1Pipe.html" title="Reads data from a builder and feeds it into a parser.">Pipe</a>();
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /// Access the builder... mostly useful for finding out</span>
<a name="l00047"></a>00047 <span class="comment"> /// the database name for the next series, if using multiple</span>
<a name="l00048"></a>00048 <span class="comment"> /// parser objects.</span>
<a name="l00049"></a><a class="code" href="classBarry_1_1Pipe.html#5a63c9f84ccb3a580b2ba81ba690bd87">00049</a> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>& GetBuilder()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_builder; }
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /// Reads one item from the builder and feeds it into the parser</span>
<a name="l00052"></a>00052 <span class="comment"> /// and returns the builder Retrieve status.</span>
<a name="l00053"></a>00053 <span class="comment"></span> <span class="keywordtype">bool</span> PumpEntry(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic = 0);
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /// Reads all items from builder, feeding them into the parser,</span>
<a name="l00056"></a>00056 <span class="comment"> /// until the builder's Retrieve() signals the end of the series.</span>
<a name="l00057"></a>00057 <span class="comment"></span> <span class="keywordtype">void</span> PumpSeries(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic = 0);
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /// Reads all series from the builder, feeding them into the parser,</span>
<a name="l00060"></a>00060 <span class="comment"> /// until the builder's EndOfFile() is true.</span>
<a name="l00061"></a>00061 <span class="comment"></span> <span class="keywordtype">void</span> PumpFile(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic = 0);
<a name="l00062"></a>00062 };
<a name="l00063"></a>00063
<a name="l00064"></a>00064 } <span class="comment">// namespace Barry</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="preprocessor">#endif</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 2011 for Barry 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>
