📄 class_waitable.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++: Waitable 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>Waitable Class Reference</h1><!-- doxytag: class="Waitable" --><code>#include <<a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>></code><p><p>Inheritance diagram for Waitable:<p><center><img src="class_waitable.png" usemap="#Waitable_map" border="0" alt=""></center><map name="Waitable_map"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="0,56,248,80"><area href="class_network_receiver.html" alt="NetworkReceiver" shape="rect" coords="516,56,764,80"><area href="class_network_sender.html" alt="NetworkSender" shape="rect" coords="1032,56,1280,80"><area href="class_auto_signaling.html" alt="AutoSignaling< BufferedTransformation >" shape="rect" coords="258,112,506,136"><area href="class_bufferless.html" alt="Bufferless< BufferedTransformation >" shape="rect" coords="258,168,506,192"><area href="class_filter.html" alt="Filter" shape="rect" coords="258,224,506,248"><area href="class_input_rejecting.html" alt="InputRejecting< BufferedTransformation >" shape="rect" coords="258,280,506,304"><area href="class_sink.html" alt="Sink" shape="rect" coords="258,336,506,360"><area href="class_socket_receiver.html" alt="SocketReceiver" shape="rect" coords="774,112,1022,136"><area href="class_windows_pipe_receiver.html" alt="WindowsPipeReceiver" shape="rect" coords="774,168,1022,192"><area href="class_socket_sender.html" alt="SocketSender" shape="rect" coords="1290,112,1538,136"><area href="class_windows_pipe_sender.html" alt="WindowsPipeSender" shape="rect" coords="1290,168,1538,192"></map><a href="class_waitable-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>interface for objects that you can wait for <p><p>Definition at line <a class="el" href="cryptlib_8h-source.html#l00680">680</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.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="34686e120d2c79666741c0c139a215cc"></a><!-- doxytag: member="Waitable::~Waitable" ref="34686e120d2c79666741c0c139a215cc" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#34686e120d2c79666741c0c139a215cc">~Waitable</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3cac959dd3d871d332b6ca87f3a044b3"></a><!-- doxytag: member="Waitable::GetMaxWaitObjectCount" ref="3cac959dd3d871d332b6ca87f3a044b3" args="() const=0" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#3cac959dd3d871d332b6ca87f3a044b3">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" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#97155f28db33d3dacc69dc453a01609a">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="#97155f28db33d3dacc69dc453a01609a"></a><br></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="97155f28db33d3dacc69dc453a01609a"></a><!-- doxytag: member="Waitable::GetWaitObjects" ref="97155f28db33d3dacc69dc453a01609a" 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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure 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_waitable.html#97155f28db33d3dacc69dc453a01609a" 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>Implemented in <a class="el" href="class_buffered_transformation.html#127ccd1793fdda6548cd1295f848d0f7">BufferedTransformation</a>, <a class="el" href="class_redirector.html#c0dc5f63f7a57af37f819aa9251a78bf">Redirector</a>, <a class="el" href="class_network_source.html#6193d15e11af19041ac1ec17b1228e61">NetworkSource</a>, <a class="el" href="class_network_sink.html#398a8ac1689dffbabb0115787904688b">NetworkSink</a>, <a class="el" href="class_socket_receiver.html#a851a6020843d4311036a6f4299f9a6b">SocketReceiver</a>, <a class="el" href="class_socket_sender.html#9f5d2a6bb5665c5b93d857485c8348e4">SocketSender</a>, <a class="el" href="class_windows_pipe_receiver.html#44a3dbb7ef3161d84731c3c320eaa33a">WindowsPipeReceiver</a>, and <a class="el" href="class_windows_pipe_sender.html#26b98ea160dc37248cb9934edb8a27ef">WindowsPipeSender</a>.<p>Referenced by <a class="el" href="network_8cpp-source.html#l00406">NetworkSink::GetWaitObjects()</a>, <a class="el" href="network_8cpp-source.html#l00242">NetworkSource::GetWaitObjects()</a>, and <a class="el" href="wait_8cpp-source.html#l00388">Wait()</a>.</div></div><p><a class="anchor" name="ded81bbe562f61932306a64e6122a6ca"></a><!-- doxytag: member="Waitable::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%"></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">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="cryptlib_8h-source.html">cryptlib.h</a><li><a class="el" href="wait_8cpp-source.html">wait.cpp</a></ul><hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 1 11:11:53 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 + -