Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > ed376d6842ea322c25405e7c23b3bc12 > files > 143

libcommoncpp-devel-1.8.0-5.1mdv2010.1.i586.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>GNU CommonC++: ost::Digest 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&nbsp;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&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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_digest.html">Digest</a>
  </div>
</div>
<div class="contents">
<h1>ost::Digest Class Reference</h1><!-- doxytag: class="ost::Digest" -->
<p>The digest base class is used for implementing and deriving one way hashing functions.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="digest_8h_source.html">digest.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ost::Digest:</div>
<div class="dynsection">
 <div class="center">
  <img src="classost_1_1_digest.png" usemap="#ost::Digest_map" alt=""/>
  <map id="ost::Digest_map" name="ost::Digest_map">
<area href="classost_1_1_checksum_digest.html" alt="ost::ChecksumDigest" shape="rect" coords="0,56,127,80"/>
<area href="classost_1_1_c_r_c16_digest.html" alt="ost::CRC16Digest" shape="rect" coords="137,56,264,80"/>
<area href="classost_1_1_c_r_c32_digest.html" alt="ost::CRC32Digest" shape="rect" coords="274,56,401,80"/>
<area href="classost_1_1_m_d5_digest.html" alt="ost::MD5Digest" shape="rect" coords="411,56,538,80"/>
</map>
 </div>
</div>

<p><a href="classost_1_1_digest-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="classost_1_1_digest.html#afb83ec064689f9351be8b23b76137584">initDigest</a> (void)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the digest table to an initial default value.  <a href="#afb83ec064689f9351be8b23b76137584"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#a73ec30c69ccb8c6185e8a23af14b2029">~Digest</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#a5f74be470aaaa4a9208553de6dfce274">Digest</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#a54bddba60131f47fab334a10b31e0850">getSize</a> (void)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the size of a digest in octets.  <a href="#a54bddba60131f47fab334a10b31e0850"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#aafe56b139e7fb543945b7350a59f44fd">getDigest</a> (unsigned char *buffer)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy the binary digest buffer to user memory.  <a href="#aafe56b139e7fb543945b7350a59f44fd"></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="classost_1_1_digest.html#aa7d1b98a1a6c5c81c730dae029ef33b6">putDigest</a> (const unsigned char *buffer, unsigned length)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Put data into the digest bypassing the stream subsystem.  <a href="#aa7d1b98a1a6c5c81c730dae029ef33b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#af47d1d12e4a3a17949475d0619dbfedc">strDigest</a> (std::ostream &amp;os)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">print a digest string for export.  <a href="#af47d1d12e4a3a17949475d0619dbfedc"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#af2324d0c454efb54bf984dcd75761c1e">operator&lt;&lt;</a> (std::ostream &amp;os, <a class="el" href="classost_1_1_digest.html">Digest</a> &amp;ia)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The digest base class is used for implementing and deriving one way hashing functions. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>&gt; base class for hashing services. </dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5f74be470aaaa4a9208553de6dfce274"></a><!-- doxytag: member="ost::Digest::Digest" ref="a5f74be470aaaa4a9208553de6dfce274" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::Digest::Digest </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a73ec30c69ccb8c6185e8a23af14b2029"></a><!-- doxytag: member="ost::Digest::~Digest" ref="a73ec30c69ccb8c6185e8a23af14b2029" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ost::Digest::~Digest </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aafe56b139e7fb543945b7350a59f44fd"></a><!-- doxytag: member="ost::Digest::getDigest" ref="aafe56b139e7fb543945b7350a59f44fd" args="(unsigned char *buffer)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual unsigned ost::Digest::getDigest </td>
          <td>(</td>
          <td class="paramtype">unsigned char *&nbsp;</td>
          <td class="paramname"> <em>buffer</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Copy the binary digest buffer to user memory. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes in digest. </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>&nbsp;</td><td>to write into. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classost_1_1_checksum_digest.html#a49ebb38c76a9997042a1ed46f53c12a4">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a57217e64cec5486587e88265aa2d78bf">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#ab04d7ae0a9ab46351f441d3a62b6ca98">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a1ebd81f1541d9654e8590e478ed3c74b">ost::MD5Digest</a>.</p>

</div>
</div>
<a class="anchor" id="a54bddba60131f47fab334a10b31e0850"></a><!-- doxytag: member="ost::Digest::getSize" ref="a54bddba60131f47fab334a10b31e0850" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual unsigned ost::Digest::getSize </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the size of a digest in octets. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes in digest. </dd></dl>

<p>Implemented in <a class="el" href="classost_1_1_checksum_digest.html#a3db2b1aba8155a14a046f39bd3747a20">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#aa26d12f656b4ed185ed5680e4197faa4">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#a10305cfa59bebc37b56d779493dbc4be">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a3b8651f97cfc44fafa597f758eb79a20">ost::MD5Digest</a>.</p>

</div>
</div>
<a class="anchor" id="afb83ec064689f9351be8b23b76137584"></a><!-- doxytag: member="ost::Digest::initDigest" ref="afb83ec064689f9351be8b23b76137584" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::Digest::initDigest </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reset the digest table to an initial default value. </p>

<p>Implemented in <a class="el" href="classost_1_1_checksum_digest.html#a379e8216ad09a5943d07cb51b6c945e7">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a92728e477621a3ce53bd2bb84f7c0c16">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#af5db909388169c71b241aa80468aca19">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#abb49416f33a850620bb6e7ad70d77af6">ost::MD5Digest</a>.</p>

</div>
</div>
<a class="anchor" id="aa7d1b98a1a6c5c81c730dae029ef33b6"></a><!-- doxytag: member="ost::Digest::putDigest" ref="aa7d1b98a1a6c5c81c730dae029ef33b6" args="(const unsigned char *buffer, unsigned length)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::Digest::putDigest </td>
          <td>(</td>
          <td class="paramtype">const unsigned char *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>length</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Put data into the digest bypassing the stream subsystem. </p>
<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>&nbsp;</td><td>to read from. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>of data. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classost_1_1_checksum_digest.html#a084929691dbd2bbaad34da37bde01321">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#aa572b17f2451a0f0a4c67e77cf25a0c0">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#a2eaff9b0e5fa824b8f16c69b673b3174">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a95b392cae2a51f06a98278f001593dd7">ost::MD5Digest</a>.</p>

</div>
</div>
<a class="anchor" id="af47d1d12e4a3a17949475d0619dbfedc"></a><!-- doxytag: member="ost::Digest::strDigest" ref="af47d1d12e4a3a17949475d0619dbfedc" args="(std::ostream &amp;os)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::ostream&amp; ost::Digest::strDigest </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>print a digest string for export. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string representation of digest. </dd></dl>

<p>Implemented in <a class="el" href="classost_1_1_checksum_digest.html#a33a2c583faa4757ff07ce705f8761328">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a7c5edf77e4f78ae9f556e3ba9dbcb0fd">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#a942cace7a6d62b8758357649648174a8">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#ada86b9bb0c35de81622c2ace92d543ad">ost::MD5Digest</a>.</p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="af2324d0c454efb54bf984dcd75761c1e"></a><!-- doxytag: member="ost::Digest::operator&lt;&lt;" ref="af2324d0c454efb54bf984dcd75761c1e" args="(std::ostream &amp;os, Digest &amp;ia)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream&amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classost_1_1_digest.html">Digest</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ia</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="digest_8h_source.html">digest.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>