support_2sync_8h.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: include/grpc/support/sync.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Core
  25. &#160;<span id="projectnumber">15.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#func-members">Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">sync.h File Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <div class="textblock"><code>#include &lt;<a class="el" href="support_2port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br />
  74. <code>#include &lt;<a class="el" href="gpr__types_8h_source.html">grpc/impl/codegen/gpr_types.h</a>&gt;</code><br />
  75. <code>#include &lt;<a class="el" href="impl_2codegen_2sync_8h_source.html">grpc/impl/codegen/sync.h</a>&gt;</code><br />
  76. </div>
  77. <p><a href="support_2sync_8h_source.html">Go to the source code of this file.</a></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  80. Functions</h2></td></tr>
  81. <tr class="memitem:a989fb0f141d90a05b20425ebdc77936d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a989fb0f141d90a05b20425ebdc77936d">gpr_mu_init</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  82. <tr class="memdesc:a989fb0f141d90a05b20425ebdc77936d"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Mutex interface &mdash; <a href="support_2sync_8h.html#a989fb0f141d90a05b20425ebdc77936d">More...</a><br /></td></tr>
  83. <tr class="separator:a989fb0f141d90a05b20425ebdc77936d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a23567fcb3d8a7d5f29834ddbcbbe1d1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a23567fcb3d8a7d5f29834ddbcbbe1d1d">gpr_mu_destroy</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  85. <tr class="memdesc:a23567fcb3d8a7d5f29834ddbcbbe1d1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cause *mu no longer to be initialized, freeing any memory in use. <a href="support_2sync_8h.html#a23567fcb3d8a7d5f29834ddbcbbe1d1d">More...</a><br /></td></tr>
  86. <tr class="separator:a23567fcb3d8a7d5f29834ddbcbbe1d1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a7001a8164ce893911acf26d2fb8fd2ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">gpr_mu_lock</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  88. <tr class="memdesc:a7001a8164ce893911acf26d2fb8fd2ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until no thread has a lock on *mu, cause the calling thread to own an exclusive lock on *mu, then return. <a href="support_2sync_8h.html#a7001a8164ce893911acf26d2fb8fd2ba">More...</a><br /></td></tr>
  89. <tr class="separator:a7001a8164ce893911acf26d2fb8fd2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:af0e6cc39401a0ee35b728f5b88135376"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">gpr_mu_unlock</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  91. <tr class="memdesc:af0e6cc39401a0ee35b728f5b88135376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release an exclusive lock on *mu held by the calling thread. <a href="support_2sync_8h.html#af0e6cc39401a0ee35b728f5b88135376">More...</a><br /></td></tr>
  92. <tr class="separator:af0e6cc39401a0ee35b728f5b88135376"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a18765dc6c6292b12388a68eb541419a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a18765dc6c6292b12388a68eb541419a8">gpr_mu_trylock</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  94. <tr class="memdesc:a18765dc6c6292b12388a68eb541419a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Without blocking, attempt to acquire an exclusive lock on *mu for the calling thread, then return non-zero iff success. <a href="support_2sync_8h.html#a18765dc6c6292b12388a68eb541419a8">More...</a><br /></td></tr>
  95. <tr class="separator:a18765dc6c6292b12388a68eb541419a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a112715bd2e69d92010a6317c839eb36f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">gpr_cv_init</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv)</td></tr>
  97. <tr class="memdesc:a112715bd2e69d92010a6317c839eb36f"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Condition variable interface &mdash; <a href="support_2sync_8h.html#a112715bd2e69d92010a6317c839eb36f">More...</a><br /></td></tr>
  98. <tr class="separator:a112715bd2e69d92010a6317c839eb36f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a053788a2217043c527afc8b424568b22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a053788a2217043c527afc8b424568b22">gpr_cv_destroy</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv)</td></tr>
  100. <tr class="memdesc:a053788a2217043c527afc8b424568b22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cause *cv no longer to be initialized, freeing any memory in use. <a href="support_2sync_8h.html#a053788a2217043c527afc8b424568b22">More...</a><br /></td></tr>
  101. <tr class="separator:a053788a2217043c527afc8b424568b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:adf647f6e8dede8b27ccda9e971ae4971"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">gpr_cv_wait</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv, <a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> abs_deadline)</td></tr>
  103. <tr class="memdesc:adf647f6e8dede8b27ccda9e971ae4971"><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomically release *mu and wait on *cv. <a href="support_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971">More...</a><br /></td></tr>
  104. <tr class="separator:adf647f6e8dede8b27ccda9e971ae4971"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:abf066e257012246303a938350d1546a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#abf066e257012246303a938350d1546a0">gpr_cv_signal</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv)</td></tr>
  106. <tr class="memdesc:abf066e257012246303a938350d1546a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">If any threads are waiting on *cv, wake at least one. <a href="support_2sync_8h.html#abf066e257012246303a938350d1546a0">More...</a><br /></td></tr>
  107. <tr class="separator:abf066e257012246303a938350d1546a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a684cb215f9f840791372180a810b405d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a684cb215f9f840791372180a810b405d">gpr_cv_broadcast</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *cv)</td></tr>
  109. <tr class="memdesc:a684cb215f9f840791372180a810b405d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wake all threads waiting on *cv. <a href="support_2sync_8h.html#a684cb215f9f840791372180a810b405d">More...</a><br /></td></tr>
  110. <tr class="separator:a684cb215f9f840791372180a810b405d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ac6566f51f1304fec359b2b9cccc89f69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#ac6566f51f1304fec359b2b9cccc89f69">gpr_once_init</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#a28731dc17a4158343f58f453a4d5e37f">gpr_once</a> *once, void(*init_function)(void))</td></tr>
  112. <tr class="memdesc:ac6566f51f1304fec359b2b9cccc89f69"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; One-time initialization &mdash; <a href="support_2sync_8h.html#ac6566f51f1304fec359b2b9cccc89f69">More...</a><br /></td></tr>
  113. <tr class="separator:ac6566f51f1304fec359b2b9cccc89f69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a8c1e214b5ff9e8f25dfc785977d8a092"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a8c1e214b5ff9e8f25dfc785977d8a092">gpr_event_init</a> (<a class="el" href="structgpr__event.html">gpr_event</a> *ev)</td></tr>
  115. <tr class="memdesc:a8c1e214b5ff9e8f25dfc785977d8a092"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; One-time event notification &mdash; <a href="support_2sync_8h.html#a8c1e214b5ff9e8f25dfc785977d8a092">More...</a><br /></td></tr>
  116. <tr class="separator:a8c1e214b5ff9e8f25dfc785977d8a092"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a39a77b09ffc2c288b097c84c4e0e29a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a39a77b09ffc2c288b097c84c4e0e29a5">gpr_event_set</a> (<a class="el" href="structgpr__event.html">gpr_event</a> *ev, void *value)</td></tr>
  118. <tr class="memdesc:a39a77b09ffc2c288b097c84c4e0e29a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set *ev so that <a class="el" href="support_2sync_8h.html#afb62d3857409962718465c407f97fec3" title="Return the value set by gpr_event_set(ev, ...), or NULL if no such call has completed.">gpr_event_get()</a> and <a class="el" href="support_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3" title="Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is exceeded, then return gpr_event_g...">gpr_event_wait()</a> will return value. <a href="support_2sync_8h.html#a39a77b09ffc2c288b097c84c4e0e29a5">More...</a><br /></td></tr>
  119. <tr class="separator:a39a77b09ffc2c288b097c84c4e0e29a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:afb62d3857409962718465c407f97fec3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#afb62d3857409962718465c407f97fec3">gpr_event_get</a> (<a class="el" href="structgpr__event.html">gpr_event</a> *ev)</td></tr>
  121. <tr class="memdesc:afb62d3857409962718465c407f97fec3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value set by gpr_event_set(ev, ...), or NULL if no such call has completed. <a href="support_2sync_8h.html#afb62d3857409962718465c407f97fec3">More...</a><br /></td></tr>
  122. <tr class="separator:afb62d3857409962718465c407f97fec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:acc62f586f166d0cbd2c3ba7a707ac5a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3">gpr_event_wait</a> (<a class="el" href="structgpr__event.html">gpr_event</a> *ev, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> abs_deadline)</td></tr>
  124. <tr class="memdesc:acc62f586f166d0cbd2c3ba7a707ac5a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is exceeded, then return gpr_event_get(ev). <a href="support_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3">More...</a><br /></td></tr>
  125. <tr class="separator:acc62f586f166d0cbd2c3ba7a707ac5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:afb46be51462503426660193b7d49f599"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#afb46be51462503426660193b7d49f599">gpr_ref_init</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r, int n)</td></tr>
  127. <tr class="memdesc:afb46be51462503426660193b7d49f599"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Reference counting &mdash; <a href="support_2sync_8h.html#afb46be51462503426660193b7d49f599">More...</a><br /></td></tr>
  128. <tr class="separator:afb46be51462503426660193b7d49f599"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a2653bdd931dc3e35ef24f52b4ab074ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a2653bdd931dc3e35ef24f52b4ab074ee">gpr_ref</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r)</td></tr>
  130. <tr class="memdesc:a2653bdd931dc3e35ef24f52b4ab074ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the reference count *r. <a href="support_2sync_8h.html#a2653bdd931dc3e35ef24f52b4ab074ee">More...</a><br /></td></tr>
  131. <tr class="separator:a2653bdd931dc3e35ef24f52b4ab074ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ad152a5820acaa9ca6163bcbe45d078d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#ad152a5820acaa9ca6163bcbe45d078d6">gpr_ref_non_zero</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r)</td></tr>
  133. <tr class="memdesc:ad152a5820acaa9ca6163bcbe45d078d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the reference count *r. <a href="support_2sync_8h.html#ad152a5820acaa9ca6163bcbe45d078d6">More...</a><br /></td></tr>
  134. <tr class="separator:ad152a5820acaa9ca6163bcbe45d078d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a91472a0360a87654379b3b6eb0fe942e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a91472a0360a87654379b3b6eb0fe942e">gpr_refn</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r, int n)</td></tr>
  136. <tr class="memdesc:a91472a0360a87654379b3b6eb0fe942e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the reference count *r by n. <a href="support_2sync_8h.html#a91472a0360a87654379b3b6eb0fe942e">More...</a><br /></td></tr>
  137. <tr class="separator:a91472a0360a87654379b3b6eb0fe942e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a244626eb1a00a846eb602820fc736f84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a244626eb1a00a846eb602820fc736f84">gpr_unref</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r)</td></tr>
  139. <tr class="memdesc:a244626eb1a00a846eb602820fc736f84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrement the reference count *r and return non-zero iff it has reached zero. <a href="support_2sync_8h.html#a244626eb1a00a846eb602820fc736f84">More...</a><br /></td></tr>
  140. <tr class="separator:a244626eb1a00a846eb602820fc736f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a532b23d0393bf91ebcc221f5855c17fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a532b23d0393bf91ebcc221f5855c17fa">gpr_ref_is_unique</a> (<a class="el" href="structgpr__refcount.html">gpr_refcount</a> *r)</td></tr>
  142. <tr class="memdesc:a532b23d0393bf91ebcc221f5855c17fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return non-zero iff the reference count of *r is one, and thus is owned by exactly one object. <a href="support_2sync_8h.html#a532b23d0393bf91ebcc221f5855c17fa">More...</a><br /></td></tr>
  143. <tr class="separator:a532b23d0393bf91ebcc221f5855c17fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a05c0002cb69dbce4d94819f65551fca2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a05c0002cb69dbce4d94819f65551fca2">gpr_stats_init</a> (<a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c, intptr_t n)</td></tr>
  145. <tr class="memdesc:a05c0002cb69dbce4d94819f65551fca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Stats counters &mdash; <a href="support_2sync_8h.html#a05c0002cb69dbce4d94819f65551fca2">More...</a><br /></td></tr>
  146. <tr class="separator:a05c0002cb69dbce4d94819f65551fca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a8d1f3e75040086f0da4d7fc4e94a5b2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#a8d1f3e75040086f0da4d7fc4e94a5b2b">gpr_stats_inc</a> (<a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c, intptr_t inc)</td></tr>
  148. <tr class="memdesc:a8d1f3e75040086f0da4d7fc4e94a5b2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">*c += inc. <a href="support_2sync_8h.html#a8d1f3e75040086f0da4d7fc4e94a5b2b">More...</a><br /></td></tr>
  149. <tr class="separator:a8d1f3e75040086f0da4d7fc4e94a5b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:ab451d39b50836fcad4ed48f080b7f648"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> intptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="support_2sync_8h.html#ab451d39b50836fcad4ed48f080b7f648">gpr_stats_read</a> (const <a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *c)</td></tr>
  151. <tr class="memdesc:ab451d39b50836fcad4ed48f080b7f648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return *c. <a href="support_2sync_8h.html#ab451d39b50836fcad4ed48f080b7f648">More...</a><br /></td></tr>
  152. <tr class="separator:ab451d39b50836fcad4ed48f080b7f648"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table>
  154. <h2 class="groupheader">Function Documentation</h2>
  155. <a id="a684cb215f9f840791372180a810b405d"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#a684cb215f9f840791372180a810b405d">&#9670;&nbsp;</a></span>gpr_cv_broadcast()</h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cv_broadcast </td>
  162. <td>(</td>
  163. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *&#160;</td>
  164. <td class="paramname"><em>cv</em></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Wake all threads waiting on *cv. </p>
  170. <p>Requires: *cv initialized. <br />
  171. </p>
  172. </div>
  173. </div>
  174. <a id="a053788a2217043c527afc8b424568b22"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#a053788a2217043c527afc8b424568b22">&#9670;&nbsp;</a></span>gpr_cv_destroy()</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cv_destroy </td>
  181. <td>(</td>
  182. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *&#160;</td>
  183. <td class="paramname"><em>cv</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Cause *cv no longer to be initialized, freeing any memory in use. </p>
  189. <p>Requires: cv initialized; no other concurrent operation on *cv. </p>
  190. </div>
  191. </div>
  192. <a id="a112715bd2e69d92010a6317c839eb36f"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a112715bd2e69d92010a6317c839eb36f">&#9670;&nbsp;</a></span>gpr_cv_init()</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cv_init </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *&#160;</td>
  201. <td class="paramname"><em>cv</em></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>&mdash; Condition variable interface &mdash; </p>
  207. <p>A while-loop should be used with <a class="el" href="support_2sync_8h.html#adf647f6e8dede8b27ccda9e971ae4971" title="Atomically release *mu and wait on *cv.">gpr_cv_wait()</a> when waiting for conditions to become true. See the example below. Variables of type gpr_cv are uninitialized when first declared. <br />
  208. Initialize *cv. Requires: *cv uninitialized. <br />
  209. </p>
  210. </div>
  211. </div>
  212. <a id="abf066e257012246303a938350d1546a0"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#abf066e257012246303a938350d1546a0">&#9670;&nbsp;</a></span>gpr_cv_signal()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_cv_signal </td>
  219. <td>(</td>
  220. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *&#160;</td>
  221. <td class="paramname"><em>cv</em></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>If any threads are waiting on *cv, wake at least one. </p>
  227. <p>Clients may treat this as an optimization of <a class="el" href="support_2sync_8h.html#a684cb215f9f840791372180a810b405d" title="Wake all threads waiting on *cv.">gpr_cv_broadcast()</a> for use in the case where waking more than one waiter is not useful. Requires: *cv initialized. <br />
  228. </p>
  229. </div>
  230. </div>
  231. <a id="adf647f6e8dede8b27ccda9e971ae4971"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#adf647f6e8dede8b27ccda9e971ae4971">&#9670;&nbsp;</a></span>gpr_cv_wait()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_cv_wait </td>
  238. <td>(</td>
  239. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a1ad613e07180c0459cda9f3f6d881885">gpr_cv</a> *&#160;</td>
  240. <td class="paramname"><em>cv</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  246. <td class="paramname"><em>mu</em>, </td>
  247. </tr>
  248. <tr>
  249. <td class="paramkey"></td>
  250. <td></td>
  251. <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
  252. <td class="paramname"><em>abs_deadline</em>&#160;</td>
  253. </tr>
  254. <tr>
  255. <td></td>
  256. <td>)</td>
  257. <td></td><td></td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Atomically release *mu and wait on *cv. </p>
  262. <p>When the calling thread is woken from *cv or the deadline abs_deadline is exceeded, execute gpr_mu_lock(mu) and return whether the deadline was exceeded. Use abs_deadline==gpr_inf_future for no deadline. abs_deadline can be either an absolute deadline, or a GPR_TIMESPAN. May return even when not woken explicitly. Requires: *mu and *cv initialized; the calling thread holds an exclusive lock on *mu. <br />
  263. </p>
  264. </div>
  265. </div>
  266. <a id="afb62d3857409962718465c407f97fec3"></a>
  267. <h2 class="memtitle"><span class="permalink"><a href="#afb62d3857409962718465c407f97fec3">&#9670;&nbsp;</a></span>gpr_event_get()</h2>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_event_get </td>
  273. <td>(</td>
  274. <td class="paramtype"><a class="el" href="structgpr__event.html">gpr_event</a> *&#160;</td>
  275. <td class="paramname"><em>ev</em></td><td>)</td>
  276. <td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Return the value set by gpr_event_set(ev, ...), or NULL if no such call has completed. </p>
  281. <p>If the result is non-NULL, all operations that occurred prior to the gpr_event_set(ev, ...) set will be visible after this call returns. Requires: *ev initialized. This operation is faster than acquiring a mutex on most platforms. <br />
  282. </p>
  283. </div>
  284. </div>
  285. <a id="a8c1e214b5ff9e8f25dfc785977d8a092"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#a8c1e214b5ff9e8f25dfc785977d8a092">&#9670;&nbsp;</a></span>gpr_event_init()</h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_event_init </td>
  292. <td>(</td>
  293. <td class="paramtype"><a class="el" href="structgpr__event.html">gpr_event</a> *&#160;</td>
  294. <td class="paramname"><em>ev</em></td><td>)</td>
  295. <td></td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>&mdash; One-time event notification &mdash; </p>
  300. <p>These operations act on a <a class="el" href="structgpr__event.html">gpr_event</a>, which should be initialized with gpr_ev_init(), or with GPR_EVENT_INIT if static, e.g., static <a class="el" href="structgpr__event.html">gpr_event</a> event_var = GPR_EVENT_INIT; It requires no destruction. <br />
  301. Initialize *ev. </p>
  302. </div>
  303. </div>
  304. <a id="a39a77b09ffc2c288b097c84c4e0e29a5"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a39a77b09ffc2c288b097c84c4e0e29a5">&#9670;&nbsp;</a></span>gpr_event_set()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_event_set </td>
  311. <td>(</td>
  312. <td class="paramtype"><a class="el" href="structgpr__event.html">gpr_event</a> *&#160;</td>
  313. <td class="paramname"><em>ev</em>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype">void *&#160;</td>
  319. <td class="paramname"><em>value</em>&#160;</td>
  320. </tr>
  321. <tr>
  322. <td></td>
  323. <td>)</td>
  324. <td></td><td></td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Set *ev so that <a class="el" href="support_2sync_8h.html#afb62d3857409962718465c407f97fec3" title="Return the value set by gpr_event_set(ev, ...), or NULL if no such call has completed.">gpr_event_get()</a> and <a class="el" href="support_2sync_8h.html#acc62f586f166d0cbd2c3ba7a707ac5a3" title="Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is exceeded, then return gpr_event_g...">gpr_event_wait()</a> will return value. </p>
  329. <p>Requires: *ev initialized; value != NULL; no prior or concurrent calls to gpr_event_set(ev, ...) since initialization. <br />
  330. </p>
  331. </div>
  332. </div>
  333. <a id="acc62f586f166d0cbd2c3ba7a707ac5a3"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#acc62f586f166d0cbd2c3ba7a707ac5a3">&#9670;&nbsp;</a></span>gpr_event_wait()</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void* gpr_event_wait </td>
  340. <td>(</td>
  341. <td class="paramtype"><a class="el" href="structgpr__event.html">gpr_event</a> *&#160;</td>
  342. <td class="paramname"><em>ev</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
  348. <td class="paramname"><em>abs_deadline</em>&#160;</td>
  349. </tr>
  350. <tr>
  351. <td></td>
  352. <td>)</td>
  353. <td></td><td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is exceeded, then return gpr_event_get(ev). </p>
  358. <p>Requires: *ev initialized. Use abs_deadline==gpr_inf_future for no deadline. When the event has been signalled before the call, this operation is faster than acquiring a mutex on most platforms. <br />
  359. </p>
  360. </div>
  361. </div>
  362. <a id="a23567fcb3d8a7d5f29834ddbcbbe1d1d"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#a23567fcb3d8a7d5f29834ddbcbbe1d1d">&#9670;&nbsp;</a></span>gpr_mu_destroy()</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_mu_destroy </td>
  369. <td>(</td>
  370. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  371. <td class="paramname"><em>mu</em></td><td>)</td>
  372. <td></td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Cause *mu no longer to be initialized, freeing any memory in use. </p>
  377. <p>Requires: mu initialized; no other concurrent operation on *mu. <br />
  378. </p>
  379. </div>
  380. </div>
  381. <a id="a989fb0f141d90a05b20425ebdc77936d"></a>
  382. <h2 class="memtitle"><span class="permalink"><a href="#a989fb0f141d90a05b20425ebdc77936d">&#9670;&nbsp;</a></span>gpr_mu_init()</h2>
  383. <div class="memitem">
  384. <div class="memproto">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_mu_init </td>
  388. <td>(</td>
  389. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  390. <td class="paramname"><em>mu</em></td><td>)</td>
  391. <td></td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>&mdash; Mutex interface &mdash; </p>
  396. <p>At most one thread may hold an exclusive lock on a mutex at any given time. Actions taken by a thread that holds a mutex exclusively happen after actions taken by all previous holders of the mutex. Variables of type gpr_mu are uninitialized when first declared. <br />
  397. Initialize *mu. Requires: *mu uninitialized. <br />
  398. </p>
  399. </div>
  400. </div>
  401. <a id="a7001a8164ce893911acf26d2fb8fd2ba"></a>
  402. <h2 class="memtitle"><span class="permalink"><a href="#a7001a8164ce893911acf26d2fb8fd2ba">&#9670;&nbsp;</a></span>gpr_mu_lock()</h2>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_mu_lock </td>
  408. <td>(</td>
  409. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  410. <td class="paramname"><em>mu</em></td><td>)</td>
  411. <td></td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>Wait until no thread has a lock on *mu, cause the calling thread to own an exclusive lock on *mu, then return. </p>
  416. <p>May block indefinitely or crash if the calling thread has a lock on *mu. Requires: *mu initialized. <br />
  417. </p>
  418. </div>
  419. </div>
  420. <a id="a18765dc6c6292b12388a68eb541419a8"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a18765dc6c6292b12388a68eb541419a8">&#9670;&nbsp;</a></span>gpr_mu_trylock()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_mu_trylock </td>
  427. <td>(</td>
  428. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  429. <td class="paramname"><em>mu</em></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <p>Without blocking, attempt to acquire an exclusive lock on *mu for the calling thread, then return non-zero iff success. </p>
  435. <p>Fail, if any thread holds the lock; succeeds with high probability if no thread holds the lock. Requires: *mu initialized. <br />
  436. </p>
  437. </div>
  438. </div>
  439. <a id="af0e6cc39401a0ee35b728f5b88135376"></a>
  440. <h2 class="memtitle"><span class="permalink"><a href="#af0e6cc39401a0ee35b728f5b88135376">&#9670;&nbsp;</a></span>gpr_mu_unlock()</h2>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_mu_unlock </td>
  446. <td>(</td>
  447. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  448. <td class="paramname"><em>mu</em></td><td>)</td>
  449. <td></td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Release an exclusive lock on *mu held by the calling thread. </p>
  454. <p>Requires: *mu initialized; the calling thread holds an exclusive lock on *mu. <br />
  455. </p>
  456. </div>
  457. </div>
  458. <a id="ac6566f51f1304fec359b2b9cccc89f69"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#ac6566f51f1304fec359b2b9cccc89f69">&#9670;&nbsp;</a></span>gpr_once_init()</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_once_init </td>
  465. <td>(</td>
  466. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#a28731dc17a4158343f58f453a4d5e37f">gpr_once</a> *&#160;</td>
  467. <td class="paramname"><em>once</em>, </td>
  468. </tr>
  469. <tr>
  470. <td class="paramkey"></td>
  471. <td></td>
  472. <td class="paramtype">void(*)(void)&#160;</td>
  473. <td class="paramname"><em>init_function</em>&#160;</td>
  474. </tr>
  475. <tr>
  476. <td></td>
  477. <td>)</td>
  478. <td></td><td></td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. <p>&mdash; One-time initialization &mdash; </p>
  483. <p>gpr_once must be declared with static storage class, and initialized with GPR_ONCE_INIT. e.g., static gpr_once once_var = GPR_ONCE_INIT; <br />
  484. Ensure that (*init_function)() has been called exactly once (for the specified gpr_once instance) and then return. If multiple threads call <a class="el" href="impl_2codegen_2sync__posix_8h.html#a28731dc17a4158343f58f453a4d5e37f">gpr_once()</a> on the same gpr_once instance, one of them will call (*init_function)(), and the others will block until that call finishes. </p>
  485. </div>
  486. </div>
  487. <a id="a2653bdd931dc3e35ef24f52b4ab074ee"></a>
  488. <h2 class="memtitle"><span class="permalink"><a href="#a2653bdd931dc3e35ef24f52b4ab074ee">&#9670;&nbsp;</a></span>gpr_ref()</h2>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_ref </td>
  494. <td>(</td>
  495. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  496. <td class="paramname"><em>r</em></td><td>)</td>
  497. <td></td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <p>Increment the reference count *r. </p>
  502. <p>Requires *r initialized. </p>
  503. </div>
  504. </div>
  505. <a id="afb46be51462503426660193b7d49f599"></a>
  506. <h2 class="memtitle"><span class="permalink"><a href="#afb46be51462503426660193b7d49f599">&#9670;&nbsp;</a></span>gpr_ref_init()</h2>
  507. <div class="memitem">
  508. <div class="memproto">
  509. <table class="memname">
  510. <tr>
  511. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_ref_init </td>
  512. <td>(</td>
  513. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  514. <td class="paramname"><em>r</em>, </td>
  515. </tr>
  516. <tr>
  517. <td class="paramkey"></td>
  518. <td></td>
  519. <td class="paramtype">int&#160;</td>
  520. <td class="paramname"><em>n</em>&#160;</td>
  521. </tr>
  522. <tr>
  523. <td></td>
  524. <td>)</td>
  525. <td></td><td></td>
  526. </tr>
  527. </table>
  528. </div><div class="memdoc">
  529. <p>&mdash; Reference counting &mdash; </p>
  530. <p>These calls act on the type <a class="el" href="structgpr__refcount.html">gpr_refcount</a>. It requires no destruction. <br />
  531. Initialize *r to value n. <br />
  532. </p>
  533. </div>
  534. </div>
  535. <a id="a532b23d0393bf91ebcc221f5855c17fa"></a>
  536. <h2 class="memtitle"><span class="permalink"><a href="#a532b23d0393bf91ebcc221f5855c17fa">&#9670;&nbsp;</a></span>gpr_ref_is_unique()</h2>
  537. <div class="memitem">
  538. <div class="memproto">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_ref_is_unique </td>
  542. <td>(</td>
  543. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  544. <td class="paramname"><em>r</em></td><td>)</td>
  545. <td></td>
  546. </tr>
  547. </table>
  548. </div><div class="memdoc">
  549. <p>Return non-zero iff the reference count of *r is one, and thus is owned by exactly one object. </p>
  550. </div>
  551. </div>
  552. <a id="ad152a5820acaa9ca6163bcbe45d078d6"></a>
  553. <h2 class="memtitle"><span class="permalink"><a href="#ad152a5820acaa9ca6163bcbe45d078d6">&#9670;&nbsp;</a></span>gpr_ref_non_zero()</h2>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <table class="memname">
  557. <tr>
  558. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_ref_non_zero </td>
  559. <td>(</td>
  560. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  561. <td class="paramname"><em>r</em></td><td>)</td>
  562. <td></td>
  563. </tr>
  564. </table>
  565. </div><div class="memdoc">
  566. <p>Increment the reference count *r. </p>
  567. <p>Requires *r initialized. Crashes if refcount is zero </p>
  568. </div>
  569. </div>
  570. <a id="a91472a0360a87654379b3b6eb0fe942e"></a>
  571. <h2 class="memtitle"><span class="permalink"><a href="#a91472a0360a87654379b3b6eb0fe942e">&#9670;&nbsp;</a></span>gpr_refn()</h2>
  572. <div class="memitem">
  573. <div class="memproto">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_refn </td>
  577. <td>(</td>
  578. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  579. <td class="paramname"><em>r</em>, </td>
  580. </tr>
  581. <tr>
  582. <td class="paramkey"></td>
  583. <td></td>
  584. <td class="paramtype">int&#160;</td>
  585. <td class="paramname"><em>n</em>&#160;</td>
  586. </tr>
  587. <tr>
  588. <td></td>
  589. <td>)</td>
  590. <td></td><td></td>
  591. </tr>
  592. </table>
  593. </div><div class="memdoc">
  594. <p>Increment the reference count *r by n. </p>
  595. <p>Requires *r initialized, n &gt; 0. </p>
  596. </div>
  597. </div>
  598. <a id="a8d1f3e75040086f0da4d7fc4e94a5b2b"></a>
  599. <h2 class="memtitle"><span class="permalink"><a href="#a8d1f3e75040086f0da4d7fc4e94a5b2b">&#9670;&nbsp;</a></span>gpr_stats_inc()</h2>
  600. <div class="memitem">
  601. <div class="memproto">
  602. <table class="memname">
  603. <tr>
  604. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_stats_inc </td>
  605. <td>(</td>
  606. <td class="paramtype"><a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *&#160;</td>
  607. <td class="paramname"><em>c</em>, </td>
  608. </tr>
  609. <tr>
  610. <td class="paramkey"></td>
  611. <td></td>
  612. <td class="paramtype">intptr_t&#160;</td>
  613. <td class="paramname"><em>inc</em>&#160;</td>
  614. </tr>
  615. <tr>
  616. <td></td>
  617. <td>)</td>
  618. <td></td><td></td>
  619. </tr>
  620. </table>
  621. </div><div class="memdoc">
  622. <p>*c += inc. </p>
  623. <p>Requires: *c initialized. </p>
  624. </div>
  625. </div>
  626. <a id="a05c0002cb69dbce4d94819f65551fca2"></a>
  627. <h2 class="memtitle"><span class="permalink"><a href="#a05c0002cb69dbce4d94819f65551fca2">&#9670;&nbsp;</a></span>gpr_stats_init()</h2>
  628. <div class="memitem">
  629. <div class="memproto">
  630. <table class="memname">
  631. <tr>
  632. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> void gpr_stats_init </td>
  633. <td>(</td>
  634. <td class="paramtype"><a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *&#160;</td>
  635. <td class="paramname"><em>c</em>, </td>
  636. </tr>
  637. <tr>
  638. <td class="paramkey"></td>
  639. <td></td>
  640. <td class="paramtype">intptr_t&#160;</td>
  641. <td class="paramname"><em>n</em>&#160;</td>
  642. </tr>
  643. <tr>
  644. <td></td>
  645. <td>)</td>
  646. <td></td><td></td>
  647. </tr>
  648. </table>
  649. </div><div class="memdoc">
  650. <p>&mdash; Stats counters &mdash; </p>
  651. <p>These calls act on the integral type <a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a>. It requires no destruction. Static instances may be initialized with <a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> c = GPR_STATS_INIT; Beware: These operations do not imply memory barriers. Do not use them to synchronize other events. <br />
  652. Initialize *c to the value n. </p>
  653. </div>
  654. </div>
  655. <a id="ab451d39b50836fcad4ed48f080b7f648"></a>
  656. <h2 class="memtitle"><span class="permalink"><a href="#ab451d39b50836fcad4ed48f080b7f648">&#9670;&nbsp;</a></span>gpr_stats_read()</h2>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="memname">
  660. <tr>
  661. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> intptr_t gpr_stats_read </td>
  662. <td>(</td>
  663. <td class="paramtype">const <a class="el" href="structgpr__stats__counter.html">gpr_stats_counter</a> *&#160;</td>
  664. <td class="paramname"><em>c</em></td><td>)</td>
  665. <td></td>
  666. </tr>
  667. </table>
  668. </div><div class="memdoc">
  669. <p>Return *c. </p>
  670. <p>Requires: *c initialized. </p>
  671. </div>
  672. </div>
  673. <a id="a244626eb1a00a846eb602820fc736f84"></a>
  674. <h2 class="memtitle"><span class="permalink"><a href="#a244626eb1a00a846eb602820fc736f84">&#9670;&nbsp;</a></span>gpr_unref()</h2>
  675. <div class="memitem">
  676. <div class="memproto">
  677. <table class="memname">
  678. <tr>
  679. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> int gpr_unref </td>
  680. <td>(</td>
  681. <td class="paramtype"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> *&#160;</td>
  682. <td class="paramname"><em>r</em></td><td>)</td>
  683. <td></td>
  684. </tr>
  685. </table>
  686. </div><div class="memdoc">
  687. <p>Decrement the reference count *r and return non-zero iff it has reached zero. </p>
  688. <p>. Requires *r initialized. </p>
  689. </div>
  690. </div>
  691. </div><!-- contents -->
  692. <!-- start footer part -->
  693. <hr class="footer"/><address class="footer"><small>
  694. Generated on Wed Mar 3 2021 19:17:10 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  695. <img class="footer" src="doxygen.png" alt="doxygen"/>
  696. </a> 1.8.17
  697. </small></address>
  698. </body>
  699. </html>