grpcpp_2alarm_8h_source.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpcpp/alarm.h Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">alarm.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="grpcpp_2alarm_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>
  72. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  73. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015 gRPC authors.</span></div>
  74. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  75. <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>
  76. <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>
  77. <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>
  78. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  79. <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>
  80. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
  81. <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>
  82. <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>
  83. <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>
  84. <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>
  85. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
  86. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
  87. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  88. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  89. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef GRPCPP_ALARM_H</span></div>
  90. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define GRPCPP_ALARM_H</span></div>
  91. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  92. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
  93. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  94. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc_8h.html">grpc/grpc.h</a>&gt;</span></div>
  95. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2completion__queue_8h.html">grpcpp/impl/codegen/completion_queue.h</a>&gt;</span></div>
  96. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2completion__queue__tag_8h.html">grpcpp/impl/codegen/completion_queue_tag.h</a>&gt;</span></div>
  97. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2grpc__library_8h.html">grpcpp/impl/codegen/grpc_library.h</a>&gt;</span></div>
  98. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2time_8h.html">grpcpp/impl/codegen/time.h</a>&gt;</span></div>
  99. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2grpc__library_8h.html">grpcpp/impl/grpc_library.h</a>&gt;</span></div>
  100. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  101. <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacegrpc.html"> 33</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
  102. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
  103. <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_alarm.html">Alarm</a> : <span class="keyword">private</span> <a class="code" href="classgrpc_1_1_grpc_library_codegen.html">::grpc::GrpcLibraryCodegen</a> {</div>
  104. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">public</span>:</div>
  105. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classgrpc_1_1_alarm.html#a49ce7f2934d753389bd192574c509302">Alarm</a>();</div>
  106. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
  107. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classgrpc_1_1_alarm.html#a6c20836a5cd364d77e69e1fa5db58a61">~Alarm</a>() <span class="keyword">override</span>;</div>
  108. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
  109. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
  110. <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html#a5d6a1d58b1c1ba695f0633fb402ad7f3"> 51</a></span>&#160; <a class="code" href="classgrpc_1_1_alarm.html#a5d6a1d58b1c1ba695f0633fb402ad7f3">Alarm</a>(::<a class="code" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a>* cq, <span class="keyword">const</span> T&amp; deadline, <span class="keywordtype">void</span>* tag) : <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>() {</div>
  111. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; SetInternal(cq, ::<a class="code" href="classgrpc_1_1_time_point.html">grpc::TimePoint&lt;T&gt;</a>(deadline).raw_time(), tag);</div>
  112. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
  113. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
  114. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
  115. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110"> 60</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110">Set</a>(::<a class="code" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a>* cq, <span class="keyword">const</span> T&amp; deadline, <span class="keywordtype">void</span>* tag) {</div>
  116. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; SetInternal(cq, ::<a class="code" href="classgrpc_1_1_time_point.html">grpc::TimePoint&lt;T&gt;</a>(deadline).raw_time(), tag);</div>
  117. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div>
  118. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
  119. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="classgrpc_1_1_alarm.html#a49ce7f2934d753389bd192574c509302">Alarm</a>(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp;) = <span class="keyword">delete</span>;</div>
  120. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; <a class="code" href="classgrpc_1_1_alarm.html#a4c46dacfd26561470f0901cec2686f49">operator=</a>(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp;) = <span class="keyword">delete</span>;</div>
  121. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
  122. <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html#a6117d8709dc1468d0111f29abb84aa6d"> 69</a></span>&#160; <a class="code" href="classgrpc_1_1_alarm.html#a6117d8709dc1468d0111f29abb84aa6d">Alarm</a>(<a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp;&amp; rhs) noexcept : alarm_(rhs.alarm_) { rhs.alarm_ = <span class="keyword">nullptr</span>; }</div>
  123. <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html#ac17293fbf6f3a256e743c55ce66eac00"> 70</a></span>&#160; <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; <a class="code" href="classgrpc_1_1_alarm.html#ac17293fbf6f3a256e743c55ce66eac00">operator=</a>(<a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>&amp;&amp; rhs) noexcept {</div>
  124. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; alarm_ = rhs.alarm_;</div>
  125. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; rhs.alarm_ = <span class="keyword">nullptr</span>;</div>
  126. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
  127. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
  128. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
  129. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_alarm.html#a57837c6b6d75f622c056b3050cf000fb">Cancel</a>();</div>
  130. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
  131. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#ifdef GRPC_CALLBACK_API_NONEXPERIMENTAL</span></div>
  132. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
  133. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110">Set</a>(<span class="keyword">const</span> T&amp; deadline, std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">bool</span>)&gt; f) {</div>
  134. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; SetInternal(::<a class="code" href="classgrpc_1_1_time_point.html">grpc::TimePoint&lt;T&gt;</a>(deadline).raw_time(), std::move(f));</div>
  135. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
  136. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif</span></div>
  137. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
  138. <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm_1_1experimental__type.html"> 93</a></span>&#160; <span class="keyword">class </span><a class="code" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a> {</div>
  139. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">public</span>:</div>
  140. <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm_1_1experimental__type.html#a557856f03a8cb5f854e855fad8a545a1"> 95</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classgrpc_1_1_alarm_1_1experimental__type.html#a557856f03a8cb5f854e855fad8a545a1">experimental_type</a>(<a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>* alarm) : alarm_(alarm) {}</div>
  141. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
  142. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
  143. <div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm_1_1experimental__type.html#a44d38dda62537eedafcd453a04e2d274"> 101</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_alarm_1_1experimental__type.html#a44d38dda62537eedafcd453a04e2d274">Set</a>(<span class="keyword">const</span> T&amp; deadline, std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">bool</span>)&gt; f) {</div>
  144. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; alarm_-&gt;SetInternal(::<a class="code" href="classgrpc_1_1_time_point.html">grpc::TimePoint&lt;T&gt;</a>(deadline).raw_time(),</div>
  145. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; std::move(f));</div>
  146. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div>
  147. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
  148. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">private</span>:</div>
  149. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <a class="code" href="classgrpc_1_1_alarm.html">Alarm</a>* alarm_;</div>
  150. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; };</div>
  151. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
  152. <div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7"> 113</a></span>&#160; <a class="code" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a> <a class="code" href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7">experimental</a>() { <span class="keywordflow">return</span> <a class="code" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a>(<span class="keyword">this</span>); }</div>
  153. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
  154. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">private</span>:</div>
  155. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">void</span> SetInternal(::<a class="code" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a>* cq, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> deadline,</div>
  156. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordtype">void</span>* tag);</div>
  157. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">void</span> SetInternal(<a class="code" href="structgpr__timespec.html">gpr_timespec</a> deadline, std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">bool</span>)&gt; f);</div>
  158. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
  159. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="classgrpc_1_1internal_1_1_completion_queue_tag.html">::grpc::internal::CompletionQueueTag</a>* alarm_;</div>
  160. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;};</div>
  161. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
  162. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;} <span class="comment">// namespace grpc</span></div>
  163. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
  164. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif // GRPCPP_ALARM_H</span></div>
  165. </div><!-- fragment --></div><!-- contents -->
  166. <div class="ttc" id="aclassgrpc_1_1_grpc_library_codegen_html"><div class="ttname"><a href="classgrpc_1_1_grpc_library_codegen.html">grpc::GrpcLibraryCodegen</a></div><div class="ttdoc">Classes that require gRPC to be initialized should inherit from this class.</div><div class="ttdef"><b>Definition:</b> grpc_library.h:38</div></div>
  167. <div class="ttc" id="agrpcpp_2impl_2codegen_2time_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2time_8h.html">time.h</a></div></div>
  168. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a4c46dacfd26561470f0901cec2686f49"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a4c46dacfd26561470f0901cec2686f49">grpc::Alarm::operator=</a></div><div class="ttdeci">Alarm &amp; operator=(const Alarm &amp;)=delete</div></div>
  169. <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>
  170. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a6117d8709dc1468d0111f29abb84aa6d"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a6117d8709dc1468d0111f29abb84aa6d">grpc::Alarm::Alarm</a></div><div class="ttdeci">Alarm(Alarm &amp;&amp;rhs) noexcept</div><div class="ttdoc">Alarms are movable.</div><div class="ttdef"><b>Definition:</b> alarm.h:69</div></div>
  171. <div class="ttc" id="aclassgrpc_1_1_alarm_html_ac17293fbf6f3a256e743c55ce66eac00"><div class="ttname"><a href="classgrpc_1_1_alarm.html#ac17293fbf6f3a256e743c55ce66eac00">grpc::Alarm::operator=</a></div><div class="ttdeci">Alarm &amp; operator=(Alarm &amp;&amp;rhs) noexcept</div><div class="ttdef"><b>Definition:</b> alarm.h:70</div></div>
  172. <div class="ttc" id="aclassgrpc_1_1_alarm_html_abb9d93f77976356ddf8b79963be2c110"><div class="ttname"><a href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110">grpc::Alarm::Set</a></div><div class="ttdeci">void Set(::grpc::CompletionQueue *cq, const T &amp;deadline, void *tag)</div><div class="ttdoc">Trigger an alarm instance on completion queue cq at the specified time.</div><div class="ttdef"><b>Definition:</b> alarm.h:60</div></div>
  173. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a57837c6b6d75f622c056b3050cf000fb"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a57837c6b6d75f622c056b3050cf000fb">grpc::Alarm::Cancel</a></div><div class="ttdeci">void Cancel()</div><div class="ttdoc">Cancel a completion queue alarm.</div></div>
  174. <div class="ttc" id="agrpc_8h_html"><div class="ttname"><a href="grpc_8h.html">grpc.h</a></div></div>
  175. <div class="ttc" id="agrpcpp_2impl_2codegen_2completion__queue__tag_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2completion__queue__tag_8h.html">completion_queue_tag.h</a></div></div>
  176. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a49ce7f2934d753389bd192574c509302"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a49ce7f2934d753389bd192574c509302">grpc::Alarm::Alarm</a></div><div class="ttdeci">Alarm()</div><div class="ttdoc">Create an unset completion queue alarm.</div></div>
  177. <div class="ttc" id="aclassgrpc_1_1_alarm_1_1experimental__type_html"><div class="ttname"><a href="classgrpc_1_1_alarm_1_1experimental__type.html">grpc::Alarm::experimental_type</a></div><div class="ttdoc">NOTE: class experimental_type is not part of the public API of this class TODO(vjpai): Move these con...</div><div class="ttdef"><b>Definition:</b> alarm.h:93</div></div>
  178. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a8077a15a877dc22b4e2138960b678ab7"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7">grpc::Alarm::experimental</a></div><div class="ttdeci">experimental_type experimental()</div><div class="ttdoc">NOTE: The function experimental() is not stable public API.</div><div class="ttdef"><b>Definition:</b> alarm.h:113</div></div>
  179. <div class="ttc" id="aclassgrpc_1_1_alarm_html"><div class="ttname"><a href="classgrpc_1_1_alarm.html">grpc::Alarm</a></div><div class="ttdef"><b>Definition:</b> alarm.h:35</div></div>
  180. <div class="ttc" id="aclassgrpc_1_1internal_1_1_completion_queue_tag_html"><div class="ttname"><a href="classgrpc_1_1internal_1_1_completion_queue_tag.html">grpc::internal::CompletionQueueTag</a></div><div class="ttdoc">An interface allowing implementors to process and filter event tags.</div><div class="ttdef"><b>Definition:</b> completion_queue_tag.h:26</div></div>
  181. <div class="ttc" id="aclassgrpc_1_1_alarm_1_1experimental__type_html_a557856f03a8cb5f854e855fad8a545a1"><div class="ttname"><a href="classgrpc_1_1_alarm_1_1experimental__type.html#a557856f03a8cb5f854e855fad8a545a1">grpc::Alarm::experimental_type::experimental_type</a></div><div class="ttdeci">experimental_type(Alarm *alarm)</div><div class="ttdef"><b>Definition:</b> alarm.h:95</div></div>
  182. <div class="ttc" id="agrpcpp_2impl_2codegen_2grpc__library_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2grpc__library_8h.html">grpc_library.h</a></div></div>
  183. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a6c20836a5cd364d77e69e1fa5db58a61"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a6c20836a5cd364d77e69e1fa5db58a61">grpc::Alarm::~Alarm</a></div><div class="ttdeci">~Alarm() override</div><div class="ttdoc">Destroy the given completion queue alarm, cancelling it in the process.</div></div>
  184. <div class="ttc" id="agrpcpp_2impl_2grpc__library_8h_html"><div class="ttname"><a href="grpcpp_2impl_2grpc__library_8h.html">grpc_library.h</a></div></div>
  185. <div class="ttc" id="aclassgrpc_1_1_completion_queue_html"><div class="ttname"><a href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a></div><div class="ttdoc">A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....</div><div class="ttdef"><b>Definition:</b> completion_queue.h:102</div></div>
  186. <div class="ttc" id="aclassgrpc_1_1_alarm_1_1experimental__type_html_a44d38dda62537eedafcd453a04e2d274"><div class="ttname"><a href="classgrpc_1_1_alarm_1_1experimental__type.html#a44d38dda62537eedafcd453a04e2d274">grpc::Alarm::experimental_type::Set</a></div><div class="ttdeci">void Set(const T &amp;deadline, std::function&lt; void(bool)&gt; f)</div><div class="ttdoc">Set an alarm to invoke callback f.</div><div class="ttdef"><b>Definition:</b> alarm.h:101</div></div>
  187. <div class="ttc" id="agrpcpp_2impl_2codegen_2completion__queue_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2completion__queue_8h.html">completion_queue.h</a></div></div>
  188. <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> gpr_types.h:47</div></div>
  189. <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>
  190. <div class="ttc" id="aclassgrpc_1_1_alarm_html_a5d6a1d58b1c1ba695f0633fb402ad7f3"><div class="ttname"><a href="classgrpc_1_1_alarm.html#a5d6a1d58b1c1ba695f0633fb402ad7f3">grpc::Alarm::Alarm</a></div><div class="ttdeci">Alarm(::grpc::CompletionQueue *cq, const T &amp;deadline, void *tag)</div><div class="ttdoc">DEPRECATED: Create and set a completion queue alarm instance associated to cq.</div><div class="ttdef"><b>Definition:</b> alarm.h:51</div></div>
  191. <!-- start footer part -->
  192. <hr class="footer"/><address class="footer"><small>
  193. Generated on Wed Mar 3 2021 19:17:17 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  194. <img class="footer" src="doxygen.png" alt="doxygen"/>
  195. </a> 1.8.17
  196. </small></address>
  197. </body>
  198. </html>