blob: 11463080fd1d434f29f4a8d4b26018d02033ba6c [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: include/grpc/support/cancellable_platform.h Source File</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_cad3142e04109052413f2d2a2d1813b0.html">support</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cancellable_platform.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cancellable__platform_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>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015, Google Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<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>
<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>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<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>
<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>
<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>
<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>
<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>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * distribution.</span></div>
<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>
<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>
<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>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> *</span></div>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#ifndef GRPC_SUPPORT_CANCELLABLE_PLATFORM_H</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_SUPPORT_CANCELLABLE_PLATFORM_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="atm_8h.html">grpc/support/atm.h</a>&gt;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="sync_8h.html">grpc/support/sync.h</a>&gt;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structgpr__cancellable__list__.html"> 40</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgpr__cancellable__list__.html">gpr_cancellable_list_</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">/* a doubly-linked list on cancellable&#39;s waiters queue */</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structgpr__cancellable__list__.html#a425195e5ab594a2cfdcc976e5167242a"> 42</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structgpr__cancellable__list__.html">gpr_cancellable_list_</a> *<a class="code" href="structgpr__cancellable__list__.html#a425195e5ab594a2cfdcc976e5167242a">next</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structgpr__cancellable__list__.html#a58fba7e59ac49bbb9468c2669e21b8b4"> 43</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structgpr__cancellable__list__.html">gpr_cancellable_list_</a> *<a class="code" href="structgpr__cancellable__list__.html#a58fba7e59ac49bbb9468c2669e21b8b4">prev</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">/* The following two fields are arguments to gpr_cv_cancellable_wait() */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structgpr__cancellable__list__.html#abf62ecf7376ec1e9f708e2671e494282"> 45</a></span>&#160; <a class="code" href="structgpr__mu.html">gpr_mu</a> *<a class="code" href="structgpr__cancellable__list__.html#abf62ecf7376ec1e9f708e2671e494282">mu</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structgpr__cancellable__list__.html#ae47b7ccae73001ae1539dfe3bcc8a459"> 46</a></span>&#160; <a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *<a class="code" href="structgpr__cancellable__list__.html#ae47b7ccae73001ae1539dfe3bcc8a459">cv</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">/* Internal definition of gpr_cancellable. */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structgpr__cancellable.html"> 50</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structgpr__cancellable.html#a423e728b92c8890d63490cf4b1fdc30f"> 51</a></span>&#160; <a class="code" href="structgpr__mu.html">gpr_mu</a> <a class="code" href="structgpr__cancellable.html#a423e728b92c8890d63490cf4b1fdc30f">mu</a>; <span class="comment">/* protects waiters and modifications to cancelled */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structgpr__cancellable.html#a1729b5836bf4181d092f3636368d17b2"> 52</a></span>&#160; <a class="code" href="atm__gcc__atomic_8h.html#aa9e4b16c09888debe306f14e8090b1cc">gpr_atm</a> <a class="code" href="structgpr__cancellable.html#a1729b5836bf4181d092f3636368d17b2">cancelled</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structgpr__cancellable.html#a99dfebf899cae60307fb8b83e8cfdb43"> 53</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structgpr__cancellable__list__.html">gpr_cancellable_list_</a> waiters;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;} <a class="code" href="structgpr__cancellable.html">gpr_cancellable</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_SUPPORT_CANCELLABLE_PLATFORM_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="atm_8h_html"><div class="ttname"><a href="atm_8h.html">atm.h</a></div></div>
<div class="ttc" id="structgpr__cancellable__list___html_a58fba7e59ac49bbb9468c2669e21b8b4"><div class="ttname"><a href="structgpr__cancellable__list__.html#a58fba7e59ac49bbb9468c2669e21b8b4">gpr_cancellable_list_::prev</a></div><div class="ttdeci">struct gpr_cancellable_list_ * prev</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:43</div></div>
<div class="ttc" id="structgpr__cancellable__list___html"><div class="ttname"><a href="structgpr__cancellable__list__.html">gpr_cancellable_list_</a></div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:40</div></div>
<div class="ttc" id="structgpr__cancellable__list___html_ae47b7ccae73001ae1539dfe3bcc8a459"><div class="ttname"><a href="structgpr__cancellable__list__.html#ae47b7ccae73001ae1539dfe3bcc8a459">gpr_cancellable_list_::cv</a></div><div class="ttdeci">gpr_cv * cv</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:46</div></div>
<div class="ttc" id="structgpr__cancellable_html_a1729b5836bf4181d092f3636368d17b2"><div class="ttname"><a href="structgpr__cancellable.html#a1729b5836bf4181d092f3636368d17b2">gpr_cancellable::cancelled</a></div><div class="ttdeci">gpr_atm cancelled</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:52</div></div>
<div class="ttc" id="sync__posix_8h_html_a1ad613e07180c0459cda9f3f6d881885"><div class="ttname"><a href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a></div><div class="ttdeci">pthread_cond_t gpr_cv</div><div class="ttdef"><b>Definition:</b> sync_posix.h:42</div></div>
<div class="ttc" id="structgpr__cancellable_html"><div class="ttname"><a href="structgpr__cancellable.html">gpr_cancellable</a></div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:50</div></div>
<div class="ttc" id="structgpr__mu_html"><div class="ttname"><a href="structgpr__mu.html">gpr_mu</a></div><div class="ttdef"><b>Definition:</b> sync_win32.h:39</div></div>
<div class="ttc" id="structgpr__cancellable__list___html_abf62ecf7376ec1e9f708e2671e494282"><div class="ttname"><a href="structgpr__cancellable__list__.html#abf62ecf7376ec1e9f708e2671e494282">gpr_cancellable_list_::mu</a></div><div class="ttdeci">gpr_mu * mu</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:45</div></div>
<div class="ttc" id="structgpr__cancellable_html_a423e728b92c8890d63490cf4b1fdc30f"><div class="ttname"><a href="structgpr__cancellable.html#a423e728b92c8890d63490cf4b1fdc30f">gpr_cancellable::mu</a></div><div class="ttdeci">gpr_mu mu</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:51</div></div>
<div class="ttc" id="sync_8h_html"><div class="ttname"><a href="sync_8h.html">sync.h</a></div></div>
<div class="ttc" id="structgpr__cancellable__list___html_a425195e5ab594a2cfdcc976e5167242a"><div class="ttname"><a href="structgpr__cancellable__list__.html#a425195e5ab594a2cfdcc976e5167242a">gpr_cancellable_list_::next</a></div><div class="ttdeci">struct gpr_cancellable_list_ * next</div><div class="ttdef"><b>Definition:</b> cancellable_platform.h:42</div></div>
<div class="ttc" id="atm__gcc__atomic_8h_html_aa9e4b16c09888debe306f14e8090b1cc"><div class="ttname"><a href="atm__gcc__atomic_8h.html#aa9e4b16c09888debe306f14e8090b1cc">gpr_atm</a></div><div class="ttdeci">gpr_intptr gpr_atm</div><div class="ttdef"><b>Definition:</b> atm_gcc_atomic.h:41</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:05 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>