<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: WindowsPipeReceiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_windows_pipe_receiver-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">WindowsPipeReceiver Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Pipe-based implementation of <a class="el" href="class_network_receiver.html" title="Network Receiver. ">NetworkReceiver</a>.
<a href="class_windows_pipe_receiver.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for WindowsPipeReceiver:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="class_windows_pipe_receiver.png" usemap="#WindowsPipeReceiver_map" alt=""/>
<map id="WindowsPipeReceiver_map" name="WindowsPipeReceiver_map">
<area href="class_windows_pipe.html" title="Windows Pipe. " alt="WindowsPipe" shape="rect" coords="0,56,138,80"/>
<area href="class_network_receiver.html" title="Network Receiver. " alt="NetworkReceiver" shape="rect" coords="148,56,286,80"/>
<area href="class_waitable.html" title="Interface for objects that can be waited on. " alt="Waitable" shape="rect" coords="148,0,286,24"/>
<area href="class_windows_pipe_source.html" title="Windows Pipe Source. " alt="WindowsPipeSource" shape="rect" coords="74,168,212,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a131665b19523131ab49ce1bc1f8a5ea3"><td class="memItemLeft" align="right" valign="top"><a id="a131665b19523131ab49ce1bc1f8a5ea3"></a>
bool </td><td class="memItemRight" valign="bottom"><b>MustWaitForResult</b> ()</td></tr>
<tr class="separator:a131665b19523131ab49ce1bc1f8a5ea3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97f6f63da2411395a55e416e0ea8b11b"><td class="memItemLeft" align="right" valign="top"><a id="a97f6f63da2411395a55e416e0ea8b11b"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_receiver.html#a97f6f63da2411395a55e416e0ea8b11b">Receive</a> (byte *buf, size_t bufLen)</td></tr>
<tr class="memdesc:a97f6f63da2411395a55e416e0ea8b11b"><td class="mdescLeft"> </td><td class="mdescRight">receive data from network source, returns whether result is immediately available <br /></td></tr>
<tr class="separator:a97f6f63da2411395a55e416e0ea8b11b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8a50aca57f1f027fa1d52b1c8161cf5"><td class="memItemLeft" align="right" valign="top"><a id="ac8a50aca57f1f027fa1d52b1c8161cf5"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><b>GetReceiveResult</b> ()</td></tr>
<tr class="separator:ac8a50aca57f1f027fa1d52b1c8161cf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0611cc19d2b70f94b73a4b1b0c00ff4a"><td class="memItemLeft" align="right" valign="top"><a id="a0611cc19d2b70f94b73a4b1b0c00ff4a"></a>
bool </td><td class="memItemRight" valign="bottom"><b>EofReceived</b> () const</td></tr>
<tr class="separator:a0611cc19d2b70f94b73a4b1b0c00ff4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17685c336b4a1ff39db14b285af57e4a"><td class="memItemLeft" align="right" valign="top"><a id="a17685c336b4a1ff39db14b285af57e4a"></a>
HANDLE </td><td class="memItemRight" valign="bottom"><b>GetHandle</b> () const</td></tr>
<tr class="separator:a17685c336b4a1ff39db14b285af57e4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4147e1109927b5fb1f88c9cef5b46cb0"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_receiver.html#a4147e1109927b5fb1f88c9cef5b46cb0">GetMaxWaitObjectCount</a> () const</td></tr>
<tr class="memdesc:a4147e1109927b5fb1f88c9cef5b46cb0"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of wait objects that this object can return. <a href="#a4147e1109927b5fb1f88c9cef5b46cb0">More...</a><br /></td></tr>
<tr class="separator:a4147e1109927b5fb1f88c9cef5b46cb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a3dbb7ef3161d84731c3c320eaa33a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_windows_pipe_receiver.html#a44a3dbb7ef3161d84731c3c320eaa33a">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 class="memdesc:a44a3dbb7ef3161d84731c3c320eaa33a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves waitable objects. <a href="#a44a3dbb7ef3161d84731c3c320eaa33a">More...</a><br /></td></tr>
<tr class="separator:a44a3dbb7ef3161d84731c3c320eaa33a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_network_receiver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_network_receiver')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_network_receiver.html">NetworkReceiver</a></td></tr>
<tr class="memitem:a27501ca6a36dae0cc344c57f413aea1d inherit pub_methods_class_network_receiver"><td class="memItemLeft" align="right" valign="top"><a id="a27501ca6a36dae0cc344c57f413aea1d"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>MustWaitToReceive</b> ()</td></tr>
<tr class="separator:a27501ca6a36dae0cc344c57f413aea1d inherit pub_methods_class_network_receiver"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_waitable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_waitable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_waitable.html">Waitable</a></td></tr>
<tr class="memitem:aded81bbe562f61932306a64e6122a6ca inherit pub_methods_class_waitable"><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 class="memdesc:aded81bbe562f61932306a64e6122a6ca inherit pub_methods_class_waitable"><td class="mdescLeft"> </td><td class="mdescRight">Wait on this object. <a href="class_waitable.html#aded81bbe562f61932306a64e6122a6ca">More...</a><br /></td></tr>
<tr class="separator:aded81bbe562f61932306a64e6122a6ca inherit pub_methods_class_waitable"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Pipe-based implementation of <a class="el" href="class_network_receiver.html" title="Network Receiver. ">NetworkReceiver</a>. </p>
<p class="definition">Definition at line <a class="el" href="winpipes_8h_source.html#l00063">63</a> of file <a class="el" href="winpipes_8h_source.html">winpipes.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4147e1109927b5fb1f88c9cef5b46cb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4147e1109927b5fb1f88c9cef5b46cb0">◆ </a></span>GetMaxWaitObjectCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int WindowsPipeReceiver::GetMaxWaitObjectCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of wait objects that this object can return. </p>
<dl class="section return"><dt>Returns</dt><dd>the maximum number of wait objects </dd></dl>
<p>Implements <a class="el" href="class_waitable.html#a221cf2a8063487b56b97c27197e16b12">Waitable</a>.</p>
<p class="definition">Definition at line <a class="el" href="winpipes_8h_source.html#l00074">74</a> of file <a class="el" href="winpipes_8h_source.html">winpipes.h</a>.</p>
</div>
</div>
<a id="a44a3dbb7ef3161d84731c3c320eaa33a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a3dbb7ef3161d84731c3c320eaa33a">◆ </a></span>GetWaitObjects()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void WindowsPipeReceiver::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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves waitable objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>the wait container to receive the references to the objects. </td></tr>
<tr><td class="paramname">callStack</td><td><a class="el" href="class_call_stack.html">CallStack()</a> object used to select waitable objects</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_windows_pipe_receiver.html#a44a3dbb7ef3161d84731c3c320eaa33a" title="Retrieves waitable objects. ">GetWaitObjects()</a> is usually called in one of two ways. First, it can be called like <code>something.GetWaitObjects(c, <a class="el" href="class_call_stack.html">CallStack</a>("my func after X", 0));</code>. Second, if in an outer <a class="el" href="class_windows_pipe_receiver.html#a44a3dbb7ef3161d84731c3c320eaa33a" title="Retrieves waitable objects. ">GetWaitObjects()</a> method that itself takes a callStack parameter, it can be called like <code>innerThing.GetWaitObjects(c, <a class="el" href="class_call_stack.html">CallStack</a>("MyClass::GetWaitObjects at X", &callStack));</code>. </p>
<p>Implements <a class="el" href="class_waitable.html#a97155f28db33d3dacc69dc453a01609a">Waitable</a>.</p>
<p class="definition">Definition at line <a class="el" href="winpipes_8cpp_source.html#l00130">130</a> of file <a class="el" href="winpipes_8cpp_source.html">winpipes.cpp</a>.</p>
</div>
</div>
<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>
<li><a class="el" href="winpipes_8cpp_source.html">winpipes.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:59:07 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
2106
