📄 class_gzip.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Crypto++: Gzip class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.2 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div><h1>Gzip Class Reference</h1><code>#include <<a class="el" href="gzip_8h-source.html">gzip.h</a>></code><p><p>Inheritance diagram for Gzip:<p><center><img src="class_gzip.png" usemap="#Gzip_map" border="0" alt=""></center><map name="Gzip_map"><area href="class_deflator.html" alt="Deflator" shape="rect" coords="155,280,300,304"><area href="class_low_first_bit_writer.html" alt="LowFirstBitWriter" shape="rect" coords="155,224,300,248"><area href="class_filter.html" alt="Filter" shape="rect" coords="155,168,300,192"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="77,112,222,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,145,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="155,56,300,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,145,24"></map><a href="class_gzip-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>GZIP Compression (RFC 1952). <p><p>Definition at line <a class="el" href="gzip_8h-source.html#l00011">11</a> of file <a class="el" href="gzip_8h-source.html">gzip.h</a>.<table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>SIGNALS</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz5_0" doxytag="Gzip::IsolatedMessageSeriesEnd"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>IsolatedMessageSeriesEnd</b> (bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_compressorz5_1">SetAutoSignalPropagation</a> (int propagation)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">set propagation of automatically generated and transfered signals </em> <a href="#_zlib_compressorz5_1"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorz5_2" doxytag="Gzip::GetAutoSignalPropagation"></a>virtual int </td><td class="memItemRight" valign=bottom><b>GetAutoSignalPropagation</b> () const</td></tr><tr><td colspan=2><br><h2>Public Types</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <b>MIN_DEFLATE_LEVEL</b> = 0, <b>DEFAULT_DEFLATE_LEVEL</b> = 6, <b>MAX_DEFLATE_LEVEL</b> = 9 }</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <b>MIN_LOG2_WINDOW_SIZE</b> = 9, <b>DEFAULT_LOG2_WINDOW_SIZE</b> = 15, <b>MAX_LOG2_WINDOW_SIZE</b> = 15 }</td></tr><tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipa0" doxytag="Gzip::Gzip"></a> </td><td class="memItemRight" valign=bottom><b>Gzip</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULL, unsigned int deflateLevel=DEFAULT_DEFLATE_LEVEL, unsigned int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipa1" doxytag="Gzip::Gzip"></a> </td><td class="memItemRight" valign=bottom><b>Gzip</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULL)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora3" doxytag="Gzip::SetDeflateLevel"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_compressora3">SetDeflateLevel</a> (int deflateLevel)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this function can be used to set the deflate level in the middle of compression <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora4" doxytag="Gzip::GetDeflateLevel"></a>int </td><td class="memItemRight" valign=bottom><b>GetDeflateLevel</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora5" doxytag="Gzip::GetLog2WindowSize"></a>int </td><td class="memItemRight" valign=bottom><b>GetLog2WindowSize</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora6" doxytag="Gzip::IsolatedInitialize"></a>void </td><td class="memItemRight" valign=bottom><b>IsolatedInitialize</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_compressora7">Put2</a> (const byte *inString, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes for blocking or non-blocking processing </em> <a href="#_zlib_compressora7"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora8" doxytag="Gzip::IsolatedFlush"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedFlush</b> (bool hardFlush, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora9" doxytag="Gzip::PutBits"></a>void </td><td class="memItemRight" valign=bottom><b>PutBits</b> (unsigned long value, unsigned int length)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora10" doxytag="Gzip::FlushBitBuffer"></a>void </td><td class="memItemRight" valign=bottom><b>FlushBitBuffer</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora11" doxytag="Gzip::ClearBitBuffer"></a>void </td><td class="memItemRight" valign=bottom><b>ClearBitBuffer</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora12" doxytag="Gzip::StartCounting"></a>void </td><td class="memItemRight" valign=bottom><b>StartCounting</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressora13" doxytag="Gzip::FinishCounting"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>FinishCounting</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora7">Attachable</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object allows attachment </em> <a href="#_zlib_decompressora7"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora8" doxytag="Gzip::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora8">AttachedTransformation</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the object immediately attached to this object or NULL for no attachment <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora9" doxytag="Gzip::AttachedTransformation"></a>const <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><b>AttachedTransformation</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora10" doxytag="Gzip::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora10">Detach</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *newAttachment=NULL)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">delete the current attachment chain and replace it with newAttachment <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora11" doxytag="Gzip::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora11">TransferTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned long &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight"><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora12" doxytag="Gzip::CopyRangeTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>CopyRangeTo2</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora13" doxytag="Gzip::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora13">Initialize</a> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="el" href="cryptlib_8h.html#a3">g_nullNameValuePairs</a>, int propagation=-1)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">initialize or reinitialize this object <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora14">Flush</a> (bool hardFlush, int propagation=-1, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">flush buffered input and/or output </em> <a href="#_zlib_decompressora14"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora15">MessageSeriesEnd</a> (int propagation=-1, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">mark end of a series of messages </em> <a href="#_zlib_decompressora15"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora16">Ref</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object </em> <a href="#_zlib_decompressora16"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora17" doxytag="Gzip::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora17">AlgorithmName</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora18" doxytag="Gzip::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora18">Clone</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_gzip.html#_zlib_decompressora19">Wait</a> (unsigned long milliseconds)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">wait on this object </em> <a href="#_zlib_decompressora19"></a><em><br><br></td></tr><tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressors0" doxytag="Gzip::NULL_CHANNEL"></a>const std::string </td><td class="memItemRight" valign=bottom><b>NULL_CHANNEL</b></td></tr><tr><td colspan=2><br><h2>Protected Types</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <br> <b>MAGIC1</b> = 0x1f, <b>MAGIC2</b> = 0x8b, <b>DEFLATED</b> = 8, <b>FAST</b> = 4, <br> <b>SLOW</b> = 2<br> }</td></tr><tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipb0" doxytag="Gzip::WritePrestreamHeader"></a>void </td><td class="memItemRight" valign=bottom><b>WritePrestreamHeader</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipb1" doxytag="Gzip::ProcessUncompressedData"></a>void </td><td class="memItemRight" valign=bottom><b>ProcessUncompressedData</b> (const byte *string, unsigned int length)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipb2" doxytag="Gzip::WritePoststreamTail"></a>void </td><td class="memItemRight" valign=bottom><b>WritePoststreamTail</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb0" doxytag="Gzip::NotifyAttachmentChange"></a>virtual void </td><td class="memItemRight" valign=bottom><b>NotifyAttachmentChange</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb1" doxytag="Gzip::NewDefaultAttachment"></a>virtual <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><b>NewDefaultAttachment</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb2" doxytag="Gzip::Insert"></a>void </td><td class="memItemRight" valign=bottom><b>Insert</b> (<a class="el" href="class_filter.html">Filter</a> *nextFilter)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb3" doxytag="Gzip::ShouldPropagateMessageEnd"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>ShouldPropagateMessageEnd</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb4" doxytag="Gzip::ShouldPropagateMessageSeriesEnd"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>ShouldPropagateMessageSeriesEnd</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb5" doxytag="Gzip::PropagateInitialize"></a>void </td><td class="memItemRight" valign=bottom><b>PropagateInitialize</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, int propagation, const std::string &channel=NULL_CHANNEL)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb6" doxytag="Gzip::Output"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>Output</b> (int outputSite, const byte *inString, unsigned int length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb7" doxytag="Gzip::OutputMessageEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>OutputMessageEnd</b> (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb8" doxytag="Gzip::OutputFlush"></a>bool </td><td class="memItemRight" valign=bottom><b>OutputFlush</b> (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb9" doxytag="Gzip::OutputMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>OutputMessageSeriesEnd</b> (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)</td></tr><tr><td colspan=2><br><h2>Static Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorf0" doxytag="Gzip::DecrementPropagation"></a>int </td><td class="memItemRight" valign=bottom><b>DecrementPropagation</b> (int propagation)</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipp0" doxytag="Gzip::m_totalLen"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>m_totalLen</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_gzipp1" doxytag="Gzip::m_crc"></a><a class="el" href="class_c_r_c32.html">CRC32</a> </td><td class="memItemRight" valign=bottom><b>m_crc</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp0" doxytag="Gzip::m_counting"></a>bool </td><td class="memItemRight" valign=bottom><b>m_counting</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp1" doxytag="Gzip::m_bitCount"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>m_bitCount</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp2" doxytag="Gzip::m_buffer"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>m_buffer</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp3" doxytag="Gzip::m_bitsBuffered"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>m_bitsBuffered</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp4" doxytag="Gzip::m_bytesBuffered"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>m_bytesBuffered</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_compressorp5" doxytag="Gzip::m_outputBuffer"></a>FixedSizeSecBlock< byte, 256 > </td><td class="memItemRight" valign=bottom><b>m_outputBuffer</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorp1" doxytag="Gzip::m_inputPosition"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>m_inputPosition</b></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorp2" doxytag="Gzip::m_continueAt"></a>int </td><td class="memItemRight" valign=bottom><b>m_continueAt</b></td></tr></table><hr><h2>Member Function Documentation</h2><a name="_zlib_compressora7" doxytag="Gzip::Put2"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> unsigned int Deflator::Put2 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const byte * </td> <td class="mdname" nowrap> <em>inString</em>, </td> </tr> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -