<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Yate: SysUsage Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1SysUsage.html">SysUsage</a> </div> </div> <div class="contents"> <h1>SysUsage Class Reference</h1><!-- doxytag: class="TelEngine::SysUsage" -->A class exposing system resources usage. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yateclass_8h-source.html">yateclass.h</a>></code> <p> <p> <a href="classTelEngine_1_1SysUsage-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <b>WallTime</b>, <b>UserTime</b>, <b>KernelTime</b> }</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#edc913c139bb562646d3459b0ca28997">init</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static u_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#22c10b4a019615690bc69bc6f54e25fd">startTime</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static u_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#12064ad1c65050c798d05205916b1ac0">usecRunTime</a> (<a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type=WallTime)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static u_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#8883542aaed630dc9033c48876ab0e92">msecRunTime</a> (<a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type=WallTime)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static u_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#fff3f11eee2213799f4558ae9532175a">secRunTime</a> (<a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type=WallTime)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SysUsage.html#7094b728f1de37e8ef9f15c6897877fc">runTime</a> (<a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type=WallTime)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A class exposing system resources usage. <p> The <a class="el" href="classTelEngine_1_1SysUsage.html" title="A class exposing system resources usage.">SysUsage</a> class allows collecting some statistics about engine's usage of system resources <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::SysUsage::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Type of time usage requested </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="edc913c139bb562646d3459b0ca28997"></a><!-- doxytag: member="TelEngine::SysUsage::init" ref="edc913c139bb562646d3459b0ca28997" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void init </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Initialize the system start variable </div> </div><p> <a class="anchor" name="8883542aaed630dc9033c48876ab0e92"></a><!-- doxytag: member="TelEngine::SysUsage::msecRunTime" ref="8883542aaed630dc9033c48876ab0e92" args="(Type type=WallTime)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static u_int64_t msecRunTime </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> <td class="paramname"> <em>type</em> = <code>WallTime</code> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the program's running time in milliseconds <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of running time requested </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> in milliseconds since the start of the program </dd></dl> </div> </div><p> <a class="anchor" name="7094b728f1de37e8ef9f15c6897877fc"></a><!-- doxytag: member="TelEngine::SysUsage::runTime" ref="7094b728f1de37e8ef9f15c6897877fc" args="(Type type=WallTime)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static double runTime </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> <td class="paramname"> <em>type</em> = <code>WallTime</code> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the program's running time in seconds <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of running time requested </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> in seconds since the start of the program </dd></dl> </div> </div><p> <a class="anchor" name="fff3f11eee2213799f4558ae9532175a"></a><!-- doxytag: member="TelEngine::SysUsage::secRunTime" ref="fff3f11eee2213799f4558ae9532175a" args="(Type type=WallTime)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static u_int32_t secRunTime </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> <td class="paramname"> <em>type</em> = <code>WallTime</code> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the program's running time in seconds <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of running time requested </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> in seconds since the start of the program </dd></dl> </div> </div><p> <a class="anchor" name="22c10b4a019615690bc69bc6f54e25fd"></a><!-- doxytag: member="TelEngine::SysUsage::startTime" ref="22c10b4a019615690bc69bc6f54e25fd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static u_int64_t startTime </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the wall time used as start for the usage time <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> of the first direct or implicit call of <a class="el" href="classTelEngine_1_1SysUsage.html#edc913c139bb562646d3459b0ca28997">init()</a> </dd></dl> </div> </div><p> <a class="anchor" name="12064ad1c65050c798d05205916b1ac0"></a><!-- doxytag: member="TelEngine::SysUsage::usecRunTime" ref="12064ad1c65050c798d05205916b1ac0" args="(Type type=WallTime)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static u_int64_t usecRunTime </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SysUsage.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> <td class="paramname"> <em>type</em> = <code>WallTime</code> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the program's running time in microseconds <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of running time requested </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> in microseconds since the start of the program </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yateclass_8h-source.html">yateclass.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:11 2008 for Yate by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> </body> </html>