File: classGlib_1_1Threads_1_1Private.html

package info (click to toggle)
glibmm2.4 2.42.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 53,308 kB
  • ctags: 14,868
  • sloc: xml: 108,462; cpp: 15,282; sh: 11,421; perl: 5,139; python: 1,626; makefile: 304
file content (301 lines) | stat: -rw-r--r-- 15,965 bytes parent folder | download
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
<!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.7"/>
<title>glibmm: Glib::Threads::Private&lt; T &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="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 style="padding-left: 0.5em;">
   <div id="projectname">glibmm
   &#160;<span id="projectnumber">2.42.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceGlib.html">Glib</a></li><li class="navelem"><a class="el" href="namespaceGlib_1_1Threads.html">Threads</a></li><li class="navelem"><a class="el" href="classGlib_1_1Threads_1_1Private.html">Private</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classGlib_1_1Threads_1_1Private-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Glib::Threads::Private&lt; T &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__Threads.html">Threads</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Thread-local data pointer.  
 <a href="classGlib_1_1Threads_1_1Private.html#details">More...</a></p>

<p><code>#include &lt;glibmm/threads.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac716d81812280be9842ed62193800c3d"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#ac716d81812280be9842ed62193800c3d">DestructorFunc</a> )(void*)</td></tr>
<tr class="separator:ac716d81812280be9842ed62193800c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a72666cd6d6792e4c1efa3fe800a4c4e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#a72666cd6d6792e4c1efa3fe800a4c4e5">Private</a> (<a class="el" href="classGlib_1_1Threads_1_1Private.html#ac716d81812280be9842ed62193800c3d">DestructorFunc</a> destructor_func=&amp;<a class="el" href="classGlib_1_1Threads_1_1Private.html">Private</a>&lt; T &gt;::<a class="el" href="classGlib_1_1Threads_1_1Private.html#a440d3f7cd5ef614679c6348ceaab63be">delete_ptr</a>)</td></tr>
<tr class="memdesc:a72666cd6d6792e4c1efa3fe800a4c4e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a72666cd6d6792e4c1efa3fe800a4c4e5">More...</a><br /></td></tr>
<tr class="separator:a72666cd6d6792e4c1efa3fe800a4c4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a835b6cba77e88023798f40a2fe1ebfb1"><td class="memItemLeft" align="right" valign="top">T*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#a835b6cba77e88023798f40a2fe1ebfb1">get</a> ()</td></tr>
<tr class="memdesc:a835b6cba77e88023798f40a2fe1ebfb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pointer stored in the calling thread.  <a href="#a835b6cba77e88023798f40a2fe1ebfb1">More...</a><br /></td></tr>
<tr class="separator:a835b6cba77e88023798f40a2fe1ebfb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0740eaa856abbe880ba8466d82c81cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#ab0740eaa856abbe880ba8466d82c81cc">set</a> (T* data)</td></tr>
<tr class="memdesc:ab0740eaa856abbe880ba8466d82c81cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the pointer in the calling thread without calling <code>destructor_func()</code>.  <a href="#ab0740eaa856abbe880ba8466d82c81cc">More...</a><br /></td></tr>
<tr class="separator:ab0740eaa856abbe880ba8466d82c81cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4a8cd09419878b96b69ab4d12e98f6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#aa4a8cd09419878b96b69ab4d12e98f6b">replace</a> (T* data)</td></tr>
<tr class="memdesc:aa4a8cd09419878b96b69ab4d12e98f6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the pointer in the calling thread and calls <code>destructor_func()</code>.  <a href="#aa4a8cd09419878b96b69ab4d12e98f6b">More...</a><br /></td></tr>
<tr class="separator:aa4a8cd09419878b96b69ab4d12e98f6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e04fbb3f71768d75d4bc7ddfea3d914"><td class="memItemLeft" align="right" valign="top">GPrivate*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#a1e04fbb3f71768d75d4bc7ddfea3d914">gobj</a> ()</td></tr>
<tr class="separator:a1e04fbb3f71768d75d4bc7ddfea3d914"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a440d3f7cd5ef614679c6348ceaab63be"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Threads_1_1Private.html#a440d3f7cd5ef614679c6348ceaab63be">delete_ptr</a> (void* data)</td></tr>
<tr class="memdesc:a440d3f7cd5ef614679c6348ceaab63be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes static_cast&lt;T*&gt;(data)  <a href="#a440d3f7cd5ef614679c6348ceaab63be">More...</a><br /></td></tr>
<tr class="separator:a440d3f7cd5ef614679c6348ceaab63be"><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;class T&gt;<br />
class Glib::Threads::Private&lt; T &gt;</h3>

<p>Thread-local data pointer. </p>
<p>It is recommended that all instances of this class are statically allocated. The first time an instance is used (<a class="el" href="classGlib_1_1Threads_1_1Private.html#a835b6cba77e88023798f40a2fe1ebfb1" title="Gets the pointer stored in the calling thread. ">get()</a>, <a class="el" href="classGlib_1_1Threads_1_1Private.html#ab0740eaa856abbe880ba8466d82c81cc" title="Sets the pointer in the calling thread without calling destructor_func(). ">set()</a> or <a class="el" href="classGlib_1_1Threads_1_1Private.html#aa4a8cd09419878b96b69ab4d12e98f6b" title="Sets the pointer in the calling thread and calls destructor_func(). ">replace()</a> is called) gtk+ allocates a scarce OS resource that cannot be deallocated. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ac716d81812280be9842ed62193800c3d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::DestructorFunc)(void*)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a72666cd6d6792e4c1efa3fe800a4c4e5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::<a class="el" href="classGlib_1_1Threads_1_1Private.html">Private</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classGlib_1_1Threads_1_1Private.html#ac716d81812280be9842ed62193800c3d">DestructorFunc</a>&#160;</td>
          <td class="paramname"><em>destructor_func</em> = <code>&amp;<a class="el" href="classGlib_1_1Threads_1_1Private.html">Private</a>&lt;&#160;T&#160;&gt;::<a class="el" href="classGlib_1_1Threads_1_1Private.html#a440d3f7cd5ef614679c6348ceaab63be">delete_ptr</a></code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">destructor_func</td><td>Function pointer, or 0. If <em>destructor_func</em> is not 0 and the stored data pointer is not 0, this function is called when <a class="el" href="classGlib_1_1Threads_1_1Private.html#aa4a8cd09419878b96b69ab4d12e98f6b" title="Sets the pointer in the calling thread and calls destructor_func(). ">replace()</a> is called and when the thread exits. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a440d3f7cd5ef614679c6348ceaab63be"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::delete_ptr </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Deletes static_cast&lt;T*&gt;(data) </p>

</div>
</div>
<a class="anchor" id="a835b6cba77e88023798f40a2fe1ebfb1"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::get </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the pointer stored in the calling thread. </p>
<dl class="section return"><dt>Returns</dt><dd>If no value has yet been set in this thread, 0 is returned. </dd></dl>

</div>
</div>
<a class="anchor" id="a1e04fbb3f71768d75d4bc7ddfea3d914"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GPrivate* <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::gobj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa4a8cd09419878b96b69ab4d12e98f6b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::replace </td>
          <td>(</td>
          <td class="paramtype">T *&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the pointer in the calling thread and calls <code>destructor_func()</code>. </p>
<p>If a function pointer (and not 0) was specified in the constructor, and the stored data pointer before the call to <a class="el" href="classGlib_1_1Threads_1_1Private.html#aa4a8cd09419878b96b69ab4d12e98f6b" title="Sets the pointer in the calling thread and calls destructor_func(). ">replace()</a> is not 0, then <code>destructor_func()</code> is called with this old pointer value.</p>
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000006">Since glibmm 2.32:</a></b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="ab0740eaa856abbe880ba8466d82c81cc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template &lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classGlib_1_1Threads_1_1Private.html">Glib::Threads::Private</a>&lt; T &gt;::set </td>
          <td>(</td>
          <td class="paramtype">T *&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the pointer in the calling thread without calling <code>destructor_func()</code>. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 22 2014 21:38:34 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>