765 lines
56 KiB
HTML
765 lines
56 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>uvw: uvw::ProcessHandle 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">uvw
|
||
 <span id="projectnumber">1.11.1</span>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.8.13 -->
|
||
<script type="text/javascript">
|
||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
</script>
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
$(function() {
|
||
initMenu('',true,false,'search.php','Search');
|
||
$(document).ready(function() { init_search(); });
|
||
});
|
||
</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="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</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_1ProcessHandle-members.html">List of all members</a> </div>
|
||
<div class="headertitle">
|
||
<div class="title">uvw::ProcessHandle Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>The <a class="el" href="classuvw_1_1ProcessHandle.html" title="The ProcessHandle handle. ">ProcessHandle</a> handle.
|
||
<a href="classuvw_1_1ProcessHandle.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="process_8hpp_source.html">process.hpp</a>></code></p>
|
||
<div class="dynheader">
|
||
Inheritance diagram for uvw::ProcessHandle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1ProcessHandle__inherit__graph.png" border="0" usemap="#uvw_1_1ProcessHandle_inherit__map" alt="Inheritance graph"/></div>
|
||
<map name="uvw_1_1ProcessHandle_inherit__map" id="uvw_1_1ProcessHandle_inherit__map">
|
||
<area shape="rect" id="node2" href="classuvw_1_1Handle.html" title="uvw::Handle\< ProcessHandle,\l uv_process_t \>" alt="" coords="65,199,265,240"/>
|
||
<area shape="rect" id="node3" href="structuvw_1_1BaseHandle.html" title="Untyped handle class. " alt="" coords="5,117,131,143"/>
|
||
<area shape="rect" id="node4" href="classuvw_1_1Resource.html" title="uvw::Resource\< ProcessHandle,\l uv_process_t \>" alt="" coords="155,109,370,151"/>
|
||
<area shape="rect" id="node5" href="classuvw_1_1UnderlyingType.html" title="uvw::UnderlyingType\l\< ProcessHandle, uv\l_process_t \>" alt="" coords="89,5,234,61"/>
|
||
<area shape="rect" id="node6" href="classuvw_1_1Emitter.html" title="uvw::Emitter\< ProcessHandle \>" alt="" coords="258,20,467,47"/>
|
||
</map>
|
||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||
<div class="dynheader">
|
||
Collaboration diagram for uvw::ProcessHandle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1ProcessHandle__coll__graph.png" border="0" usemap="#uvw_1_1ProcessHandle_coll__map" alt="Collaboration graph"/></div>
|
||
<map name="uvw_1_1ProcessHandle_coll__map" id="uvw_1_1ProcessHandle_coll__map">
|
||
<area shape="rect" id="node2" href="classuvw_1_1Handle.html" title="uvw::Handle\< ProcessHandle,\l uv_process_t \>" alt="" coords="65,199,265,240"/>
|
||
<area shape="rect" id="node3" href="structuvw_1_1BaseHandle.html" title="Untyped handle class. " alt="" coords="5,117,131,143"/>
|
||
<area shape="rect" id="node4" href="classuvw_1_1Resource.html" title="uvw::Resource\< ProcessHandle,\l uv_process_t \>" alt="" coords="155,109,370,151"/>
|
||
<area shape="rect" id="node5" href="classuvw_1_1UnderlyingType.html" title="uvw::UnderlyingType\l\< ProcessHandle, uv\l_process_t \>" alt="" coords="89,5,234,61"/>
|
||
<area shape="rect" id="node6" href="classuvw_1_1Emitter.html" title="uvw::Emitter\< ProcessHandle \>" alt="" coords="258,20,467,47"/>
|
||
</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 name="pub-methods"></a>
|
||
Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:a43973ccae3afb823607152f51af84762"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a43973ccae3afb823607152f51af84762">init</a> ()</td></tr>
|
||
<tr class="memdesc:a43973ccae3afb823607152f51af84762"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <a href="#a43973ccae3afb823607152f51af84762">More...</a><br /></td></tr>
|
||
<tr class="separator:a43973ccae3afb823607152f51af84762"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9b2872324ef0ee004713a6128040a56a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a9b2872324ef0ee004713a6128040a56a">spawn</a> (const char *file, char **args, char **env=nullptr)</td></tr>
|
||
<tr class="memdesc:a9b2872324ef0ee004713a6128040a56a"><td class="mdescLeft"> </td><td class="mdescRight">spawn Starts the process. <a href="#a9b2872324ef0ee004713a6128040a56a">More...</a><br /></td></tr>
|
||
<tr class="separator:a9b2872324ef0ee004713a6128040a56a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a654d0b3fa241c9ecf7e7b05770001f08"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a654d0b3fa241c9ecf7e7b05770001f08">kill</a> (int signum)</td></tr>
|
||
<tr class="memdesc:a654d0b3fa241c9ecf7e7b05770001f08"><td class="mdescLeft"> </td><td class="mdescRight">Sends the specified signal to the internal process handle. <a href="#a654d0b3fa241c9ecf7e7b05770001f08">More...</a><br /></td></tr>
|
||
<tr class="separator:a654d0b3fa241c9ecf7e7b05770001f08"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a7463999530b4c1066f3168e889fbac45"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a7463999530b4c1066f3168e889fbac45">pid</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a7463999530b4c1066f3168e889fbac45"><td class="mdescLeft"> </td><td class="mdescRight">Gets the PID of the spawned process. <a href="#a7463999530b4c1066f3168e889fbac45">More...</a><br /></td></tr>
|
||
<tr class="separator:a7463999530b4c1066f3168e889fbac45"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a29dca1723733e51edf063f93046f52b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a29dca1723733e51edf063f93046f52b1">cwd</a> (std::string path) noexcept</td></tr>
|
||
<tr class="memdesc:a29dca1723733e51edf063f93046f52b1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current working directory for the subprocess. <a href="#a29dca1723733e51edf063f93046f52b1">More...</a><br /></td></tr>
|
||
<tr class="separator:a29dca1723733e51edf063f93046f52b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac4f524f5ac5dd208246ae7b680bd22b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#ac4f524f5ac5dd208246ae7b680bd22b0">flags</a> (<a class="el" href="classuvw_1_1Flags.html">Flags</a>< Process > flags) noexcept</td></tr>
|
||
<tr class="memdesc:ac4f524f5ac5dd208246ae7b680bd22b0"><td class="mdescLeft"> </td><td class="mdescRight">Sets flags that control how <code><a class="el" href="classuvw_1_1ProcessHandle.html#a9b2872324ef0ee004713a6128040a56a" title="spawn Starts the process. ">spawn()</a></code> behaves. <a href="#ac4f524f5ac5dd208246ae7b680bd22b0">More...</a><br /></td></tr>
|
||
<tr class="separator:ac4f524f5ac5dd208246ae7b680bd22b0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a77125dadf0597c8bb73d85e055e5df65"><td class="memTemplParams" colspan="2">template<typename T , typename U > </td></tr>
|
||
<tr class="memitem:a77125dadf0597c8bb73d85e055e5df65"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a77125dadf0597c8bb73d85e055e5df65">stdio</a> (<a class="el" href="classuvw_1_1StreamHandle.html">StreamHandle</a>< T, U > &stream, <a class="el" href="classuvw_1_1Flags.html">Flags</a>< StdIO > <a class="el" href="classuvw_1_1ProcessHandle.html#ac4f524f5ac5dd208246ae7b680bd22b0">flags</a>)</td></tr>
|
||
<tr class="memdesc:a77125dadf0597c8bb73d85e055e5df65"><td class="mdescLeft"> </td><td class="mdescRight">Makes a <code>stdio</code> handle available to the child process. <a href="#a77125dadf0597c8bb73d85e055e5df65">More...</a><br /></td></tr>
|
||
<tr class="separator:a77125dadf0597c8bb73d85e055e5df65"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2d397bbe0d623d75ed3815dfe8f5b19d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a2d397bbe0d623d75ed3815dfe8f5b19d">stdio</a> (<a class="el" href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">FileHandle</a> fd, <a class="el" href="classuvw_1_1Flags.html">Flags</a>< StdIO > <a class="el" href="classuvw_1_1ProcessHandle.html#ac4f524f5ac5dd208246ae7b680bd22b0">flags</a>)</td></tr>
|
||
<tr class="memdesc:a2d397bbe0d623d75ed3815dfe8f5b19d"><td class="mdescLeft"> </td><td class="mdescRight">Makes a file descriptor available to the child process. <a href="#a2d397bbe0d623d75ed3815dfe8f5b19d">More...</a><br /></td></tr>
|
||
<tr class="separator:a2d397bbe0d623d75ed3815dfe8f5b19d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a10dd82d4b091ca8b5922d9c60ada0b15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a10dd82d4b091ca8b5922d9c60ada0b15">uid</a> (<a class="el" href="namespaceuvw.html#a01d13fc4b5d1b58c936fdbf15c4d0a10">Uid</a> id)</td></tr>
|
||
<tr class="memdesc:a10dd82d4b091ca8b5922d9c60ada0b15"><td class="mdescLeft"> </td><td class="mdescRight">Sets the child process' user id. <a href="#a10dd82d4b091ca8b5922d9c60ada0b15">More...</a><br /></td></tr>
|
||
<tr class="separator:a10dd82d4b091ca8b5922d9c60ada0b15"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac51f418fd84059dcea345dddd52ad5bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#ac51f418fd84059dcea345dddd52ad5bd">gid</a> (<a class="el" href="namespaceuvw.html#a82c74b9200b97f2e1668fe2719eef72e">Gid</a> id)</td></tr>
|
||
<tr class="memdesc:ac51f418fd84059dcea345dddd52ad5bd"><td class="mdescLeft"> </td><td class="mdescRight">Sets the child process' group id. <a href="#ac51f418fd84059dcea345dddd52ad5bd">More...</a><br /></td></tr>
|
||
<tr class="separator:ac51f418fd84059dcea345dddd52ad5bd"><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< ProcessHandle, uv_process_t ></a></td></tr>
|
||
<tr class="memitem:a96162bff13f6bf9a53be386765f01030 inherit pub_methods_classuvw_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#aa3ae4a038de60a69b2513a039add1e48">HandleCategory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a96162bff13f6bf9a53be386765f01030">category</a> () const noexcept override</td></tr>
|
||
<tr class="memdesc:a96162bff13f6bf9a53be386765f01030 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the category of the handle. <a href="classuvw_1_1Handle.html#a96162bff13f6bf9a53be386765f01030">More...</a><br /></td></tr>
|
||
<tr class="separator:a96162bff13f6bf9a53be386765f01030 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9056993d6077e8bee8bd77c9b03f2797 inherit pub_methods_classuvw_1_1Handle"><td class="memItemLeft" align="right" valign="top">HandleType </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a9056993d6077e8bee8bd77c9b03f2797">type</a> () const noexcept override</td></tr>
|
||
<tr class="memdesc:a9056993d6077e8bee8bd77c9b03f2797 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the handle. <a href="classuvw_1_1Handle.html#a9056993d6077e8bee8bd77c9b03f2797">More...</a><br /></td></tr>
|
||
<tr class="separator:a9056993d6077e8bee8bd77c9b03f2797 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a18132668364682aae1235f71ff35c903 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#a18132668364682aae1235f71ff35c903">active</a> () const noexcept override</td></tr>
|
||
<tr class="memdesc:a18132668364682aae1235f71ff35c903 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the handle is active. <a href="classuvw_1_1Handle.html#a18132668364682aae1235f71ff35c903">More...</a><br /></td></tr>
|
||
<tr class="separator:a18132668364682aae1235f71ff35c903 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a94b17026726b0999d1dc20c82b84ef0e 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#a94b17026726b0999d1dc20c82b84ef0e">closing</a> () const noexcept override</td></tr>
|
||
<tr class="memdesc:a94b17026726b0999d1dc20c82b84ef0e inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a handle is closing or closed. <a href="classuvw_1_1Handle.html#a94b17026726b0999d1dc20c82b84ef0e">More...</a><br /></td></tr>
|
||
<tr class="separator:a94b17026726b0999d1dc20c82b84ef0e inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a83b7518a56ad891700c40a1578a1d2f1 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#a83b7518a56ad891700c40a1578a1d2f1">close</a> () noexcept override</td></tr>
|
||
<tr class="memdesc:a83b7518a56ad891700c40a1578a1d2f1 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Request handle to be closed. <a href="classuvw_1_1Handle.html#a83b7518a56ad891700c40a1578a1d2f1">More...</a><br /></td></tr>
|
||
<tr class="separator:a83b7518a56ad891700c40a1578a1d2f1 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:acd04810b141d54cac4b51c69259f15e9 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#acd04810b141d54cac4b51c69259f15e9">reference</a> () noexcept override</td></tr>
|
||
<tr class="memdesc:acd04810b141d54cac4b51c69259f15e9 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Reference the given handle. <a href="classuvw_1_1Handle.html#acd04810b141d54cac4b51c69259f15e9">More...</a><br /></td></tr>
|
||
<tr class="separator:acd04810b141d54cac4b51c69259f15e9 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af4bebc0f0cf639fcf38fd839017857e0 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#af4bebc0f0cf639fcf38fd839017857e0">unreference</a> () noexcept override</td></tr>
|
||
<tr class="memdesc:af4bebc0f0cf639fcf38fd839017857e0 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Unreference the given handle. <a href="classuvw_1_1Handle.html#af4bebc0f0cf639fcf38fd839017857e0">More...</a><br /></td></tr>
|
||
<tr class="separator:af4bebc0f0cf639fcf38fd839017857e0 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad44c23189e6c77b5a3807bb184366fd0 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#ad44c23189e6c77b5a3807bb184366fd0">referenced</a> () const noexcept override</td></tr>
|
||
<tr class="memdesc:ad44c23189e6c77b5a3807bb184366fd0 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given handle referenced. <a href="classuvw_1_1Handle.html#ad44c23189e6c77b5a3807bb184366fd0">More...</a><br /></td></tr>
|
||
<tr class="separator:ad44c23189e6c77b5a3807bb184366fd0 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aaf9f911fc627f3feb32fefd67a7d5344 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#aaf9f911fc627f3feb32fefd67a7d5344">size</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:aaf9f911fc627f3feb32fefd67a7d5344 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the underlying handle type. <a href="classuvw_1_1Handle.html#aaf9f911fc627f3feb32fefd67a7d5344">More...</a><br /></td></tr>
|
||
<tr class="separator:aaf9f911fc627f3feb32fefd67a7d5344 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a381427eccddbc061341642a0647eb5c5 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#a381427eccddbc061341642a0647eb5c5">sendBufferSize</a> ()</td></tr>
|
||
<tr class="memdesc:a381427eccddbc061341642a0647eb5c5 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the send buffer used for the socket. <a href="classuvw_1_1Handle.html#a381427eccddbc061341642a0647eb5c5">More...</a><br /></td></tr>
|
||
<tr class="separator:a381427eccddbc061341642a0647eb5c5 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac5101de6d8dea3bdd2bca444cde821db 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#ac5101de6d8dea3bdd2bca444cde821db">sendBufferSize</a> (int value)</td></tr>
|
||
<tr class="memdesc:ac5101de6d8dea3bdd2bca444cde821db inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the send buffer used for the socket. <a href="classuvw_1_1Handle.html#ac5101de6d8dea3bdd2bca444cde821db">More...</a><br /></td></tr>
|
||
<tr class="separator:ac5101de6d8dea3bdd2bca444cde821db inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:adf07222a2587ca1eb80aec5a9af892e7 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#adf07222a2587ca1eb80aec5a9af892e7">recvBufferSize</a> ()</td></tr>
|
||
<tr class="memdesc:adf07222a2587ca1eb80aec5a9af892e7 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the receive buffer used for the socket. <a href="classuvw_1_1Handle.html#adf07222a2587ca1eb80aec5a9af892e7">More...</a><br /></td></tr>
|
||
<tr class="separator:adf07222a2587ca1eb80aec5a9af892e7 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a549b5f46f62b8474bad8775c6e4ff1a9 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#a549b5f46f62b8474bad8775c6e4ff1a9">recvBufferSize</a> (int value)</td></tr>
|
||
<tr class="memdesc:a549b5f46f62b8474bad8775c6e4ff1a9 inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the receive buffer used for the socket. <a href="classuvw_1_1Handle.html#a549b5f46f62b8474bad8775c6e4ff1a9">More...</a><br /></td></tr>
|
||
<tr class="separator:a549b5f46f62b8474bad8775c6e4ff1a9 inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab33f8f753d3a19a0daece518f4a87bee inherit pub_methods_classuvw_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#ad4b1016f485b28ad7dfd320a593b152b">OSFileDescriptor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#ab33f8f753d3a19a0daece518f4a87bee">fileno</a> () const</td></tr>
|
||
<tr class="memdesc:ab33f8f753d3a19a0daece518f4a87bee inherit pub_methods_classuvw_1_1Handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the platform dependent file descriptor equivalent. <a href="classuvw_1_1Handle.html#ab33f8f753d3a19a0daece518f4a87bee">More...</a><br /></td></tr>
|
||
<tr class="separator:ab33f8f753d3a19a0daece518f4a87bee inherit pub_methods_classuvw_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_methods_classuvw_1_1UnderlyingType"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1UnderlyingType')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType< ProcessHandle, uv_process_t ></a></td></tr>
|
||
<tr class="memitem:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><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="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">loop</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop from which the resource was originated. <a href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">More...</a><br /></td></tr>
|
||
<tr class="separator:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">const uv_process_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#ab2dddf23a571afb113c8b9c5e83f056f">raw</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <a href="classuvw_1_1UnderlyingType.html#ab2dddf23a571afb113c8b9c5e83f056f">More...</a><br /></td></tr>
|
||
<tr class="separator:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">uv_process_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#a78ac17a623e508fa410453f8c17e5970">raw</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <a href="classuvw_1_1UnderlyingType.html#a78ac17a623e508fa410453f8c17e5970">More...</a><br /></td></tr>
|
||
<tr class="separator:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><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< ProcessHandle ></a></td></tr>
|
||
<tr class="memitem:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top">Connection< E > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#af6ba3eecb542efbef8d62ae905d8a8cd">on</a> (Listener< E > f)</td></tr>
|
||
<tr class="memdesc:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Registers a long-lived listener with the event emitter. <a href="classuvw_1_1Emitter.html#af6ba3eecb542efbef8d62ae905d8a8cd">More...</a><br /></td></tr>
|
||
<tr class="separator:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top">Connection< E > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a79e4ed59b5bb5cdc5ee4b0dd71a38472">once</a> (Listener< E > f)</td></tr>
|
||
<tr class="memdesc:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Registers a short-lived listener with the event emitter. <a href="classuvw_1_1Emitter.html#a79e4ed59b5bb5cdc5ee4b0dd71a38472">More...</a><br /></td></tr>
|
||
<tr class="separator:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a4c98ab223b4367073d96c51ee3d6a0d1 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#a4c98ab223b4367073d96c51ee3d6a0d1">erase</a> (Connection< E > conn) noexcept</td></tr>
|
||
<tr class="memdesc:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a listener from the event emitter. <a href="classuvw_1_1Emitter.html#a4c98ab223b4367073d96c51ee3d6a0d1">More...</a><br /></td></tr>
|
||
<tr class="separator:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top"><a id="a3d332776a2e35049549a723f35d88912"></a>
|
||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a3d332776a2e35049549a723f35d88912">clear</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects all the listeners for the given event type. <br /></td></tr>
|
||
<tr class="separator:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top"><a id="a6ff321dde35550bb40ab90a787b715cf"></a>
|
||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a6ff321dde35550bb40ab90a787b715cf">clear</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects all the listeners. <br /></td></tr>
|
||
<tr class="separator:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a2178cfdcc8b19baa6d7e1f950c7b65c4 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#a2178cfdcc8b19baa6d7e1f950c7b65c4">empty</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Checks if there are listeners registered for the specific event. <a href="classuvw_1_1Emitter.html#a2178cfdcc8b19baa6d7e1f950c7b65c4">More...</a><br /></td></tr>
|
||
<tr class="separator:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af15516ea3df907e5e27512d05f64a1cd 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#af15516ea3df907e5e27512d05f64a1cd">empty</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:af15516ea3df907e5e27512d05f64a1cd inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft"> </td><td class="mdescRight">Checks if there are listeners registered with the event emitter. <a href="classuvw_1_1Emitter.html#af15516ea3df907e5e27512d05f64a1cd">More...</a><br /></td></tr>
|
||
<tr class="separator:af15516ea3df907e5e27512d05f64a1cd 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 name="pub-static-methods"></a>
|
||
Static Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:a99d3c33bcc1d564080874c3378e5a39d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#a99d3c33bcc1d564080874c3378e5a39d">disableStdIOInheritance</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a99d3c33bcc1d564080874c3378e5a39d"><td class="mdescLeft"> </td><td class="mdescRight">Disables inheritance for file descriptors/handles. <a href="#a99d3c33bcc1d564080874c3378e5a39d">More...</a><br /></td></tr>
|
||
<tr class="separator:a99d3c33bcc1d564080874c3378e5a39d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad14f7e4e9382e39b6332235defe77051"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1ProcessHandle.html#ad14f7e4e9382e39b6332235defe77051">kill</a> (int <a class="el" href="classuvw_1_1ProcessHandle.html#a7463999530b4c1066f3168e889fbac45">pid</a>, int signum) noexcept</td></tr>
|
||
<tr class="memdesc:ad14f7e4e9382e39b6332235defe77051"><td class="mdescLeft"> </td><td class="mdescRight">kill Sends the specified signal to the given PID. <a href="#ad14f7e4e9382e39b6332235defe77051">More...</a><br /></td></tr>
|
||
<tr class="separator:ad14f7e4e9382e39b6332235defe77051"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="inherit_header pub_static_methods_classuvw_1_1UnderlyingType"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classuvw_1_1UnderlyingType')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType< ProcessHandle, uv_process_t ></a></td></tr>
|
||
<tr class="memitem:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#aa711faff7e88895f769f66e8245bda73">create</a> (Args &&... args)</td></tr>
|
||
<tr class="memdesc:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new resource of the given type. <a href="classuvw_1_1UnderlyingType.html#aa711faff7e88895f769f66e8245bda73">More...</a><br /></td></tr>
|
||
<tr class="separator:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><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 <a class="el" href="classuvw_1_1ProcessHandle.html" title="The ProcessHandle handle. ">ProcessHandle</a> 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_8hpp_source.html#l00065">65</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
<a id="a29dca1723733e51edf063f93046f52b1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a29dca1723733e51edf063f93046f52b1">◆ </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_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::cwd </td>
|
||
<td>(</td>
|
||
<td class="paramtype">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">inline</span><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_1ProcessHandle.html#a9b2872324ef0ee004713a6128040a56a" 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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00193">193</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a99d3c33bcc1d564080874c3378e5a39d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a99d3c33bcc1d564080874c3378e5a39d">◆ </a></span>disableStdIOInheritance()</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::ProcessHandle::disableStdIOInheritance </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 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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00096">96</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac4f524f5ac5dd208246ae7b680bd22b0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac4f524f5ac5dd208246ae7b680bd22b0">◆ </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_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::flags </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classuvw_1_1Flags.html">Flags</a>< Process > </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">inline</span><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_1ProcessHandle.html#a9b2872324ef0ee004713a6128040a56a" title="spawn Starts the process. ">spawn()</a></code> behaves. </p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>ProcessHandle::Process::SETUID</code></li>
|
||
<li><code>ProcessHandle::Process::SETGID</code></li>
|
||
<li><code>ProcessHandle::Process::WINDOWS_VERBATIM_ARGUMENTS</code></li>
|
||
<li><code>ProcessHandle::Process::DETACHED</code></li>
|
||
<li><code>ProcessHandle::Process::WINDOWS_HIDE</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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00216">216</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac51f418fd84059dcea345dddd52ad5bd"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac51f418fd84059dcea345dddd52ad5bd">◆ </a></span>gid()</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_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::gid </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a82c74b9200b97f2e1668fe2719eef72e">Gid</a> </td>
|
||
<td class="paramname"><em>id</em></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>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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00319">319</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a43973ccae3afb823607152f51af84762"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a43973ccae3afb823607152f51af84762">◆ </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">bool uvw::ProcessHandle::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">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Initializes the handle. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00114">114</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad14f7e4e9382e39b6332235defe77051"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad14f7e4e9382e39b6332235defe77051">◆ </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::ProcessHandle::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">inline</span><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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00106">106</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a654d0b3fa241c9ecf7e7b05770001f08"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a654d0b3fa241c9ecf7e7b05770001f08">◆ </a></span>kill() <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">void uvw::ProcessHandle::kill </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>signum</em></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>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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00173">173</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a7463999530b4c1066f3168e889fbac45"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a7463999530b4c1066f3168e889fbac45">◆ </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::ProcessHandle::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">inline</span><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_1ProcessHandle.html#a9b2872324ef0ee004713a6128040a56a" 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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00184">184</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9b2872324ef0ee004713a6128040a56a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9b2872324ef0ee004713a6128040a56a">◆ </a></span>spawn()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void uvw::ProcessHandle::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>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>spawn Starts the process. </p>
|
||
<p>If the process isn't successfully spawned, an <a class="el" href="structuvw_1_1ErrorEvent.html" title="The ErrorEvent event. ">ErrorEvent</a> event will be emitted by the handle.</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>
|
||
<p>See the constructor, poFdStdio[0] is stdin. It must be poStdio[0] by convention. From the official documentation:</p>
|
||
<blockquote class="doxtable">
|
||
<p>The convention is that stdio[0] points to stdin, fd 1 is used for stdout, and fd 2 is stderr. </p>
|
||
</blockquote>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00134">134</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a77125dadf0597c8bb73d85e055e5df65"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a77125dadf0597c8bb73d85e055e5df65">◆ </a></span>stdio() <span class="overload">[1/2]</span></h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<typename T , typename U > </div>
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::stdio </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classuvw_1_1StreamHandle.html">StreamHandle</a>< T, U > & </td>
|
||
<td class="paramname"><em>stream</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classuvw_1_1Flags.html">Flags</a>< StdIO > </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>ProcessHandle::StdIO::IGNORE_STREAM</code></li>
|
||
<li><code>ProcessHandle::StdIO::CREATE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::INHERIT_FD</code></li>
|
||
<li><code>ProcessHandle::StdIO::INHERIT_STREAM</code></li>
|
||
<li><code>ProcessHandle::StdIO::READABLE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::WRITABLE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::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_8hpp_source.html#l00243">243</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a2d397bbe0d623d75ed3815dfe8f5b19d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a2d397bbe0d623d75ed3815dfe8f5b19d">◆ </a></span>stdio() <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"><a class="el" href="classuvw_1_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::stdio </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a02b7ef3b5a65b0bec1602ef434806a27">FileHandle</a> </td>
|
||
<td class="paramname"><em>fd</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classuvw_1_1Flags.html">Flags</a>< StdIO > </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 file descriptor available to the child process. </p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>ProcessHandle::StdIO::IGNORE_STREAM</code></li>
|
||
<li><code>ProcessHandle::StdIO::CREATE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::INHERIT_FD</code></li>
|
||
<li><code>ProcessHandle::StdIO::INHERIT_STREAM</code></li>
|
||
<li><code>ProcessHandle::StdIO::READABLE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::WRITABLE_PIPE</code></li>
|
||
<li><code>ProcessHandle::StdIO::OVERLAPPED_PIPE</code></li>
|
||
</ul>
|
||
<p>Default file descriptors are:</p><ul>
|
||
<li><code><a class="el" href="namespaceuvw.html#a4e050aae48eaf10709216c0dae8af8a9">uvw::StdIN</a></code> for <code>stdin</code></li>
|
||
<li><code><a class="el" href="namespaceuvw.html#a96e64f11b96529c3a65d5b22cc56cdf0">uvw::StdOUT</a></code> for <code>stdout</code></li>
|
||
<li><code><a class="el" href="namespaceuvw.html#ab60d2d4534e3369bc372c47843f9d4b9">uvw::StdERR</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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00278">278</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a10dd82d4b091ca8b5922d9c60ada0b15"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a10dd82d4b091ca8b5922d9c60ada0b15">◆ </a></span>uid()</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_1ProcessHandle.html">ProcessHandle</a>& uvw::ProcessHandle::uid </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a01d13fc4b5d1b58c936fdbf15c4d0a10">Uid</a> </td>
|
||
<td class="paramname"><em>id</em></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>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>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00309">309</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
<li>src/uvw/<a class="el" href="process_8hpp_source.html">process.hpp</a></li>
|
||
</ul>
|
||
</div><!-- contents -->
|
||
<!-- 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.13
|
||
</small></address>
|
||
</body>
|
||
</html>
|