<!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>GNU CommonC++: ost::SysTime Class 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="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">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_sys_time.html">SysTime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="classost_1_1_sys_time-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::SysTime Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is used to access non-reentrant date and time functions in the standard C library.
<a href="classost_1_1_sys_time.html#details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aab5bc338259759c47df084065f6b605c"><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 class="separator:aab5bc338259759c47df084065f6b605c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accb0dc3c9d64b224e47649211dbe7b64"><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 class="separator:accb0dc3c9d64b224e47649211dbe7b64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b0387c29a0a79395b7f38dae4ade533"><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 class="separator:a9b0387c29a0a79395b7f38dae4ade533"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc403fcaa5a8ebf81528a34e5d5a1fac"><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 class="separator:afc403fcaa5a8ebf81528a34e5d5a1fac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac39180f2c7b282d0145134d14a288480"><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 class="separator:ac39180f2c7b282d0145134d14a288480"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4bd7e44705486a2f0cee2cb98b2f975"><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 class="separator:af4bd7e44705486a2f0cee2cb98b2f975"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0da1e5fefac7161a878daed011e79932"><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 class="separator:a0da1e5fefac7161a878daed011e79932"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1852b1563a7b8f2b96ab75bafe3948eb"><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 class="separator:a1852b1563a7b8f2b96ab75bafe3948eb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a9c5b33e9cabc7f1510653dbd1f6eb0ae"><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 class="separator:a9c5b33e9cabc7f1510653dbd1f6eb0ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d75e27d952de65d6e46b38e57ba605d"><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>
<tr class="separator:a0d75e27d952de65d6e46b38e57ba605d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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="section note"><dt>Note</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="section author"><dt>Author</dt><dd>Idar Tollefsen <a href="#" onclick="location.href='mai'+'lto:'+'ida'+'r@'+'cog'+'ni'+'ta.'+'no'; return false;">idar@<span style="display: none;">.nosp@m.</span>cogn<span style="display: none;">.nosp@m.</span>ita.n<span style="display: none;">.nosp@m.</span>o</a> <a class="el" href="classost_1_1_thread.html" title="Every thread of execution in an application is created by instantiating an object of a class derived ...">Thread</a> safe date and time functions. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0da1e5fefac7161a878daed011e79932"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</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>Referenced by <a class="el" href="namespaceost.html#a64c9138a1bf7a0d56fc8060fa1e4552c">ost::gmtime_r()</a>.</p>
</div>
</div>
<a class="anchor" id="ac39180f2c7b282d0145134d14a288480"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</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>Referenced by <a class="el" href="namespaceost.html#a2532506cb80f89403523d977ef6c2345">ost::localtime_r()</a>.</p>
</div>
</div>
<a class="anchor" id="aab5bc338259759c47df084065f6b605c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9b0387c29a0a79395b7f38dae4ade533"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afc403fcaa5a8ebf81528a34e5d5a1fac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1852b1563a7b8f2b96ab75bafe3948eb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af4bd7e44705486a2f0cee2cb98b2f975"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c5b33e9cabc7f1510653dbd1f6eb0ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="accb0dc3c9d64b224e47649211dbe7b64"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d75e27d952de65d6e46b38e57ba605d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:58 for GNU CommonC++ 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>
