📄 class_socket_receiver.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++: SocketReceiver 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>SocketReceiver Class Reference</h1><!-- doxytag: class="SocketReceiver" --><!-- doxytag: inherits="NetworkReceiver" --><p>Inheritance diagram for SocketReceiver:<p><center><img src="class_socket_receiver.png" usemap="#SocketReceiver_map" border="0" alt=""></center><map name="SocketReceiver_map"><area href="class_network_receiver.html" alt="NetworkReceiver" shape="rect" coords="0,56,109,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="0,0,109,24"></map><a href="class_socket_receiver-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><p><p>Definition at line <a class="el" href="socketft_8h-source.html#l00126">126</a> of file <a class="el" href="socketft_8h-source.html">socketft.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="05f59443fbdb49fe8696aa2fae78c9b2"></a><!-- doxytag: member="SocketReceiver::SocketReceiver" ref="05f59443fbdb49fe8696aa2fae78c9b2" args="(Socket &s)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#05f59443fbdb49fe8696aa2fae78c9b2">SocketReceiver</a> (<a class="el" href="class_socket.html">Socket</a> &s)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a58d69fa4b0afbda1184ad3cdfd3b0c"></a><!-- doxytag: member="SocketReceiver::~SocketReceiver" ref="3a58d69fa4b0afbda1184ad3cdfd3b0c" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#3a58d69fa4b0afbda1184ad3cdfd3b0c">~SocketReceiver</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f98db48d5a5b205519c03a31220c000"></a><!-- doxytag: member="SocketReceiver::MustWaitForResult" ref="3f98db48d5a5b205519c03a31220c000" args="()" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#3f98db48d5a5b205519c03a31220c000">MustWaitForResult</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31e0ccf504d9c16760051f10d749c034"></a><!-- doxytag: member="SocketReceiver::Receive" ref="31e0ccf504d9c16760051f10d749c034" args="(byte *buf, size_t bufLen)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#31e0ccf504d9c16760051f10d749c034">Receive</a> (byte *buf, size_t bufLen)</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" nowrap align="right" valign="top"><a class="anchor" name="428a62118c6e2ca975a3d4560668b3b2"></a><!-- doxytag: member="SocketReceiver::GetReceiveResult" ref="428a62118c6e2ca975a3d4560668b3b2" args="()" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#428a62118c6e2ca975a3d4560668b3b2">GetReceiveResult</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e815ba8ea618d832eeed81449d7a8474"></a><!-- doxytag: member="SocketReceiver::EofReceived" ref="e815ba8ea618d832eeed81449d7a8474" args="() const" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#e815ba8ea618d832eeed81449d7a8474">EofReceived</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d566d018be0a0d8014c824366827b67"></a><!-- doxytag: member="SocketReceiver::GetMaxWaitObjectCount" ref="8d566d018be0a0d8014c824366827b67" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#8d566d018be0a0d8014c824366827b67">GetMaxWaitObjectCount</a> () const</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" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_socket_receiver.html#a851a6020843d4311036a6f4299f9a6b">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="mdescLeft"> </td><td class="mdescRight">put wait objects into container <a href="#a851a6020843d4311036a6f4299f9a6b"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27501ca6a36dae0cc344c57f413aea1d"></a><!-- doxytag: member="SocketReceiver::MustWaitToReceive" ref="27501ca6a36dae0cc344c57f413aea1d" args="()" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_receiver.html#27501ca6a36dae0cc344c57f413aea1d">MustWaitToReceive</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#ded81bbe562f61932306a64e6122a6ca">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="#ded81bbe562f61932306a64e6122a6ca"></a><br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="a851a6020843d4311036a6f4299f9a6b"></a><!-- doxytag: member="SocketReceiver::GetWaitObjects" ref="a851a6020843d4311036a6f4299f9a6b" args="(WaitObjectContainer &container, CallStack const &callStack)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">void SocketReceiver::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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table></div><div class="memdoc"><p>put wait objects into container <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>callStack</em> </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_socket_receiver.html#a851a6020843d4311036a6f4299f9a6b" 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></dl><p>Implements <a class="el" href="class_waitable.html#97155f28db33d3dacc69dc453a01609a">Waitable</a>.<p>Definition at line <a class="el" href="socketft_8cpp-source.html#l00357">357</a> of file <a class="el" href="socketft_8cpp-source.html">socketft.cpp</a>.<p>References <a class="el" href="wait_8cpp-source.html#l00139">WaitObjectContainer::AddHandle()</a>, and <a class="el" href="wait_8cpp-source.html#l00081">WaitObjectContainer::SetNoWait()</a>.</div></div><p><a class="anchor" name="ded81bbe562f61932306a64e6122a6ca"></a><!-- doxytag: member="SocketReceiver::Wait" ref="ded81bbe562f61932306a64e6122a6ca" 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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inherited]</code></td> </tr> </table></div><div class="memdoc"><p>wait on this object <p>same as creating an empty container, calling <a class="el" href="class_waitable.html#97155f28db33d3dacc69dc453a01609a" title="put wait objects into container">GetWaitObjects()</a>, and calling <a class="el" href="class_waitable.html#ded81bbe562f61932306a64e6122a6ca" title="wait on this object">Wait()</a> on the container <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>References <a class="el" href="class_waitable.html#97155f28db33d3dacc69dc453a01609a">Waitable::GetWaitObjects()</a>, and <a class="el" href="wait_8cpp-source.html#l00206">WaitObjectContainer::Wait()</a>.<p>Referenced by <a class="el" href="network_8cpp-source.html#l00474">NetworkSink::DoFlush()</a>, and <a class="el" href="network_8cpp-source.html#l00257">NetworkSource::DoPump()</a>.</div></div><p><hr>The documentation for this class was generated from the following files:<ul><li><a class="el" href="socketft_8h-source.html">socketft.h</a><li><a class="el" href="socketft_8cpp-source.html">socketft.cpp</a></ul><hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 1 11:11:50 2007 for Crypto++ by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -