📄 class_filter_with_buffered_input.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++: FilterWithBufferedInput 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>FilterWithBufferedInput Class Reference</h1><code>#include <<a class="el" href="filters_8h-source.html">filters.h</a>></code><p><p>Inheritance diagram for FilterWithBufferedInput:<p><center><img src="class_filter_with_buffered_input.png" usemap="#FilterWithBufferedInput_map" border="0" alt=""></center><map name="FilterWithBufferedInput_map"><area href="class_filter.html" alt="Filter" shape="rect" coords="435,168,599,192"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="348,112,512,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="261,56,425,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="435,56,599,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="261,0,425,24"><area href="class_hash_verification_filter.html" alt="HashVerificationFilter" shape="rect" coords="0,280,164,304"><area href="class_proxy_filter.html" alt="ProxyFilter" shape="rect" coords="348,280,512,304"><area href="class_signature_verification_filter.html" alt="SignatureVerificationFilter" shape="rect" coords="522,280,686,304"><area href="class_stream_transformation_filter.html" alt="StreamTransformationFilter" shape="rect" coords="696,280,860,304"><area href="class_default_decryptor.html" alt="DefaultDecryptor" shape="rect" coords="0,336,164,360"><area href="class_default_decryptor_with_m_a_c.html" alt="DefaultDecryptorWithMAC" shape="rect" coords="174,336,338,360"><area href="class_default_encryptor.html" alt="DefaultEncryptor" shape="rect" coords="348,336,512,360"><area href="class_default_encryptor_with_m_a_c.html" alt="DefaultEncryptorWithMAC" shape="rect" coords="522,336,686,360"><area href="class_simple_proxy_filter.html" alt="SimpleProxyFilter" shape="rect" coords="696,336,860,360"><area href="class_base64_encoder.html" alt="Base64Encoder" shape="rect" coords="435,392,599,416"><area href="class_hex_encoder.html" alt="HexEncoder" shape="rect" coords="609,392,773,416"><area href="class_p_k___decryptor_filter.html" alt="PK_DecryptorFilter" shape="rect" coords="783,392,947,416"><area href="class_p_k___encryptor_filter.html" alt="PK_EncryptorFilter" shape="rect" coords="957,392,1121,416"></map><a href="class_filter_with_buffered_input-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>FilterWithBufferedInput divides up the input stream into a first block, a number of middle blocks, and a last block. First and last blocks are optional, and middle blocks may be a stream instead (i.e. blockSize == 1). <p><p>Definition at line <a class="el" href="filters_8h-source.html#l00128">128</a> of file <a class="el" href="filters_8h-source.html">filters.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="FilterWithBufferedInput::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_filter_with_buffered_input.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="FilterWithBufferedInput::GetAutoSignalPropagation"></a>virtual int </td><td class="memItemRight" valign=bottom><b>GetAutoSignalPropagation</b> () const</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="_filter_with_buffered_inputa0" doxytag="FilterWithBufferedInput::FilterWithBufferedInput"></a> </td><td class="memItemRight" valign=bottom><b>FilterWithBufferedInput</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_filter_with_buffered_inputa1" doxytag="FilterWithBufferedInput::FilterWithBufferedInput"></a> </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.html#_filter_with_buffered_inputa1">FilterWithBufferedInput</a> (unsigned int firstSize, unsigned int blockSize, unsigned int lastSize, <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">firstSize and lastSize may be 0, blockSize must be at least 1 <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filtera5" doxytag="FilterWithBufferedInput::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_filter_with_buffered_input.html#_stream_transformation_filtera6">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="#_stream_transformation_filtera6"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.html#_stream_transformation_filtera7">PutModifiable2</a> (byte *inString, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes that may be modified by callee for blocking or non-blocking processing </em> <a href="#_stream_transformation_filtera7"></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_filter_with_buffered_input.html#_stream_transformation_filtera8">IsolatedFlush</a> (bool hardFlush, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.html#_stream_transformation_filtera9">ForceNextPut</a> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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="FilterWithBufferedInput::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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="FilterWithBufferedInput::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="FilterWithBufferedInput::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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="FilterWithBufferedInput::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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="FilterWithBufferedInput::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="FilterWithBufferedInput::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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_filter_with_buffered_input.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_filter_with_buffered_input.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_filter_with_buffered_input.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="FilterWithBufferedInput::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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="FilterWithBufferedInput::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter_with_buffered_input.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_filter_with_buffered_input.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="FilterWithBufferedInput::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 Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filterb0" doxytag="FilterWithBufferedInput::DidFirstPut"></a>bool </td><td class="memItemRight" valign=bottom><b>DidFirstPut</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filterb1" doxytag="FilterWithBufferedInput::InitializeDerivedAndReturnNewSizes"></a>virtual void </td><td class="memItemRight" valign=bottom><b>InitializeDerivedAndReturnNewSizes</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, unsigned int &firstSize, unsigned int &blockSize, unsigned int &lastSize)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filterb2" doxytag="FilterWithBufferedInput::InitializeDerived"></a>virtual void </td><td class="memItemRight" valign=bottom><b>InitializeDerived</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><a name="_proxy_filterb3" doxytag="FilterWithBufferedInput::FirstPut"></a>virtual void </td><td class="memItemRight" valign=bottom><b>FirstPut</b> (const byte *inString)=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filterb3" doxytag="FilterWithBufferedInput::NextPutSingle"></a>virtual void </td><td class="memItemRight" valign=bottom><b>NextPutSingle</b> (const byte *inString)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_filter_with_buffered_inputb5" doxytag="FilterWithBufferedInput::NextPutMultiple"></a>virtual void </td><td class="memItemRight" valign=bottom><b>NextPutMultiple</b> (const byte *inString, unsigned int length)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_simple_proxy_filterb4" doxytag="FilterWithBufferedInput::NextPutModifiable"></a>virtual void </td><td class="memItemRight" valign=bottom><b>NextPutModifiable</b> (byte *inString, unsigned int length)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_proxy_filterb6" doxytag="FilterWithBufferedInput::LastPut"></a>virtual void </td><td class="memItemRight" valign=bottom><b>LastPut</b> (const byte *inString, unsigned int length)=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_stream_transformation_filterb4" doxytag="FilterWithBufferedInput::FlushDerived"></a>virtual void </td><td class="memItemRight" valign=bottom><b>FlushDerived</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb0" doxytag="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="FilterWithBufferedInput::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="_zlib_decompressorp1" doxytag="FilterWithBufferedInput::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="FilterWithBufferedInput::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="_stream_transformation_filtera6" doxytag="FilterWithBufferedInput::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 FilterWithBufferedInput::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> <td></td> <td></td> <td class="md" nowrap>unsigned int </td> <td class="mdname" nowrap> <em>length</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>messageEnd</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>blocking</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>input multiple bytes for blocking or non-blocking processing <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>messageEnd</em> </td><td>means how many filters to signal MessageEnd to, including this one </td></tr> </table></dl><p>Implements <a class="el" href="class_buffered_transformation.html#_unflushable_3_01_sink_01_4z1_9">BufferedTransformation</a>.<p>Definition at line <a class="el" href="filters_8h-source.html#l00136">136</a> of file <a class="el" href="filters_8h-source.html">filters.h</a>. </td> </tr></table><a name="_stream_transformation_filtera7" doxytag="FilterWithBufferedInput::PutModifiable2"></a><p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -