📄 class_transparent_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++: TransparentFilter 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>TransparentFilter Class Reference</h1><code>#include <<a class="el" href="filters_8h-source.html">filters.h</a>></code><p><p>Inheritance diagram for TransparentFilter:<p><center><img src="class_transparent_filter.png" usemap="#TransparentFilter_map" border="0" alt=""></center><map name="TransparentFilter_map"><area href="class_meter_filter.html" alt="MeterFilter" shape="rect" coords="155,280,300,304"><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_transparent_filter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><p><p>Definition at line <a class="el" href="filters_8h-source.html#l00110">110</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="_windows_pipe_sourcez5_0" doxytag="TransparentFilter::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>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::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="_transparent_filtera0" doxytag="TransparentFilter::TransparentFilter"></a> </td><td class="memItemRight" valign=bottom><b>TransparentFilter</b> (<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="_transparent_filtera1" doxytag="TransparentFilter::SetTransparent"></a>void </td><td class="memItemRight" valign=bottom><b>SetTransparent</b> (bool transparent)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera2" doxytag="TransparentFilter::ResetMeter"></a>void </td><td class="memItemRight" valign=bottom><b>ResetMeter</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera3" doxytag="TransparentFilter::GetCurrentMessageBytes"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>GetCurrentMessageBytes</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera4" doxytag="TransparentFilter::GetTotalBytes"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>GetTotalBytes</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera5" doxytag="TransparentFilter::GetCurrentSeriesMessages"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>GetCurrentSeriesMessages</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera6" doxytag="TransparentFilter::GetTotalMessages"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>GetTotalMessages</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera7" doxytag="TransparentFilter::GetTotalMessageSeries"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>GetTotalMessageSeries</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_filter.html#_transparent_filtera8">Put2</a> (const byte *begin, 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="#_transparent_filtera8"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_transparent_filtera9" doxytag="TransparentFilter::IsolatedMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedMessageSeriesEnd</b> (bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_bufferlessa2" doxytag="TransparentFilter::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>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::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="TransparentFilter::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::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="TransparentFilter::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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_transparent_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_transparent_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_transparent_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="TransparentFilter::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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="TransparentFilter::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_transparent_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_transparent_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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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_decompressorb5" doxytag="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="TransparentFilter::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="_transparent_filtera8" doxytag="TransparentFilter::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 MeterFilter::Put2 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const byte * </td> <td class="mdname" nowrap> <em>begin</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> [virtual, inherited]</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>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -