Debian Codegraph @

doc/html/UDisksLinuxProvider.html

raw
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>UDisksLinuxProvider: 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-linux-types.html" title="Linux-specific types">
9 <link rel="prev" href="udisks2-UDisksLinuxManagerNVMe.html" title="UDisksLinuxManagerNVMe">
10 <link rel="next" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice">
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="#UDisksLinuxProvider.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#UDisksLinuxProvider.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
20 <a href="#UDisksLinuxProvider.signals" class="shortcut">Signals</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="ref-daemon-linux-types.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="udisks2-UDisksLinuxManagerNVMe.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="UDisksLinuxDevice.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="UDisksLinuxProvider"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="UDisksLinuxProvider.top_of_page"></a>UDisksLinuxProvider</span></h2>
32 <p>UDisksLinuxProvider — Provides Linux-specific objects</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="UDisksLinuxProvider.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_proto_type">
41 <col class="functions_proto_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="returnvalue">UDisksLinuxProvider</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="UDisksLinuxProvider.html#udisks-linux-provider-new" title="udisks_linux_provider_new ()">udisks_linux_provider_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <a href="https://gnome.pages.gitlab.gnome.org/libgudev/libgudev/GUdevClient.html#GUdevClient-struct"><span class="returnvalue">GUdevClient</span></a> *
55 </td>
56 <td class="function_name">
57 <a class="link" href="UDisksLinuxProvider.html#udisks-linux-provider-get-udev-client" title="udisks_linux_provider_get_udev_client ()">udisks_linux_provider_get_udev_client</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">gboolean</span>
63 </td>
64 <td class="function_name">
65 <a class="link" href="UDisksLinuxProvider.html#udisks-linux-provider-get-coldplug" title="udisks_linux_provider_get_coldplug ()">udisks_linux_provider_get_coldplug</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 </tbody>
69 </table></div>
70 </div>
71 <div class="refsect1">
72 <a name="UDisksLinuxProvider.signals"></a><h2>Signals</h2>
73 <div class="informaltable"><table class="informaltable" border="0">
74 <colgroup>
75 <col width="150px" class="signal_proto_type">
76 <col width="300px" class="signal_proto_name">
77 <col width="200px" class="signal_proto_flags">
78 </colgroup>
79 <tbody><tr>
80 <td class="signal_type"><span class="returnvalue">void</span></td>
81 <td class="signal_name"><a class="link" href="UDisksLinuxProvider.html#UDisksLinuxProvider-uevent-probed" title="The “uevent-probed” signal">uevent-probed</a></td>
82 <td class="signal_flags">Run Last</td>
83 </tr></tbody>
84 </table></div>
85 </div>
86 <div class="refsect1">
87 <a name="UDisksLinuxProvider.other"></a><h2>Types and Values</h2>
88 <div class="informaltable"><table class="informaltable" width="100%" border="0">
89 <colgroup>
90 <col width="150px" class="other_proto_type">
91 <col class="other_proto_name">
92 </colgroup>
93 <tbody><tr>
94 <td class="datatype_keyword"> </td>
95 <td class="function_name"><a class="link" href="UDisksLinuxProvider.html#UDisksLinuxProvider-struct" title="UDisksLinuxProvider">UDisksLinuxProvider</a></td>
96 </tr></tbody>
97 </table></div>
98 </div>
99 <div class="refsect1">
100 <a name="UDisksLinuxProvider.object-hierarchy"></a><h2>Object Hierarchy</h2>
101 <pre class="screen"> GObject
102 <span class="lineart">╰──</span> <a class="link" href="UDisksProvider.html" title="UDisksProvider">UDisksProvider</a>
103 <span class="lineart">╰──</span> UDisksLinuxProvider
104 </pre>
105 </div>
106 <div class="refsect1">
107 <a name="UDisksLinuxProvider.description"></a><h2>Description</h2>
108 <p>This object is used to add/remove Linux specific objects of type
109 <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a>, <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> and <a class="link" href="UDisksLinuxMDRaidObject.html" title="UDisksLinuxMDRaidObject"><span class="type">UDisksLinuxMDRaidObject</span></a>.</p>
110 </div>
111 <div class="refsect1">
112 <a name="UDisksLinuxProvider.functions_details"></a><h2>Functions</h2>
113 <div class="refsect2">
114 <a name="udisks-linux-provider-new"></a><h3>udisks_linux_provider_new ()</h3>
115 <pre class="programlisting"><a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="returnvalue">UDisksLinuxProvider</span></a> *
116 udisks_linux_provider_new (<em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>);</pre>
117 <p>Create a new provider object for Linux-specific objects / functionality.</p>
118 <div class="refsect3">
119 <a name="udisks-linux-provider-new.parameters"></a><h4>Parameters</h4>
120 <div class="informaltable"><table class="informaltable" width="100%" border="0">
121 <colgroup>
122 <col width="150px" class="parameters_name">
123 <col class="parameters_description">
124 <col width="200px" class="parameters_annotations">
125 </colgroup>
126 <tbody><tr>
127 <td class="parameter_name"><p>daemon</p></td>
128 <td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>.</p></td>
129 <td class="parameter_annotations"> </td>
130 </tr></tbody>
131 </table></div>
132 </div>
133 <div class="refsect3">
134 <a name="udisks-linux-provider-new.returns"></a><h4>Returns</h4>
135 <p> A <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> object. Free with <code class="function">g_object_unref()</code>.</p>
136 </div>
137 </div>
138 <hr>
139 <div class="refsect2">
140 <a name="udisks-linux-provider-get-udev-client"></a><h3>udisks_linux_provider_get_udev_client ()</h3>
141 <pre class="programlisting"><a href="https://gnome.pages.gitlab.gnome.org/libgudev/libgudev/GUdevClient.html#GUdevClient-struct"><span class="returnvalue">GUdevClient</span></a> *
142 udisks_linux_provider_get_udev_client (<em class="parameter"><code><a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> *provider</code></em>);</pre>
143 <p>Gets the <a href="https://gnome.pages.gitlab.gnome.org/libgudev/libgudev/GUdevClient.html#GUdevClient-struct"><span class="type">GUdevClient</span></a> used by <em class="parameter"><code>provider</code></em>
144 .</p>
145 <div class="refsect3">
146 <a name="udisks-linux-provider-get-udev-client.parameters"></a><h4>Parameters</h4>
147 <div class="informaltable"><table class="informaltable" width="100%" border="0">
148 <colgroup>
149 <col width="150px" class="parameters_name">
150 <col class="parameters_description">
151 <col width="200px" class="parameters_annotations">
152 </colgroup>
153 <tbody><tr>
154 <td class="parameter_name"><p>provider</p></td>
155 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a>.</p></td>
156 <td class="parameter_annotations"> </td>
157 </tr></tbody>
158 </table></div>
159 </div>
160 <div class="refsect3">
161 <a name="udisks-linux-provider-get-udev-client.returns"></a><h4>Returns</h4>
162 <p> A <a href="https://gnome.pages.gitlab.gnome.org/libgudev/libgudev/GUdevClient.html#GUdevClient-struct"><span class="type">GUdevClient</span></a> owned by <em class="parameter"><code>provider</code></em>
163 . Do not free.</p>
164 </div>
165 </div>
166 <hr>
167 <div class="refsect2">
168 <a name="udisks-linux-provider-get-coldplug"></a><h3>udisks_linux_provider_get_coldplug ()</h3>
169 <pre class="programlisting"><span class="returnvalue">gboolean</span>
170 udisks_linux_provider_get_coldplug (<em class="parameter"><code><a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> *provider</code></em>);</pre>
171 <p>Gets whether <em class="parameter"><code>provider</code></em>
172 is in the coldplug phase.</p>
173 <div class="refsect3">
174 <a name="udisks-linux-provider-get-coldplug.parameters"></a><h4>Parameters</h4>
175 <div class="informaltable"><table class="informaltable" width="100%" border="0">
176 <colgroup>
177 <col width="150px" class="parameters_name">
178 <col class="parameters_description">
179 <col width="200px" class="parameters_annotations">
180 </colgroup>
181 <tbody><tr>
182 <td class="parameter_name"><p>provider</p></td>
183 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a>.</p></td>
184 <td class="parameter_annotations"> </td>
185 </tr></tbody>
186 </table></div>
187 </div>
188 <div class="refsect3">
189 <a name="udisks-linux-provider-get-coldplug.returns"></a><h4>Returns</h4>
190 <p> <code class="literal">TRUE</code> if in the coldplug phase, <code class="literal">FALSE</code> otherwise.</p>
191 </div>
192 </div>
193 </div>
194 <div class="refsect1">
195 <a name="UDisksLinuxProvider.other_details"></a><h2>Types and Values</h2>
196 <div class="refsect2">
197 <a name="UDisksLinuxProvider-struct"></a><h3>UDisksLinuxProvider</h3>
198 <pre class="programlisting">typedef struct _UDisksLinuxProvider UDisksLinuxProvider;</pre>
199 <p>The <a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> structure contains only private data and
200 should only be accessed using the provided API.</p>
201 </div>
202 </div>
203 <div class="refsect1">
204 <a name="UDisksLinuxProvider.signal-details"></a><h2>Signal Details</h2>
205 <div class="refsect2">
206 <a name="UDisksLinuxProvider-uevent-probed"></a><h3>The <code class="literal">“uevent-probed”</code> signal</h3>
207 <pre class="programlisting"><span class="returnvalue">void</span>
208 user_function (<a class="link" href="UDisksLinuxProvider.html" title="UDisksLinuxProvider"><span class="type">UDisksLinuxProvider</span></a> *provider,
209 <span class="type">char</span> *action,
210 <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device,
211 <span class="type">gpointer</span> user_data)</pre>
212 <p>Emitted after the <em class="parameter"><code>device</code></em>
213 is probed.</p>
214 <p>This signal is emitted in the thread-default main loop of the thread that <em class="parameter"><code>provider</code></em>
215 was created in.</p>
216 <div class="refsect3">
217 <a name="UDisksLinuxProvider-uevent-probed.parameters"></a><h4>Parameters</h4>
218 <div class="informaltable"><table class="informaltable" width="100%" border="0">
219 <colgroup>
220 <col width="150px" class="parameters_name">
221 <col class="parameters_description">
222 <col width="200px" class="parameters_annotations">
223 </colgroup>
224 <tbody>
225 <tr>
226 <td class="parameter_name"><p>provider</p></td>
227 <td class="parameter_description"><p>A <a class="link" href="UDisksProvider.html" title="UDisksProvider"><span class="type">UDisksProvider</span></a>.</p></td>
228 <td class="parameter_annotations"> </td>
229 </tr>
230 <tr>
231 <td class="parameter_name"><p>action</p></td>
232 <td class="parameter_description"><p>The action for the uevent e.g. "add", "remove", "change", "move", "online" or "offline".</p></td>
233 <td class="parameter_annotations"> </td>
234 </tr>
235 <tr>
236 <td class="parameter_name"><p>device</p></td>
237 <td class="parameter_description"><p>The <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> that was probed.</p></td>
238 <td class="parameter_annotations"> </td>
239 </tr>
240 <tr>
241 <td class="parameter_name"><p>user_data</p></td>
242 <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
243 <td class="parameter_annotations"> </td>
244 </tr>
245 </tbody>
246 </table></div>
247 </div>
248 <p>Flags: Run Last</p>
249 </div>
250 </div>
251 </div>
252 <div class="footer">
253 <hr>Generated by GTK-Doc V1.35.1</div>
254 </body>
255 </html>