📄 class_nonblocking_source.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++: NonblockingSource 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>NonblockingSource Class Reference</h1><code>#include <<a class="el" href="network_8h-source.html">network.h</a>></code><p><p>Inheritance diagram for NonblockingSource:<p><center><img src="class_nonblocking_source.png" usemap="#NonblockingSource_map" border="0" alt=""></center><map name="NonblockingSource_map"><area href="class_source.html" alt="Source" shape="rect" coords="165,280,320,304"><area href="class_filter.html" alt="Filter" shape="rect" coords="165,168,320,192"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="82,112,237,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,155,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="165,56,320,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,155,24"><area href="class_network_source.html" alt="NetworkSource" shape="rect" coords="165,448,320,472"><area href="class_socket_source.html" alt="SocketSource" shape="rect" coords="82,504,237,528"><area href="class_windows_pipe_source.html" alt="WindowsPipeSource" shape="rect" coords="247,504,402,528"></map><a href="class_nonblocking_source-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>a <a class="el" href="class_source.html">Source</a> class that can pump from a device for a specified amount of time. <p><p>Definition at line <a class="el" href="network_8h-source.html#l00010">10</a> of file <a class="el" href="network_8h-source.html">network.h</a>.<table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>NONBLOCKING SOURCE</h2></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_nonblocking_source.html#_nonblocking_sourcez53_0">GeneralPump2</a> (unsigned long &byteCount, bool blockingOutput=true, unsigned long maxTime=<a class="el" href="cryptlib_8h.html#a0">INFINITE_TIME</a>, bool checkDelimiter=false, byte delimiter='\n')=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">pump up to maxSize bytes using at most maxTime milliseconds </em> <a href="#_nonblocking_sourcez53_0"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_0" doxytag="NonblockingSource::GeneralPump"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>GeneralPump</b> (unsigned long maxSize=ULONG_MAX, unsigned long maxTime=<a class="el" href="cryptlib_8h.html#a0">INFINITE_TIME</a>, bool checkDelimiter=false, byte delimiter='\n')</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_1" doxytag="NonblockingSource::TimedPump"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>TimedPump</b> (unsigned long maxTime)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_2" doxytag="NonblockingSource::PumpLine"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>PumpLine</b> (byte delimiter='\n', unsigned long maxSize=1024)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_3" doxytag="NonblockingSource::Pump2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>Pump2</b> (unsigned long &byteCount, bool blocking=true)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_4" doxytag="NonblockingSource::PumpMessages2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>PumpMessages2</b> (unsigned int &messageCount, bool blocking=true)</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="_nonblocking_sourcea0" doxytag="NonblockingSource::NonblockingSource"></a> </td><td class="memItemRight" valign=bottom><b>NonblockingSource</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="_auto_signalinga2" doxytag="NonblockingSource::SetAutoSignalPropagation"></a>void </td><td class="memItemRight" valign=bottom><b>SetAutoSignalPropagation</b> (int propagation)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_auto_signalinga3" doxytag="NonblockingSource::GetAutoSignalPropagation"></a>int </td><td class="memItemRight" valign=bottom><b>GetAutoSignalPropagation</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea14" doxytag="NonblockingSource::Pump"></a>unsigned long </td><td class="memItemRight" valign=bottom><b>Pump</b> (unsigned long pumpMax=ULONG_MAX)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea15" doxytag="NonblockingSource::PumpMessages"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>PumpMessages</b> (unsigned int count=UINT_MAX)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea16" doxytag="NonblockingSource::PumpAll"></a>void </td><td class="memItemRight" valign=bottom><b>PumpAll</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea17" doxytag="NonblockingSource::PumpAll2"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><b>PumpAll2</b> (bool blocking=true)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_sourcea7" doxytag="NonblockingSource::SourceExhausted"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>SourceExhausted</b> () const=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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="NonblockingSource::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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="NonblockingSource::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="NonblockingSource::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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="NonblockingSource::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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="NonblockingSource::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="NonblockingSource::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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_nonblocking_source.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_nonblocking_source.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_nonblocking_source.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="NonblockingSource::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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="NonblockingSource::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_nonblocking_source.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_nonblocking_source.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="NonblockingSource::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="_windows_pipe_sourceb2" doxytag="NonblockingSource::SourceInitialize"></a>void </td><td class="memItemRight" valign=bottom><b>SourceInitialize</b> (bool pumpAll, 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="_input_rejectingb0" doxytag="NonblockingSource::Put2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>Put2</b> (const byte *begin, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb1" doxytag="NonblockingSource::IsolatedFlush"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedFlush</b> (bool, bool)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb2" doxytag="NonblockingSource::IsolatedMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedMessageSeriesEnd</b> (bool)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb3" doxytag="NonblockingSource::ChannelPut2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>ChannelPut2</b> (const std::string &channel, const byte *begin, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb4" doxytag="NonblockingSource::ChannelMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>ChannelMessageSeriesEnd</b> (const std::string &, int, bool)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorb0" doxytag="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="NonblockingSource::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="_nonblocking_sourcez53_0" doxytag="NonblockingSource::GeneralPump2"></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"> virtual unsigned int NonblockingSource::GeneralPump2 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">unsigned long & </td> <td class="mdname" nowrap> <em>byteCount</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>blockingOutput</em> = true, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>unsigned long </td> <td class="mdname" nowrap> <em>maxTime</em> = <a class="el" href="cryptlib_8h.html#a0">INFINITE_TIME</a>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>checkDelimiter</em> = false, </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -