network_8h-source.html

著名的密码库Crypto++的文档 C++语言的杰作。程序员必备。

<a name="l00068"></a><a class="code" href="class_nonblocking_source.html#7e6eb5fb495c7b2a5509629b8d49e8c1">00068</a>         lword GeneralPump(lword maxSize=LWORD_MAX, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxTime=<a class="code" href="cryptlib_8h.html#5dc7a255dd813433eeee3152544c2f1d" title="used to represent infinite time">INFINITE_TIME</a>, <span class="keywordtype">bool</span> checkDelimiter=<span class="keyword">false</span>, byte delimiter=<span class="charliteral">'\n'</span>)
<a name="l00069"></a>00069         {
<a name="l00070"></a>00070                 GeneralPump2(maxSize, <span class="keyword">true</span>, maxTime, checkDelimiter, delimiter);
<a name="l00071"></a>00071                 <span class="keywordflow">return</span> maxSize;
<a name="l00072"></a>00072         }
<a name="l00073"></a><a class="code" href="class_nonblocking_source.html#242384519357d2c41dbed2aeedd75104">00073</a>         lword TimedPump(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxTime)
<a name="l00074"></a>00074                 {<span class="keywordflow">return</span> GeneralPump(LWORD_MAX, maxTime);}
<a name="l00075"></a><a class="code" href="class_nonblocking_source.html#9880beb9cf2e16d55bf262dc6f832aa8">00075</a>         lword PumpLine(byte delimiter=<span class="charliteral">'\n'</span>, lword maxSize=1024)
<a name="l00076"></a>00076                 {<span class="keywordflow">return</span> GeneralPump(maxSize, <a class="code" href="cryptlib_8h.html#5dc7a255dd813433eeee3152544c2f1d" title="used to represent infinite time">INFINITE_TIME</a>, <span class="keyword">true</span>, delimiter);}
<a name="l00077"></a>00077 
<a name="l00078"></a><a class="code" href="class_nonblocking_source.html#6d75b28015a06d4215c44a3dd2593a72">00078</a>         <span class="keywordtype">size_t</span> Pump2(lword &amp;byteCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)
<a name="l00079"></a>00079                 {<span class="keywordflow">return</span> GeneralPump2(byteCount, blocking, blocking ? <a class="code" href="cryptlib_8h.html#5dc7a255dd813433eeee3152544c2f1d" title="used to represent infinite time">INFINITE_TIME</a> : 0);}
<a name="l00080"></a>00080         <span class="keywordtype">size_t</span> PumpMessages2(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;messageCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);<span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment">        //@}</span>
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="keyword">protected</span>:
<a name="l00084"></a>00084         <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> DoPump(lword &amp;byteCount, <span class="keywordtype">bool</span> blockingOutput,
<a name="l00085"></a>00085                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxTime, <span class="keywordtype">bool</span> checkDelimiter, byte delimiter) =0;
<a name="l00086"></a>00086 
<a name="l00087"></a><a class="code" href="class_nonblocking_source.html#32a9026054da9651a057a471c2256b45">00087</a>         <span class="keywordtype">bool</span> BlockedBySpeedLimit()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_blockedBySpeedLimit; }
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="keyword">private</span>:
<a name="l00090"></a>00090         <span class="keywordtype">bool</span> m_messageEndSent, m_doPumpBlocked, m_blockedBySpeedLimit;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">//! Network Receiver</span>
<a name="l00094"></a><a class="code" href="class_network_receiver.html">00094</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_NO_VTABLE NetworkReceiver : <span class="keyword">public</span> <a class="code" href="class_waitable.html" title="interface for objects that you can wait for">Waitable</a>
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 <span class="keyword">public</span>:
<a name="l00097"></a><a class="code" href="class_network_receiver.html#27501ca6a36dae0cc344c57f413aea1d">00097</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> MustWaitToReceive() {<span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00098"></a><a class="code" href="class_network_receiver.html#f043f80d3fc9ce4a30edd2eb77a4553a">00098</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> MustWaitForResult() {<span class="keywordflow">return</span> <span class="keyword">false</span>;}<span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">        //! receive data from network source, returns whether result is immediately available</span>
<a name="l00100"></a>00100 <span class="comment"></span>        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Receive(byte* buf, <span class="keywordtype">size_t</span> bufLen) =0;
<a name="l00101"></a>00101         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetReceiveResult() =0;
<a name="l00102"></a>00102         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> EofReceived() <span class="keyword">const</span> =0;
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104 
<a name="l00105"></a><a class="code" href="class_nonblocking_sink_info.html">00105</a> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE NonblockingSinkInfo
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keyword">public</span>:
<a name="l00108"></a><a class="code" href="class_nonblocking_sink_info.html#2dafcdc41464c434d9986c17beca5a62">00108</a>         <span class="keyword">virtual</span> ~NonblockingSinkInfo() {}
<a name="l00109"></a>00109         <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetMaxBufferSize() <span class="keyword">const</span> =0;
<a name="l00110"></a>00110         <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetCurrentBufferSize() <span class="keyword">const</span> =0;
<a name="l00111"></a>00111         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> EofPending() <span class="keyword">const</span> =0;<span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment">        //! compute the current speed of this sink in bytes per second</span>
<a name="l00113"></a>00113 <span class="comment"></span>        <span class="keyword">virtual</span> <span class="keywordtype">float</span> ComputeCurrentSpeed() =0;<span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment">        //! get the maximum observed speed of this sink in bytes per second</span>
<a name="l00115"></a>00115 <span class="comment"></span>        <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetMaxObservedSpeed() <span class="keyword">const</span> =0;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">//! a Sink class that queues input and can flush to a device for a specified amount of time.</span>
<a name="l00119"></a><a class="code" href="class_nonblocking_sink.html">00119</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_NO_VTABLE NonblockingSink : <span class="keyword">public</span> <a class="code" href="class_sink.html" title="A BufferedTransformation that doesn't produce any retrievable output.">Sink</a>, <span class="keyword">public</span> NonblockingSinkInfo, <span class="keyword">public</span> <a class="code" href="class_limited_bandwidth.html">LimitedBandwidth</a>
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 <span class="keyword">public</span>:
<a name="l00122"></a><a class="code" href="class_nonblocking_sink.html#604c2e4bcb9d110fa42286b6d3838e32">00122</a>         NonblockingSink() : m_blockedBySpeedLimit(false) {}
<a name="l00123"></a>00123 
<a name="l00124"></a>00124         <span class="keywordtype">bool</span> IsolatedFlush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking);
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment">        //! flush to device for no more than maxTime milliseconds</span>
<a name="l00127"></a>00127 <span class="comment"></span><span class="comment">        /*! This function will repeatedly attempt to flush data to some device, until</span>
<a name="l00128"></a>00128 <span class="comment">                the queue is empty, or a total of maxTime milliseconds have elapsed.</span>
<a name="l00129"></a>00129 <span class="comment">                If maxTime == 0, at least one attempt will be made to flush some data, but</span>
<a name="l00130"></a>00130 <span class="comment">                it is likely that not all queued data will be flushed, even if the device</span>
<a name="l00131"></a>00131 <span class="comment">                is ready to receive more data without waiting. If you want to flush as much data</span>
<a name="l00132"></a>00132 <span class="comment">                as possible without waiting for the device, call this function in a loop.</span>
<a name="l00133"></a>00133 <span class="comment">                For example: while (sink.TimedFlush(0) &gt; 0) {}</span>
<a name="l00134"></a>00134 <span class="comment">                \return number of bytes flushed</span>
<a name="l00135"></a>00135 <span class="comment">        */</span>
<a name="l00136"></a>00136         lword TimedFlush(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxTime, <span class="keywordtype">size_t</span> targetSize = 0);
<a name="l00137"></a>00137 
<a name="l00138"></a>00138         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMaxBufferSize(<span class="keywordtype">size_t</span> maxBufferSize) =0;<span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment">        //! set a bound which will cause sink to flush if exceeded by GetCurrentBufferSize()</span>
<a name="l00140"></a>00140 <span class="comment"></span>        <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetAutoFlushBound(<span class="keywordtype">size_t</span> bound) =0;
<a name="l00141"></a>00141 
<a name="l00142"></a>00142 <span class="keyword">protected</span>:
<a name="l00143"></a>00143         <span class="keyword">virtual</span> lword DoFlush(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxTime, <span class="keywordtype">size_t</span> targetSize) = 0;
<a name="l00144"></a>00144 
<a name="l00145"></a><a class="code" href="class_nonblocking_sink.html#5558b33305f12a74c7fc3ac88d5af8cd">00145</a>         <span class="keywordtype">bool</span> BlockedBySpeedLimit()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_blockedBySpeedLimit; }
<a name="l00146"></a>00146 
<a name="l00147"></a>00147 <span class="keyword">private</span>:
<a name="l00148"></a>00148         <span class="keywordtype">bool</span> m_blockedBySpeedLimit;
<a name="l00149"></a>00149 };
<a name="l00150"></a>00150 <span class="comment"></span>
<a name="l00151"></a>00151 <span class="comment">//! Network Sender</span>
<a name="l00152"></a><a class="code" href="class_network_sender.html">00152</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_NO_VTABLE NetworkSender : <span class="keyword">public</span> <a class="code" href="class_waitable.html" title="interface for objects that you can wait for">Waitable</a>
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 <span class="keyword">public</span>:
<a name="l00155"></a><a class="code" href="class_network_sender.html#fb86f4dc8d5ba76ad18f3be4a20d768e">00155</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> MustWaitToSend() {<span class="keywordflow">return</span> <span class="keyword">false</span>;}