162 lines
18 KiB
HTML
162 lines
18 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_PIPE_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_PIPE_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "config.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "enum.hpp"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "loop.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "request.hpp"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "stream.h"</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">enum class</span> uvw_chmod_flags : std::underlying_type_t<uv_poll_event> {</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> READABLE = UV_READABLE,</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> WRITABLE = UV_WRITABLE,</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> _UVW_ENUM = 0</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>};</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>}</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html"> 38</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1pipe__handle.html">pipe_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1stream__handle.html">stream_handle</a><pipe_handle, uv_pipe_t> {</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">using </span>chmod_flags = details::uvw_chmod_flags;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classuvw_1_1pipe__handle.html">pipe_handle</a>(loop::token token, std::shared_ptr<loop> ref, <span class="keywordtype">bool</span> pass = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#acd39d8dc12cd965b1ea2e0833a8eb33a"> 48</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#acd39d8dc12cd965b1ea2e0833a8eb33a">init</a>() final;</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#a26589dab7b89324217dee2939ab3dd9f"> 59</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a26589dab7b89324217dee2939ab3dd9f">open</a>(<a class="code hl_typedef" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> file);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#aa490105af71a1f59f2b5ec4637270194"> 69</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#aa490105af71a1f59f2b5ec4637270194">bind</a>(const std::<span class="keywordtype">string</span> &name);</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#a8fdb960c599bf4ab281dc2e19e8241a2"> 81</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a8fdb960c599bf4ab281dc2e19e8241a2">connect</a>(const std::<span class="keywordtype">string</span> &name);</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#aab27c379653ef2c49ae861a7b9039637"> 88</a></span> std::<span class="keywordtype">string</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#aab27c379653ef2c49ae861a7b9039637">sock</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#a77f5e62e504a69e47a84b04e0e7a0e67"> 96</a></span> std::<span class="keywordtype">string</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a77f5e62e504a69e47a84b04e0e7a0e67">peer</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#ae4cc20d486d44ee915eb2d526107bac8"> 107</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999">pending</a>(<span class="keywordtype">int</span> count) noexcept;</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999"> 113</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999">pending</a>() noexcept;</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#a5c8a6d67e9ec7a6507d8f181f3fb1f60"> 131</a></span> handle_type <a class="code hl_function" href="classuvw_1_1pipe__handle.html#a5c8a6d67e9ec7a6507d8f181f3fb1f60">receive</a>() noexcept;</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classuvw_1_1pipe__handle.html#af2470cc253767f663c57ce632a70c0e0"> 150</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1pipe__handle.html#af2470cc253767f663c57ce632a70c0e0">chmod</a>(chmod_flags flags) noexcept;</div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span>private:</div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">bool</span> ipc;</div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span>};</div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> </div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="preprocessor"># include "pipe.cpp"</span></div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> </div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="preprocessor">#endif </span><span class="comment">// UVW_PIPE_INCLUDE_H</span></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html"><div class="ttname"><a href="classuvw_1_1pipe__handle.html">uvw::pipe_handle</a></div><div class="ttdoc">The pipe handle.</div><div class="ttdef"><b>Definition:</b> <a href="pipe_8h_source.html#l00038">pipe.h:38</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html_a26589dab7b89324217dee2939ab3dd9f"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#a26589dab7b89324217dee2939ab3dd9f">uvw::pipe_handle::open</a></div><div class="ttdeci">int open(file_handle file)</div><div class="ttdoc">Opens an existing file descriptor or HANDLE as a pipe.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html_a32692d6af15e300e3f147ff13d251999"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999">uvw::pipe_handle::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_1pipe__handle_html_a5c8a6d67e9ec7a6507d8f181f3fb1f60"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#a5c8a6d67e9ec7a6507d8f181f3fb1f60">uvw::pipe_handle::receive</a></div><div class="ttdeci">handle_type receive() noexcept</div><div class="ttdoc">Used to receive handles over IPC pipes.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html_a77f5e62e504a69e47a84b04e0e7a0e67"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#a77f5e62e504a69e47a84b04e0e7a0e67">uvw::pipe_handle::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_1pipe__handle_html_a8fdb960c599bf4ab281dc2e19e8241a2"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#a8fdb960c599bf4ab281dc2e19e8241a2">uvw::pipe_handle::connect</a></div><div class="ttdeci">int connect(const std::string &name)</div><div class="ttdoc">Connects to the Unix domain socket or the named pipe.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html_aa490105af71a1f59f2b5ec4637270194"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#aa490105af71a1f59f2b5ec4637270194">uvw::pipe_handle::bind</a></div><div class="ttdeci">int bind(const 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_1pipe__handle_html_aab27c379653ef2c49ae861a7b9039637"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#aab27c379653ef2c49ae861a7b9039637">uvw::pipe_handle::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_1pipe__handle_html_acd39d8dc12cd965b1ea2e0833a8eb33a"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#acd39d8dc12cd965b1ea2e0833a8eb33a">uvw::pipe_handle::init</a></div><div class="ttdeci">int init() final</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1pipe__handle_html_af2470cc253767f663c57ce632a70c0e0"><div class="ttname"><a href="classuvw_1_1pipe__handle.html#af2470cc253767f663c57ce632a70c0e0">uvw::pipe_handle::chmod</a></div><div class="ttdeci">int chmod(chmod_flags flags) noexcept</div><div class="ttdoc">Alters pipe permissions.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1stream__handle_html"><div class="ttname"><a href="classuvw_1_1stream__handle.html">uvw::stream_handle</a></div><div class="ttdoc">The stream handle.</div><div class="ttdef"><b>Definition:</b> <a href="stream_8h_source.html#l00108">stream.h:108</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#l00008">async.h:8</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html_a28622e02bfff09ba6cf8a86a929917ee"><div class="ttname"><a href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">uvw::file_handle</a></div><div class="ttdeci">details::uv_type_wrapper< uv_file > file_handle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00085">util.h:85</a></div></div>
|
|
</div><!-- fragment --></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.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|