709 lines
50 KiB
HTML
709 lines
50 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: uvw::process_handle 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 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="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a></li> </ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#pub-methods">Public Member Functions</a> |
|
||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
<a href="classuvw_1_1process__handle-members.html">List of all members</a> </div>
|
||
<div class="headertitle"><div class="title">uvw::process_handle Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>The process handle.
|
||
<a href="classuvw_1_1process__handle.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="process_8h_source.html">process.h</a>></code></p>
|
||
<div class="dynheader">
|
||
Inheritance diagram for uvw::process_handle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1process__handle__inherit__graph.png" border="0" usemap="#auvw_1_1process__handle_inherit__map" alt="Inheritance graph"/></div>
|
||
<map name="auvw_1_1process__handle_inherit__map" id="auvw_1_1process__handle_inherit__map">
|
||
<area shape="rect" title="The process handle." alt="" coords="79,255,222,280"/>
|
||
<area shape="rect" href="classuvw_1_1handle.html" title=" " alt="" coords="73,152,228,207"/>
|
||
<area shape="rect" href="classuvw_1_1resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="67,79,234,104"/>
|
||
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
||
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
||
</map>
|
||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||
<div class="dynheader">
|
||
Collaboration diagram for uvw::process_handle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1process__handle__coll__graph.png" border="0" usemap="#auvw_1_1process__handle_coll__map" alt="Collaboration graph"/></div>
|
||
<map name="auvw_1_1process__handle_coll__map" id="auvw_1_1process__handle_coll__map">
|
||
<area shape="rect" title="The process handle." alt="" coords="79,255,222,280"/>
|
||
<area shape="rect" href="classuvw_1_1handle.html" title=" " alt="" coords="73,152,228,207"/>
|
||
<area shape="rect" href="classuvw_1_1resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="67,79,234,104"/>
|
||
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
||
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
||
</map>
|
||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||
Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:a70981b7ea1c450c18f0079566efb5ebc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a70981b7ea1c450c18f0079566efb5ebc">init</a> () final</td></tr>
|
||
<tr class="memdesc:a70981b7ea1c450c18f0079566efb5ebc"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
||
<tr class="separator:a70981b7ea1c450c18f0079566efb5ebc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a347502d87a5e6320d573d82db0efefcb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a347502d87a5e6320d573d82db0efefcb">spawn</a> (const char *file, char **args, char **env=nullptr)</td></tr>
|
||
<tr class="memdesc:a347502d87a5e6320d573d82db0efefcb"><td class="mdescLeft"> </td><td class="mdescRight">spawn Starts the process. <br /></td></tr>
|
||
<tr class="separator:a347502d87a5e6320d573d82db0efefcb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a33d105033b8f1cf7d6d828541081be05"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a33d105033b8f1cf7d6d828541081be05">kill</a> (int signum)</td></tr>
|
||
<tr class="memdesc:a33d105033b8f1cf7d6d828541081be05"><td class="mdescLeft"> </td><td class="mdescRight">Sends the specified signal to the internal process handle. <br /></td></tr>
|
||
<tr class="separator:a33d105033b8f1cf7d6d828541081be05"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9c03441397f703b2e61ffa05473eac98"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a9c03441397f703b2e61ffa05473eac98">pid</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a9c03441397f703b2e61ffa05473eac98"><td class="mdescLeft"> </td><td class="mdescRight">Gets the PID of the spawned process. <br /></td></tr>
|
||
<tr class="separator:a9c03441397f703b2e61ffa05473eac98"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:adace9f12f13bb80a9ae2195a2de96092"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#adace9f12f13bb80a9ae2195a2de96092">cwd</a> (const std::string &path) noexcept</td></tr>
|
||
<tr class="memdesc:adace9f12f13bb80a9ae2195a2de96092"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current working directory for the subprocess. <br /></td></tr>
|
||
<tr class="separator:adace9f12f13bb80a9ae2195a2de96092"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a64fd909865f3d60250ba330ebd76bebc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a64fd909865f3d60250ba330ebd76bebc">flags</a> (process_flags flags) noexcept</td></tr>
|
||
<tr class="memdesc:a64fd909865f3d60250ba330ebd76bebc"><td class="mdescLeft"> </td><td class="mdescRight">Sets flags that control how <code><a class="el" href="classuvw_1_1process__handle.html#a347502d87a5e6320d573d82db0efefcb" title="spawn Starts the process.">spawn()</a></code> behaves. <br /></td></tr>
|
||
<tr class="separator:a64fd909865f3d60250ba330ebd76bebc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a8b75ff58155bba0bbba445d15d18a093"><td class="memTemplParams" colspan="2">template<typename T , typename U , typename... E> </td></tr>
|
||
<tr class="memitem:a8b75ff58155bba0bbba445d15d18a093"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a8b75ff58155bba0bbba445d15d18a093">stdio</a> (<a class="el" href="classuvw_1_1stream__handle.html">stream_handle</a>< T, U, E... > &stream, stdio_flags <a class="el" href="classuvw_1_1process__handle.html#a64fd909865f3d60250ba330ebd76bebc">flags</a>)</td></tr>
|
||
<tr class="memdesc:a8b75ff58155bba0bbba445d15d18a093"><td class="mdescLeft"> </td><td class="mdescRight">Makes a <code>stdio</code> handle available to the child process. <br /></td></tr>
|
||
<tr class="separator:a8b75ff58155bba0bbba445d15d18a093"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a040ae1569d2d122247ad047f6ae1c802"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a040ae1569d2d122247ad047f6ae1c802">stdio</a> (<a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> <a class="el" href="classuvw_1_1handle.html#a0ce9568c94aa0122ff4cee6a57b4fae5">fd</a>, stdio_flags <a class="el" href="classuvw_1_1process__handle.html#a64fd909865f3d60250ba330ebd76bebc">flags</a>)</td></tr>
|
||
<tr class="memdesc:a040ae1569d2d122247ad047f6ae1c802"><td class="mdescLeft"> </td><td class="mdescRight">Makes a file descriptor available to the child process. <br /></td></tr>
|
||
<tr class="separator:a040ae1569d2d122247ad047f6ae1c802"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a859dfad9118e4bd3b9bcaa6259b18229"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a859dfad9118e4bd3b9bcaa6259b18229">uid</a> (<a class="el" href="namespaceuvw.html#a0ce5f6829814d65c5087566b9e4a6a2e">uid_type</a> id)</td></tr>
|
||
<tr class="memdesc:a859dfad9118e4bd3b9bcaa6259b18229"><td class="mdescLeft"> </td><td class="mdescRight">Sets the child process' user id. <br /></td></tr>
|
||
<tr class="separator:a859dfad9118e4bd3b9bcaa6259b18229"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2bc10b8b4771f50df42daf23d71f24b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a2bc10b8b4771f50df42daf23d71f24b1">gid</a> (<a class="el" href="namespaceuvw.html#a496a2034d9041b1d7813317f83ab6623">gid_type</a> id)</td></tr>
|
||
<tr class="memdesc:a2bc10b8b4771f50df42daf23d71f24b1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the child process' group id. <br /></td></tr>
|
||
<tr class="separator:a2bc10b8b4771f50df42daf23d71f24b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_methods_classuvw_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1handle.html">uvw::handle< process_handle, uv_process_t, exit_event ></a></td></tr>
|
||
<tr class="memitem:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a9e28e1855691dd1af105626ed11f3ac4">handle_category</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a80c5ba8c4db128cc525406e998549b96">category</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the category of the handle. <br /></td></tr>
|
||
<tr class="separator:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">handle_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a88018be1fa3105e958c50a9f1881baa9">type</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the handle. <br /></td></tr>
|
||
<tr class="separator:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a938d3ac6e5cc78f9442f9bb851170643">active</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the handle is active. <br /></td></tr>
|
||
<tr class="separator:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ae93cbf2156f0d673093e48832104a3cc">closing</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a handle is closing or closed. <br /></td></tr>
|
||
<tr class="separator:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a3648ed9805e8d0e8963f137f8584e483">close</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Request handle to be closed. <br /></td></tr>
|
||
<tr class="separator:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a2f0d788997368ab1af2dc475126a46d2">reference</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Reference the given handle. <br /></td></tr>
|
||
<tr class="separator:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a83a91d1353c19f1a05aace78dc2cc453">unreference</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Unreference the given handle. <br /></td></tr>
|
||
<tr class="separator:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a1403f961ab40063f79c4a293c78ed63c">referenced</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given handle referenced. <br /></td></tr>
|
||
<tr class="separator:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a5852080ba1fd71a302c2424cf2df9a27">size</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the underlying handle type. <br /></td></tr>
|
||
<tr class="separator:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#aa99406ca909aeaac17522959db8c71a4">send_buffer_size</a> ()</td></tr>
|
||
<tr class="memdesc:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the send buffer used for the socket. <br /></td></tr>
|
||
<tr class="separator:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a917ab9c1f011232b50f9980f29167ee2">send_buffer_size</a> (int value)</td></tr>
|
||
<tr class="memdesc:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the send buffer used for the socket. <br /></td></tr>
|
||
<tr class="separator:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a7a3337ef0c68ed5ba0e9bea0e2e90539">recv_buffer_size</a> ()</td></tr>
|
||
<tr class="memdesc:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the receive buffer used for the socket. <br /></td></tr>
|
||
<tr class="separator:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ace23bb725f6f80ae7a611f5228ad9f8d">recv_buffer_size</a> (int value)</td></tr>
|
||
<tr class="memdesc:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the receive buffer used for the socket. <br /></td></tr>
|
||
<tr class="separator:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a0ce9568c94aa0122ff4cee6a57b4fae5">fd</a> () const</td></tr>
|
||
<tr class="memdesc:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the platform dependent file descriptor equivalent. <br /></td></tr>
|
||
<tr class="separator:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_methods_classuvw_1_1resource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1resource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1resource.html">uvw::resource< T, U, E ></a></td></tr>
|
||
<tr class="memitem:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memTemplParams" colspan="2">template<typename R = void> </td></tr>
|
||
<tr class="memitem:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< R > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88">data</a> () const</td></tr>
|
||
<tr class="memdesc:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Gets user-defined data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
||
<tr class="separator:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80">data</a> (std::shared_ptr< void > udata)</td></tr>
|
||
<tr class="memdesc:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Sets arbitrary data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
||
<tr class="separator:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_methods_structuvw_1_1uv__type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structuvw_1_1uv__type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structuvw_1_1uv__type.html">uvw::uv_type< U ></a></td></tr>
|
||
<tr class="memitem:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">init</a> ()</td></tr>
|
||
<tr class="memdesc:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
||
<tr class="separator:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1loop.html">loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae03b0ebbae151c6157c5ba6a24a39a7b">parent</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop from which the resource was originated. <br /></td></tr>
|
||
<tr class="separator:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">const U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
||
<tr class="separator:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#af4b6f395815f2e99302b5f09be23767c">raw</a> () noexcept</td></tr>
|
||
<tr class="memdesc:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
||
<tr class="separator:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_methods_classuvw_1_1emitter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1emitter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1emitter.html">uvw::emitter< T, E... ></a></td></tr>
|
||
<tr class="memitem:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ab913fa1c005a33c73b2eb2b0d1051b1f">on</a> (listener_t< U > f)</td></tr>
|
||
<tr class="memdesc:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Registers a long-lived listener with the event emitter. <br /></td></tr>
|
||
<tr class="separator:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="accff5c096692f5eebbe941189644e69d" name="accff5c096692f5eebbe941189644e69d"></a>
|
||
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
||
<tr class="memdesc:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects the listener for the given event type. <br /></td></tr>
|
||
<tr class="separator:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="aa71435e74e775cfa7012fe2e52ca5193" name="aa71435e74e775cfa7012fe2e52ca5193"></a>
|
||
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
||
<tr class="memdesc:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects all listeners. <br /></td></tr>
|
||
<tr class="separator:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ac02a29fe156faba7571b50450fc4f780">has</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Checks if there is a listener registered for the specific event. <br /></td></tr>
|
||
<tr class="separator:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
||
Static Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:ae3fd05c0db61df98d4af122cb58c97af"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#ae3fd05c0db61df98d4af122cb58c97af">disable_stdio_inheritance</a> () noexcept</td></tr>
|
||
<tr class="memdesc:ae3fd05c0db61df98d4af122cb58c97af"><td class="mdescLeft"> </td><td class="mdescRight">Disables inheritance for file descriptors/handles. <br /></td></tr>
|
||
<tr class="separator:ae3fd05c0db61df98d4af122cb58c97af"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a80598e1f2e2eaf262898a50421ead611"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1process__handle.html#a80598e1f2e2eaf262898a50421ead611">kill</a> (int <a class="el" href="classuvw_1_1process__handle.html#a9c03441397f703b2e61ffa05473eac98">pid</a>, int signum) noexcept</td></tr>
|
||
<tr class="memdesc:a80598e1f2e2eaf262898a50421ead611"><td class="mdescLeft"> </td><td class="mdescRight">kill Sends the specified signal to the given PID. <br /></td></tr>
|
||
<tr class="separator:a80598e1f2e2eaf262898a50421ead611"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<div class="textblock"><p>The process handle. </p>
|
||
<p>Process handles will spawn a new process and allow the user to control it and establish communication channels with it using streams. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8h_source.html#l00058">58</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>
|
||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
<a id="adace9f12f13bb80a9ae2195a2de96092" name="adace9f12f13bb80a9ae2195a2de96092"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#adace9f12f13bb80a9ae2195a2de96092">◆ </a></span>cwd()</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="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::cwd </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string & </td>
|
||
<td class="paramname"><em>path</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sets the current working directory for the subprocess. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">path</td><td>The working directory to be used when <code><a class="el" href="classuvw_1_1process__handle.html#a347502d87a5e6320d573d82db0efefcb" title="spawn Starts the process.">spawn()</a></code> is invoked. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae3fd05c0db61df98d4af122cb58c97af" name="ae3fd05c0db61df98d4af122cb58c97af"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae3fd05c0db61df98d4af122cb58c97af">◆ </a></span>disable_stdio_inheritance()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static void uvw::process_handle::disable_stdio_inheritance </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Disables inheritance for file descriptors/handles. </p>
|
||
<p>Disables inheritance for file descriptors/handles that this process inherited from its parent. The effect is that child processes spawned by this process don’t accidentally inherit these handles.<br />
|
||
It is recommended to call this function as early in your program as possible, before the inherited file descriptors can be closed or duplicated.</p>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/process.html#c.uv_disable_stdio_inheritance">documentation</a> for further details. </p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a64fd909865f3d60250ba330ebd76bebc" name="a64fd909865f3d60250ba330ebd76bebc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a64fd909865f3d60250ba330ebd76bebc">◆ </a></span>flags()</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="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::flags </td>
|
||
<td>(</td>
|
||
<td class="paramtype">process_flags </td>
|
||
<td class="paramname"><em>flags</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sets flags that control how <code><a class="el" href="classuvw_1_1process__handle.html#a347502d87a5e6320d573d82db0efefcb" title="spawn Starts the process.">spawn()</a></code> behaves. </p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>process_handle::process_flags::SETUID</code></li>
|
||
<li><code>process_handle::process_flags::SETGID</code></li>
|
||
<li><code>process_handle::process_flags::WINDOWS_VERBATIM_ARGUMENTS</code></li>
|
||
<li><code>process_handle::process_flags::DETACHED</code></li>
|
||
<li><code>process_handle::process_flags::WINDOWS_HIDE</code></li>
|
||
<li><code>process_handle::process_flags::WINDOWS_HIDE_CONSOLE</code></li>
|
||
<li><code>process_handle::process_flags::WINDOWS_HIDE_GUI</code></li>
|
||
</ul>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/process.html#c.uv_process_flags">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">flags</td><td>A valid set of flags. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2bc10b8b4771f50df42daf23d71f24b1" name="a2bc10b8b4771f50df42daf23d71f24b1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2bc10b8b4771f50df42daf23d71f24b1">◆ </a></span>gid()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::gid </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a496a2034d9041b1d7813317f83ab6623">gid_type</a> </td>
|
||
<td class="paramname"><em>id</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sets the child process' group id. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">id</td><td>A valid group id to be used. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a70981b7ea1c450c18f0079566efb5ebc" name="a70981b7ea1c450c18f0079566efb5ebc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a70981b7ea1c450c18f0079566efb5ebc">◆ </a></span>init()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::process_handle::init </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Initializes the handle. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
<p>Reimplemented from <a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">uvw::uv_type< U ></a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a80598e1f2e2eaf262898a50421ead611" name="a80598e1f2e2eaf262898a50421ead611"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a80598e1f2e2eaf262898a50421ead611">◆ </a></span>kill() <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">static bool uvw::process_handle::kill </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>pid</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>signum</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">static</span><span class="mlabel">noexcept</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>kill Sends the specified signal to the given PID. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">pid</td><td>A valid process id. </td></tr>
|
||
<tr><td class="paramname">signum</td><td>A valid signal identifier. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a33d105033b8f1cf7d6d828541081be05" name="a33d105033b8f1cf7d6d828541081be05"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a33d105033b8f1cf7d6d828541081be05">◆ </a></span>kill() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::process_handle::kill </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>signum</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sends the specified signal to the internal process handle. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">signum</td><td>A valid signal identifier. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9c03441397f703b2e61ffa05473eac98" name="a9c03441397f703b2e61ffa05473eac98"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9c03441397f703b2e61ffa05473eac98">◆ </a></span>pid()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::process_handle::pid </td>
|
||
<td>(</td>
|
||
<td class="paramname"></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Gets the PID of the spawned process. </p>
|
||
<p>It’s set after calling <code><a class="el" href="classuvw_1_1process__handle.html#a347502d87a5e6320d573d82db0efefcb" title="spawn Starts the process.">spawn()</a></code>.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The PID of the spawned process. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a347502d87a5e6320d573d82db0efefcb" name="a347502d87a5e6320d573d82db0efefcb"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a347502d87a5e6320d573d82db0efefcb">◆ </a></span>spawn()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::process_handle::spawn </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"><em>file</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">char ** </td>
|
||
<td class="paramname"><em>args</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">char ** </td>
|
||
<td class="paramname"><em>env</em> = <code>nullptr</code> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>spawn Starts the process. </p>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/process.html">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">file</td><td>Path pointing to the program to be executed. </td></tr>
|
||
<tr><td class="paramname">args</td><td>Command line arguments. </td></tr>
|
||
<tr><td class="paramname">env</td><td>Optional environment for the new process. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a040ae1569d2d122247ad047f6ae1c802" name="a040ae1569d2d122247ad047f6ae1c802"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a040ae1569d2d122247ad047f6ae1c802">◆ </a></span>stdio() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::stdio </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> </td>
|
||
<td class="paramname"><em>fd</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">stdio_flags </td>
|
||
<td class="paramname"><em>flags</em> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Makes a file descriptor available to the child process. </p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>process_handle::stdio_flags::IGNORE_STREAM</code></li>
|
||
<li><code>process_handle::stdio_flags::CREATE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::INHERIT_FD</code></li>
|
||
<li><code>process_handle::stdio_flags::INHERIT_STREAM</code></li>
|
||
<li><code>process_handle::stdio_flags::READABLE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::WRITABLE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::OVERLAPPED_PIPE</code></li>
|
||
</ul>
|
||
<p>Default file descriptors are:</p><ul>
|
||
<li><code><a class="el" href="namespaceuvw.html#a3691af2bb44186858cde323ca9f21fee">uvw::std_in</a></code> for <code>stdin</code></li>
|
||
<li><code><a class="el" href="namespaceuvw.html#aed16ccd324bef8280d2a38e321ad063d">uvw::std_out</a></code> for <code>stdout</code></li>
|
||
<li><code><a class="el" href="namespaceuvw.html#aa1f6dd38215987004990ad6e2111db4e">uvw::std_err</a></code> for <code>stderr</code></li>
|
||
</ul>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/process.html#c.uv_stdio_flags">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">fd</td><td>A valid file descriptor. </td></tr>
|
||
<tr><td class="paramname">flags</td><td>A valid set of flags. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a8b75ff58155bba0bbba445d15d18a093" name="a8b75ff58155bba0bbba445d15d18a093"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8b75ff58155bba0bbba445d15d18a093">◆ </a></span>stdio() <span class="overload">[2/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<typename T , typename U , typename... E> </div>
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::stdio </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classuvw_1_1stream__handle.html">stream_handle</a>< T, U, E... > & </td>
|
||
<td class="paramname"><em>stream</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">stdio_flags </td>
|
||
<td class="paramname"><em>flags</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">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Makes a <code>stdio</code> handle available to the child process. </p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>process_handle::stdio_flags::IGNORE_STREAM</code></li>
|
||
<li><code>process_handle::stdio_flags::CREATE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::INHERIT_FD</code></li>
|
||
<li><code>process_handle::stdio_flags::INHERIT_STREAM</code></li>
|
||
<li><code>process_handle::stdio_flags::READABLE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::WRITABLE_PIPE</code></li>
|
||
<li><code>process_handle::stdio_flags::OVERLAPPED_PIPE</code></li>
|
||
</ul>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/process.html#c.uv_stdio_flags">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">stream</td><td>A valid <code>stdio</code> handle. </td></tr>
|
||
<tr><td class="paramname">flags</td><td>A valid set of flags. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8h_source.html#l00178">178</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a859dfad9118e4bd3b9bcaa6259b18229" name="a859dfad9118e4bd3b9bcaa6259b18229"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a859dfad9118e4bd3b9bcaa6259b18229">◆ </a></span>uid()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classuvw_1_1process__handle.html">process_handle</a> & uvw::process_handle::uid </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a0ce5f6829814d65c5087566b9e4a6a2e">uid_type</a> </td>
|
||
<td class="paramname"><em>id</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sets the child process' user id. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">id</td><td>A valid user id to be used. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>A reference to this process handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
<li>src/uvw/<a class="el" href="process_8h_source.html">process.h</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.6
|
||
</small></address>
|
||
</body>
|
||
</html>
|