<!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>ucommon: ucommon::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="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00046.html">Digest</a>
</div>
</div>
<div class="contents">
<h1>ucommon::Digest Class Reference</h1><!-- doxytag: class="ucommon::Digest" -->
<p>A cryptographic digest class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00196_source.html">secure.h</a>></code></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"><a class="anchor" id="a103ea8a04ddab87689ddea52d116f869"></a><!-- doxytag: member="ucommon::Digest::c_str" ref="a103ea8a04ddab87689ddea52d116f869" args="(void)" -->
const char * </td><td class="memItemRight" valign="bottom"><b>c_str</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa913ae362dafb2afa9db33697ee3d76"></a><!-- doxytag: member="ucommon::Digest::Digest" ref="aaa913ae362dafb2afa9db33697ee3d76" args="(const char *type)" -->
</td><td class="memItemRight" valign="bottom"><b>Digest</b> (const char *type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1f11e88b6b805daec8ee6a2b20c2cd"></a><!-- doxytag: member="ucommon::Digest::get" ref="a3b1f11e88b6b805daec8ee6a2b20c2cd" args="(void)" -->
const unsigned char * </td><td class="memItemRight" valign="bottom"><b>get</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afedf632a09d6dbbe8fea1f896c4eecb1"></a><!-- doxytag: member="ucommon::Digest::operator bool" ref="afedf632a09d6dbbe8fea1f896c4eecb1" args="() const " -->
</td><td class="memItemRight" valign="bottom"><b>operator bool</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e6f107bde5b0c4dcbd76bbde05572ab"></a><!-- doxytag: member="ucommon::Digest::operator String" ref="a0e6f107bde5b0c4dcbd76bbde05572ab" args="()" -->
</td><td class="memItemRight" valign="bottom"><b>operator String</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4dcdda9a2056406a554bfc047f21056"></a><!-- doxytag: member="ucommon::Digest::operator!" ref="af4dcdda9a2056406a554bfc047f21056" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6e026e67da5e9d835c96e75457ade36"></a><!-- doxytag: member="ucommon::Digest::operator*" ref="ae6e026e67da5e9d835c96e75457ade36" args="()" -->
const char * </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c153e01c2435c0b3c37e94de041221e"></a><!-- doxytag: member="ucommon::Digest::operator*=" ref="a4c153e01c2435c0b3c37e94de041221e" args="(const char *text)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator*=</b> (const char *text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a787c747290843c2ed3ebaa679c2e9c19"></a><!-- doxytag: member="ucommon::Digest::operator+=" ref="a787c747290843c2ed3ebaa679c2e9c19" args="(const char *text)" -->
bool </td><td class="memItemRight" valign="bottom"><b>operator+=</b> (const char *text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58f1c8dbcd0041605d32ed0456edb806"></a><!-- doxytag: member="ucommon::Digest::operator=" ref="a58f1c8dbcd0041605d32ed0456edb806" args="(const char *id)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a447d8b2877bf0142941dae3febfc9a86"></a><!-- doxytag: member="ucommon::Digest::put" ref="a447d8b2877bf0142941dae3febfc9a86" args="(const void *memory, size_t size)" -->
bool </td><td class="memItemRight" valign="bottom"><b>put</b> (const void *memory, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae538daefe88ac28a807d62a9fa13f6f2"></a><!-- doxytag: member="ucommon::Digest::puts" ref="ae538daefe88ac28a807d62a9fa13f6f2" args="(const char *str)" -->
bool </td><td class="memItemRight" valign="bottom"><b>puts</b> (const char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#aaa3fe38a27522be045455b356b1f46ba">recycle</a> (bool binary=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize and recycle current digest to start a new digest. <a href="#aaa3fe38a27522be045455b356b1f46ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8207470d1d360061982d69c8526bc5b4"></a><!-- doxytag: member="ucommon::Digest::reset" ref="a8207470d1d360061982d69c8526bc5b4" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a8207470d1d360061982d69c8526bc5b4">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and restart digest object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada7addf61abc2b94f223e220669e64ce"></a><!-- doxytag: member="ucommon::Digest::set" ref="ada7addf61abc2b94f223e220669e64ce" args="(const char *id)" -->
void </td><td class="memItemRight" valign="bottom"><b>set</b> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbfa471ab4facfbccd2a42737e0f6a91"></a><!-- doxytag: member="ucommon::Digest::size" ref="afbfa471ab4facfbccd2a42737e0f6a91" args="() const " -->
unsigned </td><td class="memItemRight" valign="bottom"><b>size</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a645f0773860cf471afd69158a868a053"></a><!-- doxytag: member="ucommon::Digest::str" ref="a645f0773860cf471afd69158a868a053" args="(void)" -->
<a class="el" href="a00148.html">String</a> </td><td class="memItemRight" valign="bottom"><b>str</b> (void)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a50fdf7fd030f8864f3bccd6f0d395966">is</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if a specific digest type is supported. <a href="#a50fdf7fd030f8864f3bccd6f0d395966"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad361927e66df388046c7ae6f27777854"></a><!-- doxytag: member="ucommon::Digest::uuid" ref="ad361927e66df388046c7ae6f27777854" args="(const char *name, const unsigned char *ns=NULL)" -->
static <a class="el" href="a00148.html">String</a> </td><td class="memItemRight" valign="bottom"><b>uuid</b> (const char *name, const unsigned char *ns=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc0ca43f4c49135fe024be8fdc3129d2"></a><!-- doxytag: member="ucommon::Digest::uuid" ref="adc0ca43f4c49135fe024be8fdc3129d2" args="(char *string, const char *name, const unsigned char *ns=NULL)" -->
static void </td><td class="memItemRight" valign="bottom"><b>uuid</b> (char *<a class="el" href="a00148.html">string</a>, const char *name, const unsigned char *ns=NULL)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeab5df8a2f575b5c117a0f510099bfc0"></a><!-- doxytag: member="ucommon::Digest::release" ref="aeab5df8a2f575b5c117a0f510099bfc0" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><b>release</b> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A cryptographic digest class. </p>
<p>This class can support md5 digests, sha1, sha256, etc, depending on what the underlying library supports. The hash class accumulates the hash in the object. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00196_source.html#l00431">431</a> of file <a class="el" href="a00196_source.html">secure.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a50fdf7fd030f8864f3bccd6f0d395966"></a><!-- doxytag: member="ucommon::Digest::is" ref="a50fdf7fd030f8864f3bccd6f0d395966" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ucommon::Digest::is </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test to see if a specific digest type is supported. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of digest we want to check. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if supported, false if not. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa3fe38a27522be045455b356b1f46ba"></a><!-- doxytag: member="ucommon::Digest::recycle" ref="aaa3fe38a27522be045455b356b1f46ba" args="(bool binary=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::Digest::recycle </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>binary</em> = <code>false</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finalize and recycle current digest to start a new digest. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>binary</em> </td><td>digest used rather than text if true. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00196_source.html">secure.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:34 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
