/usr/share/doc/libjuce/apiref/classThreadLocalValue.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: ThreadLocalValue< Type > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classThreadLocalValue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ThreadLocalValue< Type > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides cross-platform support for thread-local objects.
<a href="classThreadLocalValue.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6cfe38fdd495adcfdad8dc3dc736f371"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a6cfe38fdd495adcfdad8dc3dc736f371">ThreadLocalValue</a> () noexcept</td></tr>
<tr class="separator:a6cfe38fdd495adcfdad8dc3dc736f371"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f84ce8c97c0c3d76be387b0d9cd5feb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a5f84ce8c97c0c3d76be387b0d9cd5feb">~ThreadLocalValue</a> ()</td></tr>
<tr class="memdesc:a5f84ce8c97c0c3d76be387b0d9cd5feb"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5f84ce8c97c0c3d76be387b0d9cd5feb">More...</a><br /></td></tr>
<tr class="separator:a5f84ce8c97c0c3d76be387b0d9cd5feb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8681a3805c7023574a7c8e8905e7bbcb"><td class="memItemLeft" align="right" valign="top">Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a8681a3805c7023574a7c8e8905e7bbcb">operator*</a> () const noexcept</td></tr>
<tr class="memdesc:a8681a3805c7023574a7c8e8905e7bbcb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to this thread's instance of the value. <a href="#a8681a3805c7023574a7c8e8905e7bbcb">More...</a><br /></td></tr>
<tr class="separator:a8681a3805c7023574a7c8e8905e7bbcb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbe0fe7fcfbd6511094512d01d3cdd16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#acbe0fe7fcfbd6511094512d01d3cdd16">operator Type *</a> () const noexcept</td></tr>
<tr class="memdesc:acbe0fe7fcfbd6511094512d01d3cdd16"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to this thread's instance of the value. <a href="#acbe0fe7fcfbd6511094512d01d3cdd16">More...</a><br /></td></tr>
<tr class="separator:acbe0fe7fcfbd6511094512d01d3cdd16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6112bf0cd51dcaa7cad94268984836a6"><td class="memItemLeft" align="right" valign="top">Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a6112bf0cd51dcaa7cad94268984836a6">operator-></a> () const noexcept</td></tr>
<tr class="memdesc:a6112bf0cd51dcaa7cad94268984836a6"><td class="mdescLeft"> </td><td class="mdescRight">Accesses a method or field of the value object. <a href="#a6112bf0cd51dcaa7cad94268984836a6">More...</a><br /></td></tr>
<tr class="separator:a6112bf0cd51dcaa7cad94268984836a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa218704cf23c89a7a68b283f2d623e57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#aa218704cf23c89a7a68b283f2d623e57">operator=</a> (const Type &newValue)</td></tr>
<tr class="memdesc:aa218704cf23c89a7a68b283f2d623e57"><td class="mdescLeft"> </td><td class="mdescRight">Assigns a new value to the thread-local object. <a href="#aa218704cf23c89a7a68b283f2d623e57">More...</a><br /></td></tr>
<tr class="separator:aa218704cf23c89a7a68b283f2d623e57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0350ab3d9b5d1877dec3244d5b4e71e9"><td class="memItemLeft" align="right" valign="top">Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a0350ab3d9b5d1877dec3244d5b4e71e9">get</a> () const noexcept</td></tr>
<tr class="memdesc:a0350ab3d9b5d1877dec3244d5b4e71e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to this thread's instance of the value. <a href="#a0350ab3d9b5d1877dec3244d5b4e71e9">More...</a><br /></td></tr>
<tr class="separator:a0350ab3d9b5d1877dec3244d5b4e71e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78af45671b2b057f0f584a75f79ff5b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThreadLocalValue.html#a78af45671b2b057f0f584a75f79ff5b5">releaseCurrentThreadStorage</a> ()</td></tr>
<tr class="memdesc:a78af45671b2b057f0f584a75f79ff5b5"><td class="mdescLeft"> </td><td class="mdescRight">Called by a thread before it terminates, to allow this class to release any storage associated with the thread. <a href="#a78af45671b2b057f0f584a75f79ff5b5">More...</a><br /></td></tr>
<tr class="separator:a78af45671b2b057f0f584a75f79ff5b5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename Type><br />
class ThreadLocalValue< Type ></h3>
<p>Provides cross-platform support for thread-local objects. </p>
<p>This class holds an internal list of objects of the templated type, keeping an instance for each thread that requests one. The first time a thread attempts to access its value, an object is created and added to the list for that thread.</p>
<p>Typically, you'll probably want to create a static instance of a <a class="el" href="classThreadLocalValue.html" title="Provides cross-platform support for thread-local objects. ">ThreadLocalValue</a> object, or hold one within a singleton.</p>
<p>The templated class for your value must be a primitive type, or a simple POD struct.</p>
<p>When a thread no longer needs to use its value, it can call <a class="el" href="classThreadLocalValue.html#a78af45671b2b057f0f584a75f79ff5b5" title="Called by a thread before it terminates, to allow this class to release any storage associated with t...">releaseCurrentThreadStorage()</a> to allow the storage to be re-used by another thread. If a thread exits without calling this method, the object storage will be left allocated until the <a class="el" href="classThreadLocalValue.html" title="Provides cross-platform support for thread-local objects. ">ThreadLocalValue</a> object is deleted. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a6cfe38fdd495adcfdad8dc3dc736f371"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cfe38fdd495adcfdad8dc3dc736f371">§ </a></span>ThreadLocalValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::<a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5f84ce8c97c0c3d76be387b0d9cd5feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f84ce8c97c0c3d76be387b0d9cd5feb">§ </a></span>~ThreadLocalValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::~<a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>When this object is deleted, all the value objects for all threads will be deleted. </p>
<p>References <a class="el" href="classAtomic.html#a4c042c01777b1efe30266a45b7df36f4">Atomic< Type >::value</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8681a3805c7023574a7c8e8905e7bbcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8681a3805c7023574a7c8e8905e7bbcb">§ </a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Type& <a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to this thread's instance of the value. </p>
<p>Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it. </p>
</div>
</div>
<a id="acbe0fe7fcfbd6511094512d01d3cdd16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbe0fe7fcfbd6511094512d01d3cdd16">§ </a></span>operator Type *()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::operator Type * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to this thread's instance of the value. </p>
<p>Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it. </p>
</div>
</div>
<a id="a6112bf0cd51dcaa7cad94268984836a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6112bf0cd51dcaa7cad94268984836a6">§ </a></span>operator->()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Type* <a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::operator-> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Accesses a method or field of the value object. </p>
<p>Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it. </p>
</div>
</div>
<a id="aa218704cf23c89a7a68b283f2d623e57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa218704cf23c89a7a68b283f2d623e57">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>& <a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::operator= </td>
<td>(</td>
<td class="paramtype">const Type & </td>
<td class="paramname"><em>newValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns a new value to the thread-local object. </p>
</div>
</div>
<a id="a0350ab3d9b5d1877dec3244d5b4e71e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0350ab3d9b5d1877dec3244d5b4e71e9">§ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Type& <a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to this thread's instance of the value. </p>
<p>Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it. </p>
<p>References <a class="el" href="classAtomic.html#a9c0966a21db3a9d4649f8c869bb38fa0">Atomic< Type >::compareAndSetBool()</a>, <a class="el" href="classAtomic.html#ad39856229e8d4e3da9088d31bad55b9e">Atomic< Type >::get()</a>, and <a class="el" href="classThread.html#abd4762b20144186ffc28280cedd224e9">Thread::getCurrentThreadId()</a>.</p>
</div>
</div>
<a id="a78af45671b2b057f0f584a75f79ff5b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78af45671b2b057f0f584a75f79ff5b5">§ </a></span>releaseCurrentThreadStorage()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classThreadLocalValue.html">ThreadLocalValue</a>< Type >::releaseCurrentThreadStorage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by a thread before it terminates, to allow this class to release any storage associated with the thread. </p>
<p>References <a class="el" href="classAtomic.html#ad39856229e8d4e3da9088d31bad55b9e">Atomic< Type >::get()</a>, <a class="el" href="classThread.html#abd4762b20144186ffc28280cedd224e9">Thread::getCurrentThreadId()</a>, and <a class="el" href="juce__PlatformDefs_8h.html#a6ab7a603bf4435c7cb286b1744366eb2">JUCE_DECLARE_NON_COPYABLE</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ThreadLocalValue_8h.html">juce_ThreadLocalValue.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|