blob: c6dff56dd618b7fe8ef701deff238cd97b1c5da3 [file]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg/util/timepoint.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="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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_6a066966226cd78a6111c1015733de08.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">timepoint.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provide time point conversion helpers.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;chrono&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
</div>
<p><a href="timepoint_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 id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a26b5236cc1bac2db397a235e5159efbc" id="r_a26b5236cc1bac2db397a235e5159efbc"><td class="memItemLeft" align="right" valign="top"><a id="a26b5236cc1bac2db397a235e5159efbc" name="a26b5236cc1bac2db397a235e5159efbc"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TimePointMs</b> = std::chrono::time_point&lt; std::chrono::system_clock, std::chrono::milliseconds &gt;</td></tr>
<tr class="memdesc:a26b5236cc1bac2db397a235e5159efbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">A time point in milliseconds. <br /></td></tr>
<tr class="separator:a26b5236cc1bac2db397a235e5159efbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab78083f4e9fdbfcd58a22828cd36cd95" id="r_ab78083f4e9fdbfcd58a22828cd36cd95"><td class="memItemLeft" align="right" valign="top"><a id="ab78083f4e9fdbfcd58a22828cd36cd95" name="ab78083f4e9fdbfcd58a22828cd36cd95"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TimePointNs</b> = std::chrono::time_point&lt; std::chrono::system_clock, std::chrono::nanoseconds &gt;</td></tr>
<tr class="memdesc:ab78083f4e9fdbfcd58a22828cd36cd95"><td class="mdescLeft">&#160;</td><td class="mdescRight">A time point in nanoseconds. <br /></td></tr>
<tr class="separator:ab78083f4e9fdbfcd58a22828cd36cd95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a68264521cec5f9efdea141c379e65b2c" id="r_a68264521cec5f9efdea141c379e65b2c"><td class="memItemLeft" align="right" valign="top"><a id="a68264521cec5f9efdea141c379e65b2c" name="a68264521cec5f9efdea141c379e65b2c"></a>
ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a26b5236cc1bac2db397a235e5159efbc">TimePointMs</a>&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TimePointMsFromUnixMs</b> (int64_t unix_ms)</td></tr>
<tr class="memdesc:a68264521cec5f9efdea141c379e65b2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a TimePointMs from a Unix timestamp in milliseconds. <br /></td></tr>
<tr class="separator:a68264521cec5f9efdea141c379e65b2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cf9aeeb3ad0a712224c348265624505" id="r_a5cf9aeeb3ad0a712224c348265624505"><td class="memItemLeft" align="right" valign="top"><a id="a5cf9aeeb3ad0a712224c348265624505" name="a5cf9aeeb3ad0a712224c348265624505"></a>
ICEBERG_EXPORT int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::UnixMsFromTimePointMs</b> (<a class="el" href="namespaceiceberg.html#a26b5236cc1bac2db397a235e5159efbc">TimePointMs</a> time_point_ms)</td></tr>
<tr class="memdesc:a5cf9aeeb3ad0a712224c348265624505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a Unix timestamp in milliseconds from a TimePointMs. <br /></td></tr>
<tr class="separator:a5cf9aeeb3ad0a712224c348265624505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20e9d6a5efff94b7e0e166562f20d08f" id="r_a20e9d6a5efff94b7e0e166562f20d08f"><td class="memItemLeft" align="right" valign="top"><a id="a20e9d6a5efff94b7e0e166562f20d08f" name="a20e9d6a5efff94b7e0e166562f20d08f"></a>
ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#ab78083f4e9fdbfcd58a22828cd36cd95">TimePointNs</a>&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::TimePointNsFromUnixNs</b> (int64_t unix_ns)</td></tr>
<tr class="memdesc:a20e9d6a5efff94b7e0e166562f20d08f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a TimePointNs from a Unix timestamp in nanoseconds. <br /></td></tr>
<tr class="separator:a20e9d6a5efff94b7e0e166562f20d08f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa82a3b1da10f7909f3089baed934ccb7" id="r_aa82a3b1da10f7909f3089baed934ccb7"><td class="memItemLeft" align="right" valign="top"><a id="aa82a3b1da10f7909f3089baed934ccb7" name="aa82a3b1da10f7909f3089baed934ccb7"></a>
ICEBERG_EXPORT int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::UnixNsFromTimePointNs</b> (<a class="el" href="namespaceiceberg.html#ab78083f4e9fdbfcd58a22828cd36cd95">TimePointNs</a> time_point_ns)</td></tr>
<tr class="memdesc:aa82a3b1da10f7909f3089baed934ccb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a Unix timestamp in nanoseconds from a TimePointNs. <br /></td></tr>
<tr class="separator:aa82a3b1da10f7909f3089baed934ccb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a955b0be437d37f696516c2c68b83c88f" id="r_a955b0be437d37f696516c2c68b83c88f"><td class="memItemLeft" align="right" valign="top"><a id="a955b0be437d37f696516c2c68b83c88f" name="a955b0be437d37f696516c2c68b83c88f"></a>
ICEBERG_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::FormatTimePointMs</b> (<a class="el" href="namespaceiceberg.html#a26b5236cc1bac2db397a235e5159efbc">TimePointMs</a> time_point_ms)</td></tr>
<tr class="memdesc:a955b0be437d37f696516c2c68b83c88f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string representation of a TimePointMs. <br /></td></tr>
<tr class="separator:a955b0be437d37f696516c2c68b83c88f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08a56cb35f1608d86782111f9dd4f7ec" id="r_a08a56cb35f1608d86782111f9dd4f7ec"><td class="memItemLeft" align="right" valign="top"><a id="a08a56cb35f1608d86782111f9dd4f7ec" name="a08a56cb35f1608d86782111f9dd4f7ec"></a>
ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a26b5236cc1bac2db397a235e5159efbc">TimePointMs</a>&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::CurrentTimePointMs</b> ()</td></tr>
<tr class="memdesc:a08a56cb35f1608d86782111f9dd4f7ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a time point in milliseconds that represents the current system time. <br /></td></tr>
<tr class="separator:a08a56cb35f1608d86782111f9dd4f7ec"><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>Provide time point conversion helpers. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>