| 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>UDisksModule: 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-UDisksModuleManager.html" title="UDisksModuleManager"> |
| 10 |
<link rel="next" href="ref-daemon-monitoring.html" title="State and Configuration"> |
| 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-UDisksModule.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-UDisksModuleManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 23 |
<td><a accesskey="n" href="ref-daemon-monitoring.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-UDisksModule"></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-UDisksModule.top_of_page"></a>UDisksModule</span></h2> |
| 30 |
<p>UDisksModule — Daemon module</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-UDisksModule.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 |
<span class="returnvalue">gchar</span> * |
| 45 |
</td> |
| 46 |
<td class="function_name"> |
| 47 |
<span class="c_punctuation">(</span><a class="link" href="udisks2-UDisksModule.html#UDisksModuleIDFunc" title="UDisksModuleIDFunc ()">*UDisksModuleIDFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 48 |
</td> |
| 49 |
</tr> |
| 50 |
<tr> |
| 51 |
<td class="function_type"> |
| 52 |
<a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="returnvalue">UDisksModule</span></a> * |
| 53 |
</td> |
| 54 |
<td class="function_name"> |
| 55 |
<span class="c_punctuation">(</span><a class="link" href="udisks2-UDisksModule.html#UDisksModuleNewFunc" title="UDisksModuleNewFunc ()">*UDisksModuleNewFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> |
| 56 |
</td> |
| 57 |
</tr> |
| 58 |
<tr> |
| 59 |
<td class="function_type">const <span class="returnvalue">gchar</span> * |
| 60 |
</td> |
| 61 |
<td class="function_name"> |
| 62 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-get-name" title="udisks_module_get_name ()">udisks_module_get_name</a> <span class="c_punctuation">()</span> |
| 63 |
</td> |
| 64 |
</tr> |
| 65 |
<tr> |
| 66 |
<td class="function_type"> |
| 67 |
<span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 68 |
</td> |
| 69 |
<td class="function_name"> |
| 70 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-manager" title="udisks_module_new_manager ()">udisks_module_new_manager</a> <span class="c_punctuation">()</span> |
| 71 |
</td> |
| 72 |
</tr> |
| 73 |
<tr> |
| 74 |
<td class="function_type"> |
| 75 |
<span class="returnvalue">GDBusObjectSkeleton</span> ** |
| 76 |
</td> |
| 77 |
<td class="function_name"> |
| 78 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-object" title="udisks_module_new_object ()">udisks_module_new_object</a> <span class="c_punctuation">()</span> |
| 79 |
</td> |
| 80 |
</tr> |
| 81 |
<tr> |
| 82 |
<td class="function_type"> |
| 83 |
<span class="returnvalue">GType</span> * |
| 84 |
</td> |
| 85 |
<td class="function_name"> |
| 86 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-get-block-object-interface-types" title="udisks_module_get_block_object_interface_types ()">udisks_module_get_block_object_interface_types</a> <span class="c_punctuation">()</span> |
| 87 |
</td> |
| 88 |
</tr> |
| 89 |
<tr> |
| 90 |
<td class="function_type"> |
| 91 |
<span class="returnvalue">GType</span> * |
| 92 |
</td> |
| 93 |
<td class="function_name"> |
| 94 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-get-drive-object-interface-types" title="udisks_module_get_drive_object_interface_types ()">udisks_module_get_drive_object_interface_types</a> <span class="c_punctuation">()</span> |
| 95 |
</td> |
| 96 |
</tr> |
| 97 |
<tr> |
| 98 |
<td class="function_type"> |
| 99 |
<span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 100 |
</td> |
| 101 |
<td class="function_name"> |
| 102 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-block-object-interface" title="udisks_module_new_block_object_interface ()">udisks_module_new_block_object_interface</a> <span class="c_punctuation">()</span> |
| 103 |
</td> |
| 104 |
</tr> |
| 105 |
<tr> |
| 106 |
<td class="function_type"> |
| 107 |
<span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 108 |
</td> |
| 109 |
<td class="function_name"> |
| 110 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-new-drive-object-interface" title="udisks_module_new_drive_object_interface ()">udisks_module_new_drive_object_interface</a> <span class="c_punctuation">()</span> |
| 111 |
</td> |
| 112 |
</tr> |
| 113 |
<tr> |
| 114 |
<td class="function_type"> |
| 115 |
<span class="returnvalue">gchar</span> * |
| 116 |
</td> |
| 117 |
<td class="function_name"> |
| 118 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-track-parent" title="udisks_module_track_parent ()">udisks_module_track_parent</a> <span class="c_punctuation">()</span> |
| 119 |
</td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td class="function_type"> |
| 123 |
<a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> * |
| 124 |
</td> |
| 125 |
<td class="function_name"> |
| 126 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-get-daemon" title="udisks_module_get_daemon ()">udisks_module_get_daemon</a> <span class="c_punctuation">()</span> |
| 127 |
</td> |
| 128 |
</tr> |
| 129 |
<tr> |
| 130 |
<td class="function_type"> |
| 131 |
<span class="returnvalue">gboolean</span> |
| 132 |
</td> |
| 133 |
<td class="function_name"> |
| 134 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()">udisks_module_object_process_uevent</a> <span class="c_punctuation">()</span> |
| 135 |
</td> |
| 136 |
</tr> |
| 137 |
<tr> |
| 138 |
<td class="function_type"> |
| 139 |
<span class="returnvalue">gboolean</span> |
| 140 |
</td> |
| 141 |
<td class="function_name"> |
| 142 |
<a class="link" href="udisks2-UDisksModule.html#udisks-module-object-housekeeping" title="udisks_module_object_housekeeping ()">udisks_module_object_housekeeping</a> <span class="c_punctuation">()</span> |
| 143 |
</td> |
| 144 |
</tr> |
| 145 |
</tbody> |
| 146 |
</table></div> |
| 147 |
</div> |
| 148 |
<div class="refsect1"> |
| 149 |
<a name="udisks2-UDisksModule.other"></a><h2>Types and Values</h2> |
| 150 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 151 |
<colgroup> |
| 152 |
<col width="150px" class="other_proto_type"> |
| 153 |
<col class="other_proto_name"> |
| 154 |
</colgroup> |
| 155 |
<tbody> |
| 156 |
<tr> |
| 157 |
<td class="datatype_keyword">struct</td> |
| 158 |
<td class="function_name"><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule">UDisksModule</a></td> |
| 159 |
</tr> |
| 160 |
<tr> |
| 161 |
<td class="datatype_keyword">struct</td> |
| 162 |
<td class="function_name"><a class="link" href="udisks2-UDisksModule.html#UDisksModuleClass" title="struct UDisksModuleClass">UDisksModuleClass</a></td> |
| 163 |
</tr> |
| 164 |
<tr> |
| 165 |
<td class="datatype_keyword"> </td> |
| 166 |
<td class="function_name"><a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject">UDisksModuleObject</a></td> |
| 167 |
</tr> |
| 168 |
<tr> |
| 169 |
<td class="datatype_keyword">struct</td> |
| 170 |
<td class="function_name"><a class="link" href="udisks2-UDisksModule.html#UDisksModuleObjectIface" title="struct UDisksModuleObjectIface">UDisksModuleObjectIface</a></td> |
| 171 |
</tr> |
| 172 |
</tbody> |
| 173 |
</table></div> |
| 174 |
</div> |
| 175 |
<div class="refsect1"> |
| 176 |
<a name="udisks2-UDisksModule.description"></a><h2>Description</h2> |
| 177 |
<div class="refsect3"> |
| 178 |
<a name="udisks-module-design"></a><h4>UDisks module design</h4> |
| 179 |
<p><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> is a stateful object that represents a daemon module. It is supposed |
| 180 |
to hold arbitrary runtime data and perform proper initialization and cleanup within |
| 181 |
its constructor and destructor. Once initialized by <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> the instance |
| 182 |
is usually kept around until the daemon exits. Although proper module unloading |
| 183 |
is not currently implemented the object destructor may be actually called in some |
| 184 |
cases.</p> |
| 185 |
<p>Derived <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> object is supposed to implement failable initialization |
| 186 |
and return proper error that the <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> would propagate further |
| 187 |
up the stack. Modules are free to use failable initialization for checking runtime |
| 188 |
dependencies such as additional config files and fail if misconfigured.</p> |
| 189 |
</div> |
| 190 |
<div class="refsect3"> |
| 191 |
<a name="udisks-module-naming"></a><h4>UDisks module naming conventions</h4> |
| 192 |
<p>Every module must implement and export two symbols that are used as entry points: <a class="link" href="udisks2-UDisksModule.html#UDisksModuleIDFunc" title="UDisksModuleIDFunc ()"><code class="function">udisks_module_id()</code></a> |
| 193 |
and <a class="link" href="udisks2-UDisksModule.html#UDisksModuleNewFunc" title="UDisksModuleNewFunc ()"><code class="function">udisks_module_ID_new()</code></a> |
| 194 |
where <code class="literal">ID</code> is a string returned by <a class="link" href="udisks2-UDisksModule.html#UDisksModuleIDFunc" title="UDisksModuleIDFunc ()"><code class="function">udisks_module_id()</code></a>. |
| 195 |
This identification string is subsequently used at several places - primarily |
| 196 |
serves as an unique and user readable module identifier (e.g. <code class="literal">lvm2</code>) |
| 197 |
passed in as an argument to 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> |
| 198 |
method call.</p> |
| 199 |
<p>Physically modules are essentially regular shared objects (<code class="literal">.so</code>) |
| 200 |
that are loaded from <code class="filename">$(libdir)/udisks2/modules</code> directory |
| 201 |
(typically <code class="filename">/usr/lib/udisks2/modules</code>). No extra service or |
| 202 |
config files are needed, however a specific file naming of <code class="filename">libudisks2_<span class="emphasis"><em>ID</em></span>.so</code> |
| 203 |
is required.</p> |
| 204 |
</div> |
| 205 |
<div class="refsect3"> |
| 206 |
<a name="udisks-modular-api"></a><h4>Module API</h4> |
| 207 |
<p>Other than the two entry points described in last paragraph the rest of the daemon |
| 208 |
to module interaction is done via <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> class methods over an instance |
| 209 |
created by the <a class="link" href="udisks2-UDisksModule.html#UDisksModuleNewFunc" title="UDisksModuleNewFunc ()"><code class="function">udisks_module_ID_new()</code></a> |
| 210 |
constructor. Please see particular <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> methods for detailed description |
| 211 |
of each way of extending the daemon functionality. Most methods are pretty |
| 212 |
straightforward with the exception of extra drive and block object interfaces.</p> |
| 213 |
<p>It's important to provide <a class="link" href="udisks2-UDisksModule.html#udisks-module-get-block-object-interface-types" title="udisks_module_get_block_object_interface_types ()"><code class="function">udisks_module_get_block_object_interface_types()</code></a> and |
| 214 |
<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> methods (or <code class="literal">drive</code> |
| 215 |
respectively) always in pairs as the <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> and <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> |
| 216 |
machinery needs to register available interface skeleton types first and subsequently |
| 217 |
create target interfaces for each specified type and route uevents onto. There |
| 218 |
can be only one extra interface of a given type on a single <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> |
| 219 |
or <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> object.</p> |
| 220 |
<p>In case of an existing interface for a particular type uevents are routed through |
| 221 |
the <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a> method of a <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> interface |
| 222 |
that the newly created <span class="type">GDBusInterfaceSkeleton</span> interface has to implement. This |
| 223 |
call is supposed to process updated information and indicate via the return <em class="parameter"><code>keep</code></em> |
| 224 |
|
| 225 |
argument whether the particular interface is valid or should be removed from |
| 226 |
the object.</p> |
| 227 |
<p>In case no <span class="type">GDBusInterfaceSkeleton</span> interface of a given type is attached on the |
| 228 |
particular object, <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> or |
| 229 |
<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> methods respectively are called |
| 230 |
in attempt to create new one. These methods are supposed to check whether the |
| 231 |
interface type is applicable for the current object and return <code class="literal">NULL</code> if not.</p> |
| 232 |
<p>Exposing independent module objects on the master UDisks object manager as another |
| 233 |
way of daemon extensibility works in a similar way - please 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> |
| 234 |
for detailed description.</p> |
| 235 |
</div> |
| 236 |
</div> |
| 237 |
<div class="refsect1"> |
| 238 |
<a name="udisks2-UDisksModule.functions_details"></a><h2>Functions</h2> |
| 239 |
<div class="refsect2"> |
| 240 |
<a name="UDisksModuleIDFunc"></a><h3>UDisksModuleIDFunc ()</h3> |
| 241 |
<pre class="programlisting"><span class="returnvalue">gchar</span> * |
| 242 |
<span class="c_punctuation">(</span>*UDisksModuleIDFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 243 |
<p>Function prototype that is called by <a class="link" href="udisks2-UDisksModuleManager.html#UDisksModuleManager" title="UDisksModuleManager"><span class="type">UDisksModuleManager</span></a> to get |
| 244 |
unique module identifier. No initialization is supposed to be done |
| 245 |
at this point.</p> |
| 246 |
<div class="refsect3"> |
| 247 |
<a name="UDisksModuleIDFunc.returns"></a><h4>Returns</h4> |
| 248 |
<p>The module ID string. Free with <code class="function">g_free()</code>. </p> |
| 249 |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 250 |
</div> |
| 251 |
<p class="since">Since: 2.0</p> |
| 252 |
</div> |
| 253 |
<hr> |
| 254 |
<div class="refsect2"> |
| 255 |
<a name="UDisksModuleNewFunc"></a><h3>UDisksModuleNewFunc ()</h3> |
| 256 |
<pre class="programlisting"><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="returnvalue">UDisksModule</span></a> * |
| 257 |
<span class="c_punctuation">(</span>*UDisksModuleNewFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>, |
| 258 |
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, |
| 259 |
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| 260 |
<p>Function prototype that creates a new <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> instance. Module |
| 261 |
initialization is done at this point. This is a failable method call |
| 262 |
that properly reports module initialization failure.</p> |
| 263 |
<div class="refsect3"> |
| 264 |
<a name="UDisksModuleNewFunc.parameters"></a><h4>Parameters</h4> |
| 265 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 266 |
<colgroup> |
| 267 |
<col width="150px" class="parameters_name"> |
| 268 |
<col class="parameters_description"> |
| 269 |
<col width="200px" class="parameters_annotations"> |
| 270 |
</colgroup> |
| 271 |
<tbody> |
| 272 |
<tr> |
| 273 |
<td class="parameter_name"><p>daemon</p></td> |
| 274 |
<td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> instance.</p></td> |
| 275 |
<td class="parameter_annotations"> </td> |
| 276 |
</tr> |
| 277 |
<tr> |
| 278 |
<td class="parameter_name"><p>cancellable</p></td> |
| 279 |
<td class="parameter_description"><p>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </p></td> |
| 280 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 281 |
</tr> |
| 282 |
<tr> |
| 283 |
<td class="parameter_name"><p>error</p></td> |
| 284 |
<td class="parameter_description"><p>Return location for error or <code class="literal">NULL</code>.</p></td> |
| 285 |
<td class="parameter_annotations"> </td> |
| 286 |
</tr> |
| 287 |
</tbody> |
| 288 |
</table></div> |
| 289 |
</div> |
| 290 |
<div class="refsect3"> |
| 291 |
<a name="UDisksModuleNewFunc.returns"></a><h4>Returns</h4> |
| 292 |
<p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> object or <code class="literal">NULL</code> if <em class="parameter"><code>error</code></em> |
| 293 |
is set. |
| 294 |
Free with <code class="function">g_object_unref()</code>. </p> |
| 295 |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 296 |
</div> |
| 297 |
<p class="since">Since: 2.9</p> |
| 298 |
</div> |
| 299 |
<hr> |
| 300 |
<div class="refsect2"> |
| 301 |
<a name="udisks-module-get-name"></a><h3>udisks_module_get_name ()</h3> |
| 302 |
<pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| 303 |
udisks_module_get_name (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>);</pre> |
| 304 |
<p>Gets the name of the <em class="parameter"><code>module</code></em> |
| 305 |
.</p> |
| 306 |
<div class="refsect3"> |
| 307 |
<a name="udisks-module-get-name.parameters"></a><h4>Parameters</h4> |
| 308 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 309 |
<colgroup> |
| 310 |
<col width="150px" class="parameters_name"> |
| 311 |
<col class="parameters_description"> |
| 312 |
<col width="200px" class="parameters_annotations"> |
| 313 |
</colgroup> |
| 314 |
<tbody><tr> |
| 315 |
<td class="parameter_name"><p>module</p></td> |
| 316 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 317 |
<td class="parameter_annotations"> </td> |
| 318 |
</tr></tbody> |
| 319 |
</table></div> |
| 320 |
</div> |
| 321 |
<div class="refsect3"> |
| 322 |
<a name="udisks-module-get-name.returns"></a><h4>Returns</h4> |
| 323 |
<p>A module name string. Do not free, the string is owned by <em class="parameter"><code>module</code></em> |
| 324 |
. </p> |
| 325 |
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 326 |
</div> |
| 327 |
<p class="since">Since: 2.9.0</p> |
| 328 |
</div> |
| 329 |
<hr> |
| 330 |
<div class="refsect2"> |
| 331 |
<a name="udisks-module-new-manager"></a><h3>udisks_module_new_manager ()</h3> |
| 332 |
<pre class="programlisting"><span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 333 |
udisks_module_new_manager (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>);</pre> |
| 334 |
<p>Creates a new <span class="type">GDBusInterfaceSkeleton</span> instance carrying an additional D-Bus interface |
| 335 |
to be exported on the <a class="link" href="UDisksManager.html" title="UDisksManager"><span class="type">UDisksManager</span></a> object (at the <code class="filename">/org/freedesktop/UDisks2/Manager</code> |
| 336 |
path). It is a fairly simple stateless object not related to any device and serves |
| 337 |
the purpose of performing general tasks or creating new resources. Only a single |
| 338 |
manager interface can be provided by each module.</p> |
| 339 |
<div class="refsect3"> |
| 340 |
<a name="udisks-module-new-manager.parameters"></a><h4>Parameters</h4> |
| 341 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 342 |
<colgroup> |
| 343 |
<col width="150px" class="parameters_name"> |
| 344 |
<col class="parameters_description"> |
| 345 |
<col width="200px" class="parameters_annotations"> |
| 346 |
</colgroup> |
| 347 |
<tbody><tr> |
| 348 |
<td class="parameter_name"><p>module</p></td> |
| 349 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 350 |
<td class="parameter_annotations"> </td> |
| 351 |
</tr></tbody> |
| 352 |
</table></div> |
| 353 |
</div> |
| 354 |
<div class="refsect3"> |
| 355 |
<a name="udisks-module-new-manager.returns"></a><h4>Returns</h4> |
| 356 |
<p>A new <span class="type">GDBusInterfaceSkeleton</span>. Free with <code class="function">g_object_unref()</code>. </p> |
| 357 |
<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>]</span></p> |
| 358 |
</div> |
| 359 |
<p class="since">Since: 2.9.0</p> |
| 360 |
</div> |
| 361 |
<hr> |
| 362 |
<div class="refsect2"> |
| 363 |
<a name="udisks-module-new-object"></a><h3>udisks_module_new_object ()</h3> |
| 364 |
<pre class="programlisting"><span class="returnvalue">GDBusObjectSkeleton</span> ** |
| 365 |
udisks_module_new_object (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>, |
| 366 |
<em class="parameter"><code><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device</code></em>);</pre> |
| 367 |
<p>Creates one or more <span class="type">GDBusObjectSkeleton</span> objects that implement the <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> |
| 368 |
interface. Multiple objects may be returned by this method call, e.g. in case |
| 369 |
more than one object type is needed in order to represent a particular feature.</p> |
| 370 |
<p>Objects are exported by <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> on the master object manager under |
| 371 |
the <code class="filename">/org/freedesktop/UDisks2</code> path just like regular block |
| 372 |
and drive objects. This allows to create brand new object types fully handled |
| 373 |
by modules and providing custom interfaces. Objects in this scope are meant to be |
| 374 |
of virtual kind and are pretty flexible in this regard - not necessarily bound |
| 375 |
to any specific block device or drive. Perhaps even representing a group of resources. |
| 376 |
For illustration this kind of object may represent a RAID array comprised of several |
| 377 |
block devices, devices of the same kind such as loop devices or any higher level |
| 378 |
representation of something else.</p> |
| 379 |
<p>Note that it's not currently possible to share module objects across multiple |
| 380 |
modules with the intention to attach extra interfaces on a foreign module object. |
| 381 |
In such case each module needs to export its own unique object, no matter if |
| 382 |
they share or represent similar kind of resource.</p> |
| 383 |
<p>This method may be called quite often, for nearly any uevent received. It's done |
| 384 |
this way for broad flexibility and to give module objects a chance to claim any |
| 385 |
device needed.</p> |
| 386 |
<p>Module objects are supposed to maintain internal list of claimed devices and track |
| 387 |
their validity, i.e. indicate removal only after all tracked devices are gone. |
| 388 |
Every module object may claim one or more devices. <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> essentially |
| 389 |
provides uevent routing and guarantees that existing objects are asked first to |
| 390 |
consider a claim of the <em class="parameter"><code>device</code></em> |
| 391 |
before new object is attempted to be created. |
| 392 |
This works always in the scope of a particular module, i.e. existing module objects |
| 393 |
and their claims are always considered separately for each module.</p> |
| 394 |
<p>The uevent routing works as follows:</p> |
| 395 |
<div class="orderedlist"><ol class="orderedlist" type="1"> |
| 396 |
<li class="listitem"> |
| 397 |
<p>Existing module objects are asked first to process the uevent for a particular |
| 398 |
<em class="parameter"><code>device</code></em> |
| 399 |
via the <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a> method on the |
| 400 |
<a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> interface. The method return value and the <em class="parameter"><code>keep</code></em> |
| 401 |
argument |
| 402 |
control the claim:</p> |
| 403 |
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| 404 |
<li class="listitem"><p>method return value of <code class="literal">FALSE</code> means the object doesn't currently hold |
| 405 |
the claim of the <em class="parameter"><code>device</code></em> |
| 406 |
and is not interested of making new one. The |
| 407 |
return value of <em class="parameter"><code>keep</code></em> |
| 408 |
is ignored in this case.</p></li> |
| 409 |
<li class="listitem"><p>method return value of <code class="literal">TRUE</code> and the <em class="parameter"><code>keep</code></em> |
| 410 |
return value of <code class="literal">FALSE</code> indicates |
| 411 |
the object is not valid anymore and should be unexported from the object |
| 412 |
manager.</p></li> |
| 413 |
<li class="listitem"><p>method return value of <code class="literal">TRUE</code> and the <em class="parameter"><code>keep</code></em> |
| 414 |
return value of <code class="literal">TRUE</code> indicates |
| 415 |
the object has processed the updated information and remains valid.</p></li> |
| 416 |
</ul></div> |
| 417 |
</li> |
| 418 |
<li class="listitem"><p>In case the <em class="parameter"><code>device</code></em> |
| 419 |
has not been claimed by any existing module object, meaning |
| 420 |
all the <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a> method calls from previous step |
| 421 |
returned <code class="literal">FALSE</code>, only then a new object is attempted to be created via this |
| 422 |
<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> method call. If there was a claim release in |
| 423 |
the previous step, no attempt to create new object is made to prevent creating |
| 424 |
bogus objects for recently released devices.</p></li> |
| 425 |
</ol></div> |
| 426 |
<div class="refsect3"> |
| 427 |
<a name="udisks-module-new-object.parameters"></a><h4>Parameters</h4> |
| 428 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 429 |
<colgroup> |
| 430 |
<col width="150px" class="parameters_name"> |
| 431 |
<col class="parameters_description"> |
| 432 |
<col width="200px" class="parameters_annotations"> |
| 433 |
</colgroup> |
| 434 |
<tbody> |
| 435 |
<tr> |
| 436 |
<td class="parameter_name"><p>module</p></td> |
| 437 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 438 |
<td class="parameter_annotations"> </td> |
| 439 |
</tr> |
| 440 |
<tr> |
| 441 |
<td class="parameter_name"><p>device</p></td> |
| 442 |
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> device object.</p></td> |
| 443 |
<td class="parameter_annotations"> </td> |
| 444 |
</tr> |
| 445 |
</tbody> |
| 446 |
</table></div> |
| 447 |
</div> |
| 448 |
<div class="refsect3"> |
| 449 |
<a name="udisks-module-new-object.returns"></a><h4>Returns</h4> |
| 450 |
<p>NULL-terminated array of new <span class="type">GDBusObjectSkeleton</span> objects or <code class="literal">NULL</code> when |
| 451 |
the module is not interested in the <em class="parameter"><code>device</code></em> |
| 452 |
. </p> |
| 453 |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GDBusObjectSkeleton][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<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="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 454 |
</div> |
| 455 |
<p class="since">Since: 2.9.0</p> |
| 456 |
</div> |
| 457 |
<hr> |
| 458 |
<div class="refsect2"> |
| 459 |
<a name="udisks-module-get-block-object-interface-types"></a><h3>udisks_module_get_block_object_interface_types ()</h3> |
| 460 |
<pre class="programlisting"><span class="returnvalue">GType</span> * |
| 461 |
udisks_module_get_block_object_interface_types |
| 462 |
(<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>);</pre> |
| 463 |
<p>Gets an array of interface skeleton <span class="type">GType</span> types the module provides as additional |
| 464 |
interfaces for the <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a>. This list is subsequently used by |
| 465 |
<a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> to track available interfaces and to create new ones via |
| 466 |
<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>.</p> |
| 467 |
<div class="refsect3"> |
| 468 |
<a name="udisks-module-get-block-object-interface-types.parameters"></a><h4>Parameters</h4> |
| 469 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 470 |
<colgroup> |
| 471 |
<col width="150px" class="parameters_name"> |
| 472 |
<col class="parameters_description"> |
| 473 |
<col width="200px" class="parameters_annotations"> |
| 474 |
</colgroup> |
| 475 |
<tbody><tr> |
| 476 |
<td class="parameter_name"><p>module</p></td> |
| 477 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 478 |
<td class="parameter_annotations"> </td> |
| 479 |
</tr></tbody> |
| 480 |
</table></div> |
| 481 |
</div> |
| 482 |
<div class="refsect3"> |
| 483 |
<a name="udisks-module-get-block-object-interface-types.returns"></a><h4>Returns</h4> |
| 484 |
<p>A NULL-terminated array of <span class="type">GType</span> types or <code class="literal">NULL</code> when the module doesn't |
| 485 |
handle block object interfaces. Do not free, the data belongs to the module. </p> |
| 486 |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GType][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<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="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 487 |
</div> |
| 488 |
<p class="since">Since: 2.9.0</p> |
| 489 |
</div> |
| 490 |
<hr> |
| 491 |
<div class="refsect2"> |
| 492 |
<a name="udisks-module-get-drive-object-interface-types"></a><h3>udisks_module_get_drive_object_interface_types ()</h3> |
| 493 |
<pre class="programlisting"><span class="returnvalue">GType</span> * |
| 494 |
udisks_module_get_drive_object_interface_types |
| 495 |
(<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>);</pre> |
| 496 |
<p>Gets an array of interface skeleton <span class="type">GType</span> types the module provides as additional |
| 497 |
interfaces for the <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>. This list is subsequently used by |
| 498 |
<a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> to track available interfaces and to create new ones via |
| 499 |
<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> |
| 500 |
<div class="refsect3"> |
| 501 |
<a name="udisks-module-get-drive-object-interface-types.parameters"></a><h4>Parameters</h4> |
| 502 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 503 |
<colgroup> |
| 504 |
<col width="150px" class="parameters_name"> |
| 505 |
<col class="parameters_description"> |
| 506 |
<col width="200px" class="parameters_annotations"> |
| 507 |
</colgroup> |
| 508 |
<tbody><tr> |
| 509 |
<td class="parameter_name"><p>module</p></td> |
| 510 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 511 |
<td class="parameter_annotations"> </td> |
| 512 |
</tr></tbody> |
| 513 |
</table></div> |
| 514 |
</div> |
| 515 |
<div class="refsect3"> |
| 516 |
<a name="udisks-module-get-drive-object-interface-types.returns"></a><h4>Returns</h4> |
| 517 |
<p>A NULL-terminated array of <span class="type">GType</span> types or <code class="literal">NULL</code> when the module doesn't |
| 518 |
handle drive object interfaces. Do not free, the data belongs to the module. </p> |
| 519 |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GType][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<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="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 520 |
</div> |
| 521 |
<p class="since">Since: 2.9.0</p> |
| 522 |
</div> |
| 523 |
<hr> |
| 524 |
<div class="refsect2"> |
| 525 |
<a name="udisks-module-new-block-object-interface"></a><h3>udisks_module_new_block_object_interface ()</h3> |
| 526 |
<pre class="programlisting"><span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 527 |
udisks_module_new_block_object_interface |
| 528 |
(<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>, |
| 529 |
<em class="parameter"><code><a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> *object</code></em>, |
| 530 |
<em class="parameter"><code><span class="type">GType</span> interface_type</code></em>);</pre> |
| 531 |
<p>Tries to create a new <span class="type">GDBusInterfaceSkeleton</span> instance of type <em class="parameter"><code>interface_type</code></em> |
| 532 |
|
| 533 |
that is supposed to be attached on the block <em class="parameter"><code>object</code></em> |
| 534 |
. This method call is also |
| 535 |
supposed to check whether the desired <em class="parameter"><code>interface_type</code></em> |
| 536 |
is applicable for |
| 537 |
the current <em class="parameter"><code>object</code></em> |
| 538 |
and return <code class="literal">NULL</code> if it's not. The returned instance must |
| 539 |
implement the <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> interface with the <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a> |
| 540 |
method that is used to process uevents and controls whether the interface should |
| 541 |
be removed or not.</p> |
| 542 |
<div class="note">Note that it is important not to take reference to <em class="parameter"><code>object</code></em> to avoid circular |
| 543 |
references. The returned <span class="type">GDBusInterfaceSkeleton</span> will be exported on the <em class="parameter"><code>object</code></em> |
| 544 |
and unexported when no longer valid (typically as a result of a <span class="emphasis"><em>remove</em></span> |
| 545 |
uevent). The returned object is responsible to perform cleanup in its destructor |
| 546 |
as it's not generally guaranteed the <span class="emphasis"><em>remove</em></span> uevent will be |
| 547 |
sent prior to that.</div> |
| 548 |
<div class="refsect3"> |
| 549 |
<a name="udisks-module-new-block-object-interface.parameters"></a><h4>Parameters</h4> |
| 550 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 551 |
<colgroup> |
| 552 |
<col width="150px" class="parameters_name"> |
| 553 |
<col class="parameters_description"> |
| 554 |
<col width="200px" class="parameters_annotations"> |
| 555 |
</colgroup> |
| 556 |
<tbody> |
| 557 |
<tr> |
| 558 |
<td class="parameter_name"><p>module</p></td> |
| 559 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 560 |
<td class="parameter_annotations"> </td> |
| 561 |
</tr> |
| 562 |
<tr> |
| 563 |
<td class="parameter_name"><p>object</p></td> |
| 564 |
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a>.</p></td> |
| 565 |
<td class="parameter_annotations"> </td> |
| 566 |
</tr> |
| 567 |
<tr> |
| 568 |
<td class="parameter_name"><p>interface_type</p></td> |
| 569 |
<td class="parameter_description"><p>A <span class="type">GType</span> of the desired new interface skeleton.</p></td> |
| 570 |
<td class="parameter_annotations"> </td> |
| 571 |
</tr> |
| 572 |
</tbody> |
| 573 |
</table></div> |
| 574 |
</div> |
| 575 |
<div class="refsect3"> |
| 576 |
<a name="udisks-module-new-block-object-interface.returns"></a><h4>Returns</h4> |
| 577 |
<p>A new <span class="type">GDBusInterfaceSkeleton</span> instance or |
| 578 |
<code class="literal">NULL</code> when not applicable for the <em class="parameter"><code>object</code></em> |
| 579 |
. Free with <code class="function">g_object_unref()</code>. </p> |
| 580 |
<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>]</span></p> |
| 581 |
</div> |
| 582 |
<p class="since">Since: 2.9.0</p> |
| 583 |
</div> |
| 584 |
<hr> |
| 585 |
<div class="refsect2"> |
| 586 |
<a name="udisks-module-new-drive-object-interface"></a><h3>udisks_module_new_drive_object_interface ()</h3> |
| 587 |
<pre class="programlisting"><span class="returnvalue">GDBusInterfaceSkeleton</span> * |
| 588 |
udisks_module_new_drive_object_interface |
| 589 |
(<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>, |
| 590 |
<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>, |
| 591 |
<em class="parameter"><code><span class="type">GType</span> interface_type</code></em>);</pre> |
| 592 |
<p>Tries to create a new <span class="type">GDBusInterfaceSkeleton</span> instance of type <em class="parameter"><code>interface_type</code></em> |
| 593 |
|
| 594 |
that is supposed to be attached on the drive <em class="parameter"><code>object</code></em> |
| 595 |
. This method call is also |
| 596 |
supposed to check whether the desired <em class="parameter"><code>interface_type</code></em> |
| 597 |
is applicable for |
| 598 |
the current <em class="parameter"><code>object</code></em> |
| 599 |
and return <code class="literal">NULL</code> if it's not. The returned instance must |
| 600 |
implement the <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> interface with the <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a> |
| 601 |
method that is used to process uevents and controls whether the interface should |
| 602 |
be removed or not.</p> |
| 603 |
<div class="note">Note that it is important not to take reference to <em class="parameter"><code>object</code></em> to avoid circular |
| 604 |
references. The returned <span class="type">GDBusInterfaceSkeleton</span> will be exported on the <em class="parameter"><code>object</code></em> |
| 605 |
and unexported when no longer valid (typically as a result of a <span class="emphasis"><em>remove</em></span> |
| 606 |
uevent). The returned object is responsible to perform cleanup in its destructor |
| 607 |
as it's not generally guaranteed the <span class="emphasis"><em>remove</em></span> uevent will be |
| 608 |
sent prior to that.</div> |
| 609 |
<div class="refsect3"> |
| 610 |
<a name="udisks-module-new-drive-object-interface.parameters"></a><h4>Parameters</h4> |
| 611 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 612 |
<colgroup> |
| 613 |
<col width="150px" class="parameters_name"> |
| 614 |
<col class="parameters_description"> |
| 615 |
<col width="200px" class="parameters_annotations"> |
| 616 |
</colgroup> |
| 617 |
<tbody> |
| 618 |
<tr> |
| 619 |
<td class="parameter_name"><p>module</p></td> |
| 620 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 621 |
<td class="parameter_annotations"> </td> |
| 622 |
</tr> |
| 623 |
<tr> |
| 624 |
<td class="parameter_name"><p>object</p></td> |
| 625 |
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td> |
| 626 |
<td class="parameter_annotations"> </td> |
| 627 |
</tr> |
| 628 |
<tr> |
| 629 |
<td class="parameter_name"><p>interface_type</p></td> |
| 630 |
<td class="parameter_description"><p>A <span class="type">GType</span> of the desired new interface skeleton.</p></td> |
| 631 |
<td class="parameter_annotations"> </td> |
| 632 |
</tr> |
| 633 |
</tbody> |
| 634 |
</table></div> |
| 635 |
</div> |
| 636 |
<div class="refsect3"> |
| 637 |
<a name="udisks-module-new-drive-object-interface.returns"></a><h4>Returns</h4> |
| 638 |
<p>A new <span class="type">GDBusInterfaceSkeleton</span> instance or |
| 639 |
<code class="literal">NULL</code> when not applicable for the <em class="parameter"><code>object</code></em> |
| 640 |
. Free with <code class="function">g_object_unref()</code>. </p> |
| 641 |
<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>]</span></p> |
| 642 |
</div> |
| 643 |
<p class="since">Since: 2.9.0</p> |
| 644 |
</div> |
| 645 |
<hr> |
| 646 |
<div class="refsect2"> |
| 647 |
<a name="udisks-module-track-parent"></a><h3>udisks_module_track_parent ()</h3> |
| 648 |
<pre class="programlisting"><span class="returnvalue">gchar</span> * |
| 649 |
udisks_module_track_parent (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>, |
| 650 |
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, |
| 651 |
<em class="parameter"><code><span class="type">gchar</span> **uuid</code></em>);</pre> |
| 652 |
<p>Finds a parent block device and returns its object path and UUID. |
| 653 |
If the return value is <code class="literal">NULL</code>, the value of <em class="parameter"><code>uuid</code></em> |
| 654 |
has not been changed. |
| 655 |
Related to <a class="link" href="UDisksDaemon.html#udisks-daemon-get-parent-for-tracking" title="udisks_daemon_get_parent_for_tracking ()"><code class="function">udisks_daemon_get_parent_for_tracking()</code></a>.</p> |
| 656 |
<div class="refsect3"> |
| 657 |
<a name="udisks-module-track-parent.parameters"></a><h4>Parameters</h4> |
| 658 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 659 |
<colgroup> |
| 660 |
<col width="150px" class="parameters_name"> |
| 661 |
<col class="parameters_description"> |
| 662 |
<col width="200px" class="parameters_annotations"> |
| 663 |
</colgroup> |
| 664 |
<tbody> |
| 665 |
<tr> |
| 666 |
<td class="parameter_name"><p>module</p></td> |
| 667 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 668 |
<td class="parameter_annotations"> </td> |
| 669 |
</tr> |
| 670 |
<tr> |
| 671 |
<td class="parameter_name"><p>path</p></td> |
| 672 |
<td class="parameter_description"><p>object path of a child to find parent of</p></td> |
| 673 |
<td class="parameter_annotations"> </td> |
| 674 |
</tr> |
| 675 |
<tr> |
| 676 |
<td class="parameter_name"><p>uuid</p></td> |
| 677 |
<td class="parameter_description"><p>a pointer to return parent UUID string</p></td> |
| 678 |
<td class="parameter_annotations"> </td> |
| 679 |
</tr> |
| 680 |
</tbody> |
| 681 |
</table></div> |
| 682 |
</div> |
| 683 |
<div class="refsect3"> |
| 684 |
<a name="udisks-module-track-parent.returns"></a><h4>Returns</h4> |
| 685 |
<p>object path of the parent device. Free with <code class="function">g_free()</code>. </p> |
| 686 |
<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>]</span></p> |
| 687 |
</div> |
| 688 |
<p class="since">Since: 2.9.0</p> |
| 689 |
</div> |
| 690 |
<hr> |
| 691 |
<div class="refsect2"> |
| 692 |
<a name="udisks-module-get-daemon"></a><h3>udisks_module_get_daemon ()</h3> |
| 693 |
<pre class="programlisting"><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> * |
| 694 |
udisks_module_get_daemon (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> *module</code></em>);</pre> |
| 695 |
<p>Gets the daemon used by <em class="parameter"><code>module</code></em> |
| 696 |
.</p> |
| 697 |
<div class="refsect3"> |
| 698 |
<a name="udisks-module-get-daemon.parameters"></a><h4>Parameters</h4> |
| 699 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 700 |
<colgroup> |
| 701 |
<col width="150px" class="parameters_name"> |
| 702 |
<col class="parameters_description"> |
| 703 |
<col width="200px" class="parameters_annotations"> |
| 704 |
</colgroup> |
| 705 |
<tbody><tr> |
| 706 |
<td class="parameter_name"><p>module</p></td> |
| 707 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p></td> |
| 708 |
<td class="parameter_annotations"> </td> |
| 709 |
</tr></tbody> |
| 710 |
</table></div> |
| 711 |
</div> |
| 712 |
<div class="refsect3"> |
| 713 |
<a name="udisks-module-get-daemon.returns"></a><h4>Returns</h4> |
| 714 |
<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>module</code></em> |
| 715 |
. </p> |
| 716 |
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 717 |
</div> |
| 718 |
<p class="since">Since: 2.9.0</p> |
| 719 |
</div> |
| 720 |
<hr> |
| 721 |
<div class="refsect2"> |
| 722 |
<a name="udisks-module-object-process-uevent"></a><h3>udisks_module_object_process_uevent ()</h3> |
| 723 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 724 |
udisks_module_object_process_uevent (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> *object</code></em>, |
| 725 |
<em class="parameter"><code>const <span class="type">gchar</span> *action</code></em>, |
| 726 |
<em class="parameter"><code><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device</code></em>, |
| 727 |
<em class="parameter"><code><span class="type">gboolean</span> *keep</code></em>);</pre> |
| 728 |
<p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> method that is called by <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a>, |
| 729 |
<a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> and <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> to process a uevent on exported |
| 730 |
module objects and interfaces and control their validity.</p> |
| 731 |
<p>Upon receiving a uevent the object implementing the <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> interface |
| 732 |
is responsible for processing updated information and indicate whether the <em class="parameter"><code>object</code></em> |
| 733 |
|
| 734 |
is still valid or not.</p> |
| 735 |
<p>This function may be called quite often and since uevent processing is currently |
| 736 |
serialized by <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> this method call should minimize its processing |
| 737 |
time as much as possible.</p> |
| 738 |
<p>See related <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>, <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> |
| 739 |
and <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> methods for information how uevent |
| 740 |
routing is done and what effect the return values have.</p> |
| 741 |
<p>Set <em class="parameter"><code>keep</code></em> |
| 742 |
to <code class="literal">FALSE</code> if the object or interface should be unexported and removed, |
| 743 |
<code class="literal">TRUE</code> if the object or interface should be kept around. The return value of <em class="parameter"><code>keep</code></em> |
| 744 |
|
| 745 |
is ignored when the return value from this method is <code class="literal">FALSE</code>. These return values |
| 746 |
should align with the uevent <em class="parameter"><code>action</code></em> |
| 747 |
, i.e. a <em class="parameter"><code>keep</code></em> |
| 748 |
return value of <code class="literal">FALSE</code> is |
| 749 |
expected for a <code class="literal">remove</code> <em class="parameter"><code>action</code></em> |
| 750 |
. Note that the <code class="literal">remove</code> |
| 751 |
uevent is not always sent to block objects and the daemon may opt for direct |
| 752 |
object destruction (for which the <em class="parameter"><code>object</code></em> |
| 753 |
should be prepared to perform proper |
| 754 |
cleanup within its destructor).</p> |
| 755 |
<div class="refsect3"> |
| 756 |
<a name="udisks-module-object-process-uevent.parameters"></a><h4>Parameters</h4> |
| 757 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 758 |
<colgroup> |
| 759 |
<col width="150px" class="parameters_name"> |
| 760 |
<col class="parameters_description"> |
| 761 |
<col width="200px" class="parameters_annotations"> |
| 762 |
</colgroup> |
| 763 |
<tbody> |
| 764 |
<tr> |
| 765 |
<td class="parameter_name"><p>object</p></td> |
| 766 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a>.</p></td> |
| 767 |
<td class="parameter_annotations"> </td> |
| 768 |
</tr> |
| 769 |
<tr> |
| 770 |
<td class="parameter_name"><p>action</p></td> |
| 771 |
<td class="parameter_description"><p>uevent action, common values are <code class="literal">add</code>, <code class="literal">change</code> and <code class="literal">remove</code> or <code class="literal">NULL</code></p></td> |
| 772 |
<td class="parameter_annotations"> </td> |
| 773 |
</tr> |
| 774 |
<tr> |
| 775 |
<td class="parameter_name"><p>device</p></td> |
| 776 |
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> device object or <code class="literal">NULL</code> if the device hasn't changed.</p></td> |
| 777 |
<td class="parameter_annotations"> </td> |
| 778 |
</tr> |
| 779 |
<tr> |
| 780 |
<td class="parameter_name"><p>keep</p></td> |
| 781 |
<td class="parameter_description"><p>A return value whether to keep the object around or not.</p></td> |
| 782 |
<td class="parameter_annotations"> </td> |
| 783 |
</tr> |
| 784 |
</tbody> |
| 785 |
</table></div> |
| 786 |
</div> |
| 787 |
<div class="refsect3"> |
| 788 |
<a name="udisks-module-object-process-uevent.returns"></a><h4>Returns</h4> |
| 789 |
<p> <code class="literal">TRUE</code> in case the uevent was processed, <code class="literal">FALSE</code> when the <em class="parameter"><code>device</code></em> |
| 790 |
is |
| 791 |
not applicable for the object or interface.</p> |
| 792 |
</div> |
| 793 |
<p class="since">Since: 2.0</p> |
| 794 |
</div> |
| 795 |
<hr> |
| 796 |
<div class="refsect2"> |
| 797 |
<a name="udisks-module-object-housekeeping"></a><h3>udisks_module_object_housekeeping ()</h3> |
| 798 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 799 |
udisks_module_object_housekeeping (<em class="parameter"><code><a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> *object</code></em>, |
| 800 |
<em class="parameter"><code><span class="type">guint</span> secs_since_last</code></em>, |
| 801 |
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, |
| 802 |
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| 803 |
<p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> method that is called periodically (every ten minutes or so) |
| 804 |
by <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> to perform module housekeeping tasks such as refreshing |
| 805 |
<code class="literal">ATA SMART</code> data.</p> |
| 806 |
<p>The method runs in a dedicated thread and is allowed to perform |
| 807 |
blocking I/O.</p> |
| 808 |
<p>Long-running tasks should periodically check <em class="parameter"><code>cancellable</code></em> |
| 809 |
to see if |
| 810 |
they have been cancelled.</p> |
| 811 |
<div class="refsect3"> |
| 812 |
<a name="udisks-module-object-housekeeping.parameters"></a><h4>Parameters</h4> |
| 813 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 814 |
<colgroup> |
| 815 |
<col width="150px" class="parameters_name"> |
| 816 |
<col class="parameters_description"> |
| 817 |
<col width="200px" class="parameters_annotations"> |
| 818 |
</colgroup> |
| 819 |
<tbody> |
| 820 |
<tr> |
| 821 |
<td class="parameter_name"><p>object</p></td> |
| 822 |
<td class="parameter_description"><p>A <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a>.</p></td> |
| 823 |
<td class="parameter_annotations"> </td> |
| 824 |
</tr> |
| 825 |
<tr> |
| 826 |
<td class="parameter_name"><p>secs_since_last</p></td> |
| 827 |
<td class="parameter_description"><p>Number of seconds since the last housekeeping or 0 if the first housekeeping ever.</p></td> |
| 828 |
<td class="parameter_annotations"> </td> |
| 829 |
</tr> |
| 830 |
<tr> |
| 831 |
<td class="parameter_name"><p>cancellable</p></td> |
| 832 |
<td class="parameter_description"><p>A <code class="literal">GCancellable</code> or <code class="literal">NULL</code>.</p></td> |
| 833 |
<td class="parameter_annotations"> </td> |
| 834 |
</tr> |
| 835 |
<tr> |
| 836 |
<td class="parameter_name"><p>error</p></td> |
| 837 |
<td class="parameter_description"><p>Return location for error or <code class="literal">NULL</code>.</p></td> |
| 838 |
<td class="parameter_annotations"> </td> |
| 839 |
</tr> |
| 840 |
</tbody> |
| 841 |
</table></div> |
| 842 |
</div> |
| 843 |
<div class="refsect3"> |
| 844 |
<a name="udisks-module-object-housekeeping.returns"></a><h4>Returns</h4> |
| 845 |
<p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em> |
| 846 |
is set.</p> |
| 847 |
</div> |
| 848 |
<p class="since">Since: 2.0</p> |
| 849 |
</div> |
| 850 |
</div> |
| 851 |
<div class="refsect1"> |
| 852 |
<a name="udisks2-UDisksModule.other_details"></a><h2>Types and Values</h2> |
| 853 |
<div class="refsect2"> |
| 854 |
<a name="UDisksModule"></a><h3>struct UDisksModule</h3> |
| 855 |
<pre class="programlisting">struct UDisksModule { |
| 856 |
}; |
| 857 |
</pre> |
| 858 |
<p>The <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a> structure contains only private data and |
| 859 |
should only be accessed using the provided API.</p> |
| 860 |
</div> |
| 861 |
<hr> |
| 862 |
<div class="refsect2"> |
| 863 |
<a name="UDisksModuleClass"></a><h3>struct UDisksModuleClass</h3> |
| 864 |
<pre class="programlisting">struct UDisksModuleClass { |
| 865 |
GObjectClass parent_class; |
| 866 |
|
| 867 |
GDBusInterfaceSkeleton * (*new_manager) (UDisksModule *module); |
| 868 |
GDBusObjectSkeleton ** (*new_object) (UDisksModule *module, |
| 869 |
UDisksLinuxDevice *device); |
| 870 |
gchar * (*track_parent) (UDisksModule *module, |
| 871 |
const gchar *path, |
| 872 |
gchar **uuid); |
| 873 |
GType * (*get_block_object_interface_types) (UDisksModule *module); |
| 874 |
GType * (*get_drive_object_interface_types) (UDisksModule *module); |
| 875 |
GDBusInterfaceSkeleton * (*new_block_object_interface) (UDisksModule *module, |
| 876 |
UDisksLinuxBlockObject *object, |
| 877 |
GType interface_type); |
| 878 |
GDBusInterfaceSkeleton * (*new_drive_object_interface) (UDisksModule *module, |
| 879 |
UDisksLinuxDriveObject *object, |
| 880 |
GType interface_type); |
| 881 |
void (*handle_uevent) (UDisksModule *module, |
| 882 |
UDisksLinuxDevice *device); |
| 883 |
}; |
| 884 |
</pre> |
| 885 |
<p>Class structure for <a class="link" href="udisks2-UDisksModule.html#UDisksModule" title="struct UDisksModule"><span class="type">UDisksModule</span></a>.</p> |
| 886 |
<div class="refsect3"> |
| 887 |
<a name="UDisksModuleClass.members"></a><h4>Members</h4> |
| 888 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 889 |
<colgroup> |
| 890 |
<col width="300px" class="struct_members_name"> |
| 891 |
<col class="struct_members_description"> |
| 892 |
<col width="200px" class="struct_members_annotations"> |
| 893 |
</colgroup> |
| 894 |
<tbody> |
| 895 |
<tr> |
| 896 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.new-manager"></a>new_manager</code></em> ()</p></td> |
| 897 |
<td class="struct_member_description"><p>Virtual function for <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>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 898 |
<td class="struct_member_annotations"> </td> |
| 899 |
</tr> |
| 900 |
<tr> |
| 901 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.new-object"></a>new_object</code></em> ()</p></td> |
| 902 |
<td class="struct_member_description"><p>Virtual function for <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>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 903 |
<td class="struct_member_annotations"> </td> |
| 904 |
</tr> |
| 905 |
<tr> |
| 906 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.track-parent"></a>track_parent</code></em> ()</p></td> |
| 907 |
<td class="struct_member_description"><p>Virtual function for <a class="link" href="udisks2-UDisksModule.html#udisks-module-track-parent" title="udisks_module_track_parent ()"><code class="function">udisks_module_track_parent()</code></a>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 908 |
<td class="struct_member_annotations"> </td> |
| 909 |
</tr> |
| 910 |
<tr> |
| 911 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.get-block-object-interface-types"></a>get_block_object_interface_types</code></em> ()</p></td> |
| 912 |
<td class="struct_member_description"><p>Virtual function for <a class="link" href="udisks2-UDisksModule.html#udisks-module-get-block-object-interface-types" title="udisks_module_get_block_object_interface_types ()"><code class="function">udisks_module_get_block_object_interface_types()</code></a>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 913 |
<td class="struct_member_annotations"> </td> |
| 914 |
</tr> |
| 915 |
<tr> |
| 916 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.get-drive-object-interface-types"></a>get_drive_object_interface_types</code></em> ()</p></td> |
| 917 |
<td class="struct_member_description"><p>Virtual function for <a class="link" href="udisks2-UDisksModule.html#udisks-module-get-drive-object-interface-types" title="udisks_module_get_drive_object_interface_types ()"><code class="function">udisks_module_get_drive_object_interface_types()</code></a>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 918 |
<td class="struct_member_annotations"> </td> |
| 919 |
</tr> |
| 920 |
<tr> |
| 921 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.new-block-object-interface"></a>new_block_object_interface</code></em> ()</p></td> |
| 922 |
<td class="struct_member_description"><p>Virtual function for <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>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 923 |
<td class="struct_member_annotations"> </td> |
| 924 |
</tr> |
| 925 |
<tr> |
| 926 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.new-drive-object-interface"></a>new_drive_object_interface</code></em> ()</p></td> |
| 927 |
<td class="struct_member_description"><p>Virtual function for <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>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 928 |
<td class="struct_member_annotations"> </td> |
| 929 |
</tr> |
| 930 |
<tr> |
| 931 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleClass.handle-uevent"></a>handle_uevent</code></em> ()</p></td> |
| 932 |
<td class="struct_member_description"><p>Virtual function for <code class="function">udisks_module_handle_uevent()</code>. The default implementation returns <code class="literal">NULL</code>.</p></td> |
| 933 |
<td class="struct_member_annotations"> </td> |
| 934 |
</tr> |
| 935 |
</tbody> |
| 936 |
</table></div> |
| 937 |
</div> |
| 938 |
</div> |
| 939 |
<hr> |
| 940 |
<div class="refsect2"> |
| 941 |
<a name="UDisksModuleObject"></a><h3>UDisksModuleObject</h3> |
| 942 |
<pre class="programlisting">typedef struct _UDisksModuleObject UDisksModuleObject;</pre> |
| 943 |
<p>The <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a> structure contains only private data and |
| 944 |
should only be accessed using the provided API.</p> |
| 945 |
</div> |
| 946 |
<hr> |
| 947 |
<div class="refsect2"> |
| 948 |
<a name="UDisksModuleObjectIface"></a><h3>struct UDisksModuleObjectIface</h3> |
| 949 |
<pre class="programlisting">struct UDisksModuleObjectIface { |
| 950 |
GTypeInterface parent_iface; |
| 951 |
|
| 952 |
gboolean (*process_uevent) (UDisksModuleObject *object, |
| 953 |
const gchar *action, |
| 954 |
UDisksLinuxDevice *device, |
| 955 |
gboolean *keep); |
| 956 |
|
| 957 |
gboolean (*housekeeping) (UDisksModuleObject *object, |
| 958 |
guint secs_since_last, |
| 959 |
GCancellable *cancellable, |
| 960 |
GError **error); |
| 961 |
}; |
| 962 |
</pre> |
| 963 |
<p>Object interface structure for <a class="link" href="udisks2-UDisksModule.html#UDisksModuleObject" title="UDisksModuleObject"><span class="type">UDisksModuleObject</span></a>.</p> |
| 964 |
<div class="refsect3"> |
| 965 |
<a name="UDisksModuleObjectIface.members"></a><h4>Members</h4> |
| 966 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 967 |
<colgroup> |
| 968 |
<col width="300px" class="struct_members_name"> |
| 969 |
<col class="struct_members_description"> |
| 970 |
<col width="200px" class="struct_members_annotations"> |
| 971 |
</colgroup> |
| 972 |
<tbody> |
| 973 |
<tr> |
| 974 |
<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="UDisksModuleObjectIface.parent-iface"></a>parent_iface</code></em>;</p></td> |
| 975 |
<td class="struct_member_description"><p>The parent interface.</p></td> |
| 976 |
<td class="struct_member_annotations"> </td> |
| 977 |
</tr> |
| 978 |
<tr> |
| 979 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleObjectIface.process-uevent"></a>process_uevent</code></em> ()</p></td> |
| 980 |
<td class="struct_member_description"><p>Virtual function for <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-process-uevent" title="udisks_module_object_process_uevent ()"><code class="function">udisks_module_object_process_uevent()</code></a>.</p></td> |
| 981 |
<td class="struct_member_annotations"> </td> |
| 982 |
</tr> |
| 983 |
<tr> |
| 984 |
<td class="struct_member_name"><p><em class="structfield"><code><a name="UDisksModuleObjectIface.housekeeping"></a>housekeeping</code></em> ()</p></td> |
| 985 |
<td class="struct_member_description"><p>Virtual function for <a class="link" href="udisks2-UDisksModule.html#udisks-module-object-housekeeping" title="udisks_module_object_housekeeping ()"><code class="function">udisks_module_object_housekeeping()</code></a>.</p></td> |
| 986 |
<td class="struct_member_annotations"> </td> |
| 987 |
</tr> |
| 988 |
</tbody> |
| 989 |
</table></div> |
| 990 |
</div> |
| 991 |
</div> |
| 992 |
</div> |
| 993 |
</div> |
| 994 |
<div class="footer"> |
| 995 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 996 |
</body> |
| 997 |
</html> |