blob: 24caa8f7bd537cae06486555afdfddc0cd470a93 [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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: proton/timestamp.hpp Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @license-end */
</script>
</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('timestamp_8hpp_source.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="headertitle">
<div class="title">timestamp.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="timestamp_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef PROTON_TIMESTAMP_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define PROTON_TIMESTAMP_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="duration_8hpp.html">./duration.hpp</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;proton/type_compat.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classproton_1_1timestamp.html">timestamp</a> : <span class="keyword">private</span> internal::comparable&lt;timestamp&gt; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2"> 38</a></span>&#160; <span class="keyword">typedef</span> int64_t <a class="code" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html#a8a432817c74685a518a08ede48d1db34"> 41</a></span>&#160; PN_CPP_EXTERN <span class="keyword">static</span> <a class="code" href="classproton_1_1timestamp.html">timestamp</a> <a class="code" href="classproton_1_1timestamp.html#a8a432817c74685a518a08ede48d1db34">now</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html#a7dd3e30aaca70057a02dca7cc5eb5b4d"> 44</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classproton_1_1timestamp.html#a7dd3e30aaca70057a02dca7cc5eb5b4d">timestamp</a>(<a class="code" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms = 0) : ms_(ms) {}</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html#a9d99d74acbdd9e73e7bfa74e9886cbb6"> 47</a></span>&#160; <a class="code" href="classproton_1_1timestamp.html">timestamp</a>&amp; <a class="code" href="classproton_1_1timestamp.html#a9d99d74acbdd9e73e7bfa74e9886cbb6">operator=</a>(<a class="code" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms) { ms_ = ms; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classproton_1_1timestamp.html#afb6516c796d13a88dcbd295247f0f535"> 50</a></span>&#160; <a class="code" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> <a class="code" href="classproton_1_1timestamp.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ms_; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms_;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(timestamp x, timestamp y) { <span class="keywordflow">return</span> x.milliseconds() == y.milliseconds(); }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> operator&lt;(timestamp x, timestamp y) { <span class="keywordflow">return</span> x.milliseconds() &lt; y.milliseconds(); }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">inline</span> timestamp operator+(timestamp ts, duration d) { <span class="keywordflow">return</span> timestamp(ts.milliseconds() + d.milliseconds()); }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">inline</span> timestamp operator-(timestamp ts, duration d) { <span class="keywordflow">return</span> timestamp(ts.milliseconds() - d.milliseconds()); }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keyword">inline</span> duration operator-(timestamp t0, timestamp t1) { <span class="keywordflow">return</span> duration(t0.milliseconds() - t1.milliseconds()); }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">inline</span> timestamp operator+(duration d, timestamp ts) { <span class="keywordflow">return</span> ts + d; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="namespaceproton.html#aed74ac4c1f42d3d4bed8b37934dbcc77"> 68</a></span>&#160;PN_CPP_EXTERN std::ostream&amp; <a class="code" href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">operator&lt;&lt;</a>(std::ostream&amp;, <a class="code" href="classproton_1_1timestamp.html">timestamp</a>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// proton</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif // PROTON_TIMESTAMP_HPP</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespaceproton_html_ae6fabe30961a3d3280bb8445e743b21c"><div class="ttname"><a href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">proton::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;, const binary &amp;)</div><div class="ttdoc">Print a binary value.</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html_a8a432817c74685a518a08ede48d1db34"><div class="ttname"><a href="classproton_1_1timestamp.html#a8a432817c74685a518a08ede48d1db34">proton::timestamp::now</a></div><div class="ttdeci">static timestamp now()</div><div class="ttdoc">The current wall-clock time.</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html_afb6516c796d13a88dcbd295247f0f535"><div class="ttname"><a href="classproton_1_1timestamp.html#afb6516c796d13a88dcbd295247f0f535">proton::timestamp::milliseconds</a></div><div class="ttdeci">numeric_type milliseconds() const</div><div class="ttdoc">Get the value in milliseconds.</div><div class="ttdef"><b>Definition:</b> timestamp.hpp:50</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html_a44829e89515fec974f57f37bbdbfaeb2"><div class="ttname"><a href="classproton_1_1timestamp.html#a44829e89515fec974f57f37bbdbfaeb2">proton::timestamp::numeric_type</a></div><div class="ttdeci">int64_t numeric_type</div><div class="ttdoc">A numeric type holding a value in milliseconds.</div><div class="ttdef"><b>Definition:</b> timestamp.hpp:38</div></div>
<div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html_a7dd3e30aaca70057a02dca7cc5eb5b4d"><div class="ttname"><a href="classproton_1_1timestamp.html#a7dd3e30aaca70057a02dca7cc5eb5b4d">proton::timestamp::timestamp</a></div><div class="ttdeci">timestamp(numeric_type ms=0)</div><div class="ttdoc">Construct from a value in milliseconds.</div><div class="ttdef"><b>Definition:</b> timestamp.hpp:44</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html"><div class="ttname"><a href="classproton_1_1timestamp.html">proton::timestamp</a></div><div class="ttdoc">A 64-bit timestamp in milliseconds since the Unix epoch.</div><div class="ttdef"><b>Definition:</b> timestamp.hpp:35</div></div>
<div class="ttc" id="aduration_8hpp_html"><div class="ttname"><a href="duration_8hpp.html">duration.hpp</a></div><div class="ttdoc">A span of time in milliseconds.</div></div>
<div class="ttc" id="aclassproton_1_1timestamp_html_a9d99d74acbdd9e73e7bfa74e9886cbb6"><div class="ttname"><a href="classproton_1_1timestamp.html#a9d99d74acbdd9e73e7bfa74e9886cbb6">proton::timestamp::operator=</a></div><div class="ttdeci">timestamp &amp; operator=(numeric_type ms)</div><div class="ttdoc">Assign a value in milliseconds.</div><div class="ttdef"><b>Definition:</b> timestamp.hpp:47</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="timestamp_8hpp.html">timestamp.hpp</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>