<!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: Digest Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00044.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>Digest Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Digest" -->
<p>A cryptographic digest class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00195_source.html">secure.h</a>></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a688337335cb748d3154c76ac8ea720a1"></a><!-- doxytag: member="Digest::c_str" ref="a688337335cb748d3154c76ac8ea720a1" 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="a5848479ccd4a6129e1befdaa51247614"></a><!-- doxytag: member="Digest::Digest" ref="a5848479ccd4a6129e1befdaa51247614" 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="a95a09842ab5aeabc5dc5e5dca37f4562"></a><!-- doxytag: member="Digest::get" ref="a95a09842ab5aeabc5dc5e5dca37f4562" 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="ab7932acc2ac5227077f1e58e09e48d48"></a><!-- doxytag: member="Digest::operator bool" ref="ab7932acc2ac5227077f1e58e09e48d48" 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="acb5e84f1b2b592ce60c02ac57fb7da28"></a><!-- doxytag: member="Digest::operator String" ref="acb5e84f1b2b592ce60c02ac57fb7da28" 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="a2ddd0e3e3e10adf40ac918637c3dcc7d"></a><!-- doxytag: member="Digest::operator!" ref="a2ddd0e3e3e10adf40ac918637c3dcc7d" 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="a34a848483d865812c8dd3aa6d16b9aa1"></a><!-- doxytag: member="Digest::operator*" ref="a34a848483d865812c8dd3aa6d16b9aa1" 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="a475d05ac114564e2aafa5efeaa0c016e"></a><!-- doxytag: member="Digest::operator*=" ref="a475d05ac114564e2aafa5efeaa0c016e" 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="aca8d46c182cf0b934907cb70223475de"></a><!-- doxytag: member="Digest::operator+=" ref="aca8d46c182cf0b934907cb70223475de" 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="a97e25f91e207f785c0e6ca81aaea1f4b"></a><!-- doxytag: member="Digest::operator=" ref="a97e25f91e207f785c0e6ca81aaea1f4b" 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="a1882657ba44153f792162638f679da9d"></a><!-- doxytag: member="Digest::put" ref="a1882657ba44153f792162638f679da9d" 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="ac7f816c55d64fd6310e9b12d6afe8746"></a><!-- doxytag: member="Digest::puts" ref="ac7f816c55d64fd6310e9b12d6afe8746" 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="a00044.html#a5bcf843cb8d4341b1362681490610ba8">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="#a5bcf843cb8d4341b1362681490610ba8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23240884108bde76072a7e25a3cd9587"></a><!-- doxytag: member="Digest::reset" ref="a23240884108bde76072a7e25a3cd9587" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a23240884108bde76072a7e25a3cd9587">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="a48d7cd85000381e77483c47c6002946d"></a><!-- doxytag: member="Digest::set" ref="a48d7cd85000381e77483c47c6002946d" 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="a88b424d019aa6f332a4539712de2770b"></a><!-- doxytag: member="Digest::size" ref="a88b424d019aa6f332a4539712de2770b" 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="ad9ed60cce3dfdeb1c734171c3ed0eca5"></a><!-- doxytag: member="Digest::str" ref="ad9ed60cce3dfdeb1c734171c3ed0eca5" args="(void)" -->
<a class="el" href="a00150.html">String</a> </td><td class="memItemRight" valign="bottom"><b>str</b> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
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="a00044.html#ab453d2b8b915a0de2f45f6acdf9a3a9d">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="#ab453d2b8b915a0de2f45f6acdf9a3a9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43296d97ec702cff50319d16522bfccd"></a><!-- doxytag: member="Digest::uuid" ref="a43296d97ec702cff50319d16522bfccd" args="(const char *name, const unsigned char *ns=NULL)" -->
static <a class="el" href="a00150.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="aee5429a6d86e57b163dcd39434ee6126"></a><!-- doxytag: member="Digest::uuid" ref="aee5429a6d86e57b163dcd39434ee6126" 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="a00150.html">string</a>, const char *name, const unsigned char *ns=NULL)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5d9587407c1357664e3193e7ea87b9c"></a><!-- doxytag: member="Digest::release" ref="ac5d9587407c1357664e3193e7ea87b9c" 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>
<div class="textblock"><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>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="a00005.html#_a0">digest.cpp</a>.</p>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00387">387</a> of file <a class="el" href="a00195_source.html">secure.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab453d2b8b915a0de2f45f6acdf9a3a9d"></a><!-- doxytag: member="Digest::is" ref="ab453d2b8b915a0de2f45f6acdf9a3a9d" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool 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 class="params">
<tr><td class="paramname">name</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="a5bcf843cb8d4341b1362681490610ba8"></a><!-- doxytag: member="Digest::recycle" ref="a5bcf843cb8d4341b1362681490610ba8" args="(bool binary=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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 class="params">
<tr><td class="paramname">binary</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="a00195_source.html">secure.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00044.html">Digest</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
