| <!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/duration.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&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 |
|  <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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('duration_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">duration.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="duration_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> <span class="preprocessor">#ifndef PROTON_DURATION_HPP</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_DURATION_HPP</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "./internal/comparable.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="types__fwd_8hpp.html">./types_fwd.hpp</a>"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <proton/type_compat.h></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <iosfwd></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classproton_1_1duration.html">duration</a> : <span class="keyword">private</span> internal::comparable<duration> {</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2"> 42</a></span>  <span class="keyword">typedef</span> int64_t <a class="code" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a>;</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#aa4fb0163afbe72b04236e39e2b6d2dbf"> 45</a></span>  <span class="keyword">explicit</span> <a class="code" href="classproton_1_1duration.html#aa4fb0163afbe72b04236e39e2b6d2dbf">duration</a>(<a class="code" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms = 0) : ms_(ms) {}</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#a13ff6465e0979fe301b75ea574ce2304"> 48</a></span>  <a class="code" href="classproton_1_1duration.html">duration</a>& <a class="code" href="classproton_1_1duration.html#a13ff6465e0979fe301b75ea574ce2304">operator=</a>(<a class="code" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms) { ms_ = ms; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535"> 51</a></span>  <a class="code" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> <a class="code" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ms_; }</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#acebdd3ee364870f89665ca128e97a4d7"> 53</a></span>  PN_CPP_EXTERN <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classproton_1_1duration.html">duration</a> <a class="code" href="classproton_1_1duration.html#acebdd3ee364870f89665ca128e97a4d7">FOREVER</a>; </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#ab804de8e95dd6203d6e72e797440055e"> 54</a></span>  PN_CPP_EXTERN <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classproton_1_1duration.html">duration</a> <a class="code" href="classproton_1_1duration.html#ab804de8e95dd6203d6e72e797440055e">IMMEDIATE</a>; </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562"> 55</a></span>  PN_CPP_EXTERN <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classproton_1_1duration.html">duration</a> <a class="code" href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562">SECOND</a>; </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#ad936986f8cf9cb95b0dbc93ade000b76"> 56</a></span>  PN_CPP_EXTERN <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classproton_1_1duration.html">duration</a> <a class="code" href="classproton_1_1duration.html#ad936986f8cf9cb95b0dbc93ade000b76">MILLISECOND</a>; </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0"> 57</a></span>  PN_CPP_EXTERN <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classproton_1_1duration.html">duration</a> <a class="code" href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0">MINUTE</a>; </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">numeric_type</a> ms_;</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> };</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="namespaceproton.html#a184d0e22e7da9fe7b3d1c8c84ce73f2f"> 64</a></span> PN_CPP_EXTERN std::ostream& <a class="code" href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">operator<<</a>(std::ostream&, <a class="code" href="classproton_1_1duration.html">duration</a>);</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator<(<a class="code" href="classproton_1_1duration.html">duration</a> x, <a class="code" href="classproton_1_1duration.html">duration</a> y) { <span class="keywordflow">return</span> x.<a class="code" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>() < y.<a class="code" href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">milliseconds</a>(); }</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(duration x, duration y) { <span class="keywordflow">return</span> x.milliseconds() == y.milliseconds(); }</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">inline</span> duration operator+(duration x, duration y) { <span class="keywordflow">return</span> duration(x.milliseconds() + y.milliseconds()); }</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">inline</span> duration operator-(duration x, duration y) { <span class="keywordflow">return</span> duration(x.milliseconds() - y.milliseconds()); }</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">inline</span> duration operator*(duration d, uint64_t n) { <span class="keywordflow">return</span> duration(d.milliseconds()*n); }</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">inline</span> duration operator*(uint64_t n, duration d) { <span class="keywordflow">return</span> d * n; }</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">inline</span> duration operator/(duration d, uint64_t n) { <span class="keywordflow">return</span> duration(d.milliseconds() / n); }</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// proton</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif // PROTON_DURATION_HPP</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassproton_1_1duration_html_aa4fb0163afbe72b04236e39e2b6d2dbf"><div class="ttname"><a href="classproton_1_1duration.html#aa4fb0163afbe72b04236e39e2b6d2dbf">proton::duration::duration</a></div><div class="ttdeci">duration(numeric_type ms=0)</div><div class="ttdoc">Construct from a value in milliseconds.</div><div class="ttdef"><b>Definition:</b> duration.hpp:45</div></div> |
| <div class="ttc" id="anamespaceproton_html_ae6fabe30961a3d3280bb8445e743b21c"><div class="ttname"><a href="namespaceproton.html#ae6fabe30961a3d3280bb8445e743b21c">proton::operator<<</a></div><div class="ttdeci">std::ostream & operator<<(std::ostream &, const binary &)</div><div class="ttdoc">Print a binary value.</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html"><div class="ttname"><a href="classproton_1_1duration.html">proton::duration</a></div><div class="ttdoc">A span of time in milliseconds.</div><div class="ttdef"><b>Definition:</b> duration.hpp:39</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_ad936986f8cf9cb95b0dbc93ade000b76"><div class="ttname"><a href="classproton_1_1duration.html#ad936986f8cf9cb95b0dbc93ade000b76">proton::duration::MILLISECOND</a></div><div class="ttdeci">static const duration MILLISECOND</div><div class="ttdoc">One millisecond.</div><div class="ttdef"><b>Definition:</b> duration.hpp:56</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_a44829e89515fec974f57f37bbdbfaeb2"><div class="ttname"><a href="classproton_1_1duration.html#a44829e89515fec974f57f37bbdbfaeb2">proton::duration::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> duration.hpp:42</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_afb6516c796d13a88dcbd295247f0f535"><div class="ttname"><a href="classproton_1_1duration.html#afb6516c796d13a88dcbd295247f0f535">proton::duration::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> duration.hpp:51</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_ab804de8e95dd6203d6e72e797440055e"><div class="ttname"><a href="classproton_1_1duration.html#ab804de8e95dd6203d6e72e797440055e">proton::duration::IMMEDIATE</a></div><div class="ttdeci">static const duration IMMEDIATE</div><div class="ttdoc">Don't wait at all.</div><div class="ttdef"><b>Definition:</b> duration.hpp:54</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_aced1c394edccf069b2748d46965fb562"><div class="ttname"><a href="classproton_1_1duration.html#aced1c394edccf069b2748d46965fb562">proton::duration::SECOND</a></div><div class="ttdeci">static const duration SECOND</div><div class="ttdoc">One second.</div><div class="ttdef"><b>Definition:</b> duration.hpp:55</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_1duration_html_a13ff6465e0979fe301b75ea574ce2304"><div class="ttname"><a href="classproton_1_1duration.html#a13ff6465e0979fe301b75ea574ce2304">proton::duration::operator=</a></div><div class="ttdeci">duration & operator=(numeric_type ms)</div><div class="ttdoc">Assign a value in milliseconds.</div><div class="ttdef"><b>Definition:</b> duration.hpp:48</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_a437a5e5f6a7d0c8780f3594b2272cba0"><div class="ttname"><a href="classproton_1_1duration.html#a437a5e5f6a7d0c8780f3594b2272cba0">proton::duration::MINUTE</a></div><div class="ttdeci">static const duration MINUTE</div><div class="ttdoc">One minute.</div><div class="ttdef"><b>Definition:</b> duration.hpp:57</div></div> |
| <div class="ttc" id="aclassproton_1_1duration_html_acebdd3ee364870f89665ca128e97a4d7"><div class="ttname"><a href="classproton_1_1duration.html#acebdd3ee364870f89665ca128e97a4d7">proton::duration::FOREVER</a></div><div class="ttdeci">static const duration FOREVER</div><div class="ttdoc">Wait forever.</div><div class="ttdef"><b>Definition:</b> duration.hpp:53</div></div> |
| <div class="ttc" id="atypes__fwd_8hpp_html"><div class="ttname"><a href="types__fwd_8hpp.html">types_fwd.hpp</a></div><div class="ttdoc">Forward declarations for Proton types used to represent AMQP types.</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="duration_8hpp.html">duration.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> |
