979 lines
48 KiB
HTML
979 lines
48 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::utilities 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"> 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="structuvw_1_1utilities.html">utilities</a></li> </ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#nested-classes">Classes</a> |
|
||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
<a href="structuvw_1_1utilities-members.html">List of all members</a> </div>
|
||
<div class="headertitle"><div class="title">uvw::utilities Struct Reference</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>Miscellaneous utilities.
|
||
<a href="structuvw_1_1utilities.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="util_8h_source.html">util.h</a>></code></p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||
Classes</h2></td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities_1_1os.html">os</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">OS dedicated utilities. <a href="structuvw_1_1utilities_1_1os.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><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:ab234bae92058e009c344eaf6a190d7f2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ab234bae92058e009c344eaf6a190d7f2">guess_handle</a> (<a class="el" href="namespaceuvw.html#a9e28e1855691dd1af105626ed11f3ac4">handle_category</a> category) noexcept</td></tr>
|
||
<tr class="memdesc:ab234bae92058e009c344eaf6a190d7f2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the handle given a category. <br /></td></tr>
|
||
<tr class="separator:ab234bae92058e009c344eaf6a190d7f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a739abc3af744580b9a9fb333afb49538"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a739abc3af744580b9a9fb333afb49538">guess_handle</a> (<a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> file) noexcept</td></tr>
|
||
<tr class="memdesc:a739abc3af744580b9a9fb333afb49538"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the stream to be used with the given descriptor. <br /></td></tr>
|
||
<tr class="separator:a739abc3af744580b9a9fb333afb49538"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aab702f4675e6fccc3c3c13d65f20ff03"><td class="memItemLeft" align="right" valign="top">static std::vector< <a class="el" href="structuvw_1_1cpu__info.html">cpu_info</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#aab702f4675e6fccc3c3c13d65f20ff03">cpu</a> () noexcept</td></tr>
|
||
<tr class="memdesc:aab702f4675e6fccc3c3c13d65f20ff03"><td class="mdescLeft"> </td><td class="mdescRight">Gets information about the CPUs on the system. <br /></td></tr>
|
||
<tr class="separator:aab702f4675e6fccc3c3c13d65f20ff03"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a750016c9d9a030249d5e7d539ef72bd6"><td class="memItemLeft" align="right" valign="top">static std::vector< <a class="el" href="structuvw_1_1interface__address.html">interface_address</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a750016c9d9a030249d5e7d539ef72bd6">interface_addresses</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a750016c9d9a030249d5e7d539ef72bd6"><td class="mdescLeft"> </td><td class="mdescRight">Gets a set of descriptors of all the available interfaces. <br /></td></tr>
|
||
<tr class="separator:a750016c9d9a030249d5e7d539ef72bd6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9f2ab16b038ec08136a51ab25ae26012"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a9f2ab16b038ec08136a51ab25ae26012">index_to_name</a> (unsigned int index) noexcept</td></tr>
|
||
<tr class="memdesc:a9f2ab16b038ec08136a51ab25ae26012"><td class="mdescLeft"> </td><td class="mdescRight">IPv6-capable implementation of <a href="https://linux.die.net/man/3/if_indextoname">if_indextoname</a>. <br /></td></tr>
|
||
<tr class="separator:a9f2ab16b038ec08136a51ab25ae26012"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aed4f4fa55989e8365d76f97987214bed"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#aed4f4fa55989e8365d76f97987214bed">index_to_iid</a> (unsigned int index) noexcept</td></tr>
|
||
<tr class="memdesc:aed4f4fa55989e8365d76f97987214bed"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a network interface identifier. <br /></td></tr>
|
||
<tr class="separator:aed4f4fa55989e8365d76f97987214bed"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab3f0617b9e706bb24d1c24fd33f30438"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ab3f0617b9e706bb24d1c24fd33f30438">replace_allocator</a> (malloc_func_type malloc_func, realloc_func_type realloc_func, calloc_func_type calloc_func, free_func_type free_func) noexcept</td></tr>
|
||
<tr class="memdesc:ab3f0617b9e706bb24d1c24fd33f30438"><td class="mdescLeft"> </td><td class="mdescRight">Override the use of some standard library’s functions. <br /></td></tr>
|
||
<tr class="separator:ab3f0617b9e706bb24d1c24fd33f30438"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad1afc089f95a88ecb332a65984d9f612"><td class="memItemLeft" align="right" valign="top">static std::array< double, 3 > </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ad1afc089f95a88ecb332a65984d9f612">load_average</a> () noexcept</td></tr>
|
||
<tr class="memdesc:ad1afc089f95a88ecb332a65984d9f612"><td class="mdescLeft"> </td><td class="mdescRight">Gets the load average. <br /></td></tr>
|
||
<tr class="separator:ad1afc089f95a88ecb332a65984d9f612"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abb44617ffbb67a4c01df30c3afc33796"><td class="memItemLeft" align="right" valign="top">static char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#abb44617ffbb67a4c01df30c3afc33796">setup_args</a> (int argc, char **argv)</td></tr>
|
||
<tr class="memdesc:abb44617ffbb67a4c01df30c3afc33796"><td class="mdescLeft"> </td><td class="mdescRight">Store the program arguments. <br /></td></tr>
|
||
<tr class="separator:abb44617ffbb67a4c01df30c3afc33796"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a02b8b997bfe97cc148c498fbcf33f7f9"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a02b8b997bfe97cc148c498fbcf33f7f9">process_title</a> ()</td></tr>
|
||
<tr class="memdesc:a02b8b997bfe97cc148c498fbcf33f7f9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the title of the current process. <br /></td></tr>
|
||
<tr class="separator:a02b8b997bfe97cc148c498fbcf33f7f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a0730b90ade5c4b3d23083f985daf8311"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a0730b90ade5c4b3d23083f985daf8311">process_title</a> (const std::string &title)</td></tr>
|
||
<tr class="memdesc:a0730b90ade5c4b3d23083f985daf8311"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current process title. <br /></td></tr>
|
||
<tr class="separator:a0730b90ade5c4b3d23083f985daf8311"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae9bb42d7306d723d822872abfdee8750"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ae9bb42d7306d723d822872abfdee8750">total_memory</a> () noexcept</td></tr>
|
||
<tr class="memdesc:ae9bb42d7306d723d822872abfdee8750"><td class="mdescLeft"> </td><td class="mdescRight">Gets memory information (in bytes). <br /></td></tr>
|
||
<tr class="separator:ae9bb42d7306d723d822872abfdee8750"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aab97685b6e566289194d1b8c2b0bc3fa"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#aab97685b6e566289194d1b8c2b0bc3fa">constrained_memory</a> () noexcept</td></tr>
|
||
<tr class="memdesc:aab97685b6e566289194d1b8c2b0bc3fa"><td class="mdescLeft"> </td><td class="mdescRight">Gets the amount of memory available to the process (in bytes). <br /></td></tr>
|
||
<tr class="separator:aab97685b6e566289194d1b8c2b0bc3fa"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ab17305bbb49d505ab06796d1de50335f"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ab17305bbb49d505ab06796d1de50335f">available_memory</a> () noexcept</td></tr>
|
||
<tr class="memdesc:ab17305bbb49d505ab06796d1de50335f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the amount of free memory still available to the process. <br /></td></tr>
|
||
<tr class="separator:ab17305bbb49d505ab06796d1de50335f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:acaf26accecf5d896fac21953c49bf77d"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#acaf26accecf5d896fac21953c49bf77d">uptime</a> () noexcept</td></tr>
|
||
<tr class="memdesc:acaf26accecf5d896fac21953c49bf77d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current system uptime. <br /></td></tr>
|
||
<tr class="separator:acaf26accecf5d896fac21953c49bf77d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abcd87fab2e4727cb6b9a7ad7c4353b19"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#aab1e2e7f501f4ddb737c4a127d898dd1">resource_usage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#abcd87fab2e4727cb6b9a7ad7c4353b19">rusage</a> () noexcept</td></tr>
|
||
<tr class="memdesc:abcd87fab2e4727cb6b9a7ad7c4353b19"><td class="mdescLeft"> </td><td class="mdescRight">Gets the resource usage measures for the current process. <br /></td></tr>
|
||
<tr class="separator:abcd87fab2e4727cb6b9a7ad7c4353b19"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af670af2d3c469a3b43f1fa0d4a8f2251"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a9ede2b9dae02dbb38659d21c36a51d5e">timespec64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#af670af2d3c469a3b43f1fa0d4a8f2251">gettime</a> (<a class="el" href="namespaceuvw.html#a583fc1ea7bcbb46b9d8cf8cd83f534d0">clock_id</a> source) noexcept</td></tr>
|
||
<tr class="memdesc:af670af2d3c469a3b43f1fa0d4a8f2251"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current system time from a high-resolution clock source. <br /></td></tr>
|
||
<tr class="separator:af670af2d3c469a3b43f1fa0d4a8f2251"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a795550d5bceddd69e9b4cb81b525a4ee"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a795550d5bceddd69e9b4cb81b525a4ee">hrtime</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a795550d5bceddd69e9b4cb81b525a4ee"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current high-resolution real time. <br /></td></tr>
|
||
<tr class="separator:a795550d5bceddd69e9b4cb81b525a4ee"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac3760ed5fa34935feecc2cfa4b1ceab6"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ac3760ed5fa34935feecc2cfa4b1ceab6">path</a> () noexcept</td></tr>
|
||
<tr class="memdesc:ac3760ed5fa34935feecc2cfa4b1ceab6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the executable path. <br /></td></tr>
|
||
<tr class="separator:ac3760ed5fa34935feecc2cfa4b1ceab6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5a51515886ccab0efaf52926762b51e6"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#a5a51515886ccab0efaf52926762b51e6">cwd</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a5a51515886ccab0efaf52926762b51e6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current working directory. <br /></td></tr>
|
||
<tr class="separator:a5a51515886ccab0efaf52926762b51e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ad3309730032bdd912bcc9e8e547a163a"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ad3309730032bdd912bcc9e8e547a163a">chdir</a> (const std::string &dir) noexcept</td></tr>
|
||
<tr class="memdesc:ad3309730032bdd912bcc9e8e547a163a"><td class="mdescLeft"> </td><td class="mdescRight">Changes the current working directory. <br /></td></tr>
|
||
<tr class="separator:ad3309730032bdd912bcc9e8e547a163a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa7196c5785df36f97f822e12912e26cc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceuvw.html#a520d66d5d768ca2de372b2a61e1f6a26">timeval64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#aa7196c5785df36f97f822e12912e26cc">time_of_day</a> () noexcept</td></tr>
|
||
<tr class="memdesc:aa7196c5785df36f97f822e12912e26cc"><td class="mdescLeft"> </td><td class="mdescRight">Cross-platform implementation of <a href="https://linux.die.net/man/2/gettimeofday"><code>gettimeofday</code></a> <br /></td></tr>
|
||
<tr class="separator:aa7196c5785df36f97f822e12912e26cc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ace2194771c4b581cbcfc8827cba93dc0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#ace2194771c4b581cbcfc8827cba93dc0">sleep</a> (unsigned int msec) noexcept</td></tr>
|
||
<tr class="memdesc:ace2194771c4b581cbcfc8827cba93dc0"><td class="mdescLeft"> </td><td class="mdescRight">Causes the calling thread to sleep for a while. <br /></td></tr>
|
||
<tr class="separator:ace2194771c4b581cbcfc8827cba93dc0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:abea71dca400539052c2f4e20a882b9b4"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1utilities.html#abea71dca400539052c2f4e20a882b9b4">available_parallelism</a> () noexcept</td></tr>
|
||
<tr class="memdesc:abea71dca400539052c2f4e20a882b9b4"><td class="mdescLeft"> </td><td class="mdescRight">Returns an estimate of the amount of parallelism a program should use (always a non-zero value). <br /></td></tr>
|
||
<tr class="separator:abea71dca400539052c2f4e20a882b9b4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<div class="textblock"><p>Miscellaneous utilities. </p>
|
||
<p>Miscellaneous functions that don’t really belong to any other class. </p>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="util_8h_source.html#l00288">288</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="ab17305bbb49d505ab06796d1de50335f" name="ab17305bbb49d505ab06796d1de50335f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab17305bbb49d505ab06796d1de50335f">◆ </a></span>available_memory()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static uint64_t uvw::utilities::available_memory </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 amount of free memory still available to the process. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Amount of free memory still available to the process (in bytes). </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abea71dca400539052c2f4e20a882b9b4" name="abea71dca400539052c2f4e20a882b9b4"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abea71dca400539052c2f4e20a882b9b4">◆ </a></span>available_parallelism()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static unsigned int uvw::utilities::available_parallelism </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 an estimate of the amount of parallelism a program should use (always a non-zero value). </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Estimate of the amount of parallelism a program should use. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad3309730032bdd912bcc9e8e547a163a" name="ad3309730032bdd912bcc9e8e547a163a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad3309730032bdd912bcc9e8e547a163a">◆ </a></span>chdir()</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::chdir </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string & </td>
|
||
<td class="paramname"><em>dir</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>Changes the current working directory. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">dir</td><td>The working directory to be set. </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="aab97685b6e566289194d1b8c2b0bc3fa" name="aab97685b6e566289194d1b8c2b0bc3fa"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aab97685b6e566289194d1b8c2b0bc3fa">◆ </a></span>constrained_memory()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static uint64_t uvw::utilities::constrained_memory </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 amount of memory available to the process (in bytes). </p>
|
||
<p>Gets the amount of memory available to the process based on limits imposed by the OS. If there is no such constraint, or the constraint is unknown, <code>0</code> is returned.<br />
|
||
Note that it is not unusual for this value to be less than or greater than <code>totalMemory</code>.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Amount of memory available to the process. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aab702f4675e6fccc3c3c13d65f20ff03" name="aab702f4675e6fccc3c3c13d65f20ff03"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aab702f4675e6fccc3c3c13d65f20ff03">◆ </a></span>cpu()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static std::vector< <a class="el" href="structuvw_1_1cpu__info.html">cpu_info</a> > uvw::utilities::cpu </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 information about the CPUs on the system. </p>
|
||
<p>This function can be used to query the underlying system and get a set of descriptors of all the available CPUs.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>A set of descriptors of all the available CPUs. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5a51515886ccab0efaf52926762b51e6" name="a5a51515886ccab0efaf52926762b51e6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5a51515886ccab0efaf52926762b51e6">◆ </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">static std::string uvw::utilities::cwd </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 working directory. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The current working directory, an empty string in case of errors. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af670af2d3c469a3b43f1fa0d4a8f2251" name="af670af2d3c469a3b43f1fa0d4a8f2251"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af670af2d3c469a3b43f1fa0d4a8f2251">◆ </a></span>gettime()</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#a9ede2b9dae02dbb38659d21c36a51d5e">timespec64</a> uvw::utilities::gettime </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a583fc1ea7bcbb46b9d8cf8cd83f534d0">clock_id</a> </td>
|
||
<td class="paramname"><em>source</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>Gets the current system time from a high-resolution clock source. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">source</td><td>Clock source, either real-time or monotonic. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Current system time from the given high-resolution clock source. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a739abc3af744580b9a9fb333afb49538" name="a739abc3af744580b9a9fb333afb49538"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a739abc3af744580b9a9fb333afb49538">◆ </a></span>guess_handle() <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 <a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> uvw::utilities::guess_handle </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> </td>
|
||
<td class="paramname"><em>file</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>Gets the type of the stream to be used with the given descriptor. </p>
|
||
<p>Returns the type of stream that should be used with a given file descriptor.<br />
|
||
Usually this will be used during initialization to guess the type of the stdio streams.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">file</td><td>A valid descriptor. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>One of the following types:</dd></dl>
|
||
<ul>
|
||
<li><code>handle_type::UNKNOWN</code></li>
|
||
<li><code>handle_type::PIPE</code></li>
|
||
<li><code>handle_type::TCP</code></li>
|
||
<li><code>handle_type::TTY</code></li>
|
||
<li><code>handle_type::UDP</code></li>
|
||
<li><code>handle_type::FILE</code> </li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ab234bae92058e009c344eaf6a190d7f2" name="ab234bae92058e009c344eaf6a190d7f2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab234bae92058e009c344eaf6a190d7f2">◆ </a></span>guess_handle() <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 <a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> uvw::utilities::guess_handle </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a9e28e1855691dd1af105626ed11f3ac4">handle_category</a> </td>
|
||
<td class="paramname"><em>category</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>Gets the type of the handle given a category. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">category</td><td>A properly initialized handle category. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>The actual type of the handle as defined by handle_type </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a795550d5bceddd69e9b4cb81b525a4ee" name="a795550d5bceddd69e9b4cb81b525a4ee"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a795550d5bceddd69e9b4cb81b525a4ee">◆ </a></span>hrtime()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static uint64_t uvw::utilities::hrtime </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 high-resolution real time. </p>
|
||
<p>The time is expressed in nanoseconds. It is relative to an arbitrary time in the past. It is not related to the time of the day and therefore not subject to clock drift. The primary use is for measuring performance between interval.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The current high-resolution real time. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aed4f4fa55989e8365d76f97987214bed" name="aed4f4fa55989e8365d76f97987214bed"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aed4f4fa55989e8365d76f97987214bed">◆ </a></span>index_to_iid()</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::index_to_iid </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned int </td>
|
||
<td class="paramname"><em>index</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 a network interface identifier. </p>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_if_indextoiid">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">index</td><td>Network interface index. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Network interface identifier. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a9f2ab16b038ec08136a51ab25ae26012" name="a9f2ab16b038ec08136a51ab25ae26012"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a9f2ab16b038ec08136a51ab25ae26012">◆ </a></span>index_to_name()</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::index_to_name </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned int </td>
|
||
<td class="paramname"><em>index</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>IPv6-capable implementation of <a href="https://linux.die.net/man/3/if_indextoname">if_indextoname</a>. </p>
|
||
<p>Mapping between network interface names and indexes.</p>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/misc.html#c.uv_if_indextoname">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">index</td><td>Network interface index. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Network interface name. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a750016c9d9a030249d5e7d539ef72bd6" name="a750016c9d9a030249d5e7d539ef72bd6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a750016c9d9a030249d5e7d539ef72bd6">◆ </a></span>interface_addresses()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static std::vector< <a class="el" href="structuvw_1_1interface__address.html">interface_address</a> > uvw::utilities::interface_addresses </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 set of descriptors of all the available interfaces. </p>
|
||
<p>This function can be used to query the underlying system and get a set of descriptors of all the available interfaces, either internal or not.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>A set of descriptors of all the available interfaces. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ad1afc089f95a88ecb332a65984d9f612" name="ad1afc089f95a88ecb332a65984d9f612"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ad1afc089f95a88ecb332a65984d9f612">◆ </a></span>load_average()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static std::array< double, 3 > uvw::utilities::load_average </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 load average. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd><code>[0,0,0]</code> on Windows (not available), the load average otherwise. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ac3760ed5fa34935feecc2cfa4b1ceab6" name="ac3760ed5fa34935feecc2cfa4b1ceab6"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ac3760ed5fa34935feecc2cfa4b1ceab6">◆ </a></span>path()</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::path </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 executable path. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The executable path, an empty string in case of errors. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a02b8b997bfe97cc148c498fbcf33f7f9" name="a02b8b997bfe97cc148c498fbcf33f7f9"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a02b8b997bfe97cc148c498fbcf33f7f9">◆ </a></span>process_title() <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 std::string uvw::utilities::process_title </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> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Gets the title of the current process. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The process title. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a0730b90ade5c4b3d23083f985daf8311" name="a0730b90ade5c4b3d23083f985daf8311"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0730b90ade5c4b3d23083f985daf8311">◆ </a></span>process_title() <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::process_title </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string & </td>
|
||
<td class="paramname"><em>title</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>Sets the current process title. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">title</td><td>The process title to be set. </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="ab3f0617b9e706bb24d1c24fd33f30438" name="ab3f0617b9e706bb24d1c24fd33f30438"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ab3f0617b9e706bb24d1c24fd33f30438">◆ </a></span>replace_allocator()</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::replace_allocator </td>
|
||
<td>(</td>
|
||
<td class="paramtype">malloc_func_type </td>
|
||
<td class="paramname"><em>malloc_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">realloc_func_type </td>
|
||
<td class="paramname"><em>realloc_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">calloc_func_type </td>
|
||
<td class="paramname"><em>calloc_func</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">free_func_type </td>
|
||
<td class="paramname"><em>free_func</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>Override the use of some standard library’s functions. </p>
|
||
<p>Override the use of the standard library’s memory allocation functions.<br />
|
||
This method must be invoked before any other <code>uvw</code> function is called or after all resources have been freed and thus the underlying library doesn’t reference any allocated memory chunk.</p>
|
||
<p>If any of the function pointers is <em>null</em>, the invokation will fail.</p>
|
||
<dl class="section note"><dt>Note</dt><dd>There is no protection against changing the allocator multiple times. If the user changes it they are responsible for making sure the allocator is changed while no memory was allocated with the previous allocator, or that they are compatible.</dd></dl>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">malloc_func</td><td>Replacement function for <em>malloc</em>. </td></tr>
|
||
<tr><td class="paramname">realloc_func</td><td>Replacement function for <em>realloc</em>. </td></tr>
|
||
<tr><td class="paramname">calloc_func</td><td>Replacement function for <em>calloc</em>. </td></tr>
|
||
<tr><td class="paramname">free_func</td><td>Replacement function for <em>free</em>. </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="abcd87fab2e4727cb6b9a7ad7c4353b19" name="abcd87fab2e4727cb6b9a7ad7c4353b19"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abcd87fab2e4727cb6b9a7ad7c4353b19">◆ </a></span>rusage()</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#aab1e2e7f501f4ddb737c4a127d898dd1">resource_usage</a> uvw::utilities::rusage </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 resource usage measures for the current process. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Resource usage measures, zeroes-filled object in case of errors. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="abb44617ffbb67a4c01df30c3afc33796" name="abb44617ffbb67a4c01df30c3afc33796"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#abb44617ffbb67a4c01df30c3afc33796">◆ </a></span>setup_args()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static char ** uvw::utilities::setup_args </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>argc</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">char ** </td>
|
||
<td class="paramname"><em>argv</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> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Store the program arguments. </p>
|
||
<p>Required for getting / setting the process title.</p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Arguments that haven't been consumed internally. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ace2194771c4b581cbcfc8827cba93dc0" name="ace2194771c4b581cbcfc8827cba93dc0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ace2194771c4b581cbcfc8827cba93dc0">◆ </a></span>sleep()</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::utilities::sleep </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned int </td>
|
||
<td class="paramname"><em>msec</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>Causes the calling thread to sleep for a while. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">msec</td><td>Number of milliseconds to sleep. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aa7196c5785df36f97f822e12912e26cc" name="aa7196c5785df36f97f822e12912e26cc"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa7196c5785df36f97f822e12912e26cc">◆ </a></span>time_of_day()</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#a520d66d5d768ca2de372b2a61e1f6a26">timeval64</a> uvw::utilities::time_of_day </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>Cross-platform implementation of <a href="https://linux.die.net/man/2/gettimeofday"><code>gettimeofday</code></a> </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The current time. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae9bb42d7306d723d822872abfdee8750" name="ae9bb42d7306d723d822872abfdee8750"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae9bb42d7306d723d822872abfdee8750">◆ </a></span>total_memory()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static uint64_t uvw::utilities::total_memory </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 memory information (in bytes). </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>Memory information. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="acaf26accecf5d896fac21953c49bf77d" name="acaf26accecf5d896fac21953c49bf77d"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#acaf26accecf5d896fac21953c49bf77d">◆ </a></span>uptime()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static double uvw::utilities::uptime </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 system uptime. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The current system uptime or 0 in case of errors. </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 <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>
|