| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>UDisksModuleManager: UDisks Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="UDisks Reference Manual"> |
| 8 |
<link rel="up" href="ref-daemon-core.html" title="Core"> |
| 9 |
<link rel="prev" href="udisks2-ATA-commands.html" title="ATA commands"> |
| 10 |
<link rel="next" href="udisks2-UDisksModule.html" title="UDisksModule"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.35.1 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#udisks2-UDisksModuleManager.description" class="shortcut">Description</a></span> |
| 19 |
</td> |
| 20 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 21 |
<td><a accesskey="u" href="ref-daemon-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 22 |
<td><a accesskey="p" href="udisks2-ATA-commands.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 23 |
<td><a accesskey="n" href="udisks2-UDisksModule.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 24 |
</tr></table> |
| 25 |
<div class="refentry"> |
| 26 |
<a name="udisks2-UDisksModuleManager"></a><div class="titlepage"></div> |
| 27 |
<div class="refnamediv"><table width="100%"><tr> |
| 28 |
<td valign="top"> |
| 29 |
<h2><span class="refentrytitle"><a name="udisks2-UDisksModuleManager.top_of_page"></a>UDisksModuleManager</span></h2> |
| 30 |
<p>UDisksModuleManager — Manage daemon modules</p> |
| 31 |
</td> |
| 32 |
<td class="gallery_image" valign="top" align="right"></td> |
| 33 |
</tr></table></div> |
| 34 |
<div class="refsect1"> |
| 35 |
<a name="udisks2-UDisksModuleManager.functions"></a><h2>Functions</h2> |
| 36 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 37 |
<colgroup> |
| 38 |
<col width="150px" class="functions_proto_type"> |
| 39 |
<col class="functions_proto_name"> |
| 40 |
</colgroup> |
| 41 |
<tbody> |
| 42 |
<tr> |
| 43 |
<td class="function_type"> |
| 44 |
<a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="returnvalue">UDisksModuleManager</span></a> * |
| 45 |
</td> |
| 46 |
<td class="function_name"> |
| 47 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-new" title="udisks_module_manager_new ()">udisks_module_manager_new</a> <span class="c_punctuation">()</span> |
| 48 |
</td> |
| 49 |
</tr> |
| 50 |
<tr> |
| 51 |
<td class="function_type"> |
| 52 |
<a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="returnvalue">UDisksModuleManager</span></a> * |
| 53 |
</td> |
| 54 |
<td class="function_name"> |
| 55 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-new-uninstalled" title="udisks_module_manager_new_uninstalled ()">udisks_module_manager_new_uninstalled</a> <span class="c_punctuation">()</span> |
| 56 |
</td> |
| 57 |
</tr> |
| 58 |
<tr> |
| 59 |
<td class="function_type"> |
| 60 |
<span class="returnvalue">gboolean</span> |
| 61 |
</td> |
| 62 |
<td class="function_name"> |
| 63 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-load-single-module" title="udisks_module_manager_load_single_module ()">udisks_module_manager_load_single_module</a> <span class="c_punctuation">()</span> |
| 64 |
</td> |
| 65 |
</tr> |
| 66 |
<tr> |
| 67 |
<td class="function_type"> |
| 68 |
<span class="returnvalue">void</span> |
| 69 |
</td> |
| 70 |
<td class="function_name"> |
| 71 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-load-modules" title="udisks_module_manager_load_modules ()">udisks_module_manager_load_modules</a> <span class="c_punctuation">()</span> |
| 72 |
</td> |
| 73 |
</tr> |
| 74 |
<tr> |
| 75 |
<td class="function_type"> |
| 76 |
<span class="returnvalue">void</span> |
| 77 |
</td> |
| 78 |
<td class="function_name"> |
| 79 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-unload-modules" title="udisks_module_manager_unload_modules ()">udisks_module_manager_unload_modules</a> <span class="c_punctuation">()</span> |
| 80 |
</td> |
| 81 |
</tr> |
| 82 |
<tr> |
| 83 |
<td class="function_type"> |
| 84 |
<span class="returnvalue">GList</span> * |
| 85 |
</td> |
| 86 |
<td class="function_name"> |
| 87 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-get-modules" title="udisks_module_manager_get_modules ()">udisks_module_manager_get_modules</a> <span class="c_punctuation">()</span> |
| 88 |
</td> |
| 89 |
</tr> |
| 90 |
<tr> |
| 91 |
<td class="function_type"> |
| 92 |
<a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> * |
| 93 |
</td> |
| 94 |
<td class="function_name"> |
| 95 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-get-daemon" title="udisks_module_manager_get_daemon ()">udisks_module_manager_get_daemon</a> <span class="c_punctuation">()</span> |
| 96 |
</td> |
| 97 |
</tr> |
| 98 |
<tr> |
| 99 |
<td class="function_type"> |
| 100 |
<span class="returnvalue">gboolean</span> |
| 101 |
</td> |
| 102 |
<td class="function_name"> |
| 103 |
<a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-get-uninstalled" title="udisks_module_manager_get_uninstalled ()">udisks_module_manager_get_uninstalled</a> <span class="c_punctuation">()</span> |
| 104 |
</td> |
| 105 |
</tr> |
| 106 |
</tbody> |
| 107 |
</table></div> |
| 108 |
</div> |
| 109 |
<div class="refsect1"> |
| 110 |
<a name="udisks2-UDisksModuleManager.other"></a><h2>Types and Values</h2> |
| 111 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 112 |
<colgroup> |
| 113 |
<col width="150px" class="other_proto_type"> |
| 114 |
<col class="other_proto_name"> |
| 115 |
</colgroup> |
| 116 |
<tbody><tr> |
| 117 |
<td class="datatype_keyword"> </td> |
| 118 |
<td class="function_name"><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager">UDisksModuleManager</a></td> |
| 119 |
</tr></tbody> |
| 120 |
</table></div> |
| 121 |
</div> |
| 122 |
<div class="refsect1"> |
| 123 |
<a name="udisks2-UDisksModuleManager.description"></a><h2>Description</h2> |
| 124 |
<div class="refsect3"> |
| 125 |
<a name="udisks-modular-design"></a><h4>UDisks modular approach</h4> |
| 126 |
<p>UDisks functionality can be extended by modules. It's not that traditional |
| 127 |
fully pluggable system as we all know it, modules are essentially just |
| 128 |
carved-out parts of the daemon code and are free to access whatever internal |
| 129 |
daemon objects they need. There's no universal module API other than a couple |
| 130 |
of module initialization functions and a stateful module object. Out-of-tree |
| 131 |
modules are not supported either and no ABI guarantee exists at all.</p> |
| 132 |
<p>This fact allows us to stay code-wise simple and transparent. It's also easier |
| 133 |
to adapt modules for any change done to the core daemon. As a design decision |
| 134 |
and leading from <span class="type">GType</span> system limitation modules can't be unloaded once |
| 135 |
initialized. This may be a subject to change in the future, though unlikely.</p> |
| 136 |
<p>The primary motivation for introducing the modular system was to keep the daemon |
| 137 |
low on resource footprint for basic usage (typically desktop environments) and |
| 138 |
activating extended functionality only as needed (e.g. enterprise storage |
| 139 |
applications). As the extra information comes in form of additional D-Bus |
| 140 |
objects and interfaces, no difference should be observed by ordinary clients.</p> |
| 141 |
</div> |
| 142 |
<div class="refsect3"> |
| 143 |
<a name="udisks-modular-activation"></a><h4>Modules activation</h4> |
| 144 |
<p>The UDisks daemon constructs a <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> singleton acting as |
| 145 |
a module manager. This object tracks module usage and takes care of their |
| 146 |
activation.</p> |
| 147 |
<p>By default <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> is constructed on daemon startup with module |
| 148 |
loading delayed until requested. This can be overridden by the |
| 149 |
<code class="literal">--force-load-modules</code> and <code class="literal">--disable-modules</code> |
| 150 |
commandline switches that makes modules loaded right on startup or never loaded |
| 151 |
respectively.</p> |
| 152 |
<p>Clients are supposed to call the <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.EnableModule" title="The EnableModule() method">org.freedesktop.UDisks2.Manager.EnableModule()</a> |
| 153 |
D-Bus method as a <span class="emphasis"><em>"greeter"</em></span> call for each module requested. |
| 154 |
Proper error is reported should the module initialization fail or the module |
| 155 |
is not available. Clients are supposed to act accordingly and make sure that all |
| 156 |
requested modules are available and loaded prior to using any of the extra API.</p> |
| 157 |
<p>Upon successful activation, a <code class="literal">modules-activated</code> signal is |
| 158 |
emitted internally on the <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> object. Any daemon objects |
| 159 |
connected to this signal are responsible for performing <span class="emphasis"><em>"coldplug"</em></span> |
| 160 |
on exported objects to assure modules would pick up the devices they're |
| 161 |
interested in.</p> |
| 162 |
</div> |
| 163 |
<div class="refsect3"> |
| 164 |
<a name="udisks-modular-design-dbus"></a><h4>D-Bus interface extensibility</h4> |
| 165 |
<p>The modular approach is fairly simple, there are basically three primary ways |
| 166 |
of extending the D-Bus API:</p> |
| 167 |
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| 168 |
<li class="listitem"><p>by attaching custom interfaces to existing block and drive objects - see |
| 169 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-block-object-interface" title="udisks_module_new_block_object_interface ()"><code class="function">udisks_module_new_block_object_interface()</code></a> and |
| 170 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-drive-object-interface" title="udisks_module_new_drive_object_interface ()"><code class="function">udisks_module_new_drive_object_interface()</code></a>.</p></li> |
| 171 |
<li class="listitem"><p>by exporting objects of its own type (socalled <span class="emphasis"><em>"module objects"</em></span>) |
| 172 |
directly on the object manager root - see <a class="link" href="udisks2-UDisksModule.html#udisks-module-new-object" title="udisks_module_new_object ()"><code class="function">udisks_module_new_object()</code></a>.</p></li> |
| 173 |
<li class="listitem"><p>attaching a common manager interface on the master <code class="filename">/org/freedesktop/UDisks2/Manager</code> |
| 174 |
object - see <a class="link" href="udisks2-UDisksModule.html#udisks-module-new-manager" title="udisks_module_new_manager ()"><code class="function">udisks_module_new_manager()</code></a>.</p></li> |
| 175 |
</ul></div> |
| 176 |
<p>All these ways of extensibility are implemented as <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> methods and |
| 177 |
it is a <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> task to provide interconnection between <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> |
| 178 |
instances and daemon objects representing drives and block devices.</p> |
| 179 |
</div> |
| 180 |
</div> |
| 181 |
<div class="refsect1"> |
| 182 |
<a name="udisks2-UDisksModuleManager.functions_details"></a><h2>Functions</h2> |
| 183 |
<div class="refsect2"> |
| 184 |
<a name="udisks-module-manager-new"></a><h3>udisks_module_manager_new ()</h3> |
| 185 |
<pre class="programlisting"><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="returnvalue">UDisksModuleManager</span></a> * |
| 186 |
udisks_module_manager_new (<em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>);</pre> |
| 187 |
<p>Creates a new <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> object.</p> |
| 188 |
<div class="refsect3"> |
| 189 |
<a name="udisks-module-manager-new.parameters"></a><h4>Parameters</h4> |
| 190 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 191 |
<colgroup> |
| 192 |
<col width="150px" class="parameters_name"> |
| 193 |
<col class="parameters_description"> |
| 194 |
<col width="200px" class="parameters_annotations"> |
| 195 |
</colgroup> |
| 196 |
<tbody><tr> |
| 197 |
<td class="parameter_name"><p>daemon</p></td> |
| 198 |
<td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> instance.</p></td> |
| 199 |
<td class="parameter_annotations"> </td> |
| 200 |
</tr></tbody> |
| 201 |
</table></div> |
| 202 |
</div> |
| 203 |
<div class="refsect3"> |
| 204 |
<a name="udisks-module-manager-new.returns"></a><h4>Returns</h4> |
| 205 |
<p> A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a>. Free with <code class="function">g_object_unref()</code>.</p> |
| 206 |
</div> |
| 207 |
</div> |
| 208 |
<hr> |
| 209 |
<div class="refsect2"> |
| 210 |
<a name="udisks-module-manager-new-uninstalled"></a><h3>udisks_module_manager_new_uninstalled ()</h3> |
| 211 |
<pre class="programlisting"><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="returnvalue">UDisksModuleManager</span></a> * |
| 212 |
udisks_module_manager_new_uninstalled (<em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>);</pre> |
| 213 |
<p>Creates a new <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> object with indication that |
| 214 |
the daemon runs from a source tree.</p> |
| 215 |
<div class="refsect3"> |
| 216 |
<a name="udisks-module-manager-new-uninstalled.parameters"></a><h4>Parameters</h4> |
| 217 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 218 |
<colgroup> |
| 219 |
<col width="150px" class="parameters_name"> |
| 220 |
<col class="parameters_description"> |
| 221 |
<col width="200px" class="parameters_annotations"> |
| 222 |
</colgroup> |
| 223 |
<tbody><tr> |
| 224 |
<td class="parameter_name"><p>daemon</p></td> |
| 225 |
<td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> instance.</p></td> |
| 226 |
<td class="parameter_annotations"> </td> |
| 227 |
</tr></tbody> |
| 228 |
</table></div> |
| 229 |
</div> |
| 230 |
<div class="refsect3"> |
| 231 |
<a name="udisks-module-manager-new-uninstalled.returns"></a><h4>Returns</h4> |
| 232 |
<p> A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a>. Free with <code class="function">g_object_notify()</code>.</p> |
| 233 |
</div> |
| 234 |
</div> |
| 235 |
<hr> |
| 236 |
<div class="refsect2"> |
| 237 |
<a name="udisks-module-manager-load-single-module"></a><h3>udisks_module_manager_load_single_module ()</h3> |
| 238 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 239 |
udisks_module_manager_load_single_module |
| 240 |
(<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>, |
| 241 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, |
| 242 |
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| 243 |
<p>Loads single module and emits the <code class="literal">modules-activated</code> signal |
| 244 |
in case the module activation was successful. Already active module is not |
| 245 |
being reinitialized on subsequent calls to this method and <code class="literal">TRUE</code> is returned |
| 246 |
immediately.</p> |
| 247 |
<div class="refsect3"> |
| 248 |
<a name="udisks-module-manager-load-single-module.parameters"></a><h4>Parameters</h4> |
| 249 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 250 |
<colgroup> |
| 251 |
<col width="150px" class="parameters_name"> |
| 252 |
<col class="parameters_description"> |
| 253 |
<col width="200px" class="parameters_annotations"> |
| 254 |
</colgroup> |
| 255 |
<tbody> |
| 256 |
<tr> |
| 257 |
<td class="parameter_name"><p>manager</p></td> |
| 258 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> instance.</p></td> |
| 259 |
<td class="parameter_annotations"> </td> |
| 260 |
</tr> |
| 261 |
<tr> |
| 262 |
<td class="parameter_name"><p>name</p></td> |
| 263 |
<td class="parameter_description"><p>Module name.</p></td> |
| 264 |
<td class="parameter_annotations"> </td> |
| 265 |
</tr> |
| 266 |
<tr> |
| 267 |
<td class="parameter_name"><p>error</p></td> |
| 268 |
<td class="parameter_description"><p>Return location for error or <code class="literal">NULL</code>.</p></td> |
| 269 |
<td class="parameter_annotations"> </td> |
| 270 |
</tr> |
| 271 |
</tbody> |
| 272 |
</table></div> |
| 273 |
</div> |
| 274 |
<div class="refsect3"> |
| 275 |
<a name="udisks-module-manager-load-single-module.returns"></a><h4>Returns</h4> |
| 276 |
<p> <code class="literal">TRUE</code> if module was activated successfully, <code class="literal">FALSE</code> otherwise with <em class="parameter"><code>error</code></em> |
| 277 |
being set.</p> |
| 278 |
</div> |
| 279 |
</div> |
| 280 |
<hr> |
| 281 |
<div class="refsect2"> |
| 282 |
<a name="udisks-module-manager-load-modules"></a><h3>udisks_module_manager_load_modules ()</h3> |
| 283 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 284 |
udisks_module_manager_load_modules (<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>);</pre> |
| 285 |
<p>Loads all modules at a time and emits the <code class="literal">modules-activated</code> |
| 286 |
signal in case any new module has been activated. Modules that are already loaded |
| 287 |
are skipped on subsequent calls to this method.</p> |
| 288 |
<div class="refsect3"> |
| 289 |
<a name="udisks-module-manager-load-modules.parameters"></a><h4>Parameters</h4> |
| 290 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 291 |
<colgroup> |
| 292 |
<col width="150px" class="parameters_name"> |
| 293 |
<col class="parameters_description"> |
| 294 |
<col width="200px" class="parameters_annotations"> |
| 295 |
</colgroup> |
| 296 |
<tbody><tr> |
| 297 |
<td class="parameter_name"><p>manager</p></td> |
| 298 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> instance.</p></td> |
| 299 |
<td class="parameter_annotations"> </td> |
| 300 |
</tr></tbody> |
| 301 |
</table></div> |
| 302 |
</div> |
| 303 |
</div> |
| 304 |
<hr> |
| 305 |
<div class="refsect2"> |
| 306 |
<a name="udisks-module-manager-unload-modules"></a><h3>udisks_module_manager_unload_modules ()</h3> |
| 307 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 308 |
udisks_module_manager_unload_modules (<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>);</pre> |
| 309 |
<p>Unloads all modules at a time. A <code class="literal">modules-activated</code> signal |
| 310 |
is emitted if there are any modules staged for unload to give listeners room |
| 311 |
to unexport all module interfaces and objects. The <a class="link" href="udisks2-UDisksModuleManager.html#udisks-module-manager-get-modules" title="udisks_module_manager_get_modules ()"><code class="function">udisks_module_manager_get_modules()</code></a> |
| 312 |
would return <code class="literal">NULL</code> at that time. Note that proper module unload is not fully |
| 313 |
supported, this is just a convenience call for cleanup.</p> |
| 314 |
<div class="refsect3"> |
| 315 |
<a name="udisks-module-manager-unload-modules.parameters"></a><h4>Parameters</h4> |
| 316 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 317 |
<colgroup> |
| 318 |
<col width="150px" class="parameters_name"> |
| 319 |
<col class="parameters_description"> |
| 320 |
<col width="200px" class="parameters_annotations"> |
| 321 |
</colgroup> |
| 322 |
<tbody><tr> |
| 323 |
<td class="parameter_name"><p>manager</p></td> |
| 324 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> instance.</p></td> |
| 325 |
<td class="parameter_annotations"> </td> |
| 326 |
</tr></tbody> |
| 327 |
</table></div> |
| 328 |
</div> |
| 329 |
</div> |
| 330 |
<hr> |
| 331 |
<div class="refsect2"> |
| 332 |
<a name="udisks-module-manager-get-modules"></a><h3>udisks_module_manager_get_modules ()</h3> |
| 333 |
<pre class="programlisting"><span class="returnvalue">GList</span> * |
| 334 |
udisks_module_manager_get_modules (<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>);</pre> |
| 335 |
<p>Gets list of active modules. Can be called from different threads.</p> |
| 336 |
<div class="refsect3"> |
| 337 |
<a name="udisks-module-manager-get-modules.parameters"></a><h4>Parameters</h4> |
| 338 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 339 |
<colgroup> |
| 340 |
<col width="150px" class="parameters_name"> |
| 341 |
<col class="parameters_description"> |
| 342 |
<col width="200px" class="parameters_annotations"> |
| 343 |
</colgroup> |
| 344 |
<tbody><tr> |
| 345 |
<td class="parameter_name"><p>manager</p></td> |
| 346 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> instance.</p></td> |
| 347 |
<td class="parameter_annotations"> </td> |
| 348 |
</tr></tbody> |
| 349 |
</table></div> |
| 350 |
</div> |
| 351 |
<div class="refsect3"> |
| 352 |
<a name="udisks-module-manager-get-modules.returns"></a><h4>Returns</h4> |
| 353 |
<p>A list of <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> |
| 354 |
or <code class="literal">NULL</code> if no modules are presently loaded. Free the elements |
| 355 |
with <code class="function">g_object_unref()</code>. </p> |
| 356 |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> UDisksModule]</span></p> |
| 357 |
</div> |
| 358 |
</div> |
| 359 |
<hr> |
| 360 |
<div class="refsect2"> |
| 361 |
<a name="udisks-module-manager-get-daemon"></a><h3>udisks_module_manager_get_daemon ()</h3> |
| 362 |
<pre class="programlisting"><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> * |
| 363 |
udisks_module_manager_get_daemon (<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>);</pre> |
| 364 |
<p>Gets the daemon used by <em class="parameter"><code>manager</code></em> |
| 365 |
.</p> |
| 366 |
<div class="refsect3"> |
| 367 |
<a name="udisks-module-manager-get-daemon.parameters"></a><h4>Parameters</h4> |
| 368 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 369 |
<colgroup> |
| 370 |
<col width="150px" class="parameters_name"> |
| 371 |
<col class="parameters_description"> |
| 372 |
<col width="200px" class="parameters_annotations"> |
| 373 |
</colgroup> |
| 374 |
<tbody><tr> |
| 375 |
<td class="parameter_name"><p>manager</p></td> |
| 376 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a>.</p></td> |
| 377 |
<td class="parameter_annotations"> </td> |
| 378 |
</tr></tbody> |
| 379 |
</table></div> |
| 380 |
</div> |
| 381 |
<div class="refsect3"> |
| 382 |
<a name="udisks-module-manager-get-daemon.returns"></a><h4>Returns</h4> |
| 383 |
<p> A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>. Do not free, the object is owned by <em class="parameter"><code>manager</code></em> |
| 384 |
.</p> |
| 385 |
</div> |
| 386 |
</div> |
| 387 |
<hr> |
| 388 |
<div class="refsect2"> |
| 389 |
<a name="udisks-module-manager-get-uninstalled"></a><h3>udisks_module_manager_get_uninstalled ()</h3> |
| 390 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 391 |
udisks_module_manager_get_uninstalled (<em class="parameter"><code><a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> *manager</code></em>);</pre> |
| 392 |
<p>Indicates whether the udisks daemon runs from a source tree |
| 393 |
rather than being a regular system instance.</p> |
| 394 |
<div class="refsect3"> |
| 395 |
<a name="udisks-module-manager-get-uninstalled.parameters"></a><h4>Parameters</h4> |
| 396 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 397 |
<colgroup> |
| 398 |
<col width="150px" class="parameters_name"> |
| 399 |
<col class="parameters_description"> |
| 400 |
<col width="200px" class="parameters_annotations"> |
| 401 |
</colgroup> |
| 402 |
<tbody><tr> |
| 403 |
<td class="parameter_name"><p>manager</p></td> |
| 404 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a>.</p></td> |
| 405 |
<td class="parameter_annotations"> </td> |
| 406 |
</tr></tbody> |
| 407 |
</table></div> |
| 408 |
</div> |
| 409 |
<div class="refsect3"> |
| 410 |
<a name="udisks-module-manager-get-uninstalled.returns"></a><h4>Returns</h4> |
| 411 |
<p> <code class="literal">TRUE</code> when the daemon runs from a source tree, <code class="literal">FALSE</code> otherwise.</p> |
| 412 |
</div> |
| 413 |
</div> |
| 414 |
</div> |
| 415 |
<div class="refsect1"> |
| 416 |
<a name="udisks2-UDisksModuleManager.other_details"></a><h2>Types and Values</h2> |
| 417 |
<div class="refsect2"> |
| 418 |
<a name="UDisksModuleManager"></a><h3>UDisksModuleManager</h3> |
| 419 |
<pre class="programlisting">typedef struct _UDisksModuleManager UDisksModuleManager;</pre> |
| 420 |
<p>The <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> structure contains only private data and |
| 421 |
should only be accessed using the provided API.</p> |
| 422 |
</div> |
| 423 |
</div> |
| 424 |
</div> |
| 425 |
<div class="footer"> |
| 426 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 427 |
</body> |
| 428 |
</html> |