libgda-5.0-doc 5.2.4-3 / usr / share / gtk-doc / html / libgda-5.0 / GdaLockable.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-5.0/GdaLockable.html is in libgda-5.0-doc 5.2.4-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaLockable: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="multi-threading.html" title="Multi threading">
<link rel="prev" href="libgda-5.0-GdaMutex.html" title="GdaMutex">
<link rel="next" href="GdaThreadWrapper.html" title="GdaThreadWrapper">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaLockable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaLockable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#GdaLockable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#GdaLockable.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="multi-threading.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-GdaMutex.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaThreadWrapper.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaLockable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaLockable.top_of_page"></a>GdaLockable</span></h2>
<p>GdaLockable — Interface for locking objects in a multi threaded environment</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaLockable.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaLockable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaLockable.html#gda-lockable-lock" title="gda_lockable_lock ()">gda_lockable_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaLockable.html#gda-lockable-trylock" title="gda_lockable_trylock ()">gda_lockable_trylock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaLockable.html#gda-lockable-unlock" title="gda_lockable_unlock ()">gda_lockable_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaLockable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GdaLockable.html#GdaLockable-struct" title="GdaLockable">GdaLockable</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaLockable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
    <span class="lineart">╰──</span> GdaLockable
</pre>
</div>
<div class="refsect1">
<a name="GdaLockable.prerequisites"></a><h2>Prerequisites</h2>
<p>
GdaLockable requires
 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="GdaLockable.implementations"></a><h2>Known Implementations</h2>
<p>
GdaLockable is implemented by
 <a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>,  <a class="link" href="GdaHolder.html" title="GdaHolder">GdaHolder</a>,  <a class="link" href="GdaSqlParser.html" title="GdaSqlParser">GdaSqlParser</a>,  <a class="link" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">GdaVconnectionDataModel</a>,  <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub">GdaVconnectionHub</a> and  <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection">GdaVirtualConnection</a>.</p>
</div>
<div class="refsect1">
<a name="GdaLockable.description"></a><h2>Description</h2>
<p>This interface is implemented by objects which are thread safe (ie. can be used by several threads at
the same time). Before using an object from a thread, one has to call <a class="link" href="GdaLockable.html#gda-lockable-lock" title="gda_lockable_lock ()"><code class="function">gda_lockable_lock()</code></a> or
<a class="link" href="GdaLockable.html#gda-lockable-trylock" title="gda_lockable_trylock ()"><code class="function">gda_lockable_trylock()</code></a> and call <a class="link" href="GdaLockable.html#gda-lockable-unlock" title="gda_lockable_unlock ()"><code class="function">gda_lockable_unlock()</code></a> when the object is not used anymore.</p>
</div>
<div class="refsect1">
<a name="GdaLockable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-lockable-lock"></a><h3>gda_lockable_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_lockable_lock (<em class="parameter"><code><a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> *lockable</code></em>);</pre>
<p>Locks <em class="parameter"><code>lockable</code></em>
. If it is already locked by another thread, the current thread will block until it is unlocked 
by the other thread.</p>
<p>This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will do nothing.</p>
<p>Note: unlike <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-mutex-lock"><code class="function">g_mutex_lock()</code></a>, this method recursive, which means a thread can lock <em class="parameter"><code>lockable</code></em>
 several times 
(and has to unlock it as many times to actually unlock it).</p>
<div class="refsect3">
<a name="gda-lockable-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>lockable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-lockable-trylock"></a><h3>gda_lockable_trylock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_lockable_trylock (<em class="parameter"><code><a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> *lockable</code></em>);</pre>
<p>Tries to lock <em class="parameter"><code>lockable</code></em>
. If it is already locked by another thread, then it immediately returns FALSE, otherwise
it locks <em class="parameter"><code>lockable</code></em>
.</p>
<p>This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will do nothing.</p>
<p>Note: unlike <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-mutex-lock"><code class="function">g_mutex_lock()</code></a>, this method recursive, which means a thread can lock <em class="parameter"><code>lockable</code></em>
 several times 
(and has to unlock it as many times to actually unlock it).</p>
<div class="refsect3">
<a name="gda-lockable-trylock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>lockable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-lockable-trylock.returns"></a><h4>Returns</h4>
<p> TRUE if the object has successfully been locked.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-lockable-unlock"></a><h3>gda_lockable_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_lockable_unlock (<em class="parameter"><code><a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> *lockable</code></em>);</pre>
<p>Unlocks <em class="parameter"><code>lockable</code></em>
. This method should not be called if the current does not already holds a lock on <em class="parameter"><code>lockable</code></em>
 (having
used <a class="link" href="GdaLockable.html#gda-lockable-lock" title="gda_lockable_lock ()"><code class="function">gda_lockable_lock()</code></a> or <a class="link" href="GdaLockable.html#gda-lockable-trylock" title="gda_lockable_trylock ()"><code class="function">gda_lockable_trylock()</code></a>).</p>
<p>This function can be used even if <a href="/usr/share/gtk-doc/html/glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has not yet been called, and, in that case, will do nothing.</p>
<div class="refsect3">
<a name="gda-lockable-unlock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>lockable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaLockable.html" title="GdaLockable"><span class="type">GdaLockable</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaLockable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaLockable-struct"></a><h3>GdaLockable</h3>
<pre class="programlisting">typedef struct _GdaLockable GdaLockable;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdaLockable.see-also"></a><h2>See Also</h2>
<p><a class="link" href="libgda-5.0-GdaMutex.html#GdaMutex" title="GdaMutex"><span class="type">GdaMutex</span></a> and <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.