%PDF- %PDF-
Direktori : /proc/self/root/proc/self/root/usr/share/nagios/html/docs/ |
Current File : //proc/self/root/proc/self/root/usr/share/nagios/html/docs/nsutils_8h.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.5"/> <title>Nagios: nsutils.h File 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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">Nagios  <span id="projectnumber">4.4.3</span> </div> <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></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="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">nsutils.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Non-Standard (or Nagios) utility functions and macros. <a href="#details">More...</a></p> <div class="textblock"><code>#include <sys/types.h></code><br/> <code>#include <sys/time.h></code><br/> </div> <p><a href="nsutils_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="memitem:a96824974fc1cbb6da7418f3ac5e4d57d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96824974fc1cbb6da7418f3ac5e4d57d"></a> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a96824974fc1cbb6da7418f3ac5e4d57d">alloc_nr</a>(x)   (((x)+16)*3/2)</td></tr> <tr class="memdesc:a96824974fc1cbb6da7418f3ac5e4d57d"><td class="mdescLeft"> </td><td class="mdescRight">Macro for dynamically increasing vector lengths. <br/></td></tr> <tr class="separator:a96824974fc1cbb6da7418f3ac5e4d57d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7674c6154264b62f100ad41863e64dee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a7674c6154264b62f100ad41863e64dee">real_online_cpus</a> (void)</td></tr> <tr class="memdesc:a7674c6154264b62f100ad41863e64dee"><td class="mdescLeft"> </td><td class="mdescRight">Get number of online cpus. <a href="#a7674c6154264b62f100ad41863e64dee">More...</a><br/></td></tr> <tr class="separator:a7674c6154264b62f100ad41863e64dee"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a60a5912bf88ddfa4c6cbf1faa0b2ef9a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a60a5912bf88ddfa4c6cbf1faa0b2ef9a">online_cpus</a> (void)</td></tr> <tr class="memdesc:a60a5912bf88ddfa4c6cbf1faa0b2ef9a"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for <a class="el" href="nsutils_8h.html#a7674c6154264b62f100ad41863e64dee" title="Get number of online cpus. ">real_online_cpus()</a>, returning 1 in case we can't detect any active cpus. <a href="#a60a5912bf88ddfa4c6cbf1faa0b2ef9a">More...</a><br/></td></tr> <tr class="separator:a60a5912bf88ddfa4c6cbf1faa0b2ef9a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a48c79bbb0b4bb978a529835c3b17d6a2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a48c79bbb0b4bb978a529835c3b17d6a2">mkstr</a> (const char *fmt,...) __attribute__((__format__(__printf__</td></tr> <tr class="memdesc:a48c79bbb0b4bb978a529835c3b17d6a2"><td class="mdescLeft"> </td><td class="mdescRight">Create a short-lived string in stack-allocated memory The number and size of strings is limited (currently to 256 strings of 32 bytes each), so beware and use this sensibly. <a href="#a48c79bbb0b4bb978a529835c3b17d6a2">More...</a><br/></td></tr> <tr class="separator:a48c79bbb0b4bb978a529835c3b17d6a2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a89bdd94baabcc0743a916ef7fcf75532"><td class="memItemLeft" align="right" valign="top">const char int </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a89bdd94baabcc0743a916ef7fcf75532">tv_delta_msec</a> (const struct timeval *start, const struct timeval *stop)</td></tr> <tr class="memdesc:a89bdd94baabcc0743a916ef7fcf75532"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the millisecond delta between two timeval structs. <a href="#a89bdd94baabcc0743a916ef7fcf75532">More...</a><br/></td></tr> <tr class="separator:a89bdd94baabcc0743a916ef7fcf75532"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a231490982ef814eed7b04ba16edc5520"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="nsutils_8h.html#a231490982ef814eed7b04ba16edc5520">tv_delta_f</a> (const struct timeval *start, const struct timeval *stop)</td></tr> <tr class="memdesc:a231490982ef814eed7b04ba16edc5520"><td class="mdescLeft"> </td><td class="mdescRight">Get timeval delta as seconds. <a href="#a231490982ef814eed7b04ba16edc5520">More...</a><br/></td></tr> <tr class="separator:a231490982ef814eed7b04ba16edc5520"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Non-Standard (or Nagios) utility functions and macros. </p> <p>This is where we house all helpers and macros that fall outside the "standard-ish" norm. The prefixes "nsu_" and NSU_ are reserved for this purpose, so we avoid clashing with other applications that may have similarly-acting functions with identical names.</p> <p>The functions already here lack the nsu_ prefix for backwards compatibility reasons. It's possible we'll have to fix that some day, but let's leave that for later. </p> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a48c79bbb0b4bb978a529835c3b17d6a2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* mkstr </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>fmt</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>...</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create a short-lived string in stack-allocated memory The number and size of strings is limited (currently to 256 strings of 32 bytes each), so beware and use this sensibly. </p> <p>Intended for number-to-string conversion and other short strings. </p> <dl class="section note"><dt>Note</dt><dd>The returned string must <em>not</em> be free()'d! </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>The format string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A pointer to the formatted string on success. Undefined on errors </dd></dl> </div> </div> <a class="anchor" id="a60a5912bf88ddfa4c6cbf1faa0b2ef9a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int online_cpus </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Wrapper for <a class="el" href="nsutils_8h.html#a7674c6154264b62f100ad41863e64dee" title="Get number of online cpus. ">real_online_cpus()</a>, returning 1 in case we can't detect any active cpus. </p> <dl class="section return"><dt>Returns</dt><dd>Number of active cpu cores on success. 1 on failure. </dd></dl> </div> </div> <a class="anchor" id="a7674c6154264b62f100ad41863e64dee"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int real_online_cpus </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get number of online cpus. </p> <dl class="section return"><dt>Returns</dt><dd>Active cpu cores detected on success. 0 on failure. </dd></dl> </div> </div> <a class="anchor" id="a231490982ef814eed7b04ba16edc5520"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tv_delta_f </td> <td>(</td> <td class="paramtype">const struct timeval * </td> <td class="paramname"><em>start</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const struct timeval * </td> <td class="paramname"><em>stop</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Get timeval delta as seconds. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">start</td><td>The start time </td></tr> <tr><td class="paramname">stop</td><td>The stop time </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>time difference in fractions of seconds </dd></dl> </div> </div> <a class="anchor" id="a89bdd94baabcc0743a916ef7fcf75532"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char int tv_delta_msec </td> <td>(</td> <td class="paramtype">const struct timeval * </td> <td class="paramname"><em>start</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const struct timeval * </td> <td class="paramname"><em>stop</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Calculate the millisecond delta between two timeval structs. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>The start time </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">stop</td><td>The stop time </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The millisecond delta between the two structs </dd></dl> </div> </div> </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.5 </small></address> </body> </html>