164 lines
17 KiB
HTML
164 lines
17 KiB
HTML
<!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.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: src/uvw/pipe.h Source File</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">uvw
|
|
 <span id="projectnumber">2.6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<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');
|
|
/* @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"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">pipe.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef UVW_PIPE_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_PIPE_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "request.hpp"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "stream.h"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "loop.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">enum class</span> UVChmodFlags: std::underlying_type_t<uv_poll_event> {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  READABLE = UV_READABLE,</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  WRITABLE = UV_WRITABLE</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> };</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> }</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classuvw_1_1PipeHandle.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classuvw_1_1PipeHandle.html">PipeHandle</a> final: <span class="keyword">public</span> <a class="code" href="classuvw_1_1StreamHandle.html">StreamHandle</a><PipeHandle, uv_pipe_t> {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> Chmod = details::UVChmodFlags;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1PipeHandle.html">PipeHandle</a>(ConstructorAccess ca, std::shared_ptr<Loop> ref, <span class="keywordtype">bool</span> pass = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1PipeHandle.html#a90b5e34a39ce85cbe0d9376647d86828">init</a>();</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PipeHandle.html#a8055bcd13c955ecc940a36f2f3a92230">open</a>(<a class="code" href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">FileHandle</a> file);</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PipeHandle.html#ab5162f6e3dd81bdb80727336afba42a8">bind</a>(std::string name);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PipeHandle.html#ac6bcb3f96b852f0ff40a5e899981fe46">connect</a>(std::string name);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::string <a class="code" href="classuvw_1_1PipeHandle.html#aaa128e5451c5a9372d44faab507409a4">sock</a>() <span class="keyword">const</span> noexcept;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::string <a class="code" href="classuvw_1_1PipeHandle.html#af15f10d5b58ef480a6c33e0b0f5387e8">peer</a>() <span class="keyword">const</span> noexcept;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PipeHandle.html#a23f3be6f4e53abadbf043714d6ce6582">pending</a>(<span class="keywordtype">int</span> count) noexcept;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> <a class="code" href="classuvw_1_1PipeHandle.html#a23f3be6f4e53abadbf043714d6ce6582">pending</a>() noexcept;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  HandleType <a class="code" href="classuvw_1_1PipeHandle.html#ac0beb9456aeb67490d8c59396749aeab">receive</a>() noexcept;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1PipeHandle.html#a467c10506cdf86173ff912b5d3f14d8d">chmod</a>(<a class="code" href="classuvw_1_1Flags.html">Flags<Chmod></a> flags) noexcept;</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">bool</span> ipc;</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> };</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> }</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#include "pipe.cpp"</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#endif // UVW_PIPE_INCLUDE_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassuvw_1_1StreamHandle_html"><div class="ttname"><a href="classuvw_1_1StreamHandle.html">uvw::StreamHandle</a></div><div class="ttdoc">The StreamHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="stream_8h_source.html#l00128">stream.h:128</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00010">async.h:10</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_aaa128e5451c5a9372d44faab507409a4"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#aaa128e5451c5a9372d44faab507409a4">uvw::PipeHandle::sock</a></div><div class="ttdeci">std::string sock() const noexcept</div><div class="ttdoc">Gets the name of the Unix domain socket or the named pipe.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html"><div class="ttname"><a href="classuvw_1_1PipeHandle.html">uvw::PipeHandle</a></div><div class="ttdoc">The PipeHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="pipe_8h_source.html#l00041">pipe.h:41</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_a23f3be6f4e53abadbf043714d6ce6582"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#a23f3be6f4e53abadbf043714d6ce6582">uvw::PipeHandle::pending</a></div><div class="ttdeci">int pending() noexcept</div><div class="ttdoc">Gets the number of pending pipe this instance can handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_ac0beb9456aeb67490d8c59396749aeab"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#ac0beb9456aeb67490d8c59396749aeab">uvw::PipeHandle::receive</a></div><div class="ttdeci">HandleType receive() noexcept</div><div class="ttdoc">Used to receive handles over IPC pipes.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1Flags_html"><div class="ttname"><a href="classuvw_1_1Flags.html">uvw::Flags</a></div><div class="ttdoc">Utility class to handle flags.</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00082">util.h:82</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_ab5162f6e3dd81bdb80727336afba42a8"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#ab5162f6e3dd81bdb80727336afba42a8">uvw::PipeHandle::bind</a></div><div class="ttdeci">void bind(std::string name)</div><div class="ttdoc">bind Binds the pipe to a file path (Unix) or a name (Windows).</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_af15f10d5b58ef480a6c33e0b0f5387e8"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#af15f10d5b58ef480a6c33e0b0f5387e8">uvw::PipeHandle::peer</a></div><div class="ttdeci">std::string peer() const noexcept</div><div class="ttdoc">Gets the name of the Unix domain socket or the named pipe to which the handle is connected.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_a8055bcd13c955ecc940a36f2f3a92230"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#a8055bcd13c955ecc940a36f2f3a92230">uvw::PipeHandle::open</a></div><div class="ttdeci">void open(FileHandle file)</div><div class="ttdoc">Opens an existing file descriptor or HANDLE as a pipe.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_a90b5e34a39ce85cbe0d9376647d86828"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#a90b5e34a39ce85cbe0d9376647d86828">uvw::PipeHandle::init</a></div><div class="ttdeci">bool init()</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="anamespaceuvw_html_a02b7ef3b5a65b0bec1602ef434806a27"><div class="ttname"><a href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">uvw::FileHandle</a></div><div class="ttdeci">details::UVTypeWrapper< uv_file > FileHandle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00189">util.h:189</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_a467c10506cdf86173ff912b5d3f14d8d"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#a467c10506cdf86173ff912b5d3f14d8d">uvw::PipeHandle::chmod</a></div><div class="ttdeci">bool chmod(Flags< Chmod > flags) noexcept</div><div class="ttdoc">Alters pipe permissions.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1PipeHandle_html_ac6bcb3f96b852f0ff40a5e899981fe46"><div class="ttname"><a href="classuvw_1_1PipeHandle.html#ac6bcb3f96b852f0ff40a5e899981fe46">uvw::PipeHandle::connect</a></div><div class="ttdeci">void connect(std::string name)</div><div class="ttdoc">Connects to the Unix domain socket or the named pipe.</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|