File: structGlib_1_1StaticMutex.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 (210 lines) | stat: -rw-r--r-- 11,471 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
<!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::StaticMutex Struct 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="structGlib_1_1StaticMutex.html">StaticMutex</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="structGlib_1_1StaticMutex-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Glib::StaticMutex Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Like <a class="el" href="classGlib_1_1Mutex.html" title="Represents a mutex (mutual exclusion). ">Glib::Mutex</a>, but can be defined at compile time.  
 <a href="structGlib_1_1StaticMutex.html#details">More...</a></p>

<p><code>#include &lt;glibmm/thread.h&gt;</code></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:a7052b89e18e8c7fa2c987dc429a01296"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a7052b89e18e8c7fa2c987dc429a01296">lock</a> ()</td></tr>
<tr class="separator:a7052b89e18e8c7fa2c987dc429a01296"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a874e22be27896359ecb4008cd6e6f8ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a874e22be27896359ecb4008cd6e6f8ab">trylock</a> ()</td></tr>
<tr class="separator:a874e22be27896359ecb4008cd6e6f8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a539181ea215c00c84e90d4f7a0131e4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a539181ea215c00c84e90d4f7a0131e4d">unlock</a> ()</td></tr>
<tr class="separator:a539181ea215c00c84e90d4f7a0131e4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a144e7de846446e2ce1740adc7bf0dc9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a144e7de846446e2ce1740adc7bf0dc9a">operator Mutex&amp;</a> ()</td></tr>
<tr class="separator:a144e7de846446e2ce1740adc7bf0dc9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a381d25917d27c665d3db638b4aa8b743"><td class="memItemLeft" align="right" valign="top">GStaticMutex*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a381d25917d27c665d3db638b4aa8b743">gobj</a> ()</td></tr>
<tr class="separator:a381d25917d27c665d3db638b4aa8b743"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a5b1b115d491997555a22bce7256cd9b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGlib_1_1StaticMutex.html#a5b1b115d491997555a22bce7256cd9b5">GLIBMM_STATIC_MUTEX_INIT</a>&#160;&#160;&#160;{ G_STATIC_MUTEX_INIT }</td></tr>
<tr class="memdesc:a5b1b115d491997555a22bce7256cd9b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializer macro for <a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">Glib::StaticMutex</a>.  <a href="#a5b1b115d491997555a22bce7256cd9b5">More...</a><br /></td></tr>
<tr class="separator:a5b1b115d491997555a22bce7256cd9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Like <a class="el" href="classGlib_1_1Mutex.html" title="Represents a mutex (mutual exclusion). ">Glib::Mutex</a>, but can be defined at compile time. </p>
<p>Use <code>GLIBMM_STATIC_MUTEX_INIT</code> to initialize a <a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">StaticMutex</a>: </p><div class="fragment"><div class="line"><a class="code" href="structGlib_1_1StaticMutex.html">Glib::StaticMutex</a> mutex = <a class="code" href="structGlib_1_1StaticMutex.html#a5b1b115d491997555a22bce7256cd9b5">GLIBMM_STATIC_MUTEX_INIT</a>;</div>
</div><!-- fragment --><p>A <a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">StaticMutex</a> can be used without calling <a class="el" href="namespaceGlib.html#ab26d01c776801f1fff00753e97af4fc7" title="Initializes the GLib thread system. ">Glib::thread_init()</a>, it will silently do nothing then. That will also work when using the implicit conversion to <a class="el" href="classGlib_1_1Mutex.html" title="Represents a mutex (mutual exclusion). ">Mutex</a>&amp;, thus you can safely use <a class="el" href="classGlib_1_1Mutex_1_1Lock.html" title="Utility class for exception-safe mutex locking. ">Mutex::Lock</a> with a <a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">StaticMutex</a>.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGlib_1_1Threads_1_1Mutex.html" title="Represents a mutex (mutual exclusion). ">Glib::Threads::Mutex</a> instead, which can be used statically. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a381d25917d27c665d3db638b4aa8b743"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GStaticMutex* Glib::StaticMutex::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="a7052b89e18e8c7fa2c987dc429a01296"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Glib::StaticMutex::lock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a144e7de846446e2ce1740adc7bf0dc9a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Glib::StaticMutex::operator <a class="el" href="classGlib_1_1Mutex.html">Mutex</a>&amp; </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a874e22be27896359ecb4008cd6e6f8ab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Glib::StaticMutex::trylock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a539181ea215c00c84e90d4f7a0131e4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Glib::StaticMutex::unlock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a5b1b115d491997555a22bce7256cd9b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">#define GLIBMM_STATIC_MUTEX_INIT&#160;&#160;&#160;{ G_STATIC_MUTEX_INIT }</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initializer macro for <a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">Glib::StaticMutex</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd><a class="el" href="structGlib_1_1StaticMutex.html" title="Like Glib::Mutex, but can be defined at compile time. ">Glib::StaticMutex</a> is deprecated in favour of <a class="el" href="classGlib_1_1Threads_1_1Mutex.html" title="Represents a mutex (mutual exclusion). ">Glib::Threads::Mutex</a>, which can be used statically. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 22 2014 21:38:33 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>