| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139 |
- <!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.11"/>
- <title>GRPC C++: include/grpc/impl/codegen/sync.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/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </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 id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.0.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.11 -->
- <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 Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li><a href="annotated.html"><span>Data 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 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)">
- </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_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">sync.h</div> </div>
- </div><!--header-->
- <div class="contents">
- <a href="grpc_2impl_2codegen_2sync_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2016, Google Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <span class="comment"> * met:</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <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> <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> <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> <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> <span class="comment"> * distribution.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <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> <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> <span class="comment"> * this software without specific prior written permission.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <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> <span class="comment"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <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> <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> <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> <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> <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> <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> <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> <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> <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> <span class="comment"> *</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef GRPC_IMPL_CODEGEN_SYNC_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define GRPC_IMPL_CODEGEN_SYNC_H</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* Synchronization primitives for GPR.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> The type gpr_mu provides a non-reentrant mutex (lock).</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> The type gpr_cv provides a condition variable.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> The type gpr_once provides for one-time initialization.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> The type gpr_event provides one-time-setting, reading, and</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> waiting of a void*, with memory barriers.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> The type gpr_refcount provides an object reference counter,</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> with memory barriers suitable to control</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> object lifetimes.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> The type gpr_stats_counter provides an atomic statistics counter. It</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> provides no memory barriers.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> */</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/* Platform-specific type declarations of gpr_mu and gpr_cv. */</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#include <<a class="code" href="port__platform_8h.html">grpc/impl/codegen/port_platform.h</a>></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include <<a class="code" href="sync__generic_8h.html">grpc/impl/codegen/sync_generic.h</a>></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#if defined(GPR_POSIX_SYNC)</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#include <<a class="code" href="sync__posix_8h.html">grpc/impl/codegen/sync_posix.h</a>></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#elif defined(GPR_WINDOWS)</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#include <<a class="code" href="sync__windows_8h.html">grpc/impl/codegen/sync_windows.h</a>></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#elif !defined(GPR_CUSTOM_SYNC)</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#error Unable to determine platform for sync</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#include <<a class="code" href="grpc_2impl_2codegen_2time_8h.html">grpc/impl/codegen/time.h</a>></span> <span class="comment">/* for gpr_timespec */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/* --- Mutex interface ---</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> At most one thread may hold an exclusive lock on a mutex at any given time.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> Actions taken by a thread that holds a mutex exclusively happen after</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> actions taken by all previous holders of the mutex. Variables of type</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> gpr_mu are uninitialized when first declared. */</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* Initialize *mu. Requires: *mu uninitialized. */</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a989fb0f141d90a05b20425ebdc77936d">gpr_mu_init</a>(<a class="code" href="structgpr__mu.html">gpr_mu</a> *mu);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/* Cause *mu no longer to be initialized, freeing any memory in use. Requires:</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> *mu initialized; no other concurrent operation on *mu. */</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a23567fcb3d8a7d5f29834ddbcbbe1d1d">gpr_mu_destroy</a>(<a class="code" href="structgpr__mu.html">gpr_mu</a> *mu);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/* Wait until no thread has a lock on *mu, cause the calling thread to own an</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> exclusive lock on *mu, then return. May block indefinitely or crash if the</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> calling thread has a lock on *mu. Requires: *mu initialized. */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">gpr_mu_lock</a>(<a class="code" href="structgpr__mu.html">gpr_mu</a> *mu);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/* Release an exclusive lock on *mu held by the calling thread. Requires: *mu</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> initialized; the calling thread holds an exclusive lock on *mu. */</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a>(<a class="code" href="structgpr__mu.html">gpr_mu</a> *mu);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/* Without blocking, attempt to acquire an exclusive lock on *mu for the</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> calling thread, then return non-zero iff success. Fail, if any thread holds</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> the lock; succeeds with high probability if no thread holds the lock.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> Requires: *mu initialized. */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a18765dc6c6292b12388a68eb541419a8">gpr_mu_trylock</a>(<a class="code" href="structgpr__mu.html">gpr_mu</a> *mu);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/* --- Condition variable interface ---</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> A while-loop should be used with gpr_cv_wait() when waiting for conditions</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> to become true. See the example below. Variables of type gpr_cv are</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> uninitialized when first declared. */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/* Initialize *cv. Requires: *cv uninitialized. */</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">gpr_cv_init</a>(<a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">/* Cause *cv no longer to be initialized, freeing any memory in use. Requires:</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> *cv initialized; no other concurrent operation on *cv.*/</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a053788a2217043c527afc8b424568b22">gpr_cv_destroy</a>(<a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/* Atomically release *mu and wait on *cv. When the calling thread is woken</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> from *cv or the deadline abs_deadline is exceeded, execute gpr_mu_lock(mu)</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> and return whether the deadline was exceeded. Use</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> abs_deadline==gpr_inf_future for no deadline. abs_deadline can be either</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> an absolute deadline, or a GPR_TIMESPAN. May return even when not</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> woken explicitly. Requires: *mu and *cv initialized; the calling thread</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> holds an exclusive lock on *mu. */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">gpr_cv_wait</a>(<a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv, <a class="code" href="structgpr__mu.html">gpr_mu</a> *mu, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> abs_deadline);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/* If any threads are waiting on *cv, wake at least one.</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> Clients may treat this as an optimization of gpr_cv_broadcast()</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> for use in the case where waking more than one waiter is not useful.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> Requires: *cv initialized. */</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#abf066e257012246303a938350d1546a0">gpr_cv_signal</a>(<a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/* Wake all threads waiting on *cv. Requires: *cv initialized. */</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a>(<a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/* --- One-time initialization ---</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> gpr_once must be declared with static storage class, and initialized with</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> GPR_ONCE_INIT. e.g.,</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> static gpr_once once_var = GPR_ONCE_INIT; */</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/* Ensure that (*init_routine)() has been called exactly once (for the</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> specified gpr_once instance) and then return.</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> If multiple threads call gpr_once() on the same gpr_once instance, one of</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> them will call (*init_routine)(), and the others will block until that call</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> finishes.*/</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a1157f44f131ce5f000744bea273347bc">gpr_once_init</a>(<a class="code" href="sync__posix_8h.html#a28731dc17a4158343f58f453a4d5e37f">gpr_once</a> *once, <span class="keywordtype">void</span> (*init_routine)(<span class="keywordtype">void</span>));</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/* --- One-time event notification ---</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> These operations act on a gpr_event, which should be initialized with</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> gpr_ev_init(), or with GPR_EVENT_INIT if static, e.g.,</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> static gpr_event event_var = GPR_EVENT_INIT;</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> It requires no destruction. */</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/* Initialize *ev. */</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a8c1e214b5ff9e8f25dfc785977d8a092">gpr_event_init</a>(<a class="code" href="structgpr__event.html">gpr_event</a> *ev);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/* Set *ev so that gpr_event_get() and gpr_event_wait() will return value.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> Requires: *ev initialized; value != NULL; no prior or concurrent calls to</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> gpr_event_set(ev, ...) since initialization. */</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a39a77b09ffc2c288b097c84c4e0e29a5">gpr_event_set</a>(<a class="code" href="structgpr__event.html">gpr_event</a> *ev, <span class="keywordtype">void</span> *value);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/* Return the value set by gpr_event_set(ev, ...), or NULL if no such call has</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> completed. If the result is non-NULL, all operations that occurred prior to</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> the gpr_event_set(ev, ...) set will be visible after this call returns.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> Requires: *ev initialized. This operation is faster than acquiring a mutex</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> on most platforms. */</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> *<a class="code" href="grpc_2impl_2codegen_2sync_8h.html#afb62d3857409962718465c407f97fec3">gpr_event_get</a>(<a class="code" href="structgpr__event.html">gpr_event</a> *ev);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/* Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> exceeded, then return gpr_event_get(ev). Requires: *ev initialized. Use</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> abs_deadline==gpr_inf_future for no deadline. When the event has been</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> signalled before the call, this operation is faster than acquiring a mutex</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> on most platforms. */</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> *<a class="code" href="grpc_2impl_2codegen_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3">gpr_event_wait</a>(<a class="code" href="structgpr__event.html">gpr_event</a> *ev, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> abs_deadline);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">/* --- Reference counting ---</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"></span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> These calls act on the type gpr_refcount. It requires no destruction. */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/* Initialize *r to value n. */</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#afb46be51462503426660193b7d49f599">gpr_ref_init</a>(<a class="code" href="structgpr__refcount.html">gpr_refcount</a> *r, <span class="keywordtype">int</span> n);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">/* Increment the reference count *r. Requires *r initialized. */</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a2653bdd931dc3e35ef24f52b4ab074ee">gpr_ref</a>(<a class="code" href="structgpr__refcount.html">gpr_refcount</a> *r);</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment">/* Increment the reference count *r. Requires *r initialized.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> Crashes if refcount is zero */</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#ad152a5820acaa9ca6163bcbe45d078d6">gpr_ref_non_zero</a>(<a class="code" href="structgpr__refcount.html">gpr_refcount</a> *r);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">/* Increment the reference count *r by n. Requires *r initialized, n > 0. */</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a91472a0360a87654379b3b6eb0fe942e">gpr_refn</a>(<a class="code" href="structgpr__refcount.html">gpr_refcount</a> *r, <span class="keywordtype">int</span> n);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/* Decrement the reference count *r and return non-zero iff it has reached</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> zero. . Requires *r initialized. */</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a244626eb1a00a846eb602820fc736f84">gpr_unref</a>(<a class="code" href="structgpr__refcount.html">gpr_refcount</a> *r);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/* --- Stats counters ---</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"></span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> These calls act on the integral type gpr_stats_counter. It requires no</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> destruction. Static instances may be initialized with</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> gpr_stats_counter c = GPR_STATS_INIT;</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> Beware: These operations do not imply memory barriers. Do not use them to</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> synchronize other events. */</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">/* Initialize *c to the value n. */</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a05c0002cb69dbce4d94819f65551fca2">gpr_stats_init</a>(<a class="code" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c, intptr_t n);</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment">/* *c += inc. Requires: *c initialized. */</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a8d1f3e75040086f0da4d7fc4e94a5b2b">gpr_stats_inc</a>(<a class="code" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c, intptr_t inc);</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/* Return *c. Requires: *c initialized. */</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <a class="code" href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> intptr_t <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#ab451d39b50836fcad4ed48f080b7f648">gpr_stats_read</a>(<span class="keyword">const</span> <a class="code" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c);</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment">/* ==================Example use of interface===================</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> A producer-consumer queue of up to N integers,</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> illustrating the use of the calls in this interface. */</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#if 0</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor">#define N 4</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">typedef</span> <span class="keyword">struct </span>queue {</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> non_empty; <span class="comment">/* Signalled when length becomes non-zero. */</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <a class="code" href="sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> non_full; <span class="comment">/* Signalled when length becomes non-N. */</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="structgpr__mu.html">gpr_mu</a> mu; <span class="comment">/* Protects all fields below.</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> (That is, except during initialization or</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> destruction, the fields below should be accessed</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> only by a thread that holds mu.) */</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">int</span> head; <span class="comment">/* Index of head of queue 0..N-1. */</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keywordtype">int</span> length; <span class="comment">/* Number of valid elements in queue 0..N. */</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keywordtype">int</span> elem[N]; <span class="comment">/* elem[head .. head+length-1] are queue elements. */</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  } queue;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="comment">/* Initialize *q. */</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordtype">void</span> queue_init(queue *q) {</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a989fb0f141d90a05b20425ebdc77936d">gpr_mu_init</a>(&q->mu);</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">gpr_cv_init</a>(&q->non_empty);</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">gpr_cv_init</a>(&q->non_full);</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  q->head = 0;</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  q->length = 0;</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  }</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="comment">/* Free storage associated with *q. */</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordtype">void</span> queue_destroy(queue *q) {</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a23567fcb3d8a7d5f29834ddbcbbe1d1d">gpr_mu_destroy</a>(&q->mu);</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a053788a2217043c527afc8b424568b22">gpr_cv_destroy</a>(&q->non_empty);</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a053788a2217043c527afc8b424568b22">gpr_cv_destroy</a>(&q->non_full);</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  }</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="comment">/* Wait until there is room in *q, then append x to *q. */</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keywordtype">void</span> queue_append(queue *q, <span class="keywordtype">int</span> x) {</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">gpr_mu_lock</a>(&q->mu);</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="comment">/* To wait for a predicate without a deadline, loop on the negation of the</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> predicate, and use gpr_cv_wait(..., gpr_inf_future) inside the loop</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> to release the lock, wait, and reacquire on each iteration. Code that</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> makes the condition true should use gpr_cv_broadcast() on the</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> corresponding condition variable. The predicate must be on state</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> protected by the lock. */</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keywordflow">while</span> (q->length == N) {</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">gpr_cv_wait</a>(&q->non_full, &q->mu, <a class="code" href="grpc_2impl_2codegen_2time_8h.html#a57c9693ef253d0951363c5dafb6586df">gpr_inf_future</a>);</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  }</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordflow">if</span> (q->length == 0) { <span class="comment">/* Wake threads blocked in queue_remove(). */</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment">/* It's normal to use gpr_cv_broadcast() or gpr_signal() while</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> holding the lock. */</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a>(&q->non_empty);</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  }</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  q->elem[(q->head + q->length) % N] = x;</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  q->length++;</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a>(&q->mu);</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  }</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="comment">/* If it can be done without blocking, append x to *q and return non-zero.</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> Otherwise return 0. */</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keywordtype">int</span> queue_try_append(queue *q, <span class="keywordtype">int</span> x) {</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keywordtype">int</span> result = 0;</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordflow">if</span> (<a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a18765dc6c6292b12388a68eb541419a8">gpr_mu_trylock</a>(&q->mu)) {</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordflow">if</span> (q->length != N) {</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordflow">if</span> (q->length == 0) { <span class="comment">/* Wake threads blocked in queue_remove(). */</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a>(&q->non_empty);</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  }</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  q->elem[(q->head + q->length) % N] = x;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  q->length++;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  result = 1;</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  }</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a>(&q->mu);</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  }</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  }</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="comment">/* Wait until the *q is non-empty or deadline abs_deadline passes. If the</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> queue is non-empty, remove its head entry, place it in *head, and return</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> non-zero. Otherwise return 0. */</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keywordtype">int</span> queue_remove(queue *q, <span class="keywordtype">int</span> *head, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> abs_deadline) {</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="keywordtype">int</span> result = 0;</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">gpr_mu_lock</a>(&q->mu);</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <span class="comment">/* To wait for a predicate with a deadline, loop on the negation of the</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> predicate or until gpr_cv_wait() returns true. Code that makes</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> the condition true should use gpr_cv_broadcast() on the corresponding</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> condition variable. The predicate must be on state protected by the</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> lock. */</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keywordflow">while</span> (q->length == 0 &&</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  !<a class="code" href="grpc_2impl_2codegen_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">gpr_cv_wait</a>(&q->non_empty, &q->mu, abs_deadline)) {</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  }</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordflow">if</span> (q->length != 0) { <span class="comment">/* Queue is non-empty. */</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  result = 1;</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keywordflow">if</span> (q->length == N) { <span class="comment">/* Wake threads blocked in queue_append(). */</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a>(&q->non_full);</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  }</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  *head = q->elem[q->head];</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  q->head = (q->head + 1) % N;</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  q->length--;</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  } <span class="comment">/* else deadline exceeded */</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <a class="code" href="grpc_2impl_2codegen_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a>(&q->mu);</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  }</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="preprocessor">#endif </span><span class="comment">/* 0 */</span><span class="preprocessor"></span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> }</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> </div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="preprocessor">#endif </span><span class="comment">/* GRPC_IMPL_CODEGEN_SYNC_H */</span><span class="preprocessor"></span></div><div class="ttc" id="sync__posix_8h_html"><div class="ttname"><a href="sync__posix_8h.html">sync_posix.h</a></div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a05c0002cb69dbce4d94819f65551fca2"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a05c0002cb69dbce4d94819f65551fca2">gpr_stats_init</a></div><div class="ttdeci">GPRAPI void gpr_stats_init(gpr_stats_counter *c, intptr_t n)</div></div>
- <div class="ttc" id="port__platform_8h_html"><div class="ttname"><a href="port__platform_8h.html">port_platform.h</a></div></div>
- <div class="ttc" id="structgpr__refcount_html"><div class="ttname"><a href="structgpr__refcount.html">gpr_refcount</a></div><div class="ttdef"><b>Definition:</b> sync_generic.h:47</div></div>
- <div class="ttc" id="sync__generic_8h_html"><div class="ttname"><a href="sync__generic_8h.html">sync_generic.h</a></div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_ad152a5820acaa9ca6163bcbe45d078d6"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#ad152a5820acaa9ca6163bcbe45d078d6">gpr_ref_non_zero</a></div><div class="ttdeci">GPRAPI void gpr_ref_non_zero(gpr_refcount *r)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_adf647f6e8dede8b27ccda9e971ae4971"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">gpr_cv_wait</a></div><div class="ttdeci">GPRAPI int gpr_cv_wait(gpr_cv *cv, gpr_mu *mu, gpr_timespec abs_deadline)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_abf066e257012246303a938350d1546a0"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#abf066e257012246303a938350d1546a0">gpr_cv_signal</a></div><div class="ttdeci">GPRAPI void gpr_cv_signal(gpr_cv *cv)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a112715bd2e69d92010a6317c839eb36f"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">gpr_cv_init</a></div><div class="ttdeci">GPRAPI void gpr_cv_init(gpr_cv *cv)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_acc62f586f166d0cbd2c3ba7a707ac5a3"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3">gpr_event_wait</a></div><div class="ttdeci">GPRAPI void * gpr_event_wait(gpr_event *ev, gpr_timespec abs_deadline)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_afb46be51462503426660193b7d49f599"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#afb46be51462503426660193b7d49f599">gpr_ref_init</a></div><div class="ttdeci">GPRAPI void gpr_ref_init(gpr_refcount *r, int n)</div></div>
- <div class="ttc" id="port__platform_8h_html_af89d3610372fc35178e83e06916aa808"><div class="ttname"><a href="port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a></div><div class="ttdeci">#define GPRAPI</div><div class="ttdef"><b>Definition:</b> port_platform.h:463</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a8c1e214b5ff9e8f25dfc785977d8a092"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a8c1e214b5ff9e8f25dfc785977d8a092">gpr_event_init</a></div><div class="ttdeci">GPRAPI void gpr_event_init(gpr_event *ev)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a23567fcb3d8a7d5f29834ddbcbbe1d1d"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a23567fcb3d8a7d5f29834ddbcbbe1d1d">gpr_mu_destroy</a></div><div class="ttdeci">GPRAPI void gpr_mu_destroy(gpr_mu *mu)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a7001a8164ce893911acf26d2fb8fd2ba"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">gpr_mu_lock</a></div><div class="ttdeci">GPRAPI void gpr_mu_lock(gpr_mu *mu)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_af0e6cc39401a0ee35b728f5b88135376"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a></div><div class="ttdeci">GPRAPI void gpr_mu_unlock(gpr_mu *mu)</div></div>
- <div class="ttc" id="sync__posix_8h_html_a28731dc17a4158343f58f453a4d5e37f"><div class="ttname"><a href="sync__posix_8h.html#a28731dc17a4158343f58f453a4d5e37f">gpr_once</a></div><div class="ttdeci">pthread_once_t gpr_once</div><div class="ttdef"><b>Definition:</b> sync_posix.h:43</div></div>
- <div class="ttc" id="structgpr__stats__counter_html"><div class="ttname"><a href="structgpr__stats__counter.html">gpr_stats_counter</a></div><div class="ttdef"><b>Definition:</b> sync_generic.h:50</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="sync__windows_8h_html"><div class="ttname"><a href="sync__windows_8h.html">sync_windows.h</a></div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a989fb0f141d90a05b20425ebdc77936d"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a989fb0f141d90a05b20425ebdc77936d">gpr_mu_init</a></div><div class="ttdeci">GPRAPI void gpr_mu_init(gpr_mu *mu)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_ab451d39b50836fcad4ed48f080b7f648"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#ab451d39b50836fcad4ed48f080b7f648">gpr_stats_read</a></div><div class="ttdeci">GPRAPI intptr_t gpr_stats_read(const gpr_stats_counter *c)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a1157f44f131ce5f000744bea273347bc"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a1157f44f131ce5f000744bea273347bc">gpr_once_init</a></div><div class="ttdeci">GPRAPI void gpr_once_init(gpr_once *once, void(*init_routine)(void))</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a244626eb1a00a846eb602820fc736f84"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a244626eb1a00a846eb602820fc736f84">gpr_unref</a></div><div class="ttdeci">GPRAPI int gpr_unref(gpr_refcount *r)</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_windows.h:39</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a39a77b09ffc2c288b097c84c4e0e29a5"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a39a77b09ffc2c288b097c84c4e0e29a5">gpr_event_set</a></div><div class="ttdeci">GPRAPI void gpr_event_set(gpr_event *ev, void *value)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a053788a2217043c527afc8b424568b22"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a053788a2217043c527afc8b424568b22">gpr_cv_destroy</a></div><div class="ttdeci">GPRAPI void gpr_cv_destroy(gpr_cv *cv)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_afb62d3857409962718465c407f97fec3"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#afb62d3857409962718465c407f97fec3">gpr_event_get</a></div><div class="ttdeci">GPRAPI void * gpr_event_get(gpr_event *ev)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a18765dc6c6292b12388a68eb541419a8"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a18765dc6c6292b12388a68eb541419a8">gpr_mu_trylock</a></div><div class="ttdeci">GPRAPI int gpr_mu_trylock(gpr_mu *mu)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a684cb215f9f840791372180a810b405d"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a></div><div class="ttdeci">GPRAPI void gpr_cv_broadcast(gpr_cv *cv)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a91472a0360a87654379b3b6eb0fe942e"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a91472a0360a87654379b3b6eb0fe942e">gpr_refn</a></div><div class="ttdeci">GPRAPI void gpr_refn(gpr_refcount *r, int n)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a8d1f3e75040086f0da4d7fc4e94a5b2b"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a8d1f3e75040086f0da4d7fc4e94a5b2b">gpr_stats_inc</a></div><div class="ttdeci">GPRAPI void gpr_stats_inc(gpr_stats_counter *c, intptr_t inc)</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2time_8h_html_a57c9693ef253d0951363c5dafb6586df"><div class="ttname"><a href="grpc_2impl_2codegen_2time_8h.html#a57c9693ef253d0951363c5dafb6586df">gpr_inf_future</a></div><div class="ttdeci">GPRAPI gpr_timespec gpr_inf_future(gpr_clock_type type)</div></div>
- <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>
- <div class="ttc" id="grpc_2impl_2codegen_2time_8h_html"><div class="ttname"><a href="grpc_2impl_2codegen_2time_8h.html">time.h</a></div></div>
- <div class="ttc" id="structgpr__event_html"><div class="ttname"><a href="structgpr__event.html">gpr_event</a></div><div class="ttdef"><b>Definition:</b> sync_generic.h:41</div></div>
- <div class="ttc" id="grpc_2impl_2codegen_2sync_8h_html_a2653bdd931dc3e35ef24f52b4ab074ee"><div class="ttname"><a href="grpc_2impl_2codegen_2sync_8h.html#a2653bdd931dc3e35ef24f52b4ab074ee">gpr_ref</a></div><div class="ttdeci">GPRAPI void gpr_ref(gpr_refcount *r)</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.11
- </small></address>
- </body>
- </html>
|
