<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::Digest 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.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</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 class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_digest.html">Digest</a></div>
<h1>ost::Digest Class Reference</h1><!-- doxytag: class="ost::Digest" -->The digest base class is used for implementing and deriving one way hashing functions.base class for hashing services.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="digest_8h-source.html">digest.h</a>></code>
<p>
<p>Inheritance diagram for ost::Digest:
<p><center><img src="classost_1_1_digest.png" usemap="#ost::Digest_map" border="0" alt=""></center>
<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>
<a href="classost_1_1_digest-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#fb83ec064689f9351be8b23b76137584">initDigest</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the digest table to an initial default value. <a href="#fb83ec064689f9351be8b23b76137584"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#5f74be470aaaa4a9208553de6dfce274">Digest</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#54bddba60131f47fab334a10b31e0850">getSize</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of a digest in octets. <a href="#54bddba60131f47fab334a10b31e0850"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#afe56b139e7fb543945b7350a59f44fd">getDigest</a> (unsigned char *buffer)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the binary digest buffer to user memory. <a href="#afe56b139e7fb543945b7350a59f44fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#a7d1b98a1a6c5c81c730dae029ef33b6">putDigest</a> (const unsigned char *buffer, unsigned length)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put data into the digest bypassing the stream subsystem. <a href="#a7d1b98a1a6c5c81c730dae029ef33b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#f47d1d12e4a3a17949475d0619dbfedc">strDigest</a> (std::ostream &os)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">print a digest string for export. <a href="#f47d1d12e4a3a17949475d0619dbfedc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_digest.html#f2324d0c454efb54bf984dcd75761c1e">operator<<</a> (std::ostream &os, <a class="el" href="classost_1_1_digest.html">Digest</a> &ia)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The digest base class is used for implementing and deriving one way hashing functions.base class for hashing services.
<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5f74be470aaaa4a9208553de6dfce274"></a><!-- doxytag: member="ost::Digest::Digest" ref="5f74be470aaaa4a9208553de6dfce274" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Digest::Digest </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="afe56b139e7fb543945b7350a59f44fd"></a><!-- doxytag: member="ost::Digest::getDigest" ref="afe56b139e7fb543945b7350a59f44fd" args="(unsigned char *buffer)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual unsigned ost::Digest::getDigest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname1" valign="top" nowrap> <em>buffer</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copy the binary digest buffer to user memory.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes in digest. </dd></dl>
<dl compact><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 write into. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classost_1_1_checksum_digest.html#49ebb38c76a9997042a1ed46f53c12a4">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#57217e64cec5486587e88265aa2d78bf">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#b04d7ae0a9ab46351f441d3a62b6ca98">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#1ebd81f1541d9654e8590e478ed3c74b">ost::MD5Digest</a>. </td>
</tr>
</table>
<a class="anchor" name="54bddba60131f47fab334a10b31e0850"></a><!-- doxytag: member="ost::Digest::getSize" ref="54bddba60131f47fab334a10b31e0850" args="(void)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual unsigned ost::Digest::getSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the size of a digest in octets.
<p>
<dl compact><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#3db2b1aba8155a14a046f39bd3747a20">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a26d12f656b4ed185ed5680e4197faa4">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#10305cfa59bebc37b56d779493dbc4be">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#3b8651f97cfc44fafa597f758eb79a20">ost::MD5Digest</a>. </td>
</tr>
</table>
<a class="anchor" name="fb83ec064689f9351be8b23b76137584"></a><!-- doxytag: member="ost::Digest::initDigest" ref="fb83ec064689f9351be8b23b76137584" args="(void)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::Digest::initDigest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reset the digest table to an initial default value.
<p>
<p>
Implemented in <a class="el" href="classost_1_1_checksum_digest.html#379e8216ad09a5943d07cb51b6c945e7">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#92728e477621a3ce53bd2bb84f7c0c16">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#f5db909388169c71b241aa80468aca19">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#bb49416f33a850620bb6e7ad70d77af6">ost::MD5Digest</a>. </td>
</tr>
</table>
<a class="anchor" name="a7d1b98a1a6c5c81c730dae029ef33b6"></a><!-- doxytag: member="ost::Digest::putDigest" ref="a7d1b98a1a6c5c81c730dae029ef33b6" args="(const unsigned char *buffer, unsigned length)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::Digest::putDigest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>length</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Put data into the digest bypassing the stream subsystem.
<p>
<dl compact><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 from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>of data. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classost_1_1_checksum_digest.html#084929691dbd2bbaad34da37bde01321">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a572b17f2451a0f0a4c67e77cf25a0c0">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#2eaff9b0e5fa824b8f16c69b673b3174">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#95b392cae2a51f06a98278f001593dd7">ost::MD5Digest</a>. </td>
</tr>
</table>
<a class="anchor" name="f47d1d12e4a3a17949475d0619dbfedc"></a><!-- doxytag: member="ost::Digest::strDigest" ref="f47d1d12e4a3a17949475d0619dbfedc" args="(std::ostream &os)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual std::ostream& ost::Digest::strDigest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::ostream & </td>
<td class="mdname1" valign="top" nowrap> <em>os</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
print a digest string for export.
<p>
<dl compact><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#33a2c583faa4757ff07ce705f8761328">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#7c5edf77e4f78ae9f556e3ba9dbcb0fd">ost::CRC16Digest</a>, <a class="el" href="classost_1_1_c_r_c32_digest.html#942cace7a6d62b8758357649648174a8">ost::CRC32Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#da86b9bb0c35de81622c2ace92d543ad">ost::MD5Digest</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="f2324d0c454efb54bf984dcd75761c1e"></a><!-- doxytag: member="ost::Digest::operator<<" ref="f2324d0c454efb54bf984dcd75761c1e" args="(std::ostream &os, Digest &ia)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::ostream& operator<< </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::ostream & </td>
<td class="mdname" nowrap> <em>os</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_digest.html">Digest</a> & </td>
<td class="mdname" nowrap> <em>ia</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
