<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crypto++: NetworkReceiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crypto++</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">NetworkReceiver Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="NetworkReceiver" --><!-- doxytag: inherits="Waitable" -->
<p>Network Receiver.
<a href="class_network_receiver.html#details">More...</a></p>
<p><code>#include <<a class="el" href="network_8h_source.html">network.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for NetworkReceiver:</div>
<div class="dyncontent">
<div class="center">
<img src="class_network_receiver.png" usemap="#NetworkReceiver_map" alt=""/>
<map id="NetworkReceiver_map" name="NetworkReceiver_map">
<area href="class_waitable.html" title="interface for objects that you can wait for" alt="Waitable" shape="rect" coords="74,0,212,24"/>
<area href="class_socket_receiver.html" alt="SocketReceiver" shape="rect" coords="0,112,138,136"/>
<area href="class_windows_pipe_receiver.html" title="pipe-based implementation of NetworkReceiver" alt="WindowsPipeReceiver" shape="rect" coords="148,112,286,136"/>
<area href="class_windows_pipe_source.html" title="Windows Pipe Source." alt="WindowsPipeSource" shape="rect" coords="148,168,286,192"/>
</map>
</div></div>
<p><a href="class_network_receiver-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27501ca6a36dae0cc344c57f413aea1d"></a><!-- doxytag: member="NetworkReceiver::MustWaitToReceive" ref="a27501ca6a36dae0cc344c57f413aea1d" args="()" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>MustWaitToReceive</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af043f80d3fc9ce4a30edd2eb77a4553a"></a><!-- doxytag: member="NetworkReceiver::MustWaitForResult" ref="af043f80d3fc9ce4a30edd2eb77a4553a" args="()" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>MustWaitForResult</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e1c4db8bc07f0bf5b8d06496162cbe1"></a><!-- doxytag: member="NetworkReceiver::Receive" ref="a5e1c4db8bc07f0bf5b8d06496162cbe1" args="(byte *buf, size_t bufLen)=0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_receiver.html#a5e1c4db8bc07f0bf5b8d06496162cbe1">Receive</a> (byte *buf, size_t bufLen)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">receive data from network source, returns whether result is immediately available <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d7974f03642b4da960e918ca1ce485a"></a><!-- doxytag: member="NetworkReceiver::GetReceiveResult" ref="a3d7974f03642b4da960e918ca1ce485a" args="()=0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><b>GetReceiveResult</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb798984dceeec70f74339d10339b31b"></a><!-- doxytag: member="NetworkReceiver::EofReceived" ref="abb798984dceeec70f74339d10339b31b" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>EofReceived</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a221cf2a8063487b56b97c27197e16b12"></a><!-- doxytag: member="NetworkReceiver::GetMaxWaitObjectCount" ref="a221cf2a8063487b56b97c27197e16b12" args="() const =0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#a221cf2a8063487b56b97c27197e16b12">GetMaxWaitObjectCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of wait objects that this object can return <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#a97155f28db33d3dacc69dc453a01609a">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)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">put wait objects into container <a href="#a97155f28db33d3dacc69dc453a01609a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#aded81bbe562f61932306a64e6122a6ca">Wait</a> (unsigned long milliseconds, <a class="el" href="class_call_stack.html">CallStack</a> const &callStack)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">wait on this object <a href="#aded81bbe562f61932306a64e6122a6ca"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Network Receiver. </p>
<p>Definition at line <a class="el" href="network_8h_source.html#l00094">94</a> of file <a class="el" href="network_8h_source.html">network.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a97155f28db33d3dacc69dc453a01609a"></a><!-- doxytag: member="NetworkReceiver::GetWaitObjects" ref="a97155f28db33d3dacc69dc453a01609a" args="(WaitObjectContainer &container, CallStack const &callStack)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Waitable::GetWaitObjects </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_wait_object_container.html">WaitObjectContainer</a> & </td>
<td class="paramname"><em>container</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_call_stack.html">CallStack</a> const & </td>
<td class="paramname"><em>callStack</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>put wait objects into container </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">callStack</td><td>is used for tracing no wait loops, example: something.GetWaitObjects(c, <a class="el" href="class_call_stack.html">CallStack</a>("my func after X", 0));<ul>
<li>or in an outer <a class="el" href="class_waitable.html#a97155f28db33d3dacc69dc453a01609a" title="put wait objects into container">GetWaitObjects()</a> method that itself takes a callStack parameter: innerThing.GetWaitObjects(c, <a class="el" href="class_call_stack.html">CallStack</a>("MyClass::GetWaitObjects at X", &callStack)); </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_buffered_transformation.html#a127ccd1793fdda6548cd1295f848d0f7">BufferedTransformation</a>, <a class="el" href="class_redirector.html#ac0dc5f63f7a57af37f819aa9251a78bf">Redirector</a>, <a class="el" href="class_socket_receiver.html#aa851a6020843d4311036a6f4299f9a6b">SocketReceiver</a>, <a class="el" href="class_socket_sender.html#a9f5d2a6bb5665c5b93d857485c8348e4">SocketSender</a>, <a class="el" href="class_windows_pipe_receiver.html#a44a3dbb7ef3161d84731c3c320eaa33a">WindowsPipeReceiver</a>, and <a class="el" href="class_windows_pipe_sender.html#a26b98ea160dc37248cb9934edb8a27ef">WindowsPipeSender</a>.</p>
<p>Referenced by <a class="el" href="wait_8cpp_source.html#l00388">Waitable::Wait()</a>.</p>
</div>
</div>
<a class="anchor" id="aded81bbe562f61932306a64e6122a6ca"></a><!-- doxytag: member="NetworkReceiver::Wait" ref="aded81bbe562f61932306a64e6122a6ca" args="(unsigned long milliseconds, CallStack const &callStack)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Waitable::Wait </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>milliseconds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_call_stack.html">CallStack</a> const & </td>
<td class="paramname"><em>callStack</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>wait on this object </p>
<p>same as creating an empty container, calling <a class="el" href="class_waitable.html#a97155f28db33d3dacc69dc453a01609a" title="put wait objects into container">GetWaitObjects()</a>, and calling <a class="el" href="class_waitable.html#aded81bbe562f61932306a64e6122a6ca" title="wait on this object">Wait()</a> on the container </p>
<p>Definition at line <a class="el" href="wait_8cpp_source.html#l00388">388</a> of file <a class="el" href="wait_8cpp_source.html">wait.cpp</a>.</p>
<p>References <a class="el" href="class_waitable.html#a97155f28db33d3dacc69dc453a01609a">Waitable::GetWaitObjects()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="network_8h_source.html">network.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Oct 16 2011 for Crypto++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
