classgrpc_1_1_alarm.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  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++: grpc::Alarm Class Reference</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="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#pub-methods">Public Member Functions</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::Alarm Class Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><code>#include &lt;<a class="el" href="grpcpp_2alarm_8h_source.html">alarm.h</a>&gt;</code></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  77. Data Structures</h2></td></tr>
  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a></td></tr>
  79. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">NOTE: class <a class="el" href="classgrpc_1_1_alarm_1_1experimental__type.html" title="NOTE: class experimental_type is not part of the public API of this class TODO(vjpai): Move these con...">experimental_type</a> is not part of the public API of this class TODO(vjpai): Move these contents to the public API of <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> when they are no longer experimental. <a href="classgrpc_1_1_alarm_1_1experimental__type.html#details">More...</a><br /></td></tr>
  80. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table><table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a49ce7f2934d753389bd192574c509302"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a49ce7f2934d753389bd192574c509302">Alarm</a> ()</td></tr>
  85. <tr class="memdesc:a49ce7f2934d753389bd192574c509302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an unset completion queue alarm. <a href="classgrpc_1_1_alarm.html#a49ce7f2934d753389bd192574c509302">More...</a><br /></td></tr>
  86. <tr class="separator:a49ce7f2934d753389bd192574c509302"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a6c20836a5cd364d77e69e1fa5db58a61"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a6c20836a5cd364d77e69e1fa5db58a61">~Alarm</a> () override</td></tr>
  88. <tr class="memdesc:a6c20836a5cd364d77e69e1fa5db58a61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the given completion queue alarm, cancelling it in the process. <a href="classgrpc_1_1_alarm.html#a6c20836a5cd364d77e69e1fa5db58a61">More...</a><br /></td></tr>
  89. <tr class="separator:a6c20836a5cd364d77e69e1fa5db58a61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a5d6a1d58b1c1ba695f0633fb402ad7f3"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  91. <tr class="memitem:a5d6a1d58b1c1ba695f0633fb402ad7f3"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a5d6a1d58b1c1ba695f0633fb402ad7f3">Alarm</a> (::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
  92. <tr class="memdesc:a5d6a1d58b1c1ba695f0633fb402ad7f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>. <a href="classgrpc_1_1_alarm.html#a5d6a1d58b1c1ba695f0633fb402ad7f3">More...</a><br /></td></tr>
  93. <tr class="separator:a5d6a1d58b1c1ba695f0633fb402ad7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:abb9d93f77976356ddf8b79963be2c110"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  95. <tr class="memitem:abb9d93f77976356ddf8b79963be2c110"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110">Set</a> (::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
  96. <tr class="memdesc:abb9d93f77976356ddf8b79963be2c110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger an alarm instance on completion queue <em>cq</em> at the specified time. <a href="classgrpc_1_1_alarm.html#abb9d93f77976356ddf8b79963be2c110">More...</a><br /></td></tr>
  97. <tr class="separator:abb9d93f77976356ddf8b79963be2c110"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:aea1258cecd23533bf292f17b71124f66"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#aea1258cecd23533bf292f17b71124f66">Alarm</a> (const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;)=delete</td></tr>
  99. <tr class="memdesc:aea1258cecd23533bf292f17b71124f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms aren't copyable. <a href="classgrpc_1_1_alarm.html#aea1258cecd23533bf292f17b71124f66">More...</a><br /></td></tr>
  100. <tr class="separator:aea1258cecd23533bf292f17b71124f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a4c46dacfd26561470f0901cec2686f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a4c46dacfd26561470f0901cec2686f49">operator=</a> (const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;)=delete</td></tr>
  102. <tr class="separator:a4c46dacfd26561470f0901cec2686f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a6117d8709dc1468d0111f29abb84aa6d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a6117d8709dc1468d0111f29abb84aa6d">Alarm</a> (<a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;rhs) noexcept</td></tr>
  104. <tr class="memdesc:a6117d8709dc1468d0111f29abb84aa6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms are movable. <a href="classgrpc_1_1_alarm.html#a6117d8709dc1468d0111f29abb84aa6d">More...</a><br /></td></tr>
  105. <tr class="separator:a6117d8709dc1468d0111f29abb84aa6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ac17293fbf6f3a256e743c55ce66eac00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#ac17293fbf6f3a256e743c55ce66eac00">operator=</a> (<a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;rhs) noexcept</td></tr>
  107. <tr class="separator:ac17293fbf6f3a256e743c55ce66eac00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a57837c6b6d75f622c056b3050cf000fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a57837c6b6d75f622c056b3050cf000fb">Cancel</a> ()</td></tr>
  109. <tr class="memdesc:a57837c6b6d75f622c056b3050cf000fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel a completion queue alarm. <a href="classgrpc_1_1_alarm.html#a57837c6b6d75f622c056b3050cf000fb">More...</a><br /></td></tr>
  110. <tr class="separator:a57837c6b6d75f622c056b3050cf000fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a8077a15a877dc22b4e2138960b678ab7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7">experimental</a> ()</td></tr>
  112. <tr class="memdesc:a8077a15a877dc22b4e2138960b678ab7"><td class="mdescLeft">&#160;</td><td class="mdescRight">NOTE: The function <a class="el" href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. <a href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7">More...</a><br /></td></tr>
  113. <tr class="separator:a8077a15a877dc22b4e2138960b678ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a id="a49ce7f2934d753389bd192574c509302"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#a49ce7f2934d753389bd192574c509302">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[1/4]</span></h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">grpc::Alarm::Alarm </td>
  123. <td>(</td>
  124. <td class="paramname"></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Create an unset completion queue alarm. </p>
  130. </div>
  131. </div>
  132. <a id="a6c20836a5cd364d77e69e1fa5db58a61"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a6c20836a5cd364d77e69e1fa5db58a61">&#9670;&nbsp;</a></span>~Alarm()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">grpc::Alarm::~Alarm </td>
  142. <td>(</td>
  143. <td class="paramname"></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Destroy the given completion queue alarm, cancelling it in the process. </p>
  154. </div>
  155. </div>
  156. <a id="a5d6a1d58b1c1ba695f0633fb402ad7f3"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#a5d6a1d58b1c1ba695f0633fb402ad7f3">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[2/4]</span></h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <div class="memtemplate">
  161. template&lt;typename T &gt; </div>
  162. <table class="mlabels">
  163. <tr>
  164. <td class="mlabels-left">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">grpc::Alarm::Alarm </td>
  168. <td>(</td>
  169. <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *&#160;</td>
  170. <td class="paramname"><em>cq</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">const T &amp;&#160;</td>
  176. <td class="paramname"><em>deadline</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">void *&#160;</td>
  182. <td class="paramname"><em>tag</em>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>. </p>
  197. <p>This form is deprecated because it is inherently racy.</p>
  198. </div>
  199. </div>
  200. <a id="aea1258cecd23533bf292f17b71124f66"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#aea1258cecd23533bf292f17b71124f66">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[3/4]</span></h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">grpc::Alarm::Alarm </td>
  210. <td>(</td>
  211. <td class="paramtype">const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  212. <td class="paramname"></td><td>)</td>
  213. <td></td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Alarms aren't copyable. </p>
  223. </div>
  224. </div>
  225. <a id="a6117d8709dc1468d0111f29abb84aa6d"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a6117d8709dc1468d0111f29abb84aa6d">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[4/4]</span></h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">grpc::Alarm::Alarm </td>
  235. <td>(</td>
  236. <td class="paramtype"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  237. <td class="paramname"><em>rhs</em></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Alarms are movable. </p>
  248. </div>
  249. </div>
  250. <h2 class="groupheader">Member Function Documentation</h2>
  251. <a id="a57837c6b6d75f622c056b3050cf000fb"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a57837c6b6d75f622c056b3050cf000fb">&#9670;&nbsp;</a></span>Cancel()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">void grpc::Alarm::Cancel </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Cancel a completion queue alarm. </p>
  265. <p>Calling this function over an alarm that has already fired has no effect. </p>
  266. </div>
  267. </div>
  268. <a id="a8077a15a877dc22b4e2138960b678ab7"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#a8077a15a877dc22b4e2138960b678ab7">&#9670;&nbsp;</a></span>experimental()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="mlabels">
  273. <tr>
  274. <td class="mlabels-left">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="classgrpc_1_1_alarm_1_1experimental__type.html">experimental_type</a> grpc::Alarm::experimental </td>
  278. <td>(</td>
  279. <td class="paramname"></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>NOTE: The function <a class="el" href="classgrpc_1_1_alarm.html#a8077a15a877dc22b4e2138960b678ab7" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. </p>
  290. <p>It is a view to the experimental components of this class. It may be changed or removed at any time. </p>
  291. </div>
  292. </div>
  293. <a id="ac17293fbf6f3a256e743c55ce66eac00"></a>
  294. <h2 class="memtitle"><span class="permalink"><a href="#ac17293fbf6f3a256e743c55ce66eac00">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="mlabels">
  298. <tr>
  299. <td class="mlabels-left">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; grpc::Alarm::operator= </td>
  303. <td>(</td>
  304. <td class="paramtype"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  305. <td class="paramname"><em>rhs</em></td><td>)</td>
  306. <td></td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. </div>
  316. </div>
  317. <a id="a4c46dacfd26561470f0901cec2686f49"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#a4c46dacfd26561470f0901cec2686f49">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="mlabels">
  322. <tr>
  323. <td class="mlabels-left">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; grpc::Alarm::operator= </td>
  327. <td>(</td>
  328. <td class="paramtype">const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  329. <td class="paramname"></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. </div>
  340. </div>
  341. <a id="abb9d93f77976356ddf8b79963be2c110"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#abb9d93f77976356ddf8b79963be2c110">&#9670;&nbsp;</a></span>Set()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <div class="memtemplate">
  346. template&lt;typename T &gt; </div>
  347. <table class="mlabels">
  348. <tr>
  349. <td class="mlabels-left">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">void grpc::Alarm::Set </td>
  353. <td>(</td>
  354. <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *&#160;</td>
  355. <td class="paramname"><em>cq</em>, </td>
  356. </tr>
  357. <tr>
  358. <td class="paramkey"></td>
  359. <td></td>
  360. <td class="paramtype">const T &amp;&#160;</td>
  361. <td class="paramname"><em>deadline</em>, </td>
  362. </tr>
  363. <tr>
  364. <td class="paramkey"></td>
  365. <td></td>
  366. <td class="paramtype">void *&#160;</td>
  367. <td class="paramname"><em>tag</em>&#160;</td>
  368. </tr>
  369. <tr>
  370. <td></td>
  371. <td>)</td>
  372. <td></td><td></td>
  373. </tr>
  374. </table>
  375. </td>
  376. <td class="mlabels-right">
  377. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <p>Trigger an alarm instance on completion queue <em>cq</em> at the specified time. </p>
  382. <p>Once the alarm expires (at <em>deadline</em>) or it's cancelled (see <em>Cancel</em>), an event with tag <em>tag</em> will be added to <em>cq</em>. If the alarm expired, the event's success bit will be true, false otherwise (ie, upon cancellation). </p>
  383. </div>
  384. </div>
  385. <hr/>The documentation for this class was generated from the following file:<ul>
  386. <li>include/grpcpp/<a class="el" href="grpcpp_2alarm_8h_source.html">alarm.h</a></li>
  387. </ul>
  388. </div><!-- contents -->
  389. <!-- start footer part -->
  390. <hr class="footer"/><address class="footer"><small>
  391. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  392. <img class="footer" src="doxygen.png" alt="doxygen"/>
  393. </a> 1.8.17
  394. </small></address>
  395. </body>
  396. </html>