File: Poco.DigestEngine.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (96 lines) | stat: -rw-r--r-- 6,771 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<!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>
<title>Class Poco::DigestEngine</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class DigestEngine</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Crypt<br />
<b>Header:</b> Poco/DigestEngine.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is an abstract base class for all classes implementing a message digest algorithm, like <a href="Poco.MD5Engine.html" title="class Poco::MD5Engine">MD5Engine</a> and <a href="Poco.SHA1Engine.html" title="class Poco::SHA1Engine">SHA1Engine</a>. Call <a href="Poco.DigestEngine.html#4722" title="Poco::DigestEngine::update()">update</a>() repeatedly with data to compute the digest from. When done, call <a href="Poco.DigestEngine.html#4731" title="Poco::DigestEngine::digest()">digest</a>() to obtain the message digest. </p>
</div>
<h2>Inheritance</h2>
<p><b>Known Derived Classes: </b><a href="Poco.Crypto.RSADigestEngine.html" title="class Poco::Crypto::RSADigestEngine">Poco::Crypto::RSADigestEngine</a>, <a href="Poco.HMACEngine.html" title="class Poco::HMACEngine">HMACEngine</a>, <a href="Poco.MD2Engine.html" title="class Poco::MD2Engine">MD2Engine</a>, <a href="Poco.MD4Engine.html" title="class Poco::MD4Engine">MD4Engine</a>, <a href="Poco.MD5Engine.html" title="class Poco::MD5Engine">MD5Engine</a>, <a href="Poco.SHA1Engine.html" title="class Poco::SHA1Engine">SHA1Engine</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.DigestEngine.html#4731" title="Poco::DigestEngine::digest()">digest</a>, <a href="Poco.DigestEngine.html#4729" title="Poco::DigestEngine::digestLength()">digestLength</a>, <a href="Poco.DigestEngine.html#4732" title="Poco::DigestEngine::digestToHex()">digestToHex</a>, <a href="Poco.DigestEngine.html#4730" title="Poco::DigestEngine::reset()">reset</a>, <a href="Poco.DigestEngine.html#4722" title="Poco::DigestEngine::update()">update</a>, <a href="Poco.DigestEngine.html#4734" title="Poco::DigestEngine::updateImpl()">updateImpl</a></p>
<h2>Types</h2>
<h3><a name="4719">Digest</a></h3>
<p class="decl">typedef std::vector &lt; unsigned char &gt; <a href="Poco.DigestEngine.html#4719" title="Poco::DigestEngine::Digest">Digest</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="4720">DigestEngine</a></h3>
<p class="decl"><a href="Poco.DigestEngine.html" title="class Poco::DigestEngine">DigestEngine</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Destructor</h2>
<h3><a name="4721">~DigestEngine</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.DigestEngine.html" title="class Poco::DigestEngine">DigestEngine</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="4731">digest</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.DigestEngine.html#4719" title="Poco::DigestEngine::Digest">Digest</a> &amp; digest() = 0;</p>
<div class="description">
<p>Finishes the computation of the digest and returns the message digest. Resets the engine and can thus only be called once for every digest. The returned reference is valid until the next time <a href="Poco.DigestEngine.html#4731" title="Poco::DigestEngine::digest()">digest</a>() is called, or the engine object is destroyed. </p>
</div>
<h3><a name="4729">digestLength</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual unsigned digestLength() const = 0;</p>
<div class="description">
<p>Returns the length of the digest in bytes. </p>
</div>
<h3><a name="4732">digestToHex</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static std::string digestToHex(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.DigestEngine.html#4719" title="Poco::DigestEngine::Digest">Digest</a> &amp; bytes<br />);</p>
<div class="description">
<p>Converts a message digest into a string of hexadecimal numbers. </p>
</div>
<h3><a name="4730">reset</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void reset() = 0;</p>
<div class="description">
<p>Resets the engine so that a new digest can be computed. </p>
</div>
<h3><a name="4722">update</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void update(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * data,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned length<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="4725">update</a></h3>
<p class="decl">void update(<br />&nbsp;&nbsp;&nbsp;&nbsp;char data<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="4727">update</a></h3>
<p class="decl">void update(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; data<br />);</p>
<div class="description">
<p>Updates the digest with the given data. </p>
</div>
<h3><a name="4734">updateImpl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void updateImpl(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * data,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned length<br />) = 0;</p>
<div class="description">
<p>Updates the digest with the given data. Must be implemented by subclasses. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>