<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ost::Digest class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.10 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>ost::Digest Class Reference</h1>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.gif" usemap="#ost::Digest_map" border="0"></center> <map name="ost::Digest_map"> <area href="classstd_1_1streambuf.html" alt="std::streambuf" shape="rect" coords="68,0,195,24"> <area href="classstd_1_1ostream.html" alt="std::ostream" shape="rect" coords="205,0,332,24"> <area href="classost_1_1_checksum_digest.html" alt="ost::ChecksumDigest" shape="rect" coords="0,112,127,136"> <area href="classost_1_1_c_r_c16_digest.html" alt="ost::CRC16Digest" shape="rect" coords="137,112,264,136"> <area href="classost_1_1_m_d5_digest.html" alt="ost::MD5Digest" shape="rect" coords="274,112,401,136"> </map> <a href="classost_1_1_digest-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b0">Digest</a> ()</td></tr> <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b1">initDigest</a> (void)=0</td></tr> <tr><td> </td><td><font size=-1><em>Reset the digest table to an initial default value.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual unsigned </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b2">getSize</a> (void)=0</td></tr> <tr><td> </td><td><font size=-1><em>Get the size of a digest in octets.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual unsigned </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b3">getDigest</a> (unsigned char *buffer)=0</td></tr> <tr><td> </td><td><font size=-1><em>Copy the binary digest buffer to user memory.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b4">putDigest</a> (unsigned char *buffer, unsigned length)=0</td></tr> <tr><td> </td><td><font size=-1><em>Put data into the digest bypassing the stream subsystem.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual <a class="el" href="classstd_1_1ostream.html">std::ostream</a> & </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#b5">strDigest</a> (<a class="el" href="classstd_1_1ostream.html">std::ostream</a> &os)=0</td></tr> <tr><td> </td><td><font size=-1><em>print a digest string for export.</em> <a href="#b5">More...</a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Friends</h2></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classstd_1_1ostream.html">std::ostream</a> & </td><td valign=bottom><a class="el" href="classost_1_1_digest.html#l0">operator<<</a> (<a class="el" href="classstd_1_1ostream.html">std::ostream</a> &os, Digest &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><dd> David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="b0" doxytag="ost::Digest::Digest"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> ost::Digest::Digest </td> <td class="md">( </td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><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 name="b3" doxytag="ost::Digest::getDigest"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual unsigned ost::Digest::getDigest </td> <td class="md">( </td> <td class="md">unsigned char *</td> <td class="mdname1"> <em>buffer</em> </td> <td class="md">) </td> <td class="md"><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><dd> number of bytes in digest. </dl><dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>buffer </em> </td><td> to write into. </td></tr> </table> </dl> <p> Reimplemented in <a class="el" href="classost_1_1_checksum_digest.html#a3">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a3">ost::CRC16Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a3">ost::MD5Digest</a>. </td> </tr> </table> <a name="b2" doxytag="ost::Digest::getSize"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual unsigned ost::Digest::getSize </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><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><dd> number of bytes in digest. </dl> <p> Reimplemented in <a class="el" href="classost_1_1_checksum_digest.html#a2">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a2">ost::CRC16Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a2">ost::MD5Digest</a>. </td> </tr> </table> <a name="b1" doxytag="ost::Digest::initDigest"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void ost::Digest::initDigest </td> <td class="md">( </td> <td class="md">void</td> <td class="mdname1"> </td> <td class="md">) </td> <td class="md"><code> [protected, 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> Reimplemented in <a class="el" href="classost_1_1_checksum_digest.html#a1">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a1">ost::CRC16Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a1">ost::MD5Digest</a>. </td> </tr> </table> <a name="b4" doxytag="ost::Digest::putDigest"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void ost::Digest::putDigest </td> <td class="md">( </td> <td class="md">unsigned char *</td> <td class="mdname"> <em>buffer</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">unsigned</td> <td class="mdname"> <em>len</em></td> </tr> <tr> <td></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><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>buffer </em> </td><td> to read from. </td></tr> <tr><td valign=top><em>length </em> </td><td> of data. </td></tr> </table> </dl> <p> Reimplemented in <a class="el" href="classost_1_1_checksum_digest.html#a4">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#a4">ost::CRC16Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#a4">ost::MD5Digest</a>. </td> </tr> </table> <a name="b5" doxytag="ost::Digest::strDigest"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classstd_1_1ostream.html">std::ostream</a>& ost::Digest::strDigest </td> <td class="md">( </td> <td class="md"><a class="el" href="classstd_1_1ostream.html">std::ostream</a> &</td> <td class="mdname1"> <em>os</em> </td> <td class="md">) </td> <td class="md"><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><dd> string representation of digest. </dl> <p> Reimplemented in <a class="el" href="classost_1_1_checksum_digest.html#b1">ost::ChecksumDigest</a>, <a class="el" href="classost_1_1_c_r_c16_digest.html#b1">ost::CRC16Digest</a>, and <a class="el" href="classost_1_1_m_d5_digest.html#b3">ost::MD5Digest</a>. </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a name="l0" doxytag="ost::Digest::operator<<"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classstd_1_1ostream.html">std::ostream</a>& operator<< </td> <td class="md">( </td> <td class="md"><a class="el" href="classstd_1_1ostream.html">std::ostream</a> &</td> <td class="mdname"> <em>os</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md">Digest &</td> <td class="mdname"> <em>ia</em></td> </tr> <tr> <td></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><address><small>Generated at Fri Jan 4 18:51:47 2002 for CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>