blob: 339609c4499269baec5af8faf77f378ad1f5e791 [file] [log] [blame]
<!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.6"/>
<title>GRPC Core: src/core/iomgr/alarm.c File 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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 style="padding-left: 0.5em;">
<div id="projectname">GRPC Core
&#160;<span id="projectnumber">0.10.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>
<!-- 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="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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">alarm.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="alarm_8h_source.html">src/core/iomgr/alarm.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="alarm__heap_8h_source.html">src/core/iomgr/alarm_heap.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="alarm__internal_8h_source.html">src/core/iomgr/alarm_internal.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="time__averaged__stats_8h_source.html">src/core/iomgr/time_averaged_stats.h</a>&quot;</code><br/>
<code>#include &lt;<a class="el" href="log_8h_source.html">grpc/support/log.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="sync_8h_source.html">grpc/support/sync.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="useful_8h_source.html">grpc/support/useful.h</a>&gt;</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshard__type.html">shard_type</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ab10c095adee8fff29f7d8e4209b70c66"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#ab10c095adee8fff29f7d8e4209b70c66">INVALID_HEAP_INDEX</a>&#160;&#160;&#160;0xffffffffu</td></tr>
<tr class="separator:ab10c095adee8fff29f7d8e4209b70c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae48da0bb5039d191e6de667c888624c1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#ae48da0bb5039d191e6de667c888624c1">LOG2_NUM_SHARDS</a>&#160;&#160;&#160;5</td></tr>
<tr class="separator:ae48da0bb5039d191e6de667c888624c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc8b3b06fc834d57a69ca6ed5e3dfe3e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#abc8b3b06fc834d57a69ca6ed5e3dfe3e">NUM_SHARDS</a>&#160;&#160;&#160;(1 &lt;&lt; <a class="el" href="alarm_8c.html#ae48da0bb5039d191e6de667c888624c1">LOG2_NUM_SHARDS</a>)</td></tr>
<tr class="separator:abc8b3b06fc834d57a69ca6ed5e3dfe3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a035d5ac078d2c49bd8bc08a56eaeb7bb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a035d5ac078d2c49bd8bc08a56eaeb7bb">MAX_ALARMS_PER_CHECK</a>&#160;&#160;&#160;128</td></tr>
<tr class="separator:a035d5ac078d2c49bd8bc08a56eaeb7bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27a820068e725cd087726fc5d913a5b6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a27a820068e725cd087726fc5d913a5b6">ADD_DEADLINE_SCALE</a>&#160;&#160;&#160;0.33</td></tr>
<tr class="separator:a27a820068e725cd087726fc5d913a5b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1998a9b10fbd17ad50ff85991aeaa645"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a1998a9b10fbd17ad50ff85991aeaa645">MIN_QUEUE_WINDOW_DURATION</a>&#160;&#160;&#160;0.01</td></tr>
<tr class="separator:a1998a9b10fbd17ad50ff85991aeaa645"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7820b33745be59861679298b76d9a95"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#aa7820b33745be59861679298b76d9a95">MAX_QUEUE_WINDOW_DURATION</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:aa7820b33745be59861679298b76d9a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7f76e290e84d187382a25d0d6999067e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a7f76e290e84d187382a25d0d6999067e">grpc_alarm_list_init</a> (<a class="el" href="structgpr__timespec.html">gpr_timespec</a> now)</td></tr>
<tr class="separator:a7f76e290e84d187382a25d0d6999067e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a768994cd3fff1f9b3ca7805dee7b3831"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a768994cd3fff1f9b3ca7805dee7b3831">grpc_alarm_list_shutdown</a> (void)</td></tr>
<tr class="separator:a768994cd3fff1f9b3ca7805dee7b3831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50483486a229b573a29ed9fa30807999"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a50483486a229b573a29ed9fa30807999">grpc_alarm_init</a> (<a class="el" href="structgrpc__alarm.html">grpc_alarm</a> *alarm, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> deadline, <a class="el" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> alarm_cb, void *alarm_cb_arg, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> now)</td></tr>
<tr class="separator:a50483486a229b573a29ed9fa30807999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a921e9a2f728d338f42ad586e6d4eaf60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a921e9a2f728d338f42ad586e6d4eaf60">grpc_alarm_cancel</a> (<a class="el" href="structgrpc__alarm.html">grpc_alarm</a> *alarm)</td></tr>
<tr class="separator:a921e9a2f728d338f42ad586e6d4eaf60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28de65beea264f65e15824cbf866d863"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a28de65beea264f65e15824cbf866d863">grpc_alarm_check</a> (<a class="el" href="structgpr__mu.html">gpr_mu</a> *drop_mu, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> now, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> *next)</td></tr>
<tr class="separator:a28de65beea264f65e15824cbf866d863"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a257c1eaf2f1c2f352893dcc0af034dfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alarm_8c.html#a257c1eaf2f1c2f352893dcc0af034dfa">grpc_alarm_list_next_timeout</a> (void)</td></tr>
<tr class="separator:a257c1eaf2f1c2f352893dcc0af034dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a27a820068e725cd087726fc5d913a5b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ADD_DEADLINE_SCALE&#160;&#160;&#160;0.33</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab10c095adee8fff29f7d8e4209b70c66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INVALID_HEAP_INDEX&#160;&#160;&#160;0xffffffffu</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae48da0bb5039d191e6de667c888624c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOG2_NUM_SHARDS&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a035d5ac078d2c49bd8bc08a56eaeb7bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_ALARMS_PER_CHECK&#160;&#160;&#160;128</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa7820b33745be59861679298b76d9a95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_QUEUE_WINDOW_DURATION&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1998a9b10fbd17ad50ff85991aeaa645"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MIN_QUEUE_WINDOW_DURATION&#160;&#160;&#160;0.01</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abc8b3b06fc834d57a69ca6ed5e3dfe3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NUM_SHARDS&#160;&#160;&#160;(1 &lt;&lt; <a class="el" href="alarm_8c.html#ae48da0bb5039d191e6de667c888624c1">LOG2_NUM_SHARDS</a>)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a921e9a2f728d338f42ad586e6d4eaf60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_alarm_cancel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__alarm.html">grpc_alarm</a> *&#160;</td>
<td class="paramname"><em>alarm</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a28de65beea264f65e15824cbf866d863"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_alarm_check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgpr__mu.html">gpr_mu</a> *&#160;</td>
<td class="paramname"><em>drop_mu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>now</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> *&#160;</td>
<td class="paramname"><em>next</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a50483486a229b573a29ed9fa30807999"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_alarm_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__alarm.html">grpc_alarm</a> *&#160;</td>
<td class="paramname"><em>alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>deadline</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a>&#160;</td>
<td class="paramname"><em>alarm_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>alarm_cb_arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>now</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7f76e290e84d187382a25d0d6999067e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_alarm_list_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>now</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a257c1eaf2f1c2f352893dcc0af034dfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> grpc_alarm_list_next_timeout </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a768994cd3fff1f9b3ca7805dee7b3831"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_alarm_list_shutdown </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>