libjuce-doc 4.3.0~repack-1 / usr / share / doc / libjuce / apiref / classSharedResourcePointer.html

This file is indexed.

/usr/share/doc/libjuce/apiref/classSharedResourcePointer.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
<!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: SharedResourcePointer&lt; SharedObjectType &gt; 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> &#124;
<a href="classSharedResourcePointer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SharedResourcePointer&lt; SharedObjectType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a class.  
 <a href="classSharedResourcePointer.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:a37f5da91a94a3f34a8d467a11b1db2ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#a37f5da91a94a3f34a8d467a11b1db2ae">SharedResourcePointer</a> ()</td></tr>
<tr class="memdesc:a37f5da91a94a3f34a8d467a11b1db2ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an instance of the shared object.  <a href="#a37f5da91a94a3f34a8d467a11b1db2ae">More...</a><br /></td></tr>
<tr class="separator:a37f5da91a94a3f34a8d467a11b1db2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0e471d40bbf73438dec6480935341bf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#ae0e471d40bbf73438dec6480935341bf">SharedResourcePointer</a> (const <a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a> &amp;)</td></tr>
<tr class="separator:ae0e471d40bbf73438dec6480935341bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47c04d52fa4de0490c3d3873dbc2ecf2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#a47c04d52fa4de0490c3d3873dbc2ecf2">~SharedResourcePointer</a> ()</td></tr>
<tr class="memdesc:a47c04d52fa4de0490c3d3873dbc2ecf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a47c04d52fa4de0490c3d3873dbc2ecf2">More...</a><br /></td></tr>
<tr class="separator:a47c04d52fa4de0490c3d3873dbc2ecf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c266850a363bc4fb9ee2079d8c96397"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#a5c266850a363bc4fb9ee2079d8c96397">operator SharedObjectType *</a> () const noexcept</td></tr>
<tr class="memdesc:a5c266850a363bc4fb9ee2079d8c96397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the shared object.  <a href="#a5c266850a363bc4fb9ee2079d8c96397">More...</a><br /></td></tr>
<tr class="separator:a5c266850a363bc4fb9ee2079d8c96397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacfb2015a9da695e57ea6460188c6146"><td class="memItemLeft" align="right" valign="top">SharedObjectType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#aacfb2015a9da695e57ea6460188c6146">get</a> () const noexcept</td></tr>
<tr class="memdesc:aacfb2015a9da695e57ea6460188c6146"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the shared object.  <a href="#aacfb2015a9da695e57ea6460188c6146">More...</a><br /></td></tr>
<tr class="separator:aacfb2015a9da695e57ea6460188c6146"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34dc4311e7808984ef5bd796c57645c8"><td class="memItemLeft" align="right" valign="top">SharedObjectType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#a34dc4311e7808984ef5bd796c57645c8">getObject</a> () const noexcept</td></tr>
<tr class="memdesc:a34dc4311e7808984ef5bd796c57645c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object that this pointer references.  <a href="#a34dc4311e7808984ef5bd796c57645c8">More...</a><br /></td></tr>
<tr class="separator:a34dc4311e7808984ef5bd796c57645c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac66baf5a23724ae4da705d4f31008d63"><td class="memItemLeft" align="right" valign="top">SharedObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSharedResourcePointer.html#ac66baf5a23724ae4da705d4f31008d63">operator-&gt;</a> () const noexcept</td></tr>
<tr class="separator:ac66baf5a23724ae4da705d4f31008d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename SharedObjectType&gt;<br />
class SharedResourcePointer&lt; SharedObjectType &gt;</h3>

<p>A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a class. </p>
<p>The SharedObjectType template type indicates the class to use for the shared object - the only requirements on this class are that it must have a public default constructor and destructor.</p>
<p>The <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a> offers a pattern that differs from using a singleton or static instance of an object, because it uses reference-counting to make sure that the underlying shared object is automatically created/destroyed according to the number of <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a> objects that exist. When the last one is deleted, the underlying object is also immediately destroyed. This allows you to use scoping to manage the lifetime of a shared resource.</p>
<p>Note: the construction/deletion of the shared object must not involve any code that makes recursive calls to a <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a>, or you'll cause a deadlock.</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="comment">// An example of a class that contains the shared data you want to use.</span></div><div class="line"><span class="keyword">struct </span>MySharedData</div><div class="line">{</div><div class="line">    <span class="comment">// There&#39;s no need to ever create an instance of this class directly yourself,</span></div><div class="line">    <span class="comment">// but it does need a public constructor that does the initialisation.</span></div><div class="line">    MySharedData()</div><div class="line">    {</div><div class="line">        sharedStuff = generateHeavyweightStuff();</div><div class="line">    }</div><div class="line"></div><div class="line">    <a class="code" href="classArray.html">Array&lt;SomeKindOfData&gt;</a> sharedStuff;</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keyword">struct </span>DataUserClass</div><div class="line">{</div><div class="line">    DataUserClass()</div><div class="line">    {</div><div class="line">        <span class="comment">// Multiple instances of the DataUserClass will all have the same</span></div><div class="line">        <span class="comment">// shared common instance of MySharedData referenced by their sharedData</span></div><div class="line">        <span class="comment">// member variables.</span></div><div class="line">        useSharedStuff (sharedData-&gt;sharedStuff);</div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">// By keeping this pointer as a member variable, the shared resource</span></div><div class="line">    <span class="comment">// is guaranteed to be available for as long as the DataUserClass object.</span></div><div class="line">    <a class="code" href="classSharedResourcePointer.html">SharedResourcePointer&lt;MySharedData&gt;</a> sharedData;</div><div class="line">};</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a37f5da91a94a3f34a8d467a11b1db2ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37f5da91a94a3f34a8d467a11b1db2ae">&sect;&nbsp;</a></span>SharedResourcePointer() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::<a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an instance of the shared object. </p>
<p>If other <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a> objects for this type already exist, then this one will simply point to the same shared object that they are already using. Otherwise, if this is the first <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a> to be created, then a shared object will be created automatically. </p>

</div>
</div>
<a id="ae0e471d40bbf73438dec6480935341bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0e471d40bbf73438dec6480935341bf">&sect;&nbsp;</a></span>SharedResourcePointer() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::<a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt; &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a47c04d52fa4de0490c3d3873dbc2ecf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47c04d52fa4de0490c3d3873dbc2ecf2">&sect;&nbsp;</a></span>~SharedResourcePointer()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::~<a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>If no other <a class="el" href="classSharedResourcePointer.html" title="A smart-pointer that automatically creates and manages the lifetime of a shared static instance of a ...">SharedResourcePointer</a> objects exist, this will also delete the shared object to which it refers. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5c266850a363bc4fb9ee2079d8c96397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c266850a363bc4fb9ee2079d8c96397">&sect;&nbsp;</a></span>operator SharedObjectType *()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::operator SharedObjectType * </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 the shared object. </p>

</div>
</div>
<a id="aacfb2015a9da695e57ea6460188c6146"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacfb2015a9da695e57ea6460188c6146">&sect;&nbsp;</a></span>get()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SharedObjectType&amp; <a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::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 the shared object. </p>

</div>
</div>
<a id="a34dc4311e7808984ef5bd796c57645c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34dc4311e7808984ef5bd796c57645c8">&sect;&nbsp;</a></span>getObject()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SharedObjectType&amp; <a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::getObject </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 the object that this pointer references. </p>
<p>The pointer returned may be a nullptr, of course. </p>

</div>
</div>
<a id="ac66baf5a23724ae4da705d4f31008d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac66baf5a23724ae4da705d4f31008d63">&sect;&nbsp;</a></span>operator->()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SharedObjectType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SharedObjectType* <a class="el" href="classSharedResourcePointer.html">SharedResourcePointer</a>&lt; SharedObjectType &gt;::operator-&gt; </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>References <a class="el" href="juce__CompilerSupport_8h.html#a1bd79588ea529f27e89c255c0ebd7be3">JUCE_DELETED_FUNCTION</a>, and <a class="el" href="juce__LeakedObjectDetector_8h.html#ab3639a79598b35f2116f4572af0d93f1">JUCE_LEAK_DETECTOR</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__SharedResourcePointer_8h.html">juce_SharedResourcePointer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content &copy ROLI Ltd.</small></address><br/>
</body>
</html>

APT Browse - Built by Thomas Orozco.