📄 class_filter.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++: Filter 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>Filter Class Reference</h1><code>#include <<a class="el" href="filters_8h-source.html">filters.h</a>></code><p><p>Inheritance diagram for Filter:<p><center><img src="class_filter.png" usemap="#Filter_map" border="0" alt=""></center><map name="Filter_map"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="109,112,318,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,209,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="219,56,428,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,209,24"><area href="class_filter_with_buffered_input.html" alt="FilterWithBufferedInput" shape="rect" coords="438,448,647,472"><area href="class_filter_with_input_queue.html" alt="FilterWithInputQueue" shape="rect" coords="438,504,647,528"><area href="class_low_first_bit_writer.html" alt="LowFirstBitWriter" shape="rect" coords="438,616,647,640"></map><a href="class_filter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>provides an implementation of BufferedTransformation's attachment interface <p><p>Definition at line <a class="el" href="filters_8h-source.html#l00014">14</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>INPUT</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_0" doxytag="Filter::Put"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_0">Put</a> (byte inByte, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input a byte for processing <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_1" doxytag="Filter::Put"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_1">Put</a> (const byte *inString, unsigned int length, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_2" doxytag="Filter::PutWord16"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_2">PutWord16</a> (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input a 16-bit word <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_3" doxytag="Filter::PutWord32"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_3">PutWord32</a> (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input a 32-bit word <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual byte * </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_4">CreatePutSpace</a> (unsigned int &size)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">request space to write bytes into for processing </em> <a href="#_zlib_decompressorz1_4"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_5" doxytag="Filter::CanModifyInput"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>CanModifyInput</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_6" doxytag="Filter::PutModifiable"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_6">PutModifiable</a> (byte *inString, unsigned int length, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes that may be modified by callee <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_7" doxytag="Filter::MessageEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>MessageEnd</b> (int propagation=-1, bool blocking=true)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz1_8" doxytag="Filter::PutMessageEnd"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>PutMessageEnd</b> (const byte *inString, unsigned int length, int propagation=-1, bool blocking=true)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_unflushable_3_01_sink_01_4z1_9">Put2</a> (const byte *inString, unsigned int length, int messageEnd, bool blocking)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes for blocking or non-blocking processing </em> <a href="#_unflushable_3_01_sink_01_4z1_9"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.html#_zlib_decompressorz1_9">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="#_zlib_decompressorz1_9"></a><em><br><br></td></tr><tr><td colspan=2><br><h2>SIGNALS</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez5_0" doxytag="Filter::IsolatedInitialize"></a>virtual 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><a name="_sinkz5_1" doxytag="Filter::IsolatedFlush"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>IsolatedFlush</b> (bool hardFlush, bool blocking)=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz5_0" doxytag="Filter::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.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="Filter::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="_filtera0" doxytag="Filter::Filter"></a> </td><td class="memItemRight" valign=bottom><b>Filter</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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="Filter::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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="Filter::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="Filter::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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="Filter::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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="Filter::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="Filter::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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.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.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.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="Filter::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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="Filter::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_filter.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.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="Filter::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="_zlib_decompressorb0" doxytag="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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="Filter::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_decompressora7" doxytag="Filter::Attachable"></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"> bool Filter::Attachable </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>returns whether this object allows attachment <p>Some <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> objects (e.g. Filter objects) allow other <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> objects to be attached. When this is done, the first object instead of buffering its output, sents that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed.<p>Reimplemented from <a class="el" href="class_buffered_transformation.html#_windows_pipe_sinkz15_0">BufferedTransformation</a>.<p>Definition at line <a class="el" href="filters_8h-source.html#l00019">19</a> of file <a class="el" href="filters_8h-source.html">filters.h</a>. </td> </tr></table><a name="_zlib_decompressora14" doxytag="Filter::Flush"></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"> bool Filter::Flush </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">bool </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -