<!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"/>
<title>GNU CommonC++: ost::SysTime Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_sys_time.html">SysTime</a>
</div>
</div>
<div class="contents">
<h1>ost::SysTime Class Reference</h1><!-- doxytag: class="ost::SysTime" -->
<p>This class is used to access non-reentrant date and time functions in the standard C library.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<p><a href="classost_1_1_sys_time-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#aab5bc338259759c47df084065f6b605c">getTime</a> (time_t *tloc=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#accb0dc3c9d64b224e47649211dbe7b64">time</a> (time_t *tloc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#a9b0387c29a0a79395b7f38dae4ade533">getTimeOfDay</a> (struct timeval *tp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#afc403fcaa5a8ebf81528a34e5d5a1fac">gettimeofday</a> (struct timeval *tp, struct timezone *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#ac39180f2c7b282d0145134d14a288480">getLocalTime</a> (const time_t *clock, struct tm *result)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#af4bd7e44705486a2f0cee2cb98b2f975">locatime</a> (const time_t *clock, struct tm *result)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#a0da1e5fefac7161a878daed011e79932">getGMTTime</a> (const time_t *clock, struct tm *result)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static struct tm * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#a1852b1563a7b8f2b96ab75bafe3948eb">gmtime</a> (const time_t *clock, struct tm *result)</td></tr>
<tr><td colspan="2"><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#a9c5b33e9cabc7f1510653dbd1f6eb0ae">lock</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_sys_time.html#a0d75e27d952de65d6e46b38e57ba605d">unlock</a> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class is used to access non-reentrant date and time functions in the standard C library. </p>
<p>The class has two purposes:</p>
<ul>
<li>1 To be used internaly in CommonCpp's date and time classes to make them thread safe.</li>
<li>2 To be used by clients as thread safe replacements to the standard C functions, much like <a class="el" href="classost_1_1_thread.html#a663d960e8599194f3b25169915c22fb6" title="A thread-safe sleep call.">Thread::sleep()</a> represents a thread safe version of the standard sleep() function.</li>
</ul>
<dl class="note"><dt><b>Note:</b></dt><dd>The class provides one function with the same name as its equivalent standard function and one with another, unique name. For new clients, the version with the unique name is recommended to make it easy to grep for accidental usage of the standard functions. The version with the standard name is provided for existing clients to sed replace their original version.</dd>
<dd>
Also note that some functions that returned pointers have been redone to take that pointer as an argument instead, making the caller responsible for memory allocation/deallocation. This is almost how POSIX specifies *_r functions (reentrant versions of the standard time functions), except the POSIX functions also return the given pointer while we do not. We don't use the *_r functions as they aren't all generally available on all platforms yet.</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Idar Tollefsen <<a href="mailto:idar@cognita.no">idar@cognita.no</a>> <a class="el" href="classost_1_1_thread.html" title="Every thread of execution in an application is created by instantiating an object...">Thread</a> safe date and time functions. </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0da1e5fefac7161a878daed011e79932"></a><!-- doxytag: member="ost::SysTime::getGMTTime" ref="a0da1e5fefac7161a878daed011e79932" args="(const time_t *clock, struct tm *result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static struct tm* ost::SysTime::getGMTTime </td>
<td>(</td>
<td class="paramtype">const time_t * </td>
<td class="paramname"> <em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct tm * </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac39180f2c7b282d0145134d14a288480"></a><!-- doxytag: member="ost::SysTime::getLocalTime" ref="ac39180f2c7b282d0145134d14a288480" args="(const time_t *clock, struct tm *result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static struct tm* ost::SysTime::getLocalTime </td>
<td>(</td>
<td class="paramtype">const time_t * </td>
<td class="paramname"> <em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct tm * </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aab5bc338259759c47df084065f6b605c"></a><!-- doxytag: member="ost::SysTime::getTime" ref="aab5bc338259759c47df084065f6b605c" args="(time_t *tloc=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static time_t ost::SysTime::getTime </td>
<td>(</td>
<td class="paramtype">time_t * </td>
<td class="paramname"> <em>tloc</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afc403fcaa5a8ebf81528a34e5d5a1fac"></a><!-- doxytag: member="ost::SysTime::gettimeofday" ref="afc403fcaa5a8ebf81528a34e5d5a1fac" args="(struct timeval *tp, struct timezone *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int ost::SysTime::gettimeofday </td>
<td>(</td>
<td class="paramtype">struct timeval * </td>
<td class="paramname"> <em>tp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct timezone * </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9b0387c29a0a79395b7f38dae4ade533"></a><!-- doxytag: member="ost::SysTime::getTimeOfDay" ref="a9b0387c29a0a79395b7f38dae4ade533" args="(struct timeval *tp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int ost::SysTime::getTimeOfDay </td>
<td>(</td>
<td class="paramtype">struct timeval * </td>
<td class="paramname"> <em>tp</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1852b1563a7b8f2b96ab75bafe3948eb"></a><!-- doxytag: member="ost::SysTime::gmtime" ref="a1852b1563a7b8f2b96ab75bafe3948eb" args="(const time_t *clock, struct tm *result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static struct tm* ost::SysTime::gmtime </td>
<td>(</td>
<td class="paramtype">const time_t * </td>
<td class="paramname"> <em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct tm * </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af4bd7e44705486a2f0cee2cb98b2f975"></a><!-- doxytag: member="ost::SysTime::locatime" ref="af4bd7e44705486a2f0cee2cb98b2f975" args="(const time_t *clock, struct tm *result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static struct tm* ost::SysTime::locatime </td>
<td>(</td>
<td class="paramtype">const time_t * </td>
<td class="paramname"> <em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct tm * </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c5b33e9cabc7f1510653dbd1f6eb0ae"></a><!-- doxytag: member="ost::SysTime::lock" ref="a9c5b33e9cabc7f1510653dbd1f6eb0ae" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ost::SysTime::lock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="accb0dc3c9d64b224e47649211dbe7b64"></a><!-- doxytag: member="ost::SysTime::time" ref="accb0dc3c9d64b224e47649211dbe7b64" args="(time_t *tloc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static time_t ost::SysTime::time </td>
<td>(</td>
<td class="paramtype">time_t * </td>
<td class="paramname"> <em>tloc</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d75e27d952de65d6e46b38e57ba605d"></a><!-- doxytag: member="ost::SysTime::unlock" ref="a0d75e27d952de65d6e46b38e57ba605d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ost::SysTime::unlock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:57:40 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-updates
>
by-pkgid
>
f36f42783f75191f5f2d47f1e8c5504e
>
files
>
369
