classgrpc__impl_1_1_alarm.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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_impl::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.32.0</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_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_impl::Alarm Class Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><code>#include &lt;<a class="el" href="alarm__impl_8h_source.html">alarm_impl.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__impl_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__impl_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__impl_1_1_alarm.html">Alarm</a> when they are no longer experimental. <a href="classgrpc__impl_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:a7af4a0f577608f5ddd208cc7b85b500b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a7af4a0f577608f5ddd208cc7b85b500b">Alarm</a> ()</td></tr>
  85. <tr class="memdesc:a7af4a0f577608f5ddd208cc7b85b500b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an unset completion queue alarm. <a href="classgrpc__impl_1_1_alarm.html#a7af4a0f577608f5ddd208cc7b85b500b">More...</a><br /></td></tr>
  86. <tr class="separator:a7af4a0f577608f5ddd208cc7b85b500b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a9f34dc0e71a9ff3a59e8eb2437cd16b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a9f34dc0e71a9ff3a59e8eb2437cd16b5">~Alarm</a> ()</td></tr>
  88. <tr class="memdesc:a9f34dc0e71a9ff3a59e8eb2437cd16b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the given completion queue alarm, cancelling it in the process. <a href="classgrpc__impl_1_1_alarm.html#a9f34dc0e71a9ff3a59e8eb2437cd16b5">More...</a><br /></td></tr>
  89. <tr class="separator:a9f34dc0e71a9ff3a59e8eb2437cd16b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aec1e4de4038eaac76c5cf29db1ec6b58"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  91. <tr class="memitem:aec1e4de4038eaac76c5cf29db1ec6b58"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#aec1e4de4038eaac76c5cf29db1ec6b58">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:aec1e4de4038eaac76c5cf29db1ec6b58"><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__impl_1_1_alarm.html#aec1e4de4038eaac76c5cf29db1ec6b58">More...</a><br /></td></tr>
  93. <tr class="separator:aec1e4de4038eaac76c5cf29db1ec6b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a4b6abc2040ec07dd2450d0b143a55de0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  95. <tr class="memitem:a4b6abc2040ec07dd2450d0b143a55de0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a4b6abc2040ec07dd2450d0b143a55de0">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:a4b6abc2040ec07dd2450d0b143a55de0"><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__impl_1_1_alarm.html#a4b6abc2040ec07dd2450d0b143a55de0">More...</a><br /></td></tr>
  97. <tr class="separator:a4b6abc2040ec07dd2450d0b143a55de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a98b656ff248f7d1b9334414a4d2369cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a98b656ff248f7d1b9334414a4d2369cb">Alarm</a> (const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;)=delete</td></tr>
  99. <tr class="memdesc:a98b656ff248f7d1b9334414a4d2369cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms aren't copyable. <a href="classgrpc__impl_1_1_alarm.html#a98b656ff248f7d1b9334414a4d2369cb">More...</a><br /></td></tr>
  100. <tr class="separator:a98b656ff248f7d1b9334414a4d2369cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a2e71001938604857ce0438c885783990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a2e71001938604857ce0438c885783990">operator=</a> (const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;)=delete</td></tr>
  102. <tr class="separator:a2e71001938604857ce0438c885783990"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a948bd33b5f3f065e2532bf61d1466e4a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a948bd33b5f3f065e2532bf61d1466e4a">Alarm</a> (<a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;rhs)</td></tr>
  104. <tr class="memdesc:a948bd33b5f3f065e2532bf61d1466e4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms are movable. <a href="classgrpc__impl_1_1_alarm.html#a948bd33b5f3f065e2532bf61d1466e4a">More...</a><br /></td></tr>
  105. <tr class="separator:a948bd33b5f3f065e2532bf61d1466e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5c2d1cebe5e00484c574790ea4a80e76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#a5c2d1cebe5e00484c574790ea4a80e76">operator=</a> (<a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;rhs)</td></tr>
  107. <tr class="separator:a5c2d1cebe5e00484c574790ea4a80e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ae4b896bac8b48c12f95335ae8b468e4e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#ae4b896bac8b48c12f95335ae8b468e4e">Cancel</a> ()</td></tr>
  109. <tr class="memdesc:ae4b896bac8b48c12f95335ae8b468e4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel a completion queue alarm. <a href="classgrpc__impl_1_1_alarm.html#ae4b896bac8b48c12f95335ae8b468e4e">More...</a><br /></td></tr>
  110. <tr class="separator:ae4b896bac8b48c12f95335ae8b468e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:af5560d86c711748eb684ed012608c4c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_alarm_1_1experimental__type.html">experimental_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html#af5560d86c711748eb684ed012608c4c3">experimental</a> ()</td></tr>
  112. <tr class="memdesc:af5560d86c711748eb684ed012608c4c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">NOTE: The function <a class="el" href="classgrpc__impl_1_1_alarm.html#af5560d86c711748eb684ed012608c4c3" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. <a href="classgrpc__impl_1_1_alarm.html#af5560d86c711748eb684ed012608c4c3">More...</a><br /></td></tr>
  113. <tr class="separator:af5560d86c711748eb684ed012608c4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a id="a7af4a0f577608f5ddd208cc7b85b500b"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#a7af4a0f577608f5ddd208cc7b85b500b">&#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_impl::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="a9f34dc0e71a9ff3a59e8eb2437cd16b5"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a9f34dc0e71a9ff3a59e8eb2437cd16b5">&#9670;&nbsp;</a></span>~Alarm()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">grpc_impl::Alarm::~Alarm </td>
  139. <td>(</td>
  140. <td class="paramname"></td><td>)</td>
  141. <td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>Destroy the given completion queue alarm, cancelling it in the process. </p>
  146. </div>
  147. </div>
  148. <a id="aec1e4de4038eaac76c5cf29db1ec6b58"></a>
  149. <h2 class="memtitle"><span class="permalink"><a href="#aec1e4de4038eaac76c5cf29db1ec6b58">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[2/4]</span></h2>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <div class="memtemplate">
  153. template&lt;typename T &gt; </div>
  154. <table class="mlabels">
  155. <tr>
  156. <td class="mlabels-left">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">grpc_impl::Alarm::Alarm </td>
  160. <td>(</td>
  161. <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *&#160;</td>
  162. <td class="paramname"><em>cq</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">const T &amp;&#160;</td>
  168. <td class="paramname"><em>deadline</em>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype">void *&#160;</td>
  174. <td class="paramname"><em>tag</em>&#160;</td>
  175. </tr>
  176. <tr>
  177. <td></td>
  178. <td>)</td>
  179. <td></td><td></td>
  180. </tr>
  181. </table>
  182. </td>
  183. <td class="mlabels-right">
  184. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>. </p>
  189. <p>This form is deprecated because it is inherently racy.</p>
  190. </div>
  191. </div>
  192. <a id="a98b656ff248f7d1b9334414a4d2369cb"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a98b656ff248f7d1b9334414a4d2369cb">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[3/4]</span></h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">grpc_impl::Alarm::Alarm </td>
  202. <td>(</td>
  203. <td class="paramtype">const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  204. <td class="paramname"></td><td>)</td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Alarms aren't copyable. </p>
  215. </div>
  216. </div>
  217. <a id="a948bd33b5f3f065e2532bf61d1466e4a"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#a948bd33b5f3f065e2532bf61d1466e4a">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[4/4]</span></h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">grpc_impl::Alarm::Alarm </td>
  227. <td>(</td>
  228. <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  229. <td class="paramname"><em>rhs</em></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>Alarms are movable. </p>
  240. </div>
  241. </div>
  242. <h2 class="groupheader">Member Function Documentation</h2>
  243. <a id="ae4b896bac8b48c12f95335ae8b468e4e"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#ae4b896bac8b48c12f95335ae8b468e4e">&#9670;&nbsp;</a></span>Cancel()</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">void grpc_impl::Alarm::Cancel </td>
  250. <td>(</td>
  251. <td class="paramname"></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Cancel a completion queue alarm. </p>
  257. <p>Calling this function over an alarm that has already fired has no effect. </p>
  258. </div>
  259. </div>
  260. <a id="af5560d86c711748eb684ed012608c4c3"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#af5560d86c711748eb684ed012608c4c3">&#9670;&nbsp;</a></span>experimental()</h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm_1_1experimental__type.html">experimental_type</a> grpc_impl::Alarm::experimental </td>
  270. <td>(</td>
  271. <td class="paramname"></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>NOTE: The function <a class="el" href="classgrpc__impl_1_1_alarm.html#af5560d86c711748eb684ed012608c4c3" title="NOTE: The function experimental() is not stable public API.">experimental()</a> is not stable public API. </p>
  282. <p>It is a view to the experimental components of this class. It may be changed or removed at any time. </p>
  283. </div>
  284. </div>
  285. <a id="a5c2d1cebe5e00484c574790ea4a80e76"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#a5c2d1cebe5e00484c574790ea4a80e76">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="mlabels">
  290. <tr>
  291. <td class="mlabels-left">
  292. <table class="memname">
  293. <tr>
  294. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a>&amp; grpc_impl::Alarm::operator= </td>
  295. <td>(</td>
  296. <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  297. <td class="paramname"><em>rhs</em></td><td>)</td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. </div>
  308. </div>
  309. <a id="a2e71001938604857ce0438c885783990"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#a2e71001938604857ce0438c885783990">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="mlabels">
  314. <tr>
  315. <td class="mlabels-left">
  316. <table class="memname">
  317. <tr>
  318. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a>&amp; grpc_impl::Alarm::operator= </td>
  319. <td>(</td>
  320. <td class="paramtype">const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  321. <td class="paramname"></td><td>)</td>
  322. <td></td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. </div>
  332. </div>
  333. <a id="a4b6abc2040ec07dd2450d0b143a55de0"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#a4b6abc2040ec07dd2450d0b143a55de0">&#9670;&nbsp;</a></span>Set()</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <div class="memtemplate">
  338. template&lt;typename T &gt; </div>
  339. <table class="mlabels">
  340. <tr>
  341. <td class="mlabels-left">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">void grpc_impl::Alarm::Set </td>
  345. <td>(</td>
  346. <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *&#160;</td>
  347. <td class="paramname"><em>cq</em>, </td>
  348. </tr>
  349. <tr>
  350. <td class="paramkey"></td>
  351. <td></td>
  352. <td class="paramtype">const T &amp;&#160;</td>
  353. <td class="paramname"><em>deadline</em>, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">void *&#160;</td>
  359. <td class="paramname"><em>tag</em>&#160;</td>
  360. </tr>
  361. <tr>
  362. <td></td>
  363. <td>)</td>
  364. <td></td><td></td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Trigger an alarm instance on completion queue <em>cq</em> at the specified time. </p>
  374. <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>
  375. </div>
  376. </div>
  377. <hr/>The documentation for this class was generated from the following file:<ul>
  378. <li>include/grpcpp/<a class="el" href="alarm__impl_8h_source.html">alarm_impl.h</a></li>
  379. </ul>
  380. </div><!-- contents -->
  381. <!-- start footer part -->
  382. <hr class="footer"/><address class="footer"><small>
  383. Generated on Sat Sep 12 2020 00:53:57 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  384. <img class="footer" src="doxygen.png" alt="doxygen"/>
  385. </a> 1.8.17
  386. </small></address>
  387. </body>
  388. </html>