Home Explore Help
Sign In
carto
/
grpc
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: e9961d29f1
Branches Tags
grpc
/
doc
/
ref
/
core.internal
/
html
/
alarm_8h_source.html

alarm_8h_source.html 26 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.6"/>
    7. 

  7. <title>GRPC Core: src/core/iomgr/alarm.h Source File</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    12. 

  12. <script type="text/javascript" src="search/search.js"></script>
    13. 

  13. <script type="text/javascript">
    14. 

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    15. 

  15. </script>
    16. 

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    20. 

  20. <div id="titlearea">
    21. 

  21. <table cellspacing="0" cellpadding="0">
    22. 

  22.  <tbody>
    23. 

  23.  <tr style="height: 56px;">
    24. 

  24.   <td style="padding-left: 0.5em;">
    25. 

  25.    <div id="projectname">GRPC Core
    26. 

  26.    &#160;<span id="projectnumber">0.11.0.0</span>
    27. 

  27.    </div>
    28. 

  28.   </td>
    29. 

  29.  </tr>
    30. 

  30.  </tbody>
    31. 

  31. </table>
    32. 

  32. </div>
    33. 

  33. <!-- end header part -->
    34. 

  34. <!-- Generated by Doxygen 1.8.6 -->
    35. 

  35. <script type="text/javascript">
    36. 

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    37. 

  37. </script>
    38. 

  38.   <div id="navrow1" class="tabs">
    39. 

  39.     <ul class="tablist">
    40. 

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    41. 

  41.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    42. 

  42.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    43. 

  43.       <li>
    44. 

  44.         <div id="MSearchBox" class="MSearchBoxInactive">
    45. 

  45.         <span class="left">
    46. 

  46.           <img id="MSearchSelect" src="search/mag_sel.png"
    47. 

  47.                onmouseover="return searchBox.OnSearchSelectShow()"
    48. 

  48.                onmouseout="return searchBox.OnSearchSelectHide()"
    49. 

  49.                alt=""/>
    50. 

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    51. 

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    52. 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 
    53. 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    54. 

  54.           </span><span class="right">
    55. 

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    56. 

  56.           </span>
    57. 

  57.         </div>
    58. 

  58.       </li>
    59. 

  59.     </ul>
    60. 

  60.   </div>
    61. 

  61.   <div id="navrow2" class="tabs2">
    62. 

  62.     <ul class="tablist">
    63. 

  63.       <li><a href="files.html"><span>File&#160;List</span></a></li>
    64. 

  64.       <li><a href="globals.html"><span>Globals</span></a></li>
    65. 

  65.     </ul>
    66. 

  66.   </div>
    67. 

  67. <!-- window showing the filter options -->
    68. 

  68. <div id="MSearchSelectWindow"
    69. 

  69.      onmouseover="return searchBox.OnSearchSelectShow()"
    70. 

  70.      onmouseout="return searchBox.OnSearchSelectHide()"
    71. 

  71.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    72. 

  72. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
    73. 

  73. 

  74. <!-- iframe showing the search results (closed by default) -->
    75. 

  75. <div id="MSearchResultsWindow">
    76. 

  76. <iframe src="javascript:void(0)" frameborder="0" 
    77. 

  77.         name="MSearchResults" id="MSearchResults">
    78. 

  78. </iframe>
    79. 

  79. </div>
    80. 

  80. 

  81. <div id="nav-path" class="navpath">
    82. 

  82.   <ul>
    83. 

  83. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_3f1a464cbd6442b4d6b6ee306c9b0460.html">iomgr</a></li>  </ul>
    84. 

  84. </div>
    85. 

  85. </div><!-- top -->
    86. 

  86. <div class="header">
    87. 

  87.   <div class="headertitle">
    88. 

  88. <div class="title">alarm.h</div>  </div>
    89. 

  89. </div><!--header-->
    90. 

  90. <div class="contents">
    91. 

  91. <a href="alarm_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>
    92. 

  92. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div>
    93. 

  93. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2015, Google Inc.</span></div>
    94. 

  94. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * All rights reserved.</span></div>
    95. 

  95. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
    96. 

  96. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
    97. 

  97. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions are</span></div>
    98. 

  98. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * met:</span></div>
    99. 

  99. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
    100. 

  100. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *     * Redistributions of source code must retain the above copyright</span></div>
    101. 

  101. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
    102. 

  102. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *     * Redistributions in binary form must reproduce the above</span></div>
    103. 

  103. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div>
    104. 

  104. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * in the documentation and/or other materials provided with the</span></div>
    105. 

  105. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * distribution.</span></div>
    106. 

  106. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *     * Neither the name of Google Inc. nor the names of its</span></div>
    107. 

  107. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * contributors may be used to endorse or promote products derived from</span></div>
    108. 

  108. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * this software without specific prior written permission.</span></div>
    109. 

  109. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *</span></div>
    110. 

  110. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
    111. 

  111. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
    112. 

  112. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
    113. 

  113. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
    114. 

  114. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
    115. 

  115. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
    116. 

  116. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
    117. 

  117. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
    118. 

  118. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
    119. 

  119. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
    120. 

  120. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
    121. 

  121. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> *</span></div>
    122. 

  122. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> */</span></div>
    123. 

  123. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
    124. 

  124. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#ifndef GRPC_INTERNAL_CORE_IOMGR_ALARM_H</span></div>
    125. 

  125. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_INTERNAL_CORE_IOMGR_ALARM_H</span></div>
    126. 

  126. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor"></span></div>
    127. 

  127. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="iomgr_8h.html">src/core/iomgr/iomgr.h</a>&quot;</span></div>
    128. 

  128. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="port__platform_8h.html">grpc/support/port_platform.h</a>&gt;</span></div>
    129. 

  129. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="time_8h.html">grpc/support/time.h</a>&gt;</span></div>
    130. 

  130. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div>
    131. 

  131. <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html">   41</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structgrpc__alarm.html">grpc_alarm</a> {</div>
    132. 

  132. <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a8f3f1ae9b65a0cc76971ea7daed1b126">   42</a></span>&#160;  <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="structgrpc__alarm.html#a8f3f1ae9b65a0cc76971ea7daed1b126">deadline</a>;</div>
    133. 

  133. <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#adef760998486aa79b9637e95a83e061b">   43</a></span>&#160;  <a class="code" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a> <a class="code" href="structgrpc__alarm.html#adef760998486aa79b9637e95a83e061b">heap_index</a>; <span class="comment">/* INVALID_HEAP_INDEX if not in heap */</span></div>
    134. 

  134. <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a75136c755eae954d2955f3519ea2919f">   44</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="structgrpc__alarm.html#a75136c755eae954d2955f3519ea2919f">triggered</a>;</div>
    135. 

  135. <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a2f83596c1a3e1337f333dcffebabb7ab">   45</a></span>&#160;  <span class="keyword">struct </span><a class="code" href="structgrpc__alarm.html">grpc_alarm</a> *<a class="code" href="structgrpc__alarm.html#a2f83596c1a3e1337f333dcffebabb7ab">next</a>;</div>
    136. 

  136. <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a806b141943b6b45f16cc7459ab035b97">   46</a></span>&#160;  <span class="keyword">struct </span><a class="code" href="structgrpc__alarm.html">grpc_alarm</a> *<a class="code" href="structgrpc__alarm.html#a806b141943b6b45f16cc7459ab035b97">prev</a>;</div>
    137. 

  137. <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a85a6797057eb75a49d63f4301b4b32dd">   47</a></span>&#160;  <a class="code" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> <a class="code" href="structgrpc__alarm.html#a85a6797057eb75a49d63f4301b4b32dd">cb</a>;</div>
    138. 

  138. <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structgrpc__alarm.html#a0f9db224dc882f41a1d676115ede23c3">   48</a></span>&#160;  <span class="keywordtype">void</span> *<a class="code" href="structgrpc__alarm.html#a0f9db224dc882f41a1d676115ede23c3">cb_arg</a>;</div>
    139. 

  139. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;} <a class="code" href="alarm_8h.html#a2a31b5bd57cc9f6b862e9b8ef0ec2bea">grpc_alarm</a>;</div>
    140. 

  140. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
    141. 

  141. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">/* Initialize *alarm. When expired or canceled, alarm_cb will be called with</span></div>
    142. 

  142. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">   *alarm_cb_arg and status to indicate if it expired (SUCCESS) or was</span></div>
    143. 

  143. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">   canceled (CANCELLED). alarm_cb is guaranteed to be called exactly once,</span></div>
    144. 

  144. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">   and application code should check the status to determine how it was</span></div>
    145. 

  145. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">   invoked. The application callback is also responsible for maintaining</span></div>
    146. 

  146. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">   information about when to free up any user-level state. */</span></div>
    147. 

  147. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keywordtype">void</span> <a class="code" href="alarm_8h.html#a50483486a229b573a29ed9fa30807999">grpc_alarm_init</a>(<a class="code" href="structgrpc__alarm.html">grpc_alarm</a> *alarm, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="structgrpc__alarm.html#a8f3f1ae9b65a0cc76971ea7daed1b126">deadline</a>,</div>
    148. 

  148. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;                     <a class="code" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> alarm_cb, <span class="keywordtype">void</span> *alarm_cb_arg,</div>
    149. 

  149. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                     <a class="code" href="structgpr__timespec.html">gpr_timespec</a> now);</div>
    150. 

  150. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
    151. 

  151. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">/* Note that there is no alarm destroy function. This is because the</span></div>
    152. 

  152. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   alarm is a one-time occurrence with a guarantee that the callback will</span></div>
    153. 

  153. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">   be called exactly once, either at expiration or cancellation. Thus, all</span></div>
    154. 

  154. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">   the internal alarm event management state is destroyed just before</span></div>
    155. 

  155. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">   that callback is invoked. If the user has additional state associated with</span></div>
    156. 

  156. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">   the alarm, the user is responsible for determining when it is safe to</span></div>
    157. 

  157. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">   destroy that state. */</span></div>
    158. 

  158. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
    159. 

  159. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">/* Cancel an *alarm.</span></div>
    160. 

  160. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">   There are three cases:</span></div>
    161. 

  161. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">   1. We normally cancel the alarm</span></div>
    162. 

  162. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">   2. The alarm has already run</span></div>
    163. 

  163. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">   3. We can&#39;t cancel the alarm because it is &quot;in flight&quot;.</span></div>
    164. 

  164. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"></span></div>
    165. 

  165. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">   In all of these cases, the cancellation is still considered successful.</span></div>
    166. 

  166. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">   They are essentially distinguished in that the alarm_cb will be run</span></div>
    167. 

  167. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">   exactly once from either the cancellation (with status CANCELLED)</span></div>
    168. 

  168. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">   or from the activation (with status SUCCESS)</span></div>
    169. 

  169. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"></span></div>
    170. 

  170. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">   Note carefully that the callback function MAY occur in the same callstack</span></div>
    171. 

  171. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">   as grpc_alarm_cancel. It&#39;s expected that most alarms will be cancelled (their</span></div>
    172. 

  172. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">   primary use is to implement deadlines), and so this code is optimized such</span></div>
    173. 

  173. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">   that cancellation costs as little as possible. Making callbacks run inline</span></div>
    174. 

  174. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">   matches this aim.</span></div>
    175. 

  175. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"></span></div>
    176. 

  176. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">   Requires:  cancel() must happen after add() on a given alarm */</span></div>
    177. 

  177. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keywordtype">void</span> <a class="code" href="alarm_8h.html#a921e9a2f728d338f42ad586e6d4eaf60">grpc_alarm_cancel</a>(<a class="code" href="structgrpc__alarm.html">grpc_alarm</a> *alarm);</div>
    178. 

  178. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
    179. 

  179. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_INTERNAL_CORE_IOMGR_ALARM_H */</span><span class="preprocessor"></span></div>
    180. 

  180. <div class="ttc" id="structgrpc__alarm_html"><div class="ttname"><a href="structgrpc__alarm.html">grpc_alarm</a></div><div class="ttdef"><b>Definition:</b> alarm.h:41</div></div>
    181. 

  181. <div class="ttc" id="port__platform_8h_html"><div class="ttname"><a href="port__platform_8h.html">port_platform.h</a></div></div>
    182. 

  182. <div class="ttc" id="alarm_8h_html_a921e9a2f728d338f42ad586e6d4eaf60"><div class="ttname"><a href="alarm_8h.html#a921e9a2f728d338f42ad586e6d4eaf60">grpc_alarm_cancel</a></div><div class="ttdeci">void grpc_alarm_cancel(grpc_alarm *alarm)</div><div class="ttdef"><b>Definition:</b> alarm.c:226</div></div>
    183. 

  183. <div class="ttc" id="structgrpc__alarm_html_a85a6797057eb75a49d63f4301b4b32dd"><div class="ttname"><a href="structgrpc__alarm.html#a85a6797057eb75a49d63f4301b4b32dd">grpc_alarm::cb</a></div><div class="ttdeci">grpc_iomgr_cb_func cb</div><div class="ttdef"><b>Definition:</b> alarm.h:47</div></div>
    184. 

  184. <div class="ttc" id="time_8h_html"><div class="ttname"><a href="time_8h.html">time.h</a></div></div>
    185. 

  185. <div class="ttc" id="structgrpc__alarm_html_a2f83596c1a3e1337f333dcffebabb7ab"><div class="ttname"><a href="structgrpc__alarm.html#a2f83596c1a3e1337f333dcffebabb7ab">grpc_alarm::next</a></div><div class="ttdeci">struct grpc_alarm * next</div><div class="ttdef"><b>Definition:</b> alarm.h:45</div></div>
    186. 

  186. <div class="ttc" id="port__platform_8h_html_aa6abd4df815a5498d1a04b5e691a74a9"><div class="ttname"><a href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a></div><div class="ttdeci">uint32_t gpr_uint32</div><div class="ttdef"><b>Definition:</b> port_platform.h:312</div></div>
    187. 

  187. <div class="ttc" id="structgrpc__alarm_html_a0f9db224dc882f41a1d676115ede23c3"><div class="ttname"><a href="structgrpc__alarm.html#a0f9db224dc882f41a1d676115ede23c3">grpc_alarm::cb_arg</a></div><div class="ttdeci">void * cb_arg</div><div class="ttdef"><b>Definition:</b> alarm.h:48</div></div>
    188. 

  188. <div class="ttc" id="alarm_8h_html_a50483486a229b573a29ed9fa30807999"><div class="ttname"><a href="alarm_8h.html#a50483486a229b573a29ed9fa30807999">grpc_alarm_init</a></div><div class="ttdeci">void grpc_alarm_init(grpc_alarm *alarm, gpr_timespec deadline, grpc_iomgr_cb_func alarm_cb, void *alarm_cb_arg, gpr_timespec now)</div><div class="ttdef"><b>Definition:</b> alarm.c:175</div></div>
    189. 

  189. <div class="ttc" id="structgrpc__alarm_html_adef760998486aa79b9637e95a83e061b"><div class="ttname"><a href="structgrpc__alarm.html#adef760998486aa79b9637e95a83e061b">grpc_alarm::heap_index</a></div><div class="ttdeci">gpr_uint32 heap_index</div><div class="ttdef"><b>Definition:</b> alarm.h:43</div></div>
    190. 

  190. <div class="ttc" id="structgrpc__alarm_html_a8f3f1ae9b65a0cc76971ea7daed1b126"><div class="ttname"><a href="structgrpc__alarm.html#a8f3f1ae9b65a0cc76971ea7daed1b126">grpc_alarm::deadline</a></div><div class="ttdeci">gpr_timespec deadline</div><div class="ttdef"><b>Definition:</b> alarm.h:42</div></div>
    191. 

  191. <div class="ttc" id="iomgr_8h_html_ad4037ad983dff2d616a6fb90158baad3"><div class="ttname"><a href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a></div><div class="ttdeci">void(* grpc_iomgr_cb_func)(void *arg, int success)</div><div class="ttdoc">gRPC Callback definition. </div><div class="ttdef"><b>Definition:</b> iomgr.h:42</div></div>
    192. 

  192. <div class="ttc" id="alarm_8h_html_a2a31b5bd57cc9f6b862e9b8ef0ec2bea"><div class="ttname"><a href="alarm_8h.html#a2a31b5bd57cc9f6b862e9b8ef0ec2bea">grpc_alarm</a></div><div class="ttdeci">struct grpc_alarm grpc_alarm</div></div>
    193. 

  193. <div class="ttc" id="structgrpc__alarm_html_a75136c755eae954d2955f3519ea2919f"><div class="ttname"><a href="structgrpc__alarm.html#a75136c755eae954d2955f3519ea2919f">grpc_alarm::triggered</a></div><div class="ttdeci">int triggered</div><div class="ttdef"><b>Definition:</b> alarm.h:44</div></div>
    194. 

  194. <div class="ttc" id="structgrpc__alarm_html_a806b141943b6b45f16cc7459ab035b97"><div class="ttname"><a href="structgrpc__alarm.html#a806b141943b6b45f16cc7459ab035b97">grpc_alarm::prev</a></div><div class="ttdeci">struct grpc_alarm * prev</div><div class="ttdef"><b>Definition:</b> alarm.h:46</div></div>
    195. 

  195. <div class="ttc" id="structgpr__timespec_html"><div class="ttname"><a href="structgpr__timespec.html">gpr_timespec</a></div><div class="ttdef"><b>Definition:</b> time.h:63</div></div>
    196. 

  196. <div class="ttc" id="iomgr_8h_html"><div class="ttname"><a href="iomgr_8h.html">iomgr.h</a></div></div>
    197. 

  197. </div><!-- fragment --></div><!-- contents -->
    198. 

  198. <!-- start footer part -->
    199. 

  199. <hr class="footer"/><address class="footer"><small>
    200. 

  200. Generated on Thu Sep 3 2015 09:44:13 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
    201. 

  201. <img class="footer" src="doxygen.png" alt="doxygen"/>
    202. 

  202. </a> 1.8.6
    203. 

  203. </small></address>
    204. 

  204. </body>
    205. 

  205. </html>
    206.