📄 class_windows_pipe_sender.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++: WindowsPipeSender 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>WindowsPipeSender Class Reference</h1><!-- doxytag: class="WindowsPipeSender" --><!-- doxytag: inherits="WindowsPipe,NetworkSender" --><code>#include <<a class="el" href="winpipes_8h-source.html">winpipes.h</a>></code><p><p>Inheritance diagram for WindowsPipeSender:<p><center><img src="class_windows_pipe_sender.png" usemap="#WindowsPipeSender_map" border="0" alt=""></center><map name="WindowsPipeSender_map"><area href="class_windows_pipe.html" alt="WindowsPipe" shape="rect" coords="0,56,128,80"><area href="class_network_sender.html" alt="NetworkSender" shape="rect" coords="138,56,266,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="138,0,266,24"><area href="class_windows_pipe_sink.html" alt="WindowsPipeSink" shape="rect" coords="69,168,197,192"></map><a href="class_windows_pipe_sender-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>pipe-based implementation of <a class="el" href="class_network_sender.html" title="Network Sender.">NetworkSender</a> <p><p>Definition at line <a class="el" href="winpipes_8h-source.html#l00083">83</a> of file <a class="el" href="winpipes_8h-source.html">winpipes.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="05ac85d06100e5cd2ce073f7856ca82e"></a><!-- doxytag: member="WindowsPipeSender::WindowsPipeSender" ref="05ac85d06100e5cd2ce073f7856ca82e" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#05ac85d06100e5cd2ce073f7856ca82e">WindowsPipeSender</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bf4996e1995e9edf4464a682c70f967"></a><!-- doxytag: member="WindowsPipeSender::MustWaitForResult" ref="6bf4996e1995e9edf4464a682c70f967" args="()" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#6bf4996e1995e9edf4464a682c70f967">MustWaitForResult</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e75e75f0f4b2ce507b7fcdf10425a37b"></a><!-- doxytag: member="WindowsPipeSender::Send" ref="e75e75f0f4b2ce507b7fcdf10425a37b" args="(const byte *buf, size_t bufLen)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#e75e75f0f4b2ce507b7fcdf10425a37b">Send</a> (const byte *buf, size_t bufLen)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11de9777c369764fc12a2f1dacbaf7e5"></a><!-- doxytag: member="WindowsPipeSender::GetSendResult" ref="11de9777c369764fc12a2f1dacbaf7e5" args="()" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#11de9777c369764fc12a2f1dacbaf7e5">GetSendResult</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bc079866d0cd3fa86b2bcaa172b5f88"></a><!-- doxytag: member="WindowsPipeSender::MustWaitForEof" ref="3bc079866d0cd3fa86b2bcaa172b5f88" args="()" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#3bc079866d0cd3fa86b2bcaa172b5f88">MustWaitForEof</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="657f480c4f135b0133f6415faab26387"></a><!-- doxytag: member="WindowsPipeSender::SendEof" ref="657f480c4f135b0133f6415faab26387" args="()" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#657f480c4f135b0133f6415faab26387">SendEof</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96f5a29c40ae14da8b6a177201737f29"></a><!-- doxytag: member="WindowsPipeSender::GetMaxWaitObjectCount" ref="96f5a29c40ae14da8b6a177201737f29" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_sender.html#96f5a29c40ae14da8b6a177201737f29">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_windows_pipe_sender.html#26b98ea160dc37248cb9934edb8a27ef">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="#26b98ea160dc37248cb9934edb8a27ef"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb86f4dc8d5ba76ad18f3be4a20d768e"></a><!-- doxytag: member="WindowsPipeSender::MustWaitToSend" ref="fb86f4dc8d5ba76ad18f3be4a20d768e" args="()" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sender.html#fb86f4dc8d5ba76ad18f3be4a20d768e">MustWaitToSend</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="387810801daf13c48170996425c61c77"></a><!-- doxytag: member="WindowsPipeSender::EofSent" ref="387810801daf13c48170996425c61c77" args="()" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_network_sender.html#387810801daf13c48170996425c61c77">EofSent</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><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="636d8c46abf4ce20cc06647e70c1d620"></a><!-- doxytag: member="WindowsPipeSender::GetHandle" ref="636d8c46abf4ce20cc06647e70c1d620" args="() const=0" -->virtual HANDLE </td><td class="memItemRight" valign="bottom"><b>GetHandle</b> () const=0</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1df16059b04e2b291fcb14e8951be7f8"></a><!-- doxytag: member="WindowsPipeSender::HandleError" ref="1df16059b04e2b291fcb14e8951be7f8" args="(const char *operation) const " -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe.html#1df16059b04e2b291fcb14e8951be7f8">HandleError</a> (const char *operation) const </td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fef189e62486afe4dbc03156ca67c50"></a><!-- doxytag: member="WindowsPipeSender::CheckAndHandleError" ref="1fef189e62486afe4dbc03156ca67c50" args="(const char *operation, BOOL result) const" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe.html#1fef189e62486afe4dbc03156ca67c50">CheckAndHandleError</a> (const char *operation, BOOL result) const</td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="26b98ea160dc37248cb9934edb8a27ef"></a><!-- doxytag: member="WindowsPipeSender::GetWaitObjects" ref="26b98ea160dc37248cb9934edb8a27ef" args="(WaitObjectContainer &container, CallStack const &callStack)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">void WindowsPipeSender::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_windows_pipe_sender.html#26b98ea160dc37248cb9934edb8a27ef" 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="winpipes_8cpp-source.html#l00183">183</a> of file <a class="el" href="winpipes_8cpp-source.html">winpipes.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="WindowsPipeSender::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="winpipes_8h-source.html">winpipes.h</a><li><a class="el" href="winpipes_8cpp-source.html">winpipes.cpp</a></ul><hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 1 11:11:54 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 + -