<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: zlib.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.15 -->
<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">zlib.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef CRYPTOPP_ZLIB_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define CRYPTOPP_ZLIB_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "<a class="code" href="adler32_8h.html">adler32.h</a>"</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="zdeflate_8h.html">zdeflate.h</a>"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "zinflate.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> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</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="comment">/// ZLIB Compressor (RFC 1950)</span></div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_zlib_compressor.html"> 12</a></span> <span class="comment"></span>class <a class="code" href="class_zlib_compressor.html">ZlibCompressor</a> : public <a class="code" href="class_deflator.html">Deflator</a></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <a class="code" href="class_zlib_compressor.html">ZlibCompressor</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> deflateLevel=DEFAULT_DEFLATE_LEVEL, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, <span class="keywordtype">bool</span> detectUncompressible=<span class="keyword">true</span>)</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  : <a class="code" href="class_deflator.html">Deflator</a>(attachment, deflateLevel, log2WindowSize, detectUncompressible) {}</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="class_zlib_compressor.html">ZlibCompressor</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  : <a class="code" href="class_deflator.html">Deflator</a>(parameters, attachment) {}</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetCompressionLevel() <span class="keyword">const</span>;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordtype">void</span> WritePrestreamHeader();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> ProcessUncompressedData(<span class="keyword">const</span> <span class="keywordtype">byte</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">void</span> WritePoststreamTail();</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>  <a class="code" href="class_adler32.html">Adler32</a> m_adler32;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> };</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// ZLIB Decompressor (RFC 1950)</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_zlib_decompressor.html"> 31</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_zlib_decompressor.html">ZlibDecompressor</a> : <span class="keyword">public</span> <a class="code" href="class_inflator.html">Inflator</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">typedef</span> <a class="code" href="class_inflator_1_1_err.html">Inflator::Err</a> <a class="code" href="class_inflator_1_1_err.html">Err</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_zlib_decompressor_1_1_header_err.html"> 35</a></span>  <span class="keyword">class </span><a class="code" href="class_zlib_decompressor_1_1_header_err.html">HeaderErr</a> : <span class="keyword">public</span> <a class="code" href="class_inflator_1_1_err.html">Err</a> {<span class="keyword">public</span>: <a class="code" href="class_zlib_decompressor_1_1_header_err.html">HeaderErr</a>() : <a class="code" href="class_inflator_1_1_err.html">Err</a>(<a class="code" href="class_exception.html#a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646">INVALID_DATA_FORMAT</a>, <span class="stringliteral">"ZlibDecompressor: header decoding error"</span>) {}};</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_zlib_decompressor_1_1_adler32_err.html"> 36</a></span>  <span class="keyword">class </span><a class="code" href="class_zlib_decompressor_1_1_adler32_err.html">Adler32Err</a> : <span class="keyword">public</span> <a class="code" href="class_inflator_1_1_err.html">Err</a> {<span class="keyword">public</span>: <a class="code" href="class_zlib_decompressor_1_1_adler32_err.html">Adler32Err</a>() : <a class="code" href="class_inflator_1_1_err.html">Err</a>(<a class="code" href="class_exception.html#a8e53909d979479380e0274807c074c0aa77a639a803cf53052f9c76a0354247e6">DATA_INTEGRITY_CHECK_FAILED</a>, <span class="stringliteral">"ZlibDecompressor: ADLER32 check error"</span>) {}};</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_zlib_decompressor_1_1_unsupported_algorithm.html"> 37</a></span>  <span class="keyword">class </span><a class="code" href="class_zlib_decompressor_1_1_unsupported_algorithm.html">UnsupportedAlgorithm</a> : <span class="keyword">public</span> <a class="code" href="class_inflator_1_1_err.html">Err</a> {<span class="keyword">public</span>: <a class="code" href="class_zlib_decompressor_1_1_unsupported_algorithm.html">UnsupportedAlgorithm</a>() : <a class="code" href="class_inflator_1_1_err.html">Err</a>(<a class="code" href="class_exception.html#a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646">INVALID_DATA_FORMAT</a>, <span class="stringliteral">"ZlibDecompressor: unsupported algorithm"</span>) {}};</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_zlib_decompressor_1_1_unsupported_preset_dictionary.html"> 38</a></span>  <span class="keyword">class </span><a class="code" href="class_zlib_decompressor_1_1_unsupported_preset_dictionary.html">UnsupportedPresetDictionary</a> : <span class="keyword">public</span> <a class="code" href="class_inflator_1_1_err.html">Err</a> {<span class="keyword">public</span>: <a class="code" href="class_zlib_decompressor_1_1_unsupported_preset_dictionary.html">UnsupportedPresetDictionary</a>() : <a class="code" href="class_inflator_1_1_err.html">Err</a>(<a class="code" href="class_exception.html#a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646">INVALID_DATA_FORMAT</a>, <span class="stringliteral">"ZlibDecompressor: unsupported preset dictionary"</span>) {}};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// \brief Construct a ZlibDecompressor</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// \param attachment a \ BufferedTransformation to attach to this object</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// \param repeat decompress multiple compressed streams in series</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// \param autoSignalPropagation 0 to turn off MessageEnd signal</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> <a class="code" href="class_zlib_decompressor.html#a2811c881df0f9cd29a8a047c12c3a744">ZlibDecompressor</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> repeat = <span class="keyword">false</span>, <span class="keywordtype">int</span> autoSignalPropagation = -1);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetLog2WindowSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_log2WindowSize;}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MaxPrestreamHeaderSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> 2;}</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> ProcessPrestreamHeader();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> ProcessDecompressedData(<span class="keyword">const</span> <span class="keywordtype">byte</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MaxPoststreamTailSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> 4;}</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> ProcessPoststreamTail();</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="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_log2WindowSize;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="class_adler32.html">Adler32</a> m_adler32;</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> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> NAMESPACE_END</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_zlib_decompressor_html_a2811c881df0f9cd29a8a047c12c3a744"><div class="ttname"><a href="class_zlib_decompressor.html#a2811c881df0f9cd29a8a047c12c3a744">ZlibDecompressor::ZlibDecompressor</a></div><div class="ttdeci">ZlibDecompressor(BufferedTransformation *attachment=NULL, bool repeat=false, int autoSignalPropagation=-1)</div><div class="ttdoc">Construct a ZlibDecompressor.</div><div class="ttdef"><b>Definition:</b> <a href="zlib_8cpp_source.html#l00051">zlib.cpp:51</a></div></div>
<div class="ttc" id="class_zlib_decompressor_1_1_adler32_err_html"><div class="ttname"><a href="class_zlib_decompressor_1_1_adler32_err.html">ZlibDecompressor::Adler32Err</a></div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00036">zlib.h:36</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_deflator_html"><div class="ttname"><a href="class_deflator.html">Deflator</a></div><div class="ttdoc">DEFLATE compressor (RFC 1951)</div><div class="ttdef"><b>Definition:</b> <a href="zdeflate_8h_source.html#l00075">zdeflate.h:75</a></div></div>
<div class="ttc" id="class_zlib_decompressor_1_1_unsupported_algorithm_html"><div class="ttname"><a href="class_zlib_decompressor_1_1_unsupported_algorithm.html">ZlibDecompressor::UnsupportedAlgorithm</a></div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00037">zlib.h:37</a></div></div>
<div class="ttc" id="class_inflator_1_1_err_html"><div class="ttname"><a href="class_inflator_1_1_err.html">Inflator::Err</a></div><div class="ttdef"><b>Definition:</b> <a href="zinflate_8h_source.html#l00092">zinflate.h:92</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="zdeflate_8h_html"><div class="ttname"><a href="zdeflate_8h.html">zdeflate.h</a></div><div class="ttdoc">DEFLATE compression and decompression (RFC 1951)</div></div>
<div class="ttc" id="class_exception_html_a8e53909d979479380e0274807c074c0aa77a639a803cf53052f9c76a0354247e6"><div class="ttname"><a href="class_exception.html#a8e53909d979479380e0274807c074c0aa77a639a803cf53052f9c76a0354247e6">Exception::DATA_INTEGRITY_CHECK_FAILED</a></div><div class="ttdoc">Data integerity check, such as CRC or MAC, failed.</div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00168">cryptlib.h:168</a></div></div>
<div class="ttc" id="class_adler32_html"><div class="ttname"><a href="class_adler32.html">Adler32</a></div><div class="ttdoc">ADLER-32 checksum calculations.</div><div class="ttdef"><b>Definition:</b> <a href="adler32_8h_source.html#l00014">adler32.h:14</a></div></div>
<div class="ttc" id="class_exception_html_a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646"><div class="ttname"><a href="class_exception.html#a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646">Exception::INVALID_DATA_FORMAT</a></div><div class="ttdoc">Input data was received that did not conform to expected format.</div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00170">cryptlib.h:170</a></div></div>
<div class="ttc" id="class_zlib_compressor_html"><div class="ttname"><a href="class_zlib_compressor.html">ZlibCompressor</a></div><div class="ttdoc">ZLIB Compressor (RFC 1950)</div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00012">zlib.h:12</a></div></div>
<div class="ttc" id="class_zlib_decompressor_1_1_header_err_html"><div class="ttname"><a href="class_zlib_decompressor_1_1_header_err.html">ZlibDecompressor::HeaderErr</a></div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00035">zlib.h:35</a></div></div>
<div class="ttc" id="class_zlib_decompressor_html"><div class="ttname"><a href="class_zlib_decompressor.html">ZlibDecompressor</a></div><div class="ttdoc">ZLIB Decompressor (RFC 1950)</div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00031">zlib.h:31</a></div></div>
<div class="ttc" id="adler32_8h_html"><div class="ttname"><a href="adler32_8h.html">adler32.h</a></div><div class="ttdoc">Class file for ADLER-32 checksum calculations.</div></div>
<div class="ttc" id="class_inflator_html"><div class="ttname"><a href="class_inflator.html">Inflator</a></div><div class="ttdoc">DEFLATE decompressor (RFC 1951)</div><div class="ttdef"><b>Definition:</b> <a href="zinflate_8h_source.html#l00089">zinflate.h:89</a></div></div>
<div class="ttc" id="class_zlib_decompressor_1_1_unsupported_preset_dictionary_html"><div class="ttname"><a href="class_zlib_decompressor_1_1_unsupported_preset_dictionary.html">ZlibDecompressor::UnsupportedPresetDictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="zlib_8h_source.html#l00038">zlib.h:38</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_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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:03:49 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
3210
