classgrpc_1_1internal_1_1_cond_var.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  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 C++: grpc::internal::CondVar Class 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 C++
  25. &#160;<span id="projectnumber">1.36.1</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="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::internal::CondVar Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p><code>#include &lt;<a class="el" href="p_2impl_2codegen_2sync_8h_source.html">sync.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a33ce590ba2b22d31e37a92f57509b2ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a33ce590ba2b22d31e37a92f57509b2ef">CondVar</a> ()</td></tr>
  78. <tr class="separator:a33ce590ba2b22d31e37a92f57509b2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a7bce6437bf6391cd0404ae1e380a77e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a7bce6437bf6391cd0404ae1e380a77e5">~CondVar</a> ()</td></tr>
  80. <tr class="separator:a7bce6437bf6391cd0404ae1e380a77e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a3d961f0ea2c7b8929ac1b16f02a8133a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a3d961f0ea2c7b8929ac1b16f02a8133a">CondVar</a> (const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;)=delete</td></tr>
  82. <tr class="separator:a3d961f0ea2c7b8929ac1b16f02a8133a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a4ca874560c2937b6cd2012aca342f10a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a4ca874560c2937b6cd2012aca342f10a">operator=</a> (const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;)=delete</td></tr>
  84. <tr class="separator:a4ca874560c2937b6cd2012aca342f10a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a0e1e436264df6f216b27508c10e0554b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a0e1e436264df6f216b27508c10e0554b">Signal</a> ()</td></tr>
  86. <tr class="separator:a0e1e436264df6f216b27508c10e0554b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a13aeb88276bf1b834e5d85d2785fd5c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a13aeb88276bf1b834e5d85d2785fd5c7">Broadcast</a> ()</td></tr>
  88. <tr class="separator:a13aeb88276bf1b834e5d85d2785fd5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a5799b41212b05122c2797e2d0487da46"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a5799b41212b05122c2797e2d0487da46">Wait</a> (<a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *mu)</td></tr>
  90. <tr class="separator:a5799b41212b05122c2797e2d0487da46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a5a877c28bdfc56f26e7d4e525e057807"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#a5a877c28bdfc56f26e7d4e525e057807">Wait</a> (<a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *mu, const <a class="el" href="structgpr__timespec.html">gpr_timespec</a> &amp;deadline)</td></tr>
  92. <tr class="separator:a5a877c28bdfc56f26e7d4e525e057807"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ad7f1985510b62bda2f58ce0f872e265d"><td class="memTemplParams" colspan="2">template&lt;typename Predicate &gt; </td></tr>
  94. <tr class="memitem:ad7f1985510b62bda2f58ce0f872e265d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html#ad7f1985510b62bda2f58ce0f872e265d">WaitUntil</a> (<a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *mu, Predicate pred)</td></tr>
  95. <tr class="separator:ad7f1985510b62bda2f58ce0f872e265d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  98. <a id="a33ce590ba2b22d31e37a92f57509b2ef"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#a33ce590ba2b22d31e37a92f57509b2ef">&#9670;&nbsp;</a></span>CondVar() <span class="overload">[1/2]</span></h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">grpc::internal::CondVar::CondVar </td>
  108. <td>(</td>
  109. <td class="paramname"></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </td>
  114. <td class="mlabels-right">
  115. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. </div>
  120. </div>
  121. <a id="a7bce6437bf6391cd0404ae1e380a77e5"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#a7bce6437bf6391cd0404ae1e380a77e5">&#9670;&nbsp;</a></span>~CondVar()</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="mlabels">
  126. <tr>
  127. <td class="mlabels-left">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">grpc::internal::CondVar::~CondVar </td>
  131. <td>(</td>
  132. <td class="paramname"></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </td>
  137. <td class="mlabels-right">
  138. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. </div>
  143. </div>
  144. <a id="a3d961f0ea2c7b8929ac1b16f02a8133a"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#a3d961f0ea2c7b8929ac1b16f02a8133a">&#9670;&nbsp;</a></span>CondVar() <span class="overload">[2/2]</span></h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="mlabels">
  149. <tr>
  150. <td class="mlabels-left">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">grpc::internal::CondVar::CondVar </td>
  154. <td>(</td>
  155. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;&#160;</td>
  156. <td class="paramname"></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </td>
  161. <td class="mlabels-right">
  162. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. </div>
  167. </div>
  168. <h2 class="groupheader">Member Function Documentation</h2>
  169. <a id="a13aeb88276bf1b834e5d85d2785fd5c7"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a13aeb88276bf1b834e5d85d2785fd5c7">&#9670;&nbsp;</a></span>Broadcast()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">void grpc::internal::CondVar::Broadcast </td>
  179. <td>(</td>
  180. <td class="paramname"></td><td>)</td>
  181. <td></td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. </div>
  191. </div>
  192. <a id="a4ca874560c2937b6cd2012aca342f10a"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a4ca874560c2937b6cd2012aca342f10a">&#9670;&nbsp;</a></span>operator=()</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a>&amp; grpc::internal::CondVar::operator= </td>
  202. <td>(</td>
  203. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;&#160;</td>
  204. <td class="paramname"></td><td>)</td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. </div>
  215. </div>
  216. <a id="a0e1e436264df6f216b27508c10e0554b"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#a0e1e436264df6f216b27508c10e0554b">&#9670;&nbsp;</a></span>Signal()</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">void grpc::internal::CondVar::Signal </td>
  226. <td>(</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a id="a5799b41212b05122c2797e2d0487da46"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#a5799b41212b05122c2797e2d0487da46">&#9670;&nbsp;</a></span>Wait() <span class="overload">[1/2]</span></h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">int grpc::internal::CondVar::Wait </td>
  249. <td>(</td>
  250. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  251. <td class="paramname"><em>mu</em></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. </div>
  262. </div>
  263. <a id="a5a877c28bdfc56f26e7d4e525e057807"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a5a877c28bdfc56f26e7d4e525e057807">&#9670;&nbsp;</a></span>Wait() <span class="overload">[2/2]</span></h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="mlabels">
  268. <tr>
  269. <td class="mlabels-left">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">int grpc::internal::CondVar::Wait </td>
  273. <td>(</td>
  274. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  275. <td class="paramname"><em>mu</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">const <a class="el" href="structgpr__timespec.html">gpr_timespec</a> &amp;&#160;</td>
  281. <td class="paramname"><em>deadline</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. </div>
  296. </div>
  297. <a id="ad7f1985510b62bda2f58ce0f872e265d"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#ad7f1985510b62bda2f58ce0f872e265d">&#9670;&nbsp;</a></span>WaitUntil()</h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <div class="memtemplate">
  302. template&lt;typename Predicate &gt; </div>
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">void grpc::internal::CondVar::WaitUntil </td>
  309. <td>(</td>
  310. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  311. <td class="paramname"><em>mu</em>, </td>
  312. </tr>
  313. <tr>
  314. <td class="paramkey"></td>
  315. <td></td>
  316. <td class="paramtype">Predicate&#160;</td>
  317. <td class="paramname"><em>pred</em>&#160;</td>
  318. </tr>
  319. <tr>
  320. <td></td>
  321. <td>)</td>
  322. <td></td><td></td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. </div>
  332. </div>
  333. <hr/>The documentation for this class was generated from the following file:<ul>
  334. <li>include/grpcpp/impl/codegen/<a class="el" href="p_2impl_2codegen_2sync_8h_source.html">sync.h</a></li>
  335. </ul>
  336. </div><!-- contents -->
  337. <!-- start footer part -->
  338. <hr class="footer"/><address class="footer"><small>
  339. Generated on Wed Mar 3 2021 19:17:26 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  340. <img class="footer" src="doxygen.png" alt="doxygen"/>
  341. </a> 1.8.17
  342. </small></address>
  343. </body>
  344. </html>