📄 class_windows_pipe_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++: WindowsPipeSource 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>WindowsPipeSource Class Reference</h1><code>#include <<a class="el" href="winpipes_8h-source.html">winpipes.h</a>></code><p><p>Inheritance diagram for WindowsPipeSource:<p><center><img src="class_windows_pipe_source.png" usemap="#WindowsPipeSource_map" border="0" alt=""></center><map name="WindowsPipeSource_map"><area href="class_windows_handle.html" alt="WindowsHandle" shape="rect" coords="0,448,155,472"><area href="class_network_source.html" alt="NetworkSource" shape="rect" coords="165,448,320,472"><area href="class_windows_pipe_receiver.html" alt="WindowsPipeReceiver" shape="rect" coords="412,448,567,472"><area href="class_nonblocking_source.html" alt="NonblockingSource" shape="rect" coords="165,392,320,416"><area href="class_windows_pipe.html" alt="WindowsPipe" shape="rect" coords="330,392,485,416"><area href="class_network_receiver.html" alt="NetworkReceiver" shape="rect" coords="495,392,650,416"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="495,336,650,360"><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"></map><a href="class_windows_pipe_source-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Windows Pipe <a class="el" href="class_source.html">Source</a>. <p><p>Definition at line <a class="el" href="winpipes_8h-source.html#l00104">104</a> of file <a class="el" href="winpipes_8h-source.html">winpipes.h</a>.<table border=0 cellpadding=0 cellspacing=0><tr><td></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="_windows_pipe_sourcea0" doxytag="WindowsPipeSource::WindowsPipeSource"></a> </td><td class="memItemRight" valign=bottom><b>WindowsPipeSource</b> (HANDLE h=INVALID_HANDLE_VALUE, bool pumpAll=false, <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="_windows_pipe_sourcea1" doxytag="WindowsPipeSource::GetOwnership"></a>bool </td><td class="memItemRight" valign=bottom><b>GetOwnership</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea2" doxytag="WindowsPipeSource::SetOwnership"></a>void </td><td class="memItemRight" valign=bottom><b>SetOwnership</b> (bool own)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea3" doxytag="WindowsPipeSource::operator HANDLE"></a> </td><td class="memItemRight" valign=bottom><b>operator HANDLE</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea4" doxytag="WindowsPipeSource::HandleValid"></a>bool </td><td class="memItemRight" valign=bottom><b>HandleValid</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea5" doxytag="WindowsPipeSource::AttachHandle"></a>void </td><td class="memItemRight" valign=bottom><b>AttachHandle</b> (HANDLE h, bool own=false)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea6" doxytag="WindowsPipeSource::DetachHandle"></a>HANDLE </td><td class="memItemRight" valign=bottom><b>DetachHandle</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea7" doxytag="WindowsPipeSource::CloseHandle"></a>void </td><td class="memItemRight" valign=bottom><b>CloseHandle</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea8" doxytag="WindowsPipeSource::GetMaxWaitObjectCount"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_source.html#_windows_pipe_sourcea8">GetMaxWaitObjectCount</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of wait objects that this object can return <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea9" doxytag="WindowsPipeSource::GetWaitObjects"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_source.html#_windows_pipe_sourcea9">GetWaitObjects</a> (<a class="el" href="class_wait_object_container.html">WaitObjectContainer</a> &container)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">put wait objects into container <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_windows_pipe_source.html#_windows_pipe_sourcea10">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')</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">pump up to maxSize bytes using at most maxTime milliseconds </em> <a href="#_windows_pipe_sourcea10"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea11" doxytag="WindowsPipeSource::SourceExhausted"></a>bool </td><td class="memItemRight" valign=bottom><b>SourceExhausted</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_auto_signalinga2" doxytag="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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="WindowsPipeSource::AttachedTransformation"></a><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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="WindowsPipeSource::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="WindowsPipeSource::Detach"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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="WindowsPipeSource::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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="WindowsPipeSource::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="WindowsPipeSource::Initialize"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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_windows_pipe_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_windows_pipe_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_windows_pipe_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="WindowsPipeSource::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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="WindowsPipeSource::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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_windows_pipe_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 class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea31" doxytag="WindowsPipeSource::MustWaitForResult"></a>bool </td><td class="memItemRight" valign=bottom><b>MustWaitForResult</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea32" doxytag="WindowsPipeSource::Receive"></a>void </td><td class="memItemRight" valign=bottom><b>Receive</b> (byte *buf, unsigned int bufLen)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea33" doxytag="WindowsPipeSource::GetReceiveResult"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>GetReceiveResult</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea34" doxytag="WindowsPipeSource::EofReceived"></a>bool </td><td class="memItemRight" valign=bottom><b>EofReceived</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea35" doxytag="WindowsPipeSource::GetMaxWaitObjectCount"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_source.html#_windows_pipe_sourcea35">GetMaxWaitObjectCount</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of wait objects that this object can return <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea36" doxytag="WindowsPipeSource::GetWaitObjects"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_source.html#_windows_pipe_sourcea36">GetWaitObjects</a> (<a class="el" href="class_wait_object_container.html">WaitObjectContainer</a> &container)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">put wait objects into container <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcea37" doxytag="WindowsPipeSource::MustWaitToReceive"></a>virtual bool </td><td class="memItemRight" valign=bottom><b>MustWaitToReceive</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_windows_pipe_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"><div class="groupHeader">SIGNALS</div></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez5_0" doxytag="WindowsPipeSource::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 colspan="2"><div class="groupHeader">NONBLOCKING SOURCE</div></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_0" doxytag="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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"><div class="groupHeader">SIGNALS</div></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez5_0" doxytag="WindowsPipeSource::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 colspan="2"><div class="groupHeader">SIGNALS</div></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez5_0" doxytag="WindowsPipeSource::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 colspan="2"><div class="groupHeader">NONBLOCKING SOURCE</div></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sourcez53_0" doxytag="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::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="WindowsPipeSource::Pump2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>Pump2</b> (unsigned long &byteCount, bool blocking=true)</td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -