classgrpc_1_1internal_1_1_releasable_mutex_lock.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  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::ReleasableMutexLock 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_releasable_mutex_lock.html">ReleasableMutexLock</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::ReleasableMutexLock 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:a0974fcf03be935cfefcb910e20cd019e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#a0974fcf03be935cfefcb910e20cd019e">ReleasableMutexLock</a> (<a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *mu)</td></tr>
  78. <tr class="separator:a0974fcf03be935cfefcb910e20cd019e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ad048db9129cf87996a5dace738506522"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#ad048db9129cf87996a5dace738506522">ReleasableMutexLock</a> (<a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *mu)</td></tr>
  80. <tr class="separator:ad048db9129cf87996a5dace738506522"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a046af6508968edc5078794ebf338493f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#a046af6508968edc5078794ebf338493f">~ReleasableMutexLock</a> ()</td></tr>
  82. <tr class="separator:a046af6508968edc5078794ebf338493f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a205d95f25e3cc9c76877e1c460026eb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#a205d95f25e3cc9c76877e1c460026eb3">ReleasableMutexLock</a> (const <a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a> &amp;)=delete</td></tr>
  84. <tr class="separator:a205d95f25e3cc9c76877e1c460026eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:af11f872f079eb55d1d0c4c9c560d2bd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#af11f872f079eb55d1d0c4c9c560d2bd4">operator=</a> (const <a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a> &amp;)=delete</td></tr>
  86. <tr class="separator:af11f872f079eb55d1d0c4c9c560d2bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a9ab7befbf85d1d28f1a2126b094244d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#a9ab7befbf85d1d28f1a2126b094244d7">Lock</a> ()</td></tr>
  88. <tr class="separator:a9ab7befbf85d1d28f1a2126b094244d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a7637a47e9865529f8dd0572df336fd27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html#a7637a47e9865529f8dd0572df336fd27">Unlock</a> ()</td></tr>
  90. <tr class="separator:a7637a47e9865529f8dd0572df336fd27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  93. <a id="a0974fcf03be935cfefcb910e20cd019e"></a>
  94. <h2 class="memtitle"><span class="permalink"><a href="#a0974fcf03be935cfefcb910e20cd019e">&#9670;&nbsp;</a></span>ReleasableMutexLock() <span class="overload">[1/3]</span></h2>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="mlabels">
  98. <tr>
  99. <td class="mlabels-left">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">grpc::internal::ReleasableMutexLock::ReleasableMutexLock </td>
  103. <td>(</td>
  104. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_mutex.html">Mutex</a> *&#160;</td>
  105. <td class="paramname"><em>mu</em></td><td>)</td>
  106. <td></td>
  107. </tr>
  108. </table>
  109. </td>
  110. <td class="mlabels-right">
  111. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. </div>
  116. </div>
  117. <a id="ad048db9129cf87996a5dace738506522"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#ad048db9129cf87996a5dace738506522">&#9670;&nbsp;</a></span>ReleasableMutexLock() <span class="overload">[2/3]</span></h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="mlabels">
  122. <tr>
  123. <td class="mlabels-left">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">grpc::internal::ReleasableMutexLock::ReleasableMutexLock </td>
  127. <td>(</td>
  128. <td class="paramtype"><a class="el" href="impl_2codegen_2sync__posix_8h.html#aa66fb6a11304ef6759d76f84a34ee28f">gpr_mu</a> *&#160;</td>
  129. <td class="paramname"><em>mu</em></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 class="mlabel">explicit</span></span> </td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. </div>
  140. </div>
  141. <a id="a046af6508968edc5078794ebf338493f"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a046af6508968edc5078794ebf338493f">&#9670;&nbsp;</a></span>~ReleasableMutexLock()</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::ReleasableMutexLock::~ReleasableMutexLock </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </td>
  157. <td class="mlabels-right">
  158. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a id="a205d95f25e3cc9c76877e1c460026eb3"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a205d95f25e3cc9c76877e1c460026eb3">&#9670;&nbsp;</a></span>ReleasableMutexLock() <span class="overload">[3/3]</span></h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">grpc::internal::ReleasableMutexLock::ReleasableMutexLock </td>
  174. <td>(</td>
  175. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a> &amp;&#160;</td>
  176. <td class="paramname"></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">delete</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. </div>
  187. </div>
  188. <h2 class="groupheader">Member Function Documentation</h2>
  189. <a id="a9ab7befbf85d1d28f1a2126b094244d7"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#a9ab7befbf85d1d28f1a2126b094244d7">&#9670;&nbsp;</a></span>Lock()</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">void grpc::internal::ReleasableMutexLock::Lock </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <a id="af11f872f079eb55d1d0c4c9c560d2bd4"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#af11f872f079eb55d1d0c4c9c560d2bd4">&#9670;&nbsp;</a></span>operator=()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="mlabels">
  217. <tr>
  218. <td class="mlabels-left">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a>&amp; grpc::internal::ReleasableMutexLock::operator= </td>
  222. <td>(</td>
  223. <td class="paramtype">const <a class="el" href="classgrpc_1_1internal_1_1_releasable_mutex_lock.html">ReleasableMutexLock</a> &amp;&#160;</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">delete</span></span> </td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. </div>
  235. </div>
  236. <a id="a7637a47e9865529f8dd0572df336fd27"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a7637a47e9865529f8dd0572df336fd27">&#9670;&nbsp;</a></span>Unlock()</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">void grpc::internal::ReleasableMutexLock::Unlock </td>
  246. <td>(</td>
  247. <td class="paramname"></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. </div>
  258. </div>
  259. <hr/>The documentation for this class was generated from the following file:<ul>
  260. <li>include/grpcpp/impl/codegen/<a class="el" href="p_2impl_2codegen_2sync_8h_source.html">sync.h</a></li>
  261. </ul>
  262. </div><!-- contents -->
  263. <!-- start footer part -->
  264. <hr class="footer"/><address class="footer"><small>
  265. Generated on Wed Mar 3 2021 19:17:26 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  266. <img class="footer" src="doxygen.png" alt="doxygen"/>
  267. </a> 1.8.17
  268. </small></address>
  269. </body>
  270. </html>