classgrpc__impl_1_1_alarm.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  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.23.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#nested-classes">Data Structures</a> &#124;
  66. <a href="#pub-methods">Public Member Functions</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc_impl::Alarm Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#include &lt;<a class="el" href="alarm__impl_8h_source.html">alarm_impl.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  74. Data Structures</h2></td></tr>
  75. <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>
  76. <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>
  77. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <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>
  82. <tr class="memdesc:a7af4a0f577608f5ddd208cc7b85b500b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an unset completion queue alarm. <a href="#a7af4a0f577608f5ddd208cc7b85b500b">More...</a><br /></td></tr>
  83. <tr class="separator:a7af4a0f577608f5ddd208cc7b85b500b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <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="#a9f34dc0e71a9ff3a59e8eb2437cd16b5">More...</a><br /></td></tr>
  86. <tr class="separator:a9f34dc0e71a9ff3a59e8eb2437cd16b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:aec1e4de4038eaac76c5cf29db1ec6b58"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  88. <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="namespacegrpc.html#a9b59ae504113bf341ba9d1ae404b0cda">grpc::CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
  89. <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="#aec1e4de4038eaac76c5cf29db1ec6b58">More...</a><br /></td></tr>
  90. <tr class="separator:aec1e4de4038eaac76c5cf29db1ec6b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a4b6abc2040ec07dd2450d0b143a55de0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  92. <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="namespacegrpc.html#a9b59ae504113bf341ba9d1ae404b0cda">grpc::CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
  93. <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="#a4b6abc2040ec07dd2450d0b143a55de0">More...</a><br /></td></tr>
  94. <tr class="separator:a4b6abc2040ec07dd2450d0b143a55de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="memdesc:a98b656ff248f7d1b9334414a4d2369cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms aren't copyable. <a href="#a98b656ff248f7d1b9334414a4d2369cb">More...</a><br /></td></tr>
  97. <tr class="separator:a98b656ff248f7d1b9334414a4d2369cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a2e71001938604857ce0438c885783990"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="memdesc:a948bd33b5f3f065e2532bf61d1466e4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms are movable. <a href="#a948bd33b5f3f065e2532bf61d1466e4a">More...</a><br /></td></tr>
  102. <tr class="separator:a948bd33b5f3f065e2532bf61d1466e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a5c2d1cebe5e00484c574790ea4a80e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="memdesc:ae4b896bac8b48c12f95335ae8b468e4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel a completion queue alarm. <a href="#ae4b896bac8b48c12f95335ae8b468e4e">More...</a><br /></td></tr>
  107. <tr class="separator:ae4b896bac8b48c12f95335ae8b468e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <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="#af5560d86c711748eb684ed012608c4c3">More...</a><br /></td></tr>
  110. <tr class="separator:af5560d86c711748eb684ed012608c4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  113. <a id="a7af4a0f577608f5ddd208cc7b85b500b"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a7af4a0f577608f5ddd208cc7b85b500b">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[1/4]</span></h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">grpc_impl::Alarm::Alarm </td>
  120. <td>(</td>
  121. <td class="paramname"></td><td>)</td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>Create an unset completion queue alarm. </p>
  127. </div>
  128. </div>
  129. <a id="a9f34dc0e71a9ff3a59e8eb2437cd16b5"></a>
  130. <h2 class="memtitle"><span class="permalink"><a href="#a9f34dc0e71a9ff3a59e8eb2437cd16b5">&#9670;&nbsp;</a></span>~Alarm()</h2>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">grpc_impl::Alarm::~Alarm </td>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. <p>Destroy the given completion queue alarm, cancelling it in the process. </p>
  143. </div>
  144. </div>
  145. <a id="aec1e4de4038eaac76c5cf29db1ec6b58"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#aec1e4de4038eaac76c5cf29db1ec6b58">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[2/4]</span></h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <div class="memtemplate">
  150. template&lt;typename T &gt; </div>
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">grpc_impl::Alarm::Alarm </td>
  157. <td>(</td>
  158. <td class="paramtype">::<a class="el" href="namespacegrpc.html#a9b59ae504113bf341ba9d1ae404b0cda">grpc::CompletionQueue</a> *&#160;</td>
  159. <td class="paramname"><em>cq</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">const T &amp;&#160;</td>
  165. <td class="paramname"><em>deadline</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">void *&#160;</td>
  171. <td class="paramname"><em>tag</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>. </p>
  186. <p>This form is deprecated because it is inherently racy.</p>
  187. <p>. </p>
  188. </div>
  189. </div>
  190. <a id="a98b656ff248f7d1b9334414a4d2369cb"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#a98b656ff248f7d1b9334414a4d2369cb">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[3/4]</span></h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="mlabels">
  195. <tr>
  196. <td class="mlabels-left">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">grpc_impl::Alarm::Alarm </td>
  200. <td>(</td>
  201. <td class="paramtype">const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  202. <td class="paramname"></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </td>
  207. <td class="mlabels-right">
  208. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Alarms aren't copyable. </p>
  213. </div>
  214. </div>
  215. <a id="a948bd33b5f3f065e2532bf61d1466e4a"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a948bd33b5f3f065e2532bf61d1466e4a">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[4/4]</span></h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">grpc_impl::Alarm::Alarm </td>
  225. <td>(</td>
  226. <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  227. <td class="paramname"><em>rhs</em></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Alarms are movable. </p>
  238. </div>
  239. </div>
  240. <h2 class="groupheader">Member Function Documentation</h2>
  241. <a id="ae4b896bac8b48c12f95335ae8b468e4e"></a>
  242. <h2 class="memtitle"><span class="permalink"><a href="#ae4b896bac8b48c12f95335ae8b468e4e">&#9670;&nbsp;</a></span>Cancel()</h2>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">void grpc_impl::Alarm::Cancel </td>
  248. <td>(</td>
  249. <td class="paramname"></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Cancel a completion queue alarm. </p>
  255. <p>Calling this function over an alarm that has already fired has no effect. </p>
  256. </div>
  257. </div>
  258. <a id="af5560d86c711748eb684ed012608c4c3"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#af5560d86c711748eb684ed012608c4c3">&#9670;&nbsp;</a></span>experimental()</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="mlabels">
  263. <tr>
  264. <td class="mlabels-left">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm_1_1experimental__type.html">experimental_type</a> grpc_impl::Alarm::experimental </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </td>
  274. <td class="mlabels-right">
  275. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <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>
  280. <p>It is a view to the experimental components of this class. It may be changed or removed at any time. </p>
  281. </div>
  282. </div>
  283. <a id="a2e71001938604857ce0438c885783990"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#a2e71001938604857ce0438c885783990">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a>&amp; grpc_impl::Alarm::operator= </td>
  293. <td>(</td>
  294. <td class="paramtype">const <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. </div>
  306. </div>
  307. <a id="a5c2d1cebe5e00484c574790ea4a80e76"></a>
  308. <h2 class="memtitle"><span class="permalink"><a href="#a5c2d1cebe5e00484c574790ea4a80e76">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a>&amp; grpc_impl::Alarm::operator= </td>
  317. <td>(</td>
  318. <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
  319. <td class="paramname"><em>rhs</em></td><td>)</td>
  320. <td></td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. </div>
  330. </div>
  331. <a id="a4b6abc2040ec07dd2450d0b143a55de0"></a>
  332. <h2 class="memtitle"><span class="permalink"><a href="#a4b6abc2040ec07dd2450d0b143a55de0">&#9670;&nbsp;</a></span>Set()</h2>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <div class="memtemplate">
  336. template&lt;typename T &gt; </div>
  337. <table class="mlabels">
  338. <tr>
  339. <td class="mlabels-left">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">void grpc_impl::Alarm::Set </td>
  343. <td>(</td>
  344. <td class="paramtype">::<a class="el" href="namespacegrpc.html#a9b59ae504113bf341ba9d1ae404b0cda">grpc::CompletionQueue</a> *&#160;</td>
  345. <td class="paramname"><em>cq</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">const T &amp;&#160;</td>
  351. <td class="paramname"><em>deadline</em>, </td>
  352. </tr>
  353. <tr>
  354. <td class="paramkey"></td>
  355. <td></td>
  356. <td class="paramtype">void *&#160;</td>
  357. <td class="paramname"><em>tag</em>&#160;</td>
  358. </tr>
  359. <tr>
  360. <td></td>
  361. <td>)</td>
  362. <td></td><td></td>
  363. </tr>
  364. </table>
  365. </td>
  366. <td class="mlabels-right">
  367. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>Trigger an alarm instance on completion queue <em>cq</em> at the specified time. </p>
  372. <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>
  373. </div>
  374. </div>
  375. <hr/>The documentation for this class was generated from the following file:<ul>
  376. <li>include/grpcpp/<a class="el" href="alarm__impl_8h_source.html">alarm_impl.h</a></li>
  377. </ul>
  378. </div><!-- contents -->
  379. <!-- start footer part -->
  380. <hr class="footer"/><address class="footer"><small>
  381. Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  382. <img class="footer" src="doxygen.png" alt="doxygen"/>
  383. </a> 1.8.13
  384. </small></address>
  385. </body>
  386. </html>