classgrpc_1_1internal_1_1_cond_var.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  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.23.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::internal::CondVar Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="p_2impl_2codegen_2sync_8h_source.html">sync.h</a>&gt;</code></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  73. Public Member Functions</h2></td></tr>
  74. <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>
  75. <tr class="separator:a33ce590ba2b22d31e37a92f57509b2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <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>
  77. <tr class="separator:a7bce6437bf6391cd0404ae1e380a77e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:a3d961f0ea2c7b8929ac1b16f02a8133a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="separator:a4ca874560c2937b6cd2012aca342f10a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <tr class="separator:a0e1e436264df6f216b27508c10e0554b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <tr class="separator:a13aeb88276bf1b834e5d85d2785fd5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <tr class="separator:a5799b41212b05122c2797e2d0487da46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:a5a877c28bdfc56f26e7d4e525e057807"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ad7f1985510b62bda2f58ce0f872e265d"><td class="memTemplParams" colspan="2">template&lt;typename Predicate &gt; </td></tr>
  91. <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>
  92. <tr class="separator:ad7f1985510b62bda2f58ce0f872e265d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  95. <a id="a33ce590ba2b22d31e37a92f57509b2ef"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#a33ce590ba2b22d31e37a92f57509b2ef">&#9670;&nbsp;</a></span>CondVar() <span class="overload">[1/2]</span></h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="mlabels">
  100. <tr>
  101. <td class="mlabels-left">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">grpc::internal::CondVar::CondVar </td>
  105. <td>(</td>
  106. <td class="paramname"></td><td>)</td>
  107. <td></td>
  108. </tr>
  109. </table>
  110. </td>
  111. <td class="mlabels-right">
  112. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  113. </tr>
  114. </table>
  115. </div><div class="memdoc">
  116. </div>
  117. </div>
  118. <a id="a7bce6437bf6391cd0404ae1e380a77e5"></a>
  119. <h2 class="memtitle"><span class="permalink"><a href="#a7bce6437bf6391cd0404ae1e380a77e5">&#9670;&nbsp;</a></span>~CondVar()</h2>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="mlabels">
  123. <tr>
  124. <td class="mlabels-left">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">grpc::internal::CondVar::~CondVar </td>
  128. <td>(</td>
  129. <td class="paramname"></td><td>)</td>
  130. <td></td>
  131. </tr>
  132. </table>
  133. </td>
  134. <td class="mlabels-right">
  135. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. </div>
  140. </div>
  141. <a id="a3d961f0ea2c7b8929ac1b16f02a8133a"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a3d961f0ea2c7b8929ac1b16f02a8133a">&#9670;&nbsp;</a></span>CondVar() <span class="overload">[2/2]</span></h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="mlabels">
  146. <tr>
  147. <td class="mlabels-left">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">grpc::internal::CondVar::CondVar </td>
  151. <td>(</td>
  152. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;&#160;</td>
  153. <td class="paramname"></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </td>
  158. <td class="mlabels-right">
  159. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. </div>
  164. </div>
  165. <h2 class="groupheader">Member Function Documentation</h2>
  166. <a id="a13aeb88276bf1b834e5d85d2785fd5c7"></a>
  167. <h2 class="memtitle"><span class="permalink"><a href="#a13aeb88276bf1b834e5d85d2785fd5c7">&#9670;&nbsp;</a></span>Broadcast()</h2>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="mlabels">
  171. <tr>
  172. <td class="mlabels-left">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void grpc::internal::CondVar::Broadcast </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. </div>
  188. </div>
  189. <a id="a4ca874560c2937b6cd2012aca342f10a"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#a4ca874560c2937b6cd2012aca342f10a">&#9670;&nbsp;</a></span>operator=()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a>&amp; grpc::internal::CondVar::operator= </td>
  199. <td>(</td>
  200. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_cond_var.html">CondVar</a> &amp;&#160;</td>
  201. <td class="paramname"></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a id="a0e1e436264df6f216b27508c10e0554b"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#a0e1e436264df6f216b27508c10e0554b">&#9670;&nbsp;</a></span>Signal()</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">void grpc::internal::CondVar::Signal </td>
  223. <td>(</td>
  224. <td class="paramname"></td><td>)</td>
  225. <td></td>
  226. </tr>
  227. </table>
  228. </td>
  229. <td class="mlabels-right">
  230. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. </div>
  235. </div>
  236. <a id="a5799b41212b05122c2797e2d0487da46"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a5799b41212b05122c2797e2d0487da46">&#9670;&nbsp;</a></span>Wait() <span class="overload">[1/2]</span></h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="mlabels">
  241. <tr>
  242. <td class="mlabels-left">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">int grpc::internal::CondVar::Wait </td>
  246. <td>(</td>
  247. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  248. <td class="paramname"><em>mu</em></td><td>)</td>
  249. <td></td>
  250. </tr>
  251. </table>
  252. </td>
  253. <td class="mlabels-right">
  254. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. </div>
  259. </div>
  260. <a id="a5a877c28bdfc56f26e7d4e525e057807"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a5a877c28bdfc56f26e7d4e525e057807">&#9670;&nbsp;</a></span>Wait() <span class="overload">[2/2]</span></h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">int grpc::internal::CondVar::Wait </td>
  270. <td>(</td>
  271. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  272. <td class="paramname"><em>mu</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">const <a class="el" href="structgpr__timespec.html">gpr_timespec</a> &amp;&#160;</td>
  278. <td class="paramname"><em>deadline</em>&#160;</td>
  279. </tr>
  280. <tr>
  281. <td></td>
  282. <td>)</td>
  283. <td></td><td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. </div>
  293. </div>
  294. <a id="ad7f1985510b62bda2f58ce0f872e265d"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#ad7f1985510b62bda2f58ce0f872e265d">&#9670;&nbsp;</a></span>WaitUntil()</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <div class="memtemplate">
  299. template&lt;typename Predicate &gt; </div>
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">void grpc::internal::CondVar::WaitUntil </td>
  306. <td>(</td>
  307. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  308. <td class="paramname"><em>mu</em>, </td>
  309. </tr>
  310. <tr>
  311. <td class="paramkey"></td>
  312. <td></td>
  313. <td class="paramtype">Predicate&#160;</td>
  314. <td class="paramname"><em>pred</em>&#160;</td>
  315. </tr>
  316. <tr>
  317. <td></td>
  318. <td>)</td>
  319. <td></td><td></td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. </div>
  329. </div>
  330. <hr/>The documentation for this class was generated from the following file:<ul>
  331. <li>include/grpcpp/impl/codegen/<a class="el" href="p_2impl_2codegen_2sync_8h_source.html">sync.h</a></li>
  332. </ul>
  333. </div><!-- contents -->
  334. <!-- start footer part -->
  335. <hr class="footer"/><address class="footer"><small>
  336. Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  337. <img class="footer" src="doxygen.png" alt="doxygen"/>
  338. </a> 1.8.13
  339. </small></address>
  340. </body>
  341. </html>