Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 726

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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>Crystal Space 1.2.1: csMD5 Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</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>
<h1>csMD5 Class Reference</h1><!-- doxytag: class="csMD5" -->This is an encapsulation of a C-implementation of MD5 digest algorithm by Peter Deutsch &lt;<a href="mailto:ghost@aladdin.com">ghost@aladdin.com</a>&gt;.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="csmd5_8h-source.html">csutil/csmd5.h</a>&gt;</code>
<p>

<p>
<a href="classcsMD5-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">md5_byte_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">8-bit byte  <a href="#804f37972d0afc626be0e6a2f57df6bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#769ff8689e54f469b0ca3dd181eb79f5">md5_word_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">32-bit word  <a href="#769ff8689e54f469b0ca3dd181eb79f5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#fe9b89029dfc63c087e9fe956c4c2fe3">Encode</a> (const void *, size_t nbytes)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode a buffer.  <a href="#fe9b89029dfc63c087e9fe956c4c2fe3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#1746751f47fc8d44e21f6eb54174c4cf">Encode</a> (const char *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode a null-terminated string buffer.  <a href="#1746751f47fc8d44e21f6eb54174c4cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#3be9f6bab0c16d0d5e4c06bacac4dae0">Encode</a> (<a class="el" href="classcsString.html">csString</a> const &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode a string.  <a href="#3be9f6bab0c16d0d5e4c06bacac4dae0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#2a043156ebd8205d52e70b9d69af2a1c">md5_append</a> (<a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *, const <a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">md5_byte_t</a> *data, size_t nbytes)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Append a string to the message.  <a href="#2a043156ebd8205d52e70b9d69af2a1c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#34708efa15a5a161d02fca63cf08f00c">md5_finish</a> (<a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *, <a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">md5_byte_t</a> digest[16])</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish the message and return the digest.  <a href="#34708efa15a5a161d02fca63cf08f00c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsMD5.html#04afb6fb334551ba7f1a1707a133d034">md5_init</a> (<a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the algorithm.  <a href="#04afb6fb334551ba7f1a1707a133d034"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMD5_1_1Digest.html">Digest</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An MD5 digest is 16 unsigned characters (not 0-terminated).  <a href="structcsMD5_1_1Digest.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is an encapsulation of a C-implementation of MD5 digest algorithm by Peter Deutsch &lt;<a href="mailto:ghost@aladdin.com">ghost@aladdin.com</a>&gt;. 
<p>
It provides the exact raw interface as Peter's original code except that it is wrapped within a namespace, as well as a more convenient interface which allows one to create a digest in a single step. 
<p>Definition at line <a class="el" href="csmd5_8h-source.html#l00077">77</a> of file <a class="el" href="csmd5_8h-source.html">csmd5.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="804f37972d0afc626be0e6a2f57df6bf"></a><!-- doxytag: member="csMD5::md5_byte_t" ref="804f37972d0afc626be0e6a2f57df6bf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> <a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">csMD5::md5_byte_t</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
8-bit byte 
<p>

<p>Definition at line <a class="el" href="csmd5_8h-source.html#l00081">81</a> of file <a class="el" href="csmd5_8h-source.html">csmd5.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="769ff8689e54f469b0ca3dd181eb79f5"></a><!-- doxytag: member="csMD5::md5_word_t" ref="769ff8689e54f469b0ca3dd181eb79f5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> <a class="el" href="classcsMD5.html#769ff8689e54f469b0ca3dd181eb79f5">csMD5::md5_word_t</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
32-bit word 
<p>

<p>Definition at line <a class="el" href="csmd5_8h-source.html#l00083">83</a> of file <a class="el" href="csmd5_8h-source.html">csmd5.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fe9b89029dfc63c087e9fe956c4c2fe3"></a><!-- doxytag: member="csMD5::Encode" ref="fe9b89029dfc63c087e9fe956c4c2fe3" args="(const void *, size_t nbytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a> csMD5::Encode           </td>
          <td>(</td>
          <td class="paramtype">const void *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>nbytes</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Encode a buffer. 
<p>

</div>
</div><p>
<a class="anchor" name="1746751f47fc8d44e21f6eb54174c4cf"></a><!-- doxytag: member="csMD5::Encode" ref="1746751f47fc8d44e21f6eb54174c4cf" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a> csMD5::Encode           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Encode a null-terminated string buffer. 
<p>

</div>
</div><p>
<a class="anchor" name="3be9f6bab0c16d0d5e4c06bacac4dae0"></a><!-- doxytag: member="csMD5::Encode" ref="3be9f6bab0c16d0d5e4c06bacac4dae0" args="(csString const &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structcsMD5_1_1Digest.html">Digest</a> csMD5::Encode           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsString.html">csString</a> const &amp;&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Encode a string. 
<p>

</div>
</div><p>
<a class="anchor" name="2a043156ebd8205d52e70b9d69af2a1c"></a><!-- doxytag: member="csMD5::md5_append" ref="2a043156ebd8205d52e70b9d69af2a1c" args="(md5_state_t *, const md5_byte_t *data, size_t nbytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void csMD5::md5_append           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">md5_byte_t</a> *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>nbytes</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Append a string to the message. 
<p>

</div>
</div><p>
<a class="anchor" name="34708efa15a5a161d02fca63cf08f00c"></a><!-- doxytag: member="csMD5::md5_finish" ref="34708efa15a5a161d02fca63cf08f00c" args="(md5_state_t *, md5_byte_t digest[16])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void csMD5::md5_finish           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsMD5.html#804f37972d0afc626be0e6a2f57df6bf">md5_byte_t</a>&nbsp;</td>
          <td class="paramname"> <em>digest</em>[16]</td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Finish the message and return the digest. 
<p>

</div>
</div><p>
<a class="anchor" name="04afb6fb334551ba7f1a1707a133d034"></a><!-- doxytag: member="csMD5::md5_init" ref="04afb6fb334551ba7f1a1707a133d034" args="(md5_state_t *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void csMD5::md5_init           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcsMD5_1_1md5__state__t.html">md5_state_t</a> *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize the algorithm. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csmd5_8h-source.html">csmd5.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>