blob: 020083005aea44c6a06bb241a439aee82c7b2d18 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>API Reference Manual for linux-dpdk: time.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="odpdoxygen.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 id="projectlogo"><img alt="Logo" src="ODP-Logo-HQ.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">API Reference Manual for linux-dpdk
&#160;<span id="projectnumber">1.47.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('spec_2time_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">spec/time.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>ODP time.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;odp/visibility_begin.h&gt;</code><br />
<code>#include &lt;<a class="el" href="std__types_8h_source.html">odp/api/std_types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="time__types_8h_source.html">odp/api/time_types.h</a>&gt;</code><br />
<code>#include &lt;odp/visibility_end.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for spec/time.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="spec_2time_8h__incl.svg" width="982" height="411"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="spec_2time_8h__dep__incl.svg" width="75" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="spec_2time_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5d0b24d7dae739bac7585ed515bd60a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga5d0b24d7dae739bac7585ed515bd60a8">odp_time_local</a> (void)</td></tr>
<tr class="memdesc:ga5d0b24d7dae739bac7585ed515bd60a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current local time. <a href="group__odp__time.html#ga5d0b24d7dae739bac7585ed515bd60a8">More...</a><br /></td></tr>
<tr class="separator:ga5d0b24d7dae739bac7585ed515bd60a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacee07a24a70853851cab596dcf5c1016"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gacee07a24a70853851cab596dcf5c1016">odp_time_local_ns</a> (void)</td></tr>
<tr class="memdesc:gacee07a24a70853851cab596dcf5c1016"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current local time in nanoseconds. <a href="group__odp__time.html#gacee07a24a70853851cab596dcf5c1016">More...</a><br /></td></tr>
<tr class="separator:gacee07a24a70853851cab596dcf5c1016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe857e90283c71df90130d1775ceb6c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gabe857e90283c71df90130d1775ceb6c7">odp_time_local_strict</a> (void)</td></tr>
<tr class="memdesc:gabe857e90283c71df90130d1775ceb6c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current local time (strict) <a href="group__odp__time.html#gabe857e90283c71df90130d1775ceb6c7">More...</a><br /></td></tr>
<tr class="separator:gabe857e90283c71df90130d1775ceb6c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a23152fbe99f696cde44ad32252af64"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga4a23152fbe99f696cde44ad32252af64">odp_time_local_strict_ns</a> (void)</td></tr>
<tr class="memdesc:ga4a23152fbe99f696cde44ad32252af64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current local time in nanoseconds (strict) <a href="group__odp__time.html#ga4a23152fbe99f696cde44ad32252af64">More...</a><br /></td></tr>
<tr class="separator:ga4a23152fbe99f696cde44ad32252af64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5be03b8df3638435a8078d28d996bc27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga5be03b8df3638435a8078d28d996bc27">odp_time_global</a> (void)</td></tr>
<tr class="memdesc:ga5be03b8df3638435a8078d28d996bc27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current global time. <a href="group__odp__time.html#ga5be03b8df3638435a8078d28d996bc27">More...</a><br /></td></tr>
<tr class="separator:ga5be03b8df3638435a8078d28d996bc27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd81d08ca80ef77e9909bea458352500"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gabd81d08ca80ef77e9909bea458352500">odp_time_global_ns</a> (void)</td></tr>
<tr class="memdesc:gabd81d08ca80ef77e9909bea458352500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current global time in nanoseconds. <a href="group__odp__time.html#gabd81d08ca80ef77e9909bea458352500">More...</a><br /></td></tr>
<tr class="separator:gabd81d08ca80ef77e9909bea458352500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f0eaeffa47c2983db9ed7911e7f6326"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga8f0eaeffa47c2983db9ed7911e7f6326">odp_time_global_strict</a> (void)</td></tr>
<tr class="memdesc:ga8f0eaeffa47c2983db9ed7911e7f6326"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current global time (strict) <a href="group__odp__time.html#ga8f0eaeffa47c2983db9ed7911e7f6326">More...</a><br /></td></tr>
<tr class="separator:ga8f0eaeffa47c2983db9ed7911e7f6326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7134e2e4f6fec6be698a17215a59d912"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga7134e2e4f6fec6be698a17215a59d912">odp_time_global_strict_ns</a> (void)</td></tr>
<tr class="memdesc:ga7134e2e4f6fec6be698a17215a59d912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current global time in nanoseconds (strict) <a href="group__odp__time.html#ga7134e2e4f6fec6be698a17215a59d912">More...</a><br /></td></tr>
<tr class="separator:ga7134e2e4f6fec6be698a17215a59d912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a5b41e057216483b4843120631f869a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga1a5b41e057216483b4843120631f869a">odp_time_diff</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> t2, <a class="el" href="structodp__time__t.html">odp_time_t</a> t1)</td></tr>
<tr class="memdesc:ga1a5b41e057216483b4843120631f869a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time difference. <a href="group__odp__time.html#ga1a5b41e057216483b4843120631f869a">More...</a><br /></td></tr>
<tr class="separator:ga1a5b41e057216483b4843120631f869a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada453827b812a8fae651e9d93308e959"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gada453827b812a8fae651e9d93308e959">odp_time_diff_ns</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> t2, <a class="el" href="structodp__time__t.html">odp_time_t</a> t1)</td></tr>
<tr class="memdesc:gada453827b812a8fae651e9d93308e959"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time difference in nanoseconds. <a href="group__odp__time.html#gada453827b812a8fae651e9d93308e959">More...</a><br /></td></tr>
<tr class="separator:gada453827b812a8fae651e9d93308e959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95ab0d415a8f4c53771bea3091592b7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga95ab0d415a8f4c53771bea3091592b7b">odp_time_add_ns</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> time, uint64_t ns)</td></tr>
<tr class="memdesc:ga95ab0d415a8f4c53771bea3091592b7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add nanoseconds into time. <a href="group__odp__time.html#ga95ab0d415a8f4c53771bea3091592b7b">More...</a><br /></td></tr>
<tr class="separator:ga95ab0d415a8f4c53771bea3091592b7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cf6345917d31805746337cf3c4b9c53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga2cf6345917d31805746337cf3c4b9c53">odp_time_sum</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> t1, <a class="el" href="structodp__time__t.html">odp_time_t</a> t2)</td></tr>
<tr class="memdesc:ga2cf6345917d31805746337cf3c4b9c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time sum. <a href="group__odp__time.html#ga2cf6345917d31805746337cf3c4b9c53">More...</a><br /></td></tr>
<tr class="separator:ga2cf6345917d31805746337cf3c4b9c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04eed146c4559fb906766c4fbd4c2460"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga04eed146c4559fb906766c4fbd4c2460">odp_time_to_ns</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> time)</td></tr>
<tr class="memdesc:ga04eed146c4559fb906766c4fbd4c2460"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert time to nanoseconds. <a href="group__odp__time.html#ga04eed146c4559fb906766c4fbd4c2460">More...</a><br /></td></tr>
<tr class="separator:ga04eed146c4559fb906766c4fbd4c2460"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4dfd390b895e6a63601a935db7621139"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga4dfd390b895e6a63601a935db7621139">odp_time_local_from_ns</a> (uint64_t ns)</td></tr>
<tr class="memdesc:ga4dfd390b895e6a63601a935db7621139"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert nanoseconds to local time. <a href="group__odp__time.html#ga4dfd390b895e6a63601a935db7621139">More...</a><br /></td></tr>
<tr class="separator:ga4dfd390b895e6a63601a935db7621139"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac321f61eadbbd2518e689256c85e90e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structodp__time__t.html">odp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gac321f61eadbbd2518e689256c85e90e4">odp_time_global_from_ns</a> (uint64_t ns)</td></tr>
<tr class="memdesc:gac321f61eadbbd2518e689256c85e90e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert nanoseconds to global time. <a href="group__odp__time.html#gac321f61eadbbd2518e689256c85e90e4">More...</a><br /></td></tr>
<tr class="separator:gac321f61eadbbd2518e689256c85e90e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac19fb35909fb3f7f3c7fadf0e5e6e0e4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gac19fb35909fb3f7f3c7fadf0e5e6e0e4">odp_time_cmp</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> t2, <a class="el" href="structodp__time__t.html">odp_time_t</a> t1)</td></tr>
<tr class="memdesc:gac19fb35909fb3f7f3c7fadf0e5e6e0e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two times. <a href="group__odp__time.html#gac19fb35909fb3f7f3c7fadf0e5e6e0e4">More...</a><br /></td></tr>
<tr class="separator:gac19fb35909fb3f7f3c7fadf0e5e6e0e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78ae62ba2f5a961953c83e64aa56d016"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga78ae62ba2f5a961953c83e64aa56d016">odp_time_local_res</a> (void)</td></tr>
<tr class="memdesc:ga78ae62ba2f5a961953c83e64aa56d016"><td class="mdescLeft">&#160;</td><td class="mdescRight">Local time resolution in hertz. <a href="group__odp__time.html#ga78ae62ba2f5a961953c83e64aa56d016">More...</a><br /></td></tr>
<tr class="separator:ga78ae62ba2f5a961953c83e64aa56d016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7481dc4e4ad5274c0d4818864026a03"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gae7481dc4e4ad5274c0d4818864026a03">odp_time_global_res</a> (void)</td></tr>
<tr class="memdesc:gae7481dc4e4ad5274c0d4818864026a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Global time resolution in hertz. <a href="group__odp__time.html#gae7481dc4e4ad5274c0d4818864026a03">More...</a><br /></td></tr>
<tr class="separator:gae7481dc4e4ad5274c0d4818864026a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d99c8e15adb2783734b6d98dc858952"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga4d99c8e15adb2783734b6d98dc858952">odp_time_wait_until</a> (<a class="el" href="structodp__time__t.html">odp_time_t</a> time)</td></tr>
<tr class="memdesc:ga4d99c8e15adb2783734b6d98dc858952"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until the specified (wall clock) time has been reached. <a href="group__odp__time.html#ga4d99c8e15adb2783734b6d98dc858952">More...</a><br /></td></tr>
<tr class="separator:ga4d99c8e15adb2783734b6d98dc858952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga506b0234dfdd7c0dc98d6acd27d57f8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#ga506b0234dfdd7c0dc98d6acd27d57f8a">odp_time_wait_ns</a> (uint64_t ns)</td></tr>
<tr class="memdesc:ga506b0234dfdd7c0dc98d6acd27d57f8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait the specified number of nanoseconds. <a href="group__odp__time.html#ga506b0234dfdd7c0dc98d6acd27d57f8a">More...</a><br /></td></tr>
<tr class="separator:ga506b0234dfdd7c0dc98d6acd27d57f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7cf6e7ba40375d502d453096ba4e161"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__time.html#gaf7cf6e7ba40375d502d453096ba4e161">odp_time_startup</a> (<a class="el" href="structodp__time__startup__t.html">odp_time_startup_t</a> *startup)</td></tr>
<tr class="memdesc:gaf7cf6e7ba40375d502d453096ba4e161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get ODP instance startup time. <a href="group__odp__time.html#gaf7cf6e7ba40375d502d453096ba4e161">More...</a><br /></td></tr>
<tr class="separator:gaf7cf6e7ba40375d502d453096ba4e161"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ODP time. </p>
<p class="definition">Definition in file <a class="el" href="spec_2time_8h_source.html">spec/time.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a97ec78d987d17ef5986981beb9a2005.html">odp</a></li><li class="navelem"><a class="el" href="dir_be9f6d876b8eda462084eff1b3ea4553.html">api</a></li><li class="navelem"><a class="el" href="dir_6c22a75485a92e225a6a44114cdc818e.html">spec</a></li><li class="navelem"><a class="el" href="spec_2time_8h.html">time.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>