Committing Intel(R) TBB 2018 source code
[platform/upstream/tbb.git] / doc / html / a00143.html
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.4"/>
7 <title>tbb::interface5::reader_writer_lock::scoped_lock_read Class Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <!-- end header part -->
16 <!-- Generated by Doxygen 1.8.4 -->
17   <div id="navrow1" class="tabs">
18     <ul class="tablist">
19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
20       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
21       <li><a href="modules.html"><span>Modules</span></a></li>
22       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
23       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
24       <li><a href="files.html"><span>Files</span></a></li>
25     </ul>
26   </div>
27   <div id="navrow2" class="tabs2">
28     <ul class="tablist">
29       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
30       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
31       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
32     </ul>
33   </div>
34 <div id="nav-path" class="navpath">
35   <ul>
36 <li class="navelem"><a class="el" href="a00239.html">tbb</a></li><li class="navelem"><b>interface5</b></li><li class="navelem"><a class="el" href="a00113.html">reader_writer_lock</a></li><li class="navelem"><a class="el" href="a00143.html">scoped_lock_read</a></li>  </ul>
37 </div>
38 </div><!-- top -->
39 <div class="header">
40   <div class="summary">
41 <a href="#pub-methods">Public Member Functions</a> &#124;
42 <a href="#friends">Friends</a> &#124;
43 <a href="a00382.html">List of all members</a>  </div>
44   <div class="headertitle">
45 <div class="title">tbb::interface5::reader_writer_lock::scoped_lock_read Class Reference</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>The scoped lock pattern for read locks.  
50  <a href="a00143.html#details">More...</a></p>
51
52 <p><code>#include &lt;reader_writer_lock.h&gt;</code></p>
53 <div class="dynheader">
54 Inheritance diagram for tbb::interface5::reader_writer_lock::scoped_lock_read:</div>
55 <div class="dyncontent">
56  <div class="center">
57   <img src="a00143.png" usemap="#tbb::interface5::reader_writer_lock::scoped_lock_read_map" alt=""/>
58   <map id="tbb::interface5::reader_writer_lock::scoped_lock_read_map" name="tbb::interface5::reader_writer_lock::scoped_lock_read_map">
59 </map>
60  </div></div>
61 <table class="memberdecls">
62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
63 Public Member Functions</h2></td></tr>
64 <tr class="memitem:a9d3120a23016dabd4cc2683fa561ee5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d3120a23016dabd4cc2683fa561ee5a"></a>
65 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a9d3120a23016dabd4cc2683fa561ee5a">scoped_lock_read</a> (<a class="el" href="a00113.html">reader_writer_lock</a> &amp;<a class="el" href="a00113.html#af92eb949fc491af8f7e350869ea0a0d1">lock</a>)</td></tr>
66 <tr class="memdesc:a9d3120a23016dabd4cc2683fa561ee5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct with blocking attempt to acquire read lock on the passed-in lock. <br/></td></tr>
67 <tr class="separator:a9d3120a23016dabd4cc2683fa561ee5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:acf0e23fb4d3aeb6bde18d5d1236bd9d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf0e23fb4d3aeb6bde18d5d1236bd9d5"></a>
69 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#acf0e23fb4d3aeb6bde18d5d1236bd9d5">~scoped_lock_read</a> ()</td></tr>
70 <tr class="memdesc:acf0e23fb4d3aeb6bde18d5d1236bd9d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor, releases the read lock. <br/></td></tr>
71 <tr class="separator:acf0e23fb4d3aeb6bde18d5d1236bd9d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <tr class="memitem:a9eb8c7a64912a1c74ea76a01a20a1621"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9eb8c7a64912a1c74ea76a01a20a1621"></a>
73 void *&#160;</td><td class="memItemRight" valign="bottom"><b>operator new</b> (size_t s)</td></tr>
74 <tr class="separator:a9eb8c7a64912a1c74ea76a01a20a1621"><td class="memSeparator" colspan="2">&#160;</td></tr>
75 <tr class="memitem:a1a6c15dfdbe1bc7a6648ed836ebd8de6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a6c15dfdbe1bc7a6648ed836ebd8de6"></a>
76 void&#160;</td><td class="memItemRight" valign="bottom"><b>operator delete</b> (void *p)</td></tr>
77 <tr class="separator:a1a6c15dfdbe1bc7a6648ed836ebd8de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 </table><table class="memberdecls">
79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
80 Friends</h2></td></tr>
81 <tr class="memitem:afb01bc2e211c782503ef5088003f120f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb01bc2e211c782503ef5088003f120f"></a>
82 class&#160;</td><td class="memItemRight" valign="bottom"><b>reader_writer_lock</b></td></tr>
83 <tr class="separator:afb01bc2e211c782503ef5088003f120f"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 </table>
85 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
86 <div class="textblock"><p>The scoped lock pattern for read locks. </p>
87 </div><hr/>The documentation for this class was generated from the following file:<ul>
88 <li>reader_writer_lock.h</li>
89 </ul>
90 </div><!-- contents -->
91 <hr>
92 <p></p>
93 Copyright &copy; 2005-2017 Intel Corporation.  All Rights Reserved.
94 <p></p>
95 Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
96 registered trademarks or trademarks of Intel Corporation or its
97 subsidiaries in the United States and other countries.
98 <p></p>
99 * Other names and brands may be claimed as the property of others.