<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: simple.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Crypto++  <span id="projectnumber">7.0</span> </div> <div id="projectbrief">Free C++ class library of cryptographic schemes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">simple.h</div> </div> </div><!--header--> <div class="contents"> <a href="simple_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// simple.h - originally written and placed in the public domain by Wei Dai</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/// \file simple.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \brief Classes providing basic library services.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef CRYPTOPP_SIMPLE_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define CRYPTOPP_SIMPLE_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="config_8h.html">config.h</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"># pragma warning(push)</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"># pragma warning(disable: 4127 4189)</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="misc_8h.html">misc.h</a>"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/// \brief Base class for identifying alogorithm</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span><span class="comment">/// \tparam BASE base class from which to derive</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span><span class="comment">/// \tparam DERIVED class which to clone</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> DERIVED, <span class="keyword">class</span> BASE></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_clonable_impl.html"> 25</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_clonable_impl.html">ClonableImpl</a> : <span class="keyword">public</span> BASE</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="class_clonable.html">Clonable</a> * Clone()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> DERIVED(*static_cast<const DERIVED *>(<span class="keyword">this</span>));}</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/// \brief Base class information</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// \tparam BASE an Algorithm derived class</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// \tparam ALGORITHM_INFO an Algorithm derived class</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// \details AlgorithmImpl provides StaticAlgorithmName from the template parameter BASE</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> BASE, <span class="keyword">class</span> ALGORITHM_INFO=BASE></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_algorithm_impl.html"> 36</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_algorithm_impl.html">AlgorithmImpl</a> : <span class="keyword">public</span> BASE</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// \brief The algorithm name</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// \returns the algorithm name</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// \details StaticAlgorithmName returns the algorithm's name as a static member function.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// The name is taken from information provided by BASE.</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_algorithm_impl.html#a4b388176a0c4853b2a3e747c5e637b95"> 43</a></span> <span class="comment"></span> <span class="keyword">static</span> std::string CRYPTOPP_API StaticAlgorithmName() {<span class="keywordflow">return</span> ALGORITHM_INFO::StaticAlgorithmName();}<span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// \brief The algorithm name</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// \returns the algorithm name</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// \details AlgorithmName returns the algorithm's name as a member function.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// The name is is acquired by calling StaticAlgorithmName.</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="class_algorithm_impl.html#abd1b02bf6cda820fa6cc56ea5a9eac20"> 48</a></span> <span class="comment"></span> std::string <a class="code" href="class_algorithm_impl.html#abd1b02bf6cda820fa6cc56ea5a9eac20">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> ALGORITHM_INFO::StaticAlgorithmName();}</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/// \brief Exception thrown when an invalid key length is encountered</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_invalid_key_length.html"> 52</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_key_length.html">InvalidKeyLength</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_key_length.html">InvalidKeyLength</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">size_t</span> length) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(length) + <span class="stringliteral">" is not a valid key length"</span>) {}</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/// \brief Exception thrown when an invalid number of rounds is encountered</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="class_invalid_rounds.html"> 59</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_rounds.html">InvalidRounds</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_rounds.html">InvalidRounds</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> rounds) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(rounds) + <span class="stringliteral">" is not a valid number of rounds"</span>) {}</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> };</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/// \brief Exception thrown when an invalid block size is encountered</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_invalid_block_size.html"> 66</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_block_size.html">InvalidBlockSize</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_block_size.html">InvalidBlockSize</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">size_t</span> length) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(length) + <span class="stringliteral">" is not a valid block size"</span>) {}</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/// \brief Exception thrown when an invalid derived key length is encountered</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="class_invalid_derived_length.html"> 73</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_derived_length.html">InvalidDerivedLength</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_derived_length.html">InvalidDerivedLength</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">size_t</span> length) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(length) + <span class="stringliteral">" is not a valid derived key length"</span>) {}</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// \brief Exception thrown when an invalid personalization string length is encountered</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="class_invalid_personalization_length.html"> 80</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_personalization_length.html">InvalidPersonalizationLength</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_personalization_length.html">InvalidPersonalizationLength</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">size_t</span> length) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(length) + <span class="stringliteral">" is not a valid salt length"</span>) {}</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// \brief Exception thrown when an invalid salt length is encountered</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="class_invalid_salt_length.html"> 87</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_invalid_salt_length.html">InvalidSaltLength</a> : <span class="keyword">public</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">explicit</span> <a class="code" href="class_invalid_salt_length.html">InvalidSaltLength</a>(<span class="keyword">const</span> std::string &algorithm, <span class="keywordtype">size_t</span> length) : <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(algorithm + <span class="stringliteral">": "</span> + <a class="code" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>(length) + <span class="stringliteral">" is not a valid salt length"</span>) {}</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// *****************************</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/// \brief Base class for bufferless filters</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/// \tparam T the class or type</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_bufferless.html"> 98</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_bufferless.html">Bufferless</a> : <span class="keyword">public</span> T</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">bool</span> IsolatedFlush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/// \brief Base class for unflushable filters</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/// \tparam T the class or type</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="class_unflushable.html"> 108</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_unflushable.html">Unflushable</a> : <span class="keyword">public</span> T</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">bool</span> Flush(<span class="keywordtype">bool</span> completeFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {<span class="keywordflow">return</span> ChannelFlush(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, completeFlush, propagation, blocking);}</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> IsolatedFlush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>); <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">bool</span> ChannelFlush(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> (hardFlush && !InputBufferIsEmpty())</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">throw</span> <a class="code" href="class_cannot_flush.html">CannotFlush</a>(<span class="stringliteral">"Unflushable<T>: this object has buffered input that cannot be flushed"</span>);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attached = this->AttachedTransformation();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> attached && propagation ? attached-><a class="code" href="class_buffered_transformation.html#a6b504b2694ecb5d709a9858c5b93a0f7">ChannelFlush</a>(channel, hardFlush, propagation-1, blocking) : <span class="keyword">false</span>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  }</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> InputBufferIsEmpty()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/// \brief Base class for input rejecting filters</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/// \tparam T the class or type</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/// \details T should be a BufferedTransformation derived class</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="class_input_rejecting.html"> 134</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_input_rejecting.html">InputRejecting</a> : <span class="keyword">public</span> T</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="struct_input_rejecting_1_1_input_rejected.html"> 137</a></span>  <span class="keyword">struct </span><a class="code" href="struct_input_rejecting_1_1_input_rejected.html">InputRejected</a> : <span class="keyword">public</span> <a class="code" href="class_not_implemented.html">NotImplemented</a></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  {<a class="code" href="struct_input_rejecting_1_1_input_rejected.html">InputRejected</a>() : <a class="code" href="class_not_implemented.html">NotImplemented</a>(<span class="stringliteral">"BufferedTransformation: this object doesn't allow input"</span>) {}};</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"></span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> /// \name INPUT</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span><span class="comment"> //@{</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// \brief Input a byte array for processing</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /// \param inString the byte array to process</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// \param length the size of the string, in bytes</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /// \param messageEnd means how many filters to signal MessageEnd() to, including this one</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> /// \throws InputRejected</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> /// \details Internally, the default implementation throws InputRejected.</span></div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="class_input_rejecting.html#acfac9e0290dc999234df2e595c367926"> 151</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="class_input_rejecting.html#acfac9e0290dc999234df2e595c367926">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  {CRYPTOPP_UNUSED(inString); CRYPTOPP_UNUSED(length); CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">throw</span> InputRejected();}<span class="comment"></span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> //@}</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> /// \name SIGNALS</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"></span><span class="comment"> //@{</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span> <span class="keywordtype">bool</span> IsolatedFlush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">bool</span> IsolatedMessageSeriesEnd(<span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  {CRYPTOPP_UNUSED(blocking); <span class="keywordflow">throw</span> InputRejected();}</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">size_t</span> ChannelPut2(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  {CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(inString); CRYPTOPP_UNUSED(length); CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">throw</span> InputRejected();}</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">bool</span> ChannelMessageSeriesEnd(<span class="keyword">const</span> std::string& channel, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  {CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">throw</span> InputRejected();}<span class="comment"></span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> //@}</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"></span>};</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/// \brief Interface for custom flush signals propagation</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/// \tparam T BufferedTransformation derived class</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="class_custom_flush_propagation.html"> 171</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_custom_flush_propagation.html">CustomFlushPropagation</a> : <span class="keyword">public</span> T</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> {</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> /// \name SIGNALS</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span><span class="comment"> //@{</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> /// \brief Flush buffered input and/or output, with signal propagation</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> /// \param hardFlush is used to indicate whether all data should be flushed</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> /// \param propagation the number of attached transformations the Flush() signal should be passed</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> /// \note Hard flushes must be used with care. It means try to process and output everything, even if</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> /// there may not be enough data to complete the action. For example, hard flushing a HexDecoder</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> /// would cause an error if you do it after inputing an odd number of hex encoded characters.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> /// \note For some types of filters, like ZlibDecompressor, hard flushes can only</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> /// be done at "synchronization points". These synchronization points are positions in the data</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> /// stream that are created by hard flushes on the corresponding reverse filters, in this</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> /// example ZlibCompressor. This is useful when zlib compressed data is moved across a</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> /// network in packets and compression state is preserved across packets, as in the SSH2 protocol.</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Flush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) =0;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> //@}</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keywordtype">bool</span> IsolatedFlush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>); <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> };</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/// \brief Interface for custom flush signals</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">/// \tparam T BufferedTransformation derived class</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="class_custom_signal_propagation.html"> 203</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_custom_signal_propagation.html">CustomSignalPropagation</a> : <span class="keyword">public</span> <a class="code" href="class_custom_flush_propagation.html">CustomFlushPropagation</a><T></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> {</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> /// \brief Initialize or reinitialize this object, with signal propagation</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> /// \param parameters a set of NameValuePairs to initialize or reinitialize this object</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> /// \param propagation the number of attached transformations the Initialize() signal should be passed</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> /// \details Initialize() is used to initialize or reinitialize an object using a variable number of</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> /// arbitrarily typed arguments. The function avoids the need for multiple constructors providing</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> /// all possible combintations of configurable parameters.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Initialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="code" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>, <span class="keywordtype">int</span> propagation=-1) =0;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">void</span> IsolatedInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  {CRYPTOPP_UNUSED(parameters); <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>);}</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> };</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"></span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">/// \brief Multiple channels support for custom signal processing</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/// \tparam T the class or type</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">/// \details T should be a BufferedTransformation derived class</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="class_multichannel.html"> 225</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_multichannel.html">Multichannel</a> : <span class="keyword">public</span> <a class="code" href="class_custom_flush_propagation.html">CustomFlushPropagation</a><T></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> {</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="class_multichannel.html#ae3e6176eb5f0de2857aa7066272c07ce"> 228</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_multichannel.html#ae3e6176eb5f0de2857aa7066272c07ce">Flush</a>(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  {<span class="keywordflow">return</span> this->ChannelFlush(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, hardFlush, propagation, blocking);}</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"></span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> /// \brief Marks the end of a series of messages, with signal propagation</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> /// \param propagation the number of attached transformations the MessageSeriesEnd() signal should be passed</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /// \details Each object that receives the signal will perform its processing, decrement</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> /// propagation, and then pass the signal on to attached transformations if the value is not 0.</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> /// \note There should be a MessageEnd() immediately before MessageSeriesEnd().</span></div><div class="line"><a name="l00239"></a><span class="lineno"><a class="line" href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9"> 239</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9">MessageSeriesEnd</a>(<span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  {<span class="keywordflow">return</span> this->ChannelMessageSeriesEnd(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, propagation, blocking);}</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"></span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> /// \brief Request space which can be written into by the caller</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> /// \param size the requested size of the buffer</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> /// \details The purpose of this method is to help avoid extra memory allocations.</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> /// \details size is an \a IN and \a OUT parameter and used as a hint. When the call is made,</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> /// size is the requested size of the buffer. When the call returns, size is the size of</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> /// the array returned to the caller.</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> /// \details The base class implementation sets size to 0 and returns NULL.</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> /// \note Some objects, like ArraySink, cannot create a space because its fixed. In the case of</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> /// an ArraySink, the pointer to the array is returned and the size is remaining size.</span></div><div class="line"><a name="l00251"></a><span class="lineno"><a class="line" href="class_multichannel.html#af0b0eb15ec27d19c93a1455d948c578e"> 251</a></span> <span class="comment"></span> byte * <a class="code" href="class_multichannel.html#af0b0eb15ec27d19c93a1455d948c578e">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  {<span class="keywordflow">return</span> this->ChannelCreatePutSpace(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, size);}</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"></span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> /// \brief Input multiple bytes for processing</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> /// \param inString the byte buffer to process</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> /// \param length the size of the string, in bytes</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> /// \param messageEnd means how many filters to signal MessageEnd() to, including this one</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> /// \details Derived classes must implement Put2().</span></div><div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6"> 260</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  {<span class="keywordflow">return</span> this->ChannelPut2(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, inString, length, messageEnd, blocking);}</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"></span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> /// \brief Input multiple bytes that may be modified by callee.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> /// \param inString the byte buffer to process.</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> /// \param length the size of the string, in bytes.</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> /// \param messageEnd means how many filters to signal MessageEnd() to, including this one.</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input.</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> /// \details Internally, PutModifiable2() calls Put2().</span></div><div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="class_multichannel.html#ae5a9ac9bf82eb7f4eadc7c38fd604216"> 269</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="class_multichannel.html#ae5a9ac9bf82eb7f4eadc7c38fd604216">PutModifiable2</a>(byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  {<span class="keywordflow">return</span> this->ChannelPutModifiable2(<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, inString, length, messageEnd, blocking);}</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">// void ChannelMessageSeriesEnd(const std::string &channel, int propagation=-1)</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment">// {PropagateMessageSeriesEnd(propagation, channel);}</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  byte * ChannelCreatePutSpace(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  {CRYPTOPP_UNUSED(channel); size = 0; <span class="keywordflow">return</span> NULLPTR;}</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordtype">bool</span> ChannelPutModifiable(<span class="keyword">const</span> std::string &channel, byte *inString, <span class="keywordtype">size_t</span> length)</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  {this->ChannelPut(channel, inString, length); <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> ChannelPut2(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking) =0;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordtype">size_t</span> ChannelPutModifiable2(<span class="keyword">const</span> std::string &channel, byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  {<span class="keywordflow">return</span> ChannelPut2(channel, begin, length, messageEnd, blocking);}</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ChannelFlush(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) =0;</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> };</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"></span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">/// \brief Provides auto signaling support</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment">/// \tparam T BufferedTransformation derived class</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00289"></a><span class="lineno"><a class="line" href="class_auto_signaling.html"> 289</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_auto_signaling.html">AutoSignaling</a> : <span class="keyword">public</span> T</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> {</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> /// \brief Construct an AutoSignaling</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> /// \param propagation the propagation count</span></div><div class="line"><a name="l00294"></a><span class="lineno"><a class="line" href="class_auto_signaling.html#aa4972f0ce40ede0292d7d74532570d3c"> 294</a></span> <span class="comment"></span> <a class="code" href="class_auto_signaling.html#aa4972f0ce40ede0292d7d74532570d3c">AutoSignaling</a>(<span class="keywordtype">int</span> propagation=-1) : m_autoSignalPropagation(propagation) {}</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">void</span> SetAutoSignalPropagation(<span class="keywordtype">int</span> propagation)</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  {m_autoSignalPropagation = propagation;}</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordtype">int</span> GetAutoSignalPropagation()<span class="keyword"> const</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="keyword"> </span>{<span class="keywordflow">return</span> m_autoSignalPropagation;}</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordtype">int</span> m_autoSignalPropagation;</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> };</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"></span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">/// \brief Acts as a Source for pre-existing, static data</span></div><div class="line"><a name="l00306"></a><span class="lineno"><a class="line" href="class_store.html"> 306</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_store.html">Store</a> : <span class="keyword">public</span> <a class="code" href="class_auto_signaling.html">AutoSignaling</a><InputRejecting<BufferedTransformation> ></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> {</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> /// \brief Construct a Store</span></div><div class="line"><a name="l00310"></a><span class="lineno"><a class="line" href="class_store.html#a5f58eadcb7385d5a5aa6830daef84f7d"> 310</a></span> <span class="comment"></span> <a class="code" href="class_store.html#a5f58eadcb7385d5a5aa6830daef84f7d">Store</a>() : m_messageEnd(false) {}</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div><div class="line"><a name="l00312"></a><span class="lineno"><a class="line" href="class_store.html#a47bfecef2abe22b090935cfab6f19f89"> 312</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_store.html#a47bfecef2abe22b090935cfab6f19f89">IsolatedInitialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  {</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  m_messageEnd = <span class="keyword">false</span>;</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  StoreInitialize(parameters);</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  }</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div><div class="line"><a name="l00318"></a><span class="lineno"><a class="line" href="class_store.html#a671fcd19428a776aa08d767a97ed116a"> 318</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_store.html#a671fcd19428a776aa08d767a97ed116a">NumberOfMessages</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_messageEnd ? 0 : 1;}</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keywordtype">bool</span> GetNextMessage();</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> CopyMessagesTo(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count=UINT_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>) <span class="keyword">const</span>;</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> StoreInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters) =0;</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <span class="keywordtype">bool</span> m_messageEnd;</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> };</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"></span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">/// \brief Implementation of BufferedTransformation's attachment interface</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment">/// \details Sink is a cornerstone of the Pipeline trinitiy. Data flows from</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment">/// Sources, through Filters, and then terminates in Sinks. The difference</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">/// between a Source and Filter is a Source \a pumps data, while a Filter does</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">/// not. The difference between a Filter and a Sink is a Filter allows an</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment">/// attached transformation, while a Sink does not.</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment">/// \details A Sink doesnot produce any retrievable output.</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment">/// \details See the discussion of BufferedTransformation in cryptlib.h for</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment">/// more details.</span></div><div class="line"><a name="l00337"></a><span class="lineno"><a class="line" href="class_sink.html"> 337</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_sink.html">Sink</a> : <span class="keyword">public</span> <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> {</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="class_sink.html#a3f00dceb03f4eae824a42e285e2f6972"> 340</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_sink.html#a3f00dceb03f4eae824a42e285e2f6972">TransferTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  {CRYPTOPP_UNUSED(target); CRYPTOPP_UNUSED(transferBytes); CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(blocking); transferBytes = 0; <span class="keywordflow">return</span> 0;}</div><div class="line"><a name="l00342"></a><span class="lineno"><a class="line" href="class_sink.html#aed64e6f6c263c9f08fa2fc5febfb9d73"> 342</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_sink.html#aed64e6f6c263c9f08fa2fc5febfb9d73">CopyRangeTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)<span class="keyword"> const</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="keyword"> </span>{CRYPTOPP_UNUSED(target); CRYPTOPP_UNUSED(begin); CRYPTOPP_UNUSED(end); CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">return</span> 0;}</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> };</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"></span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">/// \brief Acts as an input discarding Filter or Sink</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment">/// \details The BitBucket discards all input and returns 0 to the caller</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment">/// to indicate all data was processed.</span></div><div class="line"><a name="l00349"></a><span class="lineno"><a class="line" href="class_bit_bucket.html"> 349</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_bit_bucket.html">BitBucket</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Sink></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> {</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00352"></a><span class="lineno"><a class="line" href="class_bit_bucket.html#acf61d428e496186d837348697b151fe4"> 352</a></span>  std::string <a class="code" href="class_bit_bucket.html#acf61d428e496186d837348697b151fe4">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="stringliteral">"BitBucket"</span>;}</div><div class="line"><a name="l00353"></a><span class="lineno"><a class="line" href="class_bit_bucket.html#ab284f7730a9c195e00b9d8b61efc8105"> 353</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_bit_bucket.html#ab284f7730a9c195e00b9d8b61efc8105">IsolatedInitialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &params)</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  {CRYPTOPP_UNUSED(params);}</div><div class="line"><a name="l00355"></a><span class="lineno"><a class="line" href="class_bit_bucket.html#a4eb69986b7bc8391f757c8dd7a84eda6"> 355</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_bit_bucket.html#a4eb69986b7bc8391f757c8dd7a84eda6">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  {CRYPTOPP_UNUSED(inString); CRYPTOPP_UNUSED(length); CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking); <span class="keywordflow">return</span> 0;}</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> };</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> </div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> NAMESPACE_END</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> </div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="preprocessor"># pragma warning(pop)</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> </div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_multichannel_html_a5e8ff874d5703311a9947cf086170fa6"><div class="ttname"><a href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6">Multichannel::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00260">simple.h:260</a></div></div> <div class="ttc" id="class_invalid_argument_html"><div class="ttname"><a href="class_invalid_argument.html">InvalidArgument</a></div><div class="ttdoc">An invalid argument was detected. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00199">cryptlib.h:199</a></div></div> <div class="ttc" id="misc_8h_html"><div class="ttname"><a href="misc_8h.html">misc.h</a></div><div class="ttdoc">Utility functions for the Crypto++ library. </div></div> <div class="ttc" id="class_store_html_a5f58eadcb7385d5a5aa6830daef84f7d"><div class="ttname"><a href="class_store.html#a5f58eadcb7385d5a5aa6830daef84f7d">Store::Store</a></div><div class="ttdeci">Store()</div><div class="ttdoc">Construct a Store. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00310">simple.h:310</a></div></div> <div class="ttc" id="class_clonable_impl_html"><div class="ttname"><a href="class_clonable_impl.html">ClonableImpl</a></div><div class="ttdoc">Base class for identifying alogorithm. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00025">simple.h:25</a></div></div> <div class="ttc" id="class_invalid_key_length_html"><div class="ttname"><a href="class_invalid_key_length.html">InvalidKeyLength</a></div><div class="ttdoc">Exception thrown when an invalid key length is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00052">simple.h:52</a></div></div> <div class="ttc" id="class_algorithm_impl_html_abd1b02bf6cda820fa6cc56ea5a9eac20"><div class="ttname"><a href="class_algorithm_impl.html#abd1b02bf6cda820fa6cc56ea5a9eac20">AlgorithmImpl::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">The algorithm name. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00048">simple.h:48</a></div></div> <div class="ttc" id="class_store_html_a671fcd19428a776aa08d767a97ed116a"><div class="ttname"><a href="class_store.html#a671fcd19428a776aa08d767a97ed116a">Store::NumberOfMessages</a></div><div class="ttdeci">unsigned int NumberOfMessages() const</div><div class="ttdoc">Provides the number of meesages processed by this object. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00318">simple.h:318</a></div></div> <div class="ttc" id="class_cannot_flush_html"><div class="ttname"><a href="class_cannot_flush.html">CannotFlush</a></div><div class="ttdoc">Flush(true) was called but it can&#39;t completely flush its buffers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00227">cryptlib.h:227</a></div></div> <div class="ttc" id="cryptlib_8h_html"><div class="ttname"><a href="cryptlib_8h.html">cryptlib.h</a></div><div class="ttdoc">Abstract base classes that provide a uniform interface to this library. </div></div> <div class="ttc" id="class_multichannel_html_ae3e6176eb5f0de2857aa7066272c07ce"><div class="ttname"><a href="class_multichannel.html#ae3e6176eb5f0de2857aa7066272c07ce">Multichannel::Flush</a></div><div class="ttdeci">bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00228">simple.h:228</a></div></div> <div class="ttc" id="class_bit_bucket_html_ab284f7730a9c195e00b9d8b61efc8105"><div class="ttname"><a href="class_bit_bucket.html#ab284f7730a9c195e00b9d8b61efc8105">BitBucket::IsolatedInitialize</a></div><div class="ttdeci">void IsolatedInitialize(const NameValuePairs &params)</div><div class="ttdoc">Initialize or reinitialize this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00353">simple.h:353</a></div></div> <div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Library configuration file. </div></div> <div class="ttc" id="class_store_html"><div class="ttname"><a href="class_store.html">Store</a></div><div class="ttdoc">Acts as a Source for pre-existing, static data. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00306">simple.h:306</a></div></div> <div class="ttc" id="class_input_rejecting_html"><div class="ttname"><a href="class_input_rejecting.html">InputRejecting</a></div><div class="ttdoc">Base class for input rejecting filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00134">simple.h:134</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a6b504b2694ecb5d709a9858c5b93a0f7"><div class="ttname"><a href="class_buffered_transformation.html#a6b504b2694ecb5d709a9858c5b93a0f7">BufferedTransformation::ChannelFlush</a></div><div class="ttdeci">virtual bool ChannelFlush(const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8cpp_source.html#l00490">cryptlib.cpp:490</a></div></div> <div class="ttc" id="class_buffered_transformation_html"><div class="ttname"><a href="class_buffered_transformation.html">BufferedTransformation</a></div><div class="ttdoc">Interface for buffered transformations. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01545">cryptlib.h:1545</a></div></div> <div class="ttc" id="class_clonable_html"><div class="ttname"><a href="class_clonable.html">Clonable</a></div><div class="ttdoc">Interface for cloning objects. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00559">cryptlib.h:559</a></div></div> <div class="ttc" id="class_custom_flush_propagation_html"><div class="ttname"><a href="class_custom_flush_propagation.html">CustomFlushPropagation</a></div><div class="ttdoc">Interface for custom flush signals propagation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00171">simple.h:171</a></div></div> <div class="ttc" id="class_invalid_salt_length_html"><div class="ttname"><a href="class_invalid_salt_length.html">InvalidSaltLength</a></div><div class="ttdoc">Exception thrown when an invalid salt length is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00087">simple.h:87</a></div></div> <div class="ttc" id="class_sink_html_aed64e6f6c263c9f08fa2fc5febfb9d73"><div class="ttname"><a href="class_sink.html#aed64e6f6c263c9f08fa2fc5febfb9d73">Sink::CopyRangeTo2</a></div><div class="ttdeci">size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const</div><div class="ttdoc">Copy bytes from this object to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00342">simple.h:342</a></div></div> <div class="ttc" id="class_invalid_block_size_html"><div class="ttname"><a href="class_invalid_block_size.html">InvalidBlockSize</a></div><div class="ttdoc">Exception thrown when an invalid block size is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00066">simple.h:66</a></div></div> <div class="ttc" id="class_store_html_a47bfecef2abe22b090935cfab6f19f89"><div class="ttname"><a href="class_store.html#a47bfecef2abe22b090935cfab6f19f89">Store::IsolatedInitialize</a></div><div class="ttdeci">void IsolatedInitialize(const NameValuePairs &parameters)</div><div class="ttdoc">Initialize or reinitialize this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00312">simple.h:312</a></div></div> <div class="ttc" id="class_invalid_personalization_length_html"><div class="ttname"><a href="class_invalid_personalization_length.html">InvalidPersonalizationLength</a></div><div class="ttdoc">Exception thrown when an invalid personalization string length is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00080">simple.h:80</a></div></div> <div class="ttc" id="class_not_implemented_html"><div class="ttname"><a href="class_not_implemented.html">NotImplemented</a></div><div class="ttdoc">A method was called which was not implemented. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00220">cryptlib.h:220</a></div></div> <div class="ttc" id="cryptlib_8h_html_a9a69ab5a5e0f58279c43f4f51809c84a"><div class="ttname"><a href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a></div><div class="ttdeci">const std::string DEFAULT_CHANNEL</div><div class="ttdoc">Default channel for BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00481">cryptlib.h:481</a></div></div> <div class="ttc" id="class_invalid_rounds_html"><div class="ttname"><a href="class_invalid_rounds.html">InvalidRounds</a></div><div class="ttdoc">Exception thrown when an invalid number of rounds is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00059">simple.h:59</a></div></div> <div class="ttc" id="class_sink_html_a3f00dceb03f4eae824a42e285e2f6972"><div class="ttname"><a href="class_sink.html#a3f00dceb03f4eae824a42e285e2f6972">Sink::TransferTo2</a></div><div class="ttdeci">size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)</div><div class="ttdoc">Transfer bytes from this object to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00340">simple.h:340</a></div></div> <div class="ttc" id="trap_8h_html_adf3b392588bc94cbeae9f415a78c7b95"><div class="ttname"><a href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a></div><div class="ttdeci">#define CRYPTOPP_ASSERT(exp)</div><div class="ttdoc">Debugging and diagnostic assertion. </div><div class="ttdef"><b>Definition:</b> <a href="trap_8h_source.html#l00060">trap.h:60</a></div></div> <div class="ttc" id="class_input_rejecting_html_acfac9e0290dc999234df2e595c367926"><div class="ttname"><a href="class_input_rejecting.html#acfac9e0290dc999234df2e595c367926">InputRejecting::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input a byte array for processing. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00151">simple.h:151</a></div></div> <div class="ttc" id="class_multichannel_html_ae5a9ac9bf82eb7f4eadc7c38fd604216"><div class="ttname"><a href="class_multichannel.html#ae5a9ac9bf82eb7f4eadc7c38fd604216">Multichannel::PutModifiable2</a></div><div class="ttdeci">size_t PutModifiable2(byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes that may be modified by callee. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00269">simple.h:269</a></div></div> <div class="ttc" id="cryptlib_8h_html_a04be65ada92ccb1e6aac0d94b4cc394b"><div class="ttname"><a href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a></div><div class="ttdeci">const NameValuePairs g_nullNameValuePairs</div><div class="ttdoc">An empty set of name-value pairs. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00494">cryptlib.h:494</a></div></div> <div class="ttc" id="class_unflushable_html"><div class="ttname"><a href="class_unflushable.html">Unflushable</a></div><div class="ttdoc">Base class for unflushable filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00108">simple.h:108</a></div></div> <div class="ttc" id="class_bit_bucket_html_a4eb69986b7bc8391f757c8dd7a84eda6"><div class="ttname"><a href="class_bit_bucket.html#a4eb69986b7bc8391f757c8dd7a84eda6">BitBucket::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00355">simple.h:355</a></div></div> <div class="ttc" id="class_sink_html"><div class="ttname"><a href="class_sink.html">Sink</a></div><div class="ttdoc">Implementation of BufferedTransformation&#39;s attachment interface. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00337">simple.h:337</a></div></div> <div class="ttc" id="class_auto_signaling_html"><div class="ttname"><a href="class_auto_signaling.html">AutoSignaling</a></div><div class="ttdoc">Provides auto signaling support. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00289">simple.h:289</a></div></div> <div class="ttc" id="misc_8h_html_a6cd7decd035cc4e144cd3d395e834106"><div class="ttname"><a href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a></div><div class="ttdeci">std::string IntToString(T value, unsigned int base=10)</div><div class="ttdoc">Converts a value to a string. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l00576">misc.h:576</a></div></div> <div class="ttc" id="class_multichannel_html_af0b0eb15ec27d19c93a1455d948c578e"><div class="ttname"><a href="class_multichannel.html#af0b0eb15ec27d19c93a1455d948c578e">Multichannel::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00251">simple.h:251</a></div></div> <div class="ttc" id="class_multichannel_html_a18b9b1cc4e6d2649214c62e447052db9"><div class="ttname"><a href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9">Multichannel::MessageSeriesEnd</a></div><div class="ttdeci">bool MessageSeriesEnd(int propagation=-1, bool blocking=true)</div><div class="ttdoc">Marks the end of a series of messages, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00239">simple.h:239</a></div></div> <div class="ttc" id="struct_input_rejecting_1_1_input_rejected_html"><div class="ttname"><a href="struct_input_rejecting_1_1_input_rejected.html">InputRejecting::InputRejected</a></div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00137">simple.h:137</a></div></div> <div class="ttc" id="class_invalid_derived_length_html"><div class="ttname"><a href="class_invalid_derived_length.html">InvalidDerivedLength</a></div><div class="ttdoc">Exception thrown when an invalid derived key length is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00073">simple.h:73</a></div></div> <div class="ttc" id="class_bit_bucket_html"><div class="ttname"><a href="class_bit_bucket.html">BitBucket</a></div><div class="ttdoc">Acts as an input discarding Filter or Sink. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00349">simple.h:349</a></div></div> <div class="ttc" id="namespace_crypto_p_p_html"><div class="ttname"><a href="namespace_crypto_p_p.html">CryptoPP</a></div><div class="ttdoc">Crypto++ library namespace. </div></div> <div class="ttc" id="class_bit_bucket_html_acf61d428e496186d837348697b151fe4"><div class="ttname"><a href="class_bit_bucket.html#acf61d428e496186d837348697b151fe4">BitBucket::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00352">simple.h:352</a></div></div> <div class="ttc" id="class_multichannel_html"><div class="ttname"><a href="class_multichannel.html">Multichannel</a></div><div class="ttdoc">Multiple channels support for custom signal processing. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00225">simple.h:225</a></div></div> <div class="ttc" id="class_custom_signal_propagation_html"><div class="ttname"><a href="class_custom_signal_propagation.html">CustomSignalPropagation</a></div><div class="ttdoc">Interface for custom flush signals. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00203">simple.h:203</a></div></div> <div class="ttc" id="class_auto_signaling_html_aa4972f0ce40ede0292d7d74532570d3c"><div class="ttname"><a href="class_auto_signaling.html#aa4972f0ce40ede0292d7d74532570d3c">AutoSignaling::AutoSignaling</a></div><div class="ttdeci">AutoSignaling(int propagation=-1)</div><div class="ttdoc">Construct an AutoSignaling. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00294">simple.h:294</a></div></div> <div class="ttc" id="class_bufferless_html"><div class="ttname"><a href="class_bufferless.html">Bufferless</a></div><div class="ttdoc">Base class for bufferless filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00098">simple.h:98</a></div></div> <div class="ttc" id="class_name_value_pairs_html"><div class="ttname"><a href="class_name_value_pairs.html">NameValuePairs</a></div><div class="ttdoc">Interface for retrieving values given their names. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00290">cryptlib.h:290</a></div></div> <div class="ttc" id="class_algorithm_impl_html"><div class="ttname"><a href="class_algorithm_impl.html">AlgorithmImpl</a></div><div class="ttdoc">Base class information. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00036">simple.h:36</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:05 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>