carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::Alarm Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.13.0-dev</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc::Alarm Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A thin wrapper around <em>grpc_alarm</em> (see / <em>/</em> src/core/surface/alarm.h).  
 <a href="classgrpc_1_1_alarm.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2alarm_8h_source.html">alarm.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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>
<tr class="memdesc:a49ce7f2934d753389bd192574c509302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an unset completion queue alarm.  <a href="#a49ce7f2934d753389bd192574c509302">More...</a><br /></td></tr>
<tr class="separator:a49ce7f2934d753389bd192574c509302"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab78846507ce33312823afcebe78a1215"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#ab78846507ce33312823afcebe78a1215">~Alarm</a> ()</td></tr>
<tr class="memdesc:ab78846507ce33312823afcebe78a1215"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the given completion queue alarm, cancelling it in the process.  <a href="#ab78846507ce33312823afcebe78a1215">More...</a><br /></td></tr>
<tr class="separator:ab78846507ce33312823afcebe78a1215"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6c0bc180d800973956b13c793bbac9a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:aa6c0bc180d800973956b13c793bbac9a"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#aa6c0bc180d800973956b13c793bbac9a">Alarm</a> (<a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
<tr class="memdesc:aa6c0bc180d800973956b13c793bbac9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>.  <a href="#aa6c0bc180d800973956b13c793bbac9a">More...</a><br /></td></tr>
<tr class="separator:aa6c0bc180d800973956b13c793bbac9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cfc8a72d77c446e909c9747cd852cfa"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a2cfc8a72d77c446e909c9747cd852cfa"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#a2cfc8a72d77c446e909c9747cd852cfa">Set</a> (<a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *cq, const T &amp;deadline, void *tag)</td></tr>
<tr class="memdesc:a2cfc8a72d77c446e909c9747cd852cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger an alarm instance on completion queue <em>cq</em> at the specified time.  <a href="#a2cfc8a72d77c446e909c9747cd852cfa">More...</a><br /></td></tr>
<tr class="separator:a2cfc8a72d77c446e909c9747cd852cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:aea1258cecd23533bf292f17b71124f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms aren't copyable.  <a href="#aea1258cecd23533bf292f17b71124f66">More...</a><br /></td></tr>
<tr class="separator:aea1258cecd23533bf292f17b71124f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a4c46dacfd26561470f0901cec2686f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad75ad87050d7ad9b2f66dbd6ef0da056"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_alarm.html#ad75ad87050d7ad9b2f66dbd6ef0da056">Alarm</a> (<a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;rhs)</td></tr>
<tr class="memdesc:ad75ad87050d7ad9b2f66dbd6ef0da056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alarms are movable.  <a href="#ad75ad87050d7ad9b2f66dbd6ef0da056">More...</a><br /></td></tr>
<tr class="separator:ad75ad87050d7ad9b2f66dbd6ef0da056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47545b12ace3607ed259225e38eade46"><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#a47545b12ace3607ed259225e38eade46">operator=</a> (<a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;rhs)</td></tr>
<tr class="separator:a47545b12ace3607ed259225e38eade46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:a57837c6b6d75f622c056b3050cf000fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel a completion queue alarm.  <a href="#a57837c6b6d75f622c056b3050cf000fb">More...</a><br /></td></tr>
<tr class="separator:a57837c6b6d75f622c056b3050cf000fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A thin wrapper around <em>grpc_alarm</em> (see / <em>/</em> src/core/surface/alarm.h). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a49ce7f2934d753389bd192574c509302"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49ce7f2934d753389bd192574c509302">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Alarm::Alarm </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create an unset completion queue alarm. </p>

</div>
</div>
<a id="ab78846507ce33312823afcebe78a1215"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab78846507ce33312823afcebe78a1215">&#9670;&nbsp;</a></span>~Alarm()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Alarm::~Alarm </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy the given completion queue alarm, cancelling it in the process. </p>

</div>
</div>
<a id="aa6c0bc180d800973956b13c793bbac9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6c0bc180d800973956b13c793bbac9a">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Alarm::Alarm </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
          <td class="paramname"><em>cq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>deadline</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>DEPRECATED: Create and set a completion queue alarm instance associated to <em>cq</em>. </p>
<p>This form is deprecated because it is inherently racy.</p>
<p>. </p>

</div>
</div>
<a id="aea1258cecd23533bf292f17b71124f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea1258cecd23533bf292f17b71124f66">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Alarm::Alarm </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Alarms aren't copyable. </p>

</div>
</div>
<a id="ad75ad87050d7ad9b2f66dbd6ef0da056"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad75ad87050d7ad9b2f66dbd6ef0da056">&#9670;&nbsp;</a></span>Alarm() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Alarm::Alarm </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Alarms are movable. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a57837c6b6d75f622c056b3050cf000fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57837c6b6d75f622c056b3050cf000fb">&#9670;&nbsp;</a></span>Cancel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::Alarm::Cancel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel a completion queue alarm. </p>
<p>Calling this function over an alarm that has already fired has no effect. </p>

</div>
</div>
<a id="a4c46dacfd26561470f0901cec2686f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c46dacfd26561470f0901cec2686f49">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; grpc::Alarm::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a47545b12ace3607ed259225e38eade46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47545b12ace3607ed259225e38eade46">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a>&amp; grpc::Alarm::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_alarm.html">Alarm</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a2cfc8a72d77c446e909c9747cd852cfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cfc8a72d77c446e909c9747cd852cfa">&#9670;&nbsp;</a></span>Set()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::Alarm::Set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
          <td class="paramname"><em>cq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>deadline</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Trigger an alarm instance on completion queue <em>cq</em> at the specified time. </p>
<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>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/<a class="el" href="grpcpp_2alarm_8h_source.html">alarm.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>