luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
uvw/structuvw_1_1Utilities_1_1OS.html
Michele Caini 273f6fe65e updated doc: v3.1.0
2023-05-22 11:13:58 +02:00

559 lines
28 KiB
HTML
Raw Permalink Blame History

<!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::utilities::os Struct 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">&#160;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&amp;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&amp;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="structuvw_1_1utilities.html">utilities</a></li><li class="navelem"><a class="el" href="structuvw_1_1utilities_1_1os.html">os</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structuvw_1_1utilities_1_1os-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uvw::utilities::os Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>OS dedicated utilities.
<a href="structuvw_1_1utilities_1_1os.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="util_8h_source.html">util.h</a>&gt;</code></p>
<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:acc1bc53f62932521a8425d7521929cb7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#acc1bc53f62932521a8425d7521929cb7">pid</a> () noexcept</td></tr>
<tr class="memdesc:acc1bc53f62932521a8425d7521929cb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current process id. <br /></td></tr>
<tr class="separator:acc1bc53f62932521a8425d7521929cb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1e6577860200d4b83f8d7ece3764e79"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#ac1e6577860200d4b83f8d7ece3764e79">ppid</a> () noexcept</td></tr>
<tr class="memdesc:ac1e6577860200d4b83f8d7ece3764e79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the parent process id. <br /></td></tr>
<tr class="separator:ac1e6577860200d4b83f8d7ece3764e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1170047f1e2d38e5937adeb10db88b6e"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#a1170047f1e2d38e5937adeb10db88b6e">homedir</a> () noexcept</td></tr>
<tr class="memdesc:a1170047f1e2d38e5937adeb10db88b6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current user's home directory. <br /></td></tr>
<tr class="separator:a1170047f1e2d38e5937adeb10db88b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b28361deacc797284cf060658b1413"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#ac8b28361deacc797284cf060658b1413">tmpdir</a> () noexcept</td></tr>
<tr class="memdesc:ac8b28361deacc797284cf060658b1413"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the temp directory. <br /></td></tr>
<tr class="separator:ac8b28361deacc797284cf060658b1413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb6462466bdfc1047dd617211a834d43"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#aeb6462466bdfc1047dd617211a834d43">env</a> (const std::string &amp;name) noexcept</td></tr>
<tr class="memdesc:aeb6462466bdfc1047dd617211a834d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves an environment variable. <br /></td></tr>
<tr class="separator:aeb6462466bdfc1047dd617211a834d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f4bd055208ac89468d23f2451a46bde"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#a2f4bd055208ac89468d23f2451a46bde">env</a> (const std::string &amp;name, const std::string &amp;value) noexcept</td></tr>
<tr class="memdesc:a2f4bd055208ac89468d23f2451a46bde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates, updates or deletes an environment variable. <br /></td></tr>
<tr class="separator:a2f4bd055208ac89468d23f2451a46bde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a155b88a1cad44b70b3f3860f2805c03e"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:a155b88a1cad44b70b3f3860f2805c03e"><td class="memTemplItemLeft" align="right" valign="top">static std::enable_if_t&lt; std::is_invocable_v&lt; Func, std::string_view, std::string_view &gt;, bool &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#a155b88a1cad44b70b3f3860f2805c03e">env</a> (Func func) noexcept</td></tr>
<tr class="memdesc:a155b88a1cad44b70b3f3860f2805c03e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves all environment variables and iterates them. <br /></td></tr>
<tr class="separator:a155b88a1cad44b70b3f3860f2805c03e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35fcce1ddca22c2ff06ba181b9dc67ae"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#a35fcce1ddca22c2ff06ba181b9dc67ae">hostname</a> () noexcept</td></tr>
<tr class="memdesc:a35fcce1ddca22c2ff06ba181b9dc67ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the hostname. <br /></td></tr>
<tr class="separator:a35fcce1ddca22c2ff06ba181b9dc67ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab943a05f89b8d1c9e59ffdd8a8cfdff"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structuvw_1_1uts__name.html">uts_name</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#aab943a05f89b8d1c9e59ffdd8a8cfdff">uname</a> () noexcept</td></tr>
<tr class="memdesc:aab943a05f89b8d1c9e59ffdd8a8cfdff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets name and information about the current kernel. <br /></td></tr>
<tr class="separator:aab943a05f89b8d1c9e59ffdd8a8cfdff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69268cf423cf1935cb3f8000650265d3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structuvw_1_1passwd__info.html">passwd_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#a69268cf423cf1935cb3f8000650265d3">passwd</a> () noexcept</td></tr>
<tr class="memdesc:a69268cf423cf1935cb3f8000650265d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a subset of the password file entry. <br /></td></tr>
<tr class="separator:a69268cf423cf1935cb3f8000650265d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa93ef04c3fae6abf55968988a17e6c60"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#aa93ef04c3fae6abf55968988a17e6c60">priority</a> (<a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a> <a class="el" href="structuvw_1_1utilities_1_1os.html#acc1bc53f62932521a8425d7521929cb7">pid</a>)</td></tr>
<tr class="memdesc:aa93ef04c3fae6abf55968988a17e6c60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the scheduling priority of a process. <br /></td></tr>
<tr class="separator:aa93ef04c3fae6abf55968988a17e6c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc89a848943e1737906082337b9f1913"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html#afc89a848943e1737906082337b9f1913">priority</a> (<a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a> <a class="el" href="structuvw_1_1utilities_1_1os.html#acc1bc53f62932521a8425d7521929cb7">pid</a>, int prio)</td></tr>
<tr class="memdesc:afc89a848943e1737906082337b9f1913"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the scheduling priority of a process. <br /></td></tr>
<tr class="separator:afc89a848943e1737906082337b9f1913"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>OS dedicated utilities. </p>
<p class="definition">Definition at line <a class="el" href="util_8h_source.html#l00297">297</a> of file <a class="el" href="util_8h_source.html">util.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aeb6462466bdfc1047dd617211a834d43" name="aeb6462466bdfc1047dd617211a834d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb6462466bdfc1047dd617211a834d43">&#9670;&#160;</a></span>env() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string uvw::utilities::os::env </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></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>Retrieves an environment variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the variable to be retrieved. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the environment variable, an empty string in case of errors. </dd></dl>
</div>
</div>
<a id="a2f4bd055208ac89468d23f2451a46bde" name="a2f4bd055208ac89468d23f2451a46bde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f4bd055208ac89468d23f2451a46bde">&#9670;&#160;</a></span>env() <span class="overload">[2/3]</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::utilities::os::env </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</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>Creates, updates or deletes an environment variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the variable to be updated. </td></tr>
<tr><td class="paramname">value</td><td>The value to be used for the variable (an empty string to unset it). </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="a155b88a1cad44b70b3f3860f2805c03e" name="a155b88a1cad44b70b3f3860f2805c03e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a155b88a1cad44b70b3f3860f2805c03e">&#9670;&#160;</a></span>env() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::enable_if_t&lt; std::is_invocable_v&lt; Func, std::string_view, std::string_view &gt;, bool &gt; uvw::utilities::os::env </td>
<td>(</td>
<td class="paramtype">Func&#160;</td>
<td class="paramname"><em>func</em></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>Retrieves all environment variables and iterates them. </p>
<p>Environment variables are passed one at a time to the callback in the form of <code>std::string_view</code>s.<br />
The signature of the function call operator must be such that it accepts two parameters, the name and the value of the i-th variable.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Func</td><td>Type of a function object to which to pass environment variables. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>A function object to which to pass environment variables. </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="util_8h_source.html#l00375">375</a> of file <a class="el" href="util_8h_source.html">util.h</a>.</p>
</div>
</div>
<a id="a1170047f1e2d38e5937adeb10db88b6e" name="a1170047f1e2d38e5937adeb10db88b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1170047f1e2d38e5937adeb10db88b6e">&#9670;&#160;</a></span>homedir()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string uvw::utilities::os::homedir </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>Gets the current user's home directory. </p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_homedir">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The current user's home directory, an empty string in case of errors. </dd></dl>
</div>
</div>
<a id="a35fcce1ddca22c2ff06ba181b9dc67ae" name="a35fcce1ddca22c2ff06ba181b9dc67ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35fcce1ddca22c2ff06ba181b9dc67ae">&#9670;&#160;</a></span>hostname()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string uvw::utilities::os::hostname </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>Returns the hostname. </p>
<dl class="section return"><dt>Returns</dt><dd>The hostname, an empty string in case of errors. </dd></dl>
</div>
</div>
<a id="a69268cf423cf1935cb3f8000650265d3" name="a69268cf423cf1935cb3f8000650265d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69268cf423cf1935cb3f8000650265d3">&#9670;&#160;</a></span>passwd()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structuvw_1_1passwd__info.html">passwd_info</a> uvw::utilities::os::passwd </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>Gets a subset of the password file entry. </p>
<p>This function can be used to get the subset of the password file entry for the current effective uid (not the real uid).</p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_get_passwd">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The accessible subset of the password file entry. </dd></dl>
</div>
</div>
<a id="acc1bc53f62932521a8425d7521929cb7" name="acc1bc53f62932521a8425d7521929cb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc1bc53f62932521a8425d7521929cb7">&#9670;&#160;</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">static <a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a> uvw::utilities::os::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">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current process id. </p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_getpid">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The current process id. </dd></dl>
</div>
</div>
<a id="ac1e6577860200d4b83f8d7ece3764e79" name="ac1e6577860200d4b83f8d7ece3764e79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1e6577860200d4b83f8d7ece3764e79">&#9670;&#160;</a></span>ppid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a> uvw::utilities::os::ppid </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>Returns the parent process id. </p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_getppid">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The parent process id. </dd></dl>
</div>
</div>
<a id="aa93ef04c3fae6abf55968988a17e6c60" name="aa93ef04c3fae6abf55968988a17e6c60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa93ef04c3fae6abf55968988a17e6c60">&#9670;&#160;</a></span>priority() <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 int uvw::utilities::os::priority </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a>&#160;</td>
<td class="paramname"><em>pid</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the scheduling priority of a process. </p>
<p>The returned value is between -20 (high priority) and 19 (low priority). A value that is out of range is returned in case of errors.</p>
<dl class="section note"><dt>Note</dt><dd>On Windows, the result won't equal necessarily the exact value of the priority because of a mapping to a Windows priority class.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pid</td><td>A valid process id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The scheduling priority of the process. </dd></dl>
</div>
</div>
<a id="afc89a848943e1737906082337b9f1913" name="afc89a848943e1737906082337b9f1913"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc89a848943e1737906082337b9f1913">&#9670;&#160;</a></span>priority() <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">static bool uvw::utilities::os::priority </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceuvw.html#a2e4dd0c2ad27e448543e9a3f35181928">pid_type</a>&#160;</td>
<td class="paramname"><em>pid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>prio</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the scheduling priority of a process. </p>
<p>The returned value range is between -20 (high priority) and 19 (low priority).</p>
<dl class="section note"><dt>Note</dt><dd>On Windows, the priority is mapped to a Windows priority class. When retrieving the process priority, the result won't equal necessarily the exact value of the priority.</dd></dl>
<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">prio</td><td>The scheduling priority to set to the process. </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="ac8b28361deacc797284cf060658b1413" name="ac8b28361deacc797284cf060658b1413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8b28361deacc797284cf060658b1413">&#9670;&#160;</a></span>tmpdir()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string uvw::utilities::os::tmpdir </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>Gets the temp directory. </p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_os_tmpdir">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The temp directory, an empty string in case of errors. </dd></dl>
</div>
</div>
<a id="aab943a05f89b8d1c9e59ffdd8a8cfdff" name="aab943a05f89b8d1c9e59ffdd8a8cfdff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab943a05f89b8d1c9e59ffdd8a8cfdff">&#9670;&#160;</a></span>uname()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structuvw_1_1uts__name.html">uts_name</a> uvw::utilities::os::uname </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>Gets name and information about the current kernel. </p>
<p>This function can be used to get name and information about the current kernel. The populated data includes the operating system name, release, version, and machine.</p>
<dl class="section return"><dt>Returns</dt><dd>Name and information about the current kernel. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="util_8h_source.html">util.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink