blob: 0c891422de89073f57e1858e892deac30134f09c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>oscl_time.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>oscl_time.h File Reference</h1>The file <a class="el" href="oscl__time_8h.html">oscl_time.h</a> defines to classes <a class="el" href="classNTPTime.html">NTPTime</a> and <a class="el" href="classTimeValue.html">TimeValue</a> for getting, manipulating, and formatting time values. The <a class="el" href="classTimeValue.html">TimeValue</a> class is based on the native system time format while <a class="el" href="classNTPTime.html">NTPTime</a> is used for the standard Network Time Protocol format.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="oscl__base_8h-source.html">oscl_base.h</a>"</code><br>
<code>#include "<a class="el" href="osclconfig__time_8h-source.html">osclconfig_time.h</a>"</code><br>
<code>#include "<a class="el" href="oscl__int64__utils_8h-source.html">oscl_int64_utils.h</a>"</code><br>
<code>#include "oscl_time.inl"</code><br>
<p>
<a href="oscl__time_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classNTPTime.html">NTPTime</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The NTPTime class represents a time value as the number of seconds since 0h (UTC) Jan. 1, 1900.</em> <a href="classNTPTime.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTimeValue.html">TimeValue</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The TimeValue class represents a time value in a format native to the system.</em> <a href="classTimeValue.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef char&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a> [<a class="el" href="group__osclbase.html#a0">CTIME_BUFFER_SIZE</a>]</td></tr>
<tr><td nowrap align=right valign=top>typedef char&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a> [<a class="el" href="group__osclbase.html#a1">PV8601TIME_BUFFER_SIZE</a>]</td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a109">TimeUnits</a> { <a class="el" href="group__osclbase.html#a109a10">SECONDS</a> = 0,
<a class="el" href="group__osclbase.html#a109a11">MILLISECONDS</a> = 1,
<a class="el" href="group__osclbase.html#a109a12">MICROSECONDS</a> = 2
}</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The TimeUnits enum can be used when constructing a <a class="el" href="classTimeValue.html">TimeValue</a> class.</em> <a href="group__osclbase.html#a109">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a75">PV8601ToRFC822</a> (<a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a> pv8601_buffer, <a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a> ctime_buffer)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a76">RFC822ToPV8601</a> (<a class="el" href="group__osclbase.html#a2">CtimeStrBuf</a> ctime_buffer, <a class="el" href="group__osclbase.html#a3">PV8601timeStrBuf</a>)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_COND_IMPORT_REF <a class="el" href="classTimeValue.html">TimeValue</a>&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a77">operator-</a> (const <a class="el" href="classTimeValue.html">TimeValue</a> &amp;a, const <a class="el" href="classTimeValue.html">TimeValue</a> &amp;b)</td></tr>
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
<tr><td nowrap align=right valign=top>const int&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a0">CTIME_BUFFER_SIZE</a> = 26</td></tr>
<tr><td nowrap align=right valign=top>const int&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a1">PV8601TIME_BUFFER_SIZE</a> = 21</td></tr>
<tr><td nowrap align=right valign=top>const long&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a4">USEC_PER_SEC</a> = 1000000</td></tr>
<tr><td nowrap align=right valign=top>const long&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a5">MSEC_PER_SEC</a> = 1000</td></tr>
<tr><td nowrap align=right valign=top>const uint32&nbsp;</td><td valign=bottom><a class="el" href="group__osclbase.html#a9">unix_ntp_offset</a> = 2208988800U</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The file <a class="el" href="oscl__time_8h.html">oscl_time.h</a> defines to classes <a class="el" href="classNTPTime.html">NTPTime</a> and <a class="el" href="classTimeValue.html">TimeValue</a> for getting, manipulating, and formatting time values. The <a class="el" href="classTimeValue.html">TimeValue</a> class is based on the native system time format while <a class="el" href="classNTPTime.html">NTPTime</a> is used for the standard Network Time Protocol format.
<p>
<p>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>