grpc/cpp/grpcpp_2support_2time_8h_so...

177 lines
21 KiB
HTML

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpcpp/support/time.h 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="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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">1.58.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_fee4103ebae22d88b7497e325cc77366.html">support</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">time.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="grpcpp_2support_2time_8h.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="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright 2015 gRPC authors.</span></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 under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_SUPPORT_TIME_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_SUPPORT_TIME_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc__types_8h.html">grpc/impl/grpc_types.h</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2config_8h.html">grpcpp/support/config.h</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_time_point.html">TimePoint</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// If you see the error with methods below, you may need either</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// i) using the existing types having a conversion class such as</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// gpr_timespec and std::chrono::system_clock::time_point or</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// ii) writing a new TimePoint&lt;YourType&gt; to address your case.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classgrpc_1_1_time_point.html#aaac94307837ed2b54e9ddbf459265fb4">TimePoint</a>(<span class="keyword">const</span> T&amp; <span class="comment">/*time*/</span>) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="classgrpc_1_1_time_point.html#aefaca2a1ef33585bed428bc21810221a">raw_time</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html"> 51</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_time_point.html">TimePoint</a>&lt;<a class="code" href="structgpr__timespec.html">gpr_timespec</a>&gt; {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// NOLINTNEXTLINE(google-explicit-constructor)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a092aa1afe85bf73a10bf906bb9924007"> 54</a></span>&#160; <a class="code" href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a092aa1afe85bf73a10bf906bb9924007">TimePoint</a>(<span class="keyword">const</span> <a class="code" href="structgpr__timespec.html">gpr_timespec</a>&amp; time) : time_(time) {}</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a2f952629962fc23855496ac08a70f6e2"> 55</a></span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a2f952629962fc23855496ac08a70f6e2">raw_time</a>() { <span class="keywordflow">return</span> time_; }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a> time_;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</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="comment">// namespace grpc</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment">// from and to should be absolute time.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacegrpc.html#a4e160d3739280d51ec130ab1bb1c549c">Timepoint2Timespec</a>(<span class="keyword">const</span> std::chrono::system_clock::time_point&amp; from,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a>* to);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacegrpc.html#a8b3b542af97e1ae35f327c7095d98369">TimepointHR2Timespec</a>(</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> std::chrono::high_resolution_clock::time_point&amp; from,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a>* to);</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;std::chrono::system_clock::time_point <a class="code" href="namespacegrpc.html#a12896f279762d0100669da708d466ec1">Timespec2Timepoint</a>(<a class="code" href="structgpr__timespec.html">gpr_timespec</a> t);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html"> 75</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_time_point.html">TimePoint</a>&lt;<a class="code" href="namespacestd.html">std</a>::chrono::system_clock::time_point&gt; {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// NOLINTNEXTLINE(google-explicit-constructor)</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#ad4276af3251c142fbe7f161391609d4f"> 78</a></span>&#160; <a class="code" href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#ad4276af3251c142fbe7f161391609d4f">TimePoint</a>(<span class="keyword">const</span> std::chrono::system_clock::time_point&amp; time) {</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="namespacegrpc.html#a4e160d3739280d51ec130ab1bb1c549c">Timepoint2Timespec</a>(time, &amp;time_);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#a5fb9d3f35f2435c455b23c3a9a4f4465"> 81</a></span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#a5fb9d3f35f2435c455b23c3a9a4f4465">raw_time</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> time_; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="structgpr__timespec.html">gpr_timespec</a> time_;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;} <span class="comment">// namespace grpc</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif // GRPCPP_SUPPORT_TIME_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4_html_ad4276af3251c142fbe7f161391609d4f"><div class="ttname"><a href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#ad4276af3251c142fbe7f161391609d4f">grpc::TimePoint&lt; std::chrono::system_clock::time_point &gt;::TimePoint</a></div><div class="ttdeci">TimePoint(const std::chrono::system_clock::time_point &amp;time)</div><div class="ttdef"><b>Definition:</b> time.h:78</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4_html_a5fb9d3f35f2435c455b23c3a9a4f4465"><div class="ttname"><a href="classgrpc_1_1_time_point_3_01std_1_1chrono_1_1system__clock_1_1time__point_01_4.html#a5fb9d3f35f2435c455b23c3a9a4f4465">grpc::TimePoint&lt; std::chrono::system_clock::time_point &gt;::raw_time</a></div><div class="ttdeci">gpr_timespec raw_time() const</div><div class="ttdef"><b>Definition:</b> time.h:81</div></div>
<div class="ttc" id="agrpc__types_8h_html"><div class="ttname"><a href="grpc__types_8h.html">grpc_types.h</a></div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_3_01gpr__timespec_01_4_html_a092aa1afe85bf73a10bf906bb9924007"><div class="ttname"><a href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a092aa1afe85bf73a10bf906bb9924007">grpc::TimePoint&lt; gpr_timespec &gt;::TimePoint</a></div><div class="ttdeci">TimePoint(const gpr_timespec &amp;time)</div><div class="ttdef"><b>Definition:</b> time.h:54</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_html_aefaca2a1ef33585bed428bc21810221a"><div class="ttname"><a href="classgrpc_1_1_time_point.html#aefaca2a1ef33585bed428bc21810221a">grpc::TimePoint::raw_time</a></div><div class="ttdeci">gpr_timespec raw_time()=delete</div></div>
<div class="ttc" id="agrpcpp_2support_2config_8h_html"><div class="ttname"><a href="grpcpp_2support_2config_8h.html">config.h</a></div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> async_unary_call.h:405</div></div>
<div class="ttc" id="anamespacegrpc_html_a4e160d3739280d51ec130ab1bb1c549c"><div class="ttname"><a href="namespacegrpc.html#a4e160d3739280d51ec130ab1bb1c549c">grpc::Timepoint2Timespec</a></div><div class="ttdeci">void Timepoint2Timespec(const std::chrono::system_clock::time_point &amp;from, gpr_timespec *to)</div></div>
<div class="ttc" id="anamespacegrpc_html_a8b3b542af97e1ae35f327c7095d98369"><div class="ttname"><a href="namespacegrpc.html#a8b3b542af97e1ae35f327c7095d98369">grpc::TimepointHR2Timespec</a></div><div class="ttdeci">void TimepointHR2Timespec(const std::chrono::high_resolution_clock::time_point &amp;from, gpr_timespec *to)</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_3_01gpr__timespec_01_4_html_a2f952629962fc23855496ac08a70f6e2"><div class="ttname"><a href="classgrpc_1_1_time_point_3_01gpr__timespec_01_4.html#a2f952629962fc23855496ac08a70f6e2">grpc::TimePoint&lt; gpr_timespec &gt;::raw_time</a></div><div class="ttdeci">gpr_timespec raw_time()</div><div class="ttdef"><b>Definition:</b> time.h:55</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_html_aaac94307837ed2b54e9ddbf459265fb4"><div class="ttname"><a href="classgrpc_1_1_time_point.html#aaac94307837ed2b54e9ddbf459265fb4">grpc::TimePoint::TimePoint</a></div><div class="ttdeci">TimePoint(const T &amp;)=delete</div></div>
<div class="ttc" id="astructgpr__timespec_html"><div class="ttname"><a href="structgpr__timespec.html">gpr_timespec</a></div><div class="ttdoc">Analogous to struct timespec.</div><div class="ttdef"><b>Definition:</b> time.h:48</div></div>
<div class="ttc" id="anamespacegrpc_html_a12896f279762d0100669da708d466ec1"><div class="ttname"><a href="namespacegrpc.html#a12896f279762d0100669da708d466ec1">grpc::Timespec2Timepoint</a></div><div class="ttdeci">std::chrono::system_clock::time_point Timespec2Timepoint(gpr_timespec t)</div></div>
<div class="ttc" id="aclassgrpc_1_1_time_point_html"><div class="ttname"><a href="classgrpc_1_1_time_point.html">grpc::TimePoint</a></div><div class="ttdoc">If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec ...</div><div class="ttdef"><b>Definition:</b> time.h:40</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 6 2023 16:09:16 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>