📄 class_network_sink.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>Crypto++: NetworkSink Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><h1>NetworkSink Class Reference</h1><!-- doxytag: class="NetworkSink" --><!-- doxytag: inherits="NonblockingSink" --><code>#include <<a class="el" href="network_8h-source.html">network.h</a>></code><p><p>Inheritance diagram for NetworkSink:<p><center><img src="class_network_sink.png" usemap="#NetworkSink_map" border="0" alt=""></center><map name="NetworkSink_map"><area href="class_nonblocking_sink.html" alt="NonblockingSink" shape="rect" coords="232,224,377,248"><area href="class_sink.html" alt="Sink" shape="rect" coords="77,168,222,192"><area href="class_nonblocking_sink_info.html" alt="NonblockingSinkInfo" shape="rect" coords="232,168,377,192"><area href="class_limited_bandwidth.html" alt="LimitedBandwidth" shape="rect" coords="387,168,532,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"><area href="class_socket_sink.html" alt="SocketSink" shape="rect" coords="155,336,300,360"><area href="class_windows_pipe_sink.html" alt="WindowsPipeSink" shape="rect" coords="310,336,455,360"></map><a href="class_network_sink-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Network <a class="el" href="class_sink.html" title="A BufferedTransformation that doesn't produce any retrievable output.">Sink</a>. <p><p>Definition at line <a class="el" href="network_8h-source.html#l00188">188</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>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c778064029bf196a1342625e29aaa227"></a><!-- doxytag: member="NetworkSink::NetworkSink" ref="c778064029bf196a1342625e29aaa227" args="(unsigned int maxBufferSize, unsigned int autoFlushBound)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#c778064029bf196a1342625e29aaa227">NetworkSink</a> (unsigned int maxBufferSize, unsigned int autoFlushBound)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#87f8ea4beb77135a3dc0ee1c5fcb72d5">GetMaxWaitObjectCount</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="398a8ac1689dffbabb0115787904688b"></a><!-- doxytag: member="NetworkSink::GetWaitObjects" ref="398a8ac1689dffbabb0115787904688b" args="(WaitObjectContainer &container, CallStack const &callStack)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#398a8ac1689dffbabb0115787904688b">GetWaitObjects</a> (<a class="el" href="class_wait_object_container.html">WaitObjectContainer</a> &container, <a class="el" href="class_call_stack.html">CallStack</a> const &callStack)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#5827a2d026f19314c777b068ce2b69fb">Put2</a> (const byte *inString, size_t length, int messageEnd, bool blocking)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes for blocking or non-blocking processing <a href="#5827a2d026f19314c777b068ce2b69fb"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b88676369cc1c5809c00ca6a269fc98"></a><!-- doxytag: member="NetworkSink::SetMaxBufferSize" ref="1b88676369cc1c5809c00ca6a269fc98" args="(size_t maxBufferSize)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#1b88676369cc1c5809c00ca6a269fc98">SetMaxBufferSize</a> (size_t maxBufferSize)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fe72dabc3ad9d77bbff0cbc2d73f2dc"></a><!-- doxytag: member="NetworkSink::SetAutoFlushBound" ref="2fe72dabc3ad9d77bbff0cbc2d73f2dc" args="(size_t bound)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#2fe72dabc3ad9d77bbff0cbc2d73f2dc">SetAutoFlushBound</a> (size_t bound)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">set a bound which will cause sink to flush if exceeded by <a class="el" href="class_network_sink.html#e96e4485a3281cc26465f95510ee4ced">GetCurrentBufferSize()</a> <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5fadac7e577d864fd84a38d04d0a0d84"></a><!-- doxytag: member="NetworkSink::GetMaxBufferSize" ref="5fadac7e577d864fd84a38d04d0a0d84" args="() const" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#5fadac7e577d864fd84a38d04d0a0d84">GetMaxBufferSize</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e96e4485a3281cc26465f95510ee4ced"></a><!-- doxytag: member="NetworkSink::GetCurrentBufferSize" ref="e96e4485a3281cc26465f95510ee4ced" args="() const" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#e96e4485a3281cc26465f95510ee4ced">GetCurrentBufferSize</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1f28cbff2fbbc69787238a3b955e7fe"></a><!-- doxytag: member="NetworkSink::ClearBuffer" ref="b1f28cbff2fbbc69787238a3b955e7fe" args="()" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#b1f28cbff2fbbc69787238a3b955e7fe">ClearBuffer</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2682fef333bb6bc3bb318750df7011a6"></a><!-- doxytag: member="NetworkSink::EofPending" ref="2682fef333bb6bc3bb318750df7011a6" args="() const" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#2682fef333bb6bc3bb318750df7011a6">EofPending</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0da4518b7999c27c4a131f71ef06795"></a><!-- doxytag: member="NetworkSink::ComputeCurrentSpeed" ref="a0da4518b7999c27c4a131f71ef06795" args="()" -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#a0da4518b7999c27c4a131f71ef06795">ComputeCurrentSpeed</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">compute the current speed of this sink in bytes per second <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72fd5feef36aae810f3832c8b6e8ee81"></a><!-- doxytag: member="NetworkSink::GetMaxObservedSpeed" ref="72fd5feef36aae810f3832c8b6e8ee81" args="() const" -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sink.html#72fd5feef36aae810f3832c8b6e8ee81">GetMaxObservedSpeed</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">get the maximum observed speed of this sink in bytes per second <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f09858e4c31e657d61ca458d00888e2d"></a><!-- doxytag: member="NetworkSink::IsolatedFlush" ref="f09858e4c31e657d61ca458d00888e2d" args="(bool hardFlush, bool blocking)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nonblocking_sink.html#f09858e4c31e657d61ca458d00888e2d">IsolatedFlush</a> (bool hardFlush, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nonblocking_sink.html#f5da8dc12d42cf6152588ab02de4d336">TimedFlush</a> (unsigned long maxTime, size_t targetSize=0)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">flush to device for no more than maxTime milliseconds <a href="#f5da8dc12d42cf6152588ab02de4d336"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="115552b2e4d1d2e1a1ec75b06f0da0ae"></a><!-- doxytag: member="NetworkSink::TransferTo2" ref="115552b2e4d1d2e1a1ec75b06f0da0ae" args="(BufferedTransformation &target, lword &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sink.html#115552b2e4d1d2e1a1ec75b06f0da0ae">TransferTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, const std::string &channel=<a class="el" href="class_buffered_transformation.html#5e938c68f2a5e32a03440b1dc2bdc74a">NULL_CHANNEL</a>, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9c64305f16194ab17d8b438ced3b92d"></a><!-- doxytag: member="NetworkSink::CopyRangeTo2" ref="c9c64305f16194ab17d8b438ced3b92d" args="(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const " -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sink.html#c9c64305f16194ab17d8b438ced3b92d">CopyRangeTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=<a class="el" href="class_buffered_transformation.html#5e938c68f2a5e32a03440b1dc2bdc74a">NULL_CHANNEL</a>, bool blocking=true) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block <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_buffered_transformation.html#25686ebe4c3ba26e7eeaae1dcd4d4215">Ref</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object <a href="#25686ebe4c3ba26e7eeaae1dcd4d4215"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31510a192d1121856efe8ad0a9b844"></a><!-- doxytag: member="NetworkSink::AlgorithmName" ref="4f31510a192d1121856efe8ad0a9b844" args="() const" -->⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -