Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 2aa62c5bbb658df1fece777472a7bcf2 > files > 990

barry-devel-docs-0.17-0.3.20100730git.fc14.noarch.rpm

<!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>Barry: ChecksumParser 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.2-20100208 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>ChecksumParser Class Reference</h1><!-- doxytag: class="ChecksumParser" --><!-- doxytag: inherits="Barry::Parser" --><div class="dynheader">
Inheritance diagram for ChecksumParser:</div>
<div class="dynsection">
<div class="center"><img src="classChecksumParser__inherit__graph.png" border="0" usemap="#ChecksumParser_inherit__map" alt="Inheritance graph"/></div>
<map name="ChecksumParser_inherit__map" id="ChecksumParser_inherit__map">
<area shape="rect" id="node2" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy." alt="" coords="17,6,119,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ChecksumParser:</div>
<div class="dynsection">
<div class="center"><img src="classChecksumParser__coll__graph.png" border="0" usemap="#ChecksumParser_coll__map" alt="Collaboration graph"/></div>
<map name="ChecksumParser_coll__map" id="ChecksumParser_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy." alt="" coords="5,6,107,37"/><area shape="rect" id="node4" href="structBarry_1_1SHA__CTX.html" title="Barry::SHA_CTX" alt="" coords="131,6,253,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classChecksumParser-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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChecksumParser.html#ae557918eae2b18aad4d2b9d211f637aa">Clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and prepare for a new raw data packet.  <a href="#ae557918eae2b18aad4d2b9d211f637aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChecksumParser.html#ab3b20a2418a4cb1427cdf50524ad911a">SetIds</a> (uint8_t RecType, uint32_t UniqueId)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores the IDs.  <a href="#ab3b20a2418a4cb1427cdf50524ad911a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChecksumParser.html#a3a2ac40a6d48218e17f43937a81668a7">ParseHeader</a> (const <a class="el" href="classBarry_1_1Data.html">Barry::Data</a> &amp;, size_t &amp;)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to parse the header portion of the raw data packet.  <a href="#a3a2ac40a6d48218e17f43937a81668a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChecksumParser.html#aa8381c46cf4d2f1eca7d13ca0218c98b">ParseFields</a> (const <a class="el" href="classBarry_1_1Data.html">Barry::Data</a> &amp;data, size_t &amp;offset, const <a class="el" href="classBarry_1_1IConverter.html">Barry::IConverter</a> *ic)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to parse sub fields in the raw data packet.  <a href="#aa8381c46cf4d2f1eca7d13ca0218c98b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChecksumParser.html#adac9dc038ae4436aeef29c04a9b5f9de">Store</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called at the very end of record parsing, and used to store the final packet somewhere, either in memory, disk, etc.  <a href="#adac9dc038ae4436aeef29c04a9b5f9de"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00055">55</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae557918eae2b18aad4d2b9d211f637aa"></a><!-- doxytag: member="ChecksumParser::Clear" ref="ae557918eae2b18aad4d2b9d211f637aa" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ChecksumParser::Clear </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reset and prepare for a new raw data packet. </p>

<p>Implements <a class="el" href="classBarry_1_1Parser.html#a15acb3544613d43d8f928cd63a19022b">Barry::Parser</a>.</p>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00065">65</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>

</div>
</div>
<a class="anchor" id="aa8381c46cf4d2f1eca7d13ca0218c98b"></a><!-- doxytag: member="ChecksumParser::ParseFields" ref="aa8381c46cf4d2f1eca7d13ca0218c98b" args="(const Barry::Data &amp;data, size_t &amp;offset, const Barry::IConverter *ic)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ChecksumParser::ParseFields </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classBarry_1_1Data.html">Barry::Data</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t &amp;&nbsp;</td>
          <td class="paramname"> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classBarry_1_1IConverter.html">Barry::IConverter</a> *&nbsp;</td>
          <td class="paramname"> <em>ic</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called to parse sub fields in the raw data packet. </p>
<p>The same data is passed as was passed in ParseHeader, only the offset will be updated if it was advanced during the header parsing. </p>

<p>Implements <a class="el" href="classBarry_1_1Parser.html#a645718d87aaad3ee2c36664de05046d2">Barry::Parser</a>.</p>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00083">83</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>

</div>
</div>
<a class="anchor" id="a3a2ac40a6d48218e17f43937a81668a7"></a><!-- doxytag: member="ChecksumParser::ParseHeader" ref="a3a2ac40a6d48218e17f43937a81668a7" args="(const Barry::Data &amp;, size_t &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ChecksumParser::ParseHeader </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classBarry_1_1Data.html">Barry::Data</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t &amp;&nbsp;</td>
          <td class="paramname"> <em>offset</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called to parse the header portion of the raw data packet. </p>
<p>data contains the entire packet, and offset contains the location at which to start parsing. </p>

<p>Implements <a class="el" href="classBarry_1_1Parser.html#a2087d07fb5d8d57c934c4e60278f41d8">Barry::Parser</a>.</p>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00078">78</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>

</div>
</div>
<a class="anchor" id="ab3b20a2418a4cb1427cdf50524ad911a"></a><!-- doxytag: member="ChecksumParser::SetIds" ref="ab3b20a2418a4cb1427cdf50524ad911a" args="(uint8_t RecType, uint32_t UniqueId)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ChecksumParser::SetIds </td>
          <td>(</td>
          <td class="paramtype">uint8_t&nbsp;</td>
          <td class="paramname"> <em>RecType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&nbsp;</td>
          <td class="paramname"> <em>UniqueId</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Stores the IDs. </p>

<p>Implements <a class="el" href="classBarry_1_1Parser.html#a95bfc4014e3e8ded94625f43d1d29800">Barry::Parser</a>.</p>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00070">70</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>

</div>
</div>
<a class="anchor" id="adac9dc038ae4436aeef29c04a9b5f9de"></a><!-- doxytag: member="ChecksumParser::Store" ref="adac9dc038ae4436aeef29c04a9b5f9de" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ChecksumParser::Store </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called at the very end of record parsing, and used to store the final packet somewhere, either in memory, disk, etc. </p>

<p>Implements <a class="el" href="classBarry_1_1Parser.html#abf8ab1598be74268ee486af938c527d4">Barry::Parser</a>.</p>

<p>Definition at line <a class="el" href="brecsum_8cc_source.html#l00091">91</a> of file <a class="el" href="brecsum_8cc_source.html">brecsum.cc</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="brecsum_8cc_source.html">brecsum.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>