blob: d966bdf479a0fa4e99e728c152fd54d9a3429713 (
plain) (
tree)
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>winapi_common: winapi::Pipe 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">winapi_common
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winapi</b></li><li class="navelem"><a class="el" href="classwinapi_1_1Pipe.html">Pipe</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwinapi_1_1Pipe-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">winapi::Pipe Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Anonymous pipe wrapper.
<a href="classwinapi_1_1Pipe.html#details">More...</a></p>
<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:aa41a6275dab93f4fc0d2e593aa9b39f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Pipe.html#aa41a6275dab93f4fc0d2e593aa9b39f0">Pipe</a> ()</td></tr>
<tr class="separator:aa41a6275dab93f4fc0d2e593aa9b39f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07412b04db253f1c24fe4aeda5db82e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinapi_1_1Handle.html">Handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Pipe.html#a07412b04db253f1c24fe4aeda5db82e1">read_end</a> ()</td></tr>
<tr class="separator:a07412b04db253f1c24fe4aeda5db82e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc45a1f2a5cdee7bbe4f73dd62d667ac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classwinapi_1_1Handle.html">Handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Pipe.html#afc45a1f2a5cdee7bbe4f73dd62d667ac">read_end</a> () const</td></tr>
<tr class="separator:afc45a1f2a5cdee7bbe4f73dd62d667ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19e504588020c68639154ed597151cd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinapi_1_1Handle.html">Handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Pipe.html#a19e504588020c68639154ed597151cd6">write_end</a> ()</td></tr>
<tr class="separator:a19e504588020c68639154ed597151cd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad010465685f521c17bd4b6731ed00e00"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classwinapi_1_1Handle.html">Handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1Pipe.html#ad010465685f521c17bd4b6731ed00e00">write_end</a> () const</td></tr>
<tr class="separator:ad010465685f521c17bd4b6731ed00e00"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Anonymous pipe wrapper. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8hpp_source.html#l00015">15</a> of file <a class="el" href="pipe_8hpp_source.html">pipe.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa41a6275dab93f4fc0d2e593aa9b39f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa41a6275dab93f4fc0d2e593aa9b39f0">◆ </a></span>Pipe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">winapi::Pipe::Pipe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new pipe. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8cpp_source.html#l00041">41</a> of file <a class="el" href="pipe_8cpp_source.html">pipe.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a07412b04db253f1c24fe4aeda5db82e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07412b04db253f1c24fe4aeda5db82e1">◆ </a></span>read_end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinapi_1_1Handle.html">Handle</a>& winapi::Pipe::read_end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the read end of the pipe. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8hpp_source.html#l00021">21</a> of file <a class="el" href="pipe_8hpp_source.html">pipe.hpp</a>.</p>
</div>
</div>
<a id="afc45a1f2a5cdee7bbe4f73dd62d667ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc45a1f2a5cdee7bbe4f73dd62d667ac">◆ </a></span>read_end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classwinapi_1_1Handle.html">Handle</a>& winapi::Pipe::read_end </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8hpp_source.html#l00023">23</a> of file <a class="el" href="pipe_8hpp_source.html">pipe.hpp</a>.</p>
</div>
</div>
<a id="a19e504588020c68639154ed597151cd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19e504588020c68639154ed597151cd6">◆ </a></span>write_end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinapi_1_1Handle.html">Handle</a>& winapi::Pipe::write_end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the write end of the pipe. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8hpp_source.html#l00025">25</a> of file <a class="el" href="pipe_8hpp_source.html">pipe.hpp</a>.</p>
</div>
</div>
<a id="ad010465685f521c17bd4b6731ed00e00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad010465685f521c17bd4b6731ed00e00">◆ </a></span>write_end() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classwinapi_1_1Handle.html">Handle</a>& winapi::Pipe::write_end </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<p class="definition">Definition at line <a class="el" href="pipe_8hpp_source.html#l00027">27</a> of file <a class="el" href="pipe_8hpp_source.html">pipe.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/winapi/<a class="el" href="pipe_8hpp_source.html">pipe.hpp</a></li>
<li>src/<a class="el" href="pipe_8cpp_source.html">pipe.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
