Debian Codegraph @

doc/html/UDisksLinuxNVMeController.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>UDisksLinuxNVMeController: 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-drives.html" title="Drives on Linux">
9 <link rel="prev" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject">
10 <link rel="next" href="udisks2-UDisksLinuxNVMeFabrics.html" title="UDisksLinuxNVMeFabrics">
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="#UDisksLinuxNVMeController.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#UDisksLinuxNVMeController.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#UDisksLinuxNVMeController.implemented-interfaces" class="shortcut">Implemented Interfaces</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-drives.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="UDisksLinuxDriveObject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="udisks2-UDisksLinuxNVMeFabrics.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="UDisksLinuxNVMeController"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="UDisksLinuxNVMeController.top_of_page"></a>UDisksLinuxNVMeController</span></h2>
32 <p>UDisksLinuxNVMeController — Linux implementation of <a class="link" href="UDisksNVMeController.html" title="UDisksNVMeController"><span class="type">UDisksNVMeController</span></a></p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="UDisksLinuxNVMeController.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="UDisksNVMeController.html" title="UDisksNVMeController"><span class="returnvalue">UDisksNVMeController</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="UDisksLinuxNVMeController.html#udisks-linux-nvme-controller-new" title="udisks_linux_nvme_controller_new ()">udisks_linux_nvme_controller_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <span class="returnvalue">gboolean</span>
55 </td>
56 <td class="function_name">
57 <a class="link" href="UDisksLinuxNVMeController.html#udisks-linux-nvme-controller-update" title="udisks_linux_nvme_controller_update ()">udisks_linux_nvme_controller_update</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="UDisksLinuxNVMeController.html#udisks-linux-nvme-controller-refresh-smart-sync" title="udisks_linux_nvme_controller_refresh_smart_sync ()">udisks_linux_nvme_controller_refresh_smart_sync</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 </tbody>
69 </table></div>
70 </div>
71 <div class="refsect1">
72 <a name="UDisksLinuxNVMeController.other"></a><h2>Types and Values</h2>
73 <div class="informaltable"><table class="informaltable" width="100%" border="0">
74 <colgroup>
75 <col width="150px" class="other_proto_type">
76 <col class="other_proto_name">
77 </colgroup>
78 <tbody><tr>
79 <td class="datatype_keyword"> </td>
80 <td class="function_name"><a class="link" href="UDisksLinuxNVMeController.html#UDisksLinuxNVMeController-struct" title="UDisksLinuxNVMeController">UDisksLinuxNVMeController</a></td>
81 </tr></tbody>
82 </table></div>
83 </div>
84 <div class="refsect1">
85 <a name="UDisksLinuxNVMeController.object-hierarchy"></a><h2>Object Hierarchy</h2>
86 <pre class="screen"> GObject
87 <span class="lineart">╰──</span> GDBusInterfaceSkeleton
88 <span class="lineart">╰──</span> <a class="link" href="UDisksNVMeController.html#UDisksNVMeControllerSkeleton">UDisksNVMeControllerSkeleton</a>
89 <span class="lineart">╰──</span> UDisksLinuxNVMeController
90 </pre>
91 </div>
92 <div class="refsect1">
93 <a name="UDisksLinuxNVMeController.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
94 <p>
95 UDisksLinuxNVMeController implements
96 GDBusInterface and <a class="link" href="UDisksNVMeController.html" title="UDisksNVMeController">UDisksNVMeController</a>.</p>
97 </div>
98 <div class="refsect1">
99 <a name="UDisksLinuxNVMeController.description"></a><h2>Description</h2>
100 <p>This type provides an implementation of the <a class="link" href="UDisksNVMeController.html" title="UDisksNVMeController"><span class="type">UDisksNVMeController</span></a>
101 interface on Linux.</p>
102 </div>
103 <div class="refsect1">
104 <a name="UDisksLinuxNVMeController.functions_details"></a><h2>Functions</h2>
105 <div class="refsect2">
106 <a name="udisks-linux-nvme-controller-new"></a><h3>udisks_linux_nvme_controller_new ()</h3>
107 <pre class="programlisting"><a class="link" href="UDisksNVMeController.html" title="UDisksNVMeController"><span class="returnvalue">UDisksNVMeController</span></a> *
108 udisks_linux_nvme_controller_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
109 <p>Creates a new <a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a> instance.</p>
110 <div class="refsect3">
111 <a name="udisks-linux-nvme-controller-new.returns"></a><h4>Returns</h4>
112 <p> A new <a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a>. Free with <code class="function">g_object_unref()</code>.</p>
113 </div>
114 </div>
115 <hr>
116 <div class="refsect2">
117 <a name="udisks-linux-nvme-controller-update"></a><h3>udisks_linux_nvme_controller_update ()</h3>
118 <pre class="programlisting"><span class="returnvalue">gboolean</span>
119 udisks_linux_nvme_controller_update (<em class="parameter"><code><a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a> *ctrl</code></em>,
120 <em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>);</pre>
121 <p>Updates the interface.</p>
122 <div class="refsect3">
123 <a name="udisks-linux-nvme-controller-update.parameters"></a><h4>Parameters</h4>
124 <div class="informaltable"><table class="informaltable" width="100%" border="0">
125 <colgroup>
126 <col width="150px" class="parameters_name">
127 <col class="parameters_description">
128 <col width="200px" class="parameters_annotations">
129 </colgroup>
130 <tbody>
131 <tr>
132 <td class="parameter_name"><p>ctrl</p></td>
133 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a>.</p></td>
134 <td class="parameter_annotations"> </td>
135 </tr>
136 <tr>
137 <td class="parameter_name"><p>object</p></td>
138 <td class="parameter_description"><p>The enclosing <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> instance.</p></td>
139 <td class="parameter_annotations"> </td>
140 </tr>
141 </tbody>
142 </table></div>
143 </div>
144 <div class="refsect3">
145 <a name="udisks-linux-nvme-controller-update.returns"></a><h4>Returns</h4>
146 <p> <code class="literal">TRUE</code> if configuration has changed, <code class="literal">FALSE</code> otherwise.</p>
147 </div>
148 </div>
149 <hr>
150 <div class="refsect2">
151 <a name="udisks-linux-nvme-controller-refresh-smart-sync"></a><h3>udisks_linux_nvme_controller_refresh_smart_sync ()</h3>
152 <pre class="programlisting"><span class="returnvalue">gboolean</span>
153 udisks_linux_nvme_controller_refresh_smart_sync
154 (<em class="parameter"><code><a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a> *ctrl</code></em>,
155 <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
156 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
157 <p>Synchronously refreshes SMART/Health Information Log on <em class="parameter"><code>ctrl</code></em>
158 .
159 Includes Sanitize Status information. The calling thread
160 is blocked until the data has been obtained.</p>
161 <p>This may only be called if <em class="parameter"><code>ctrl</code></em>
162 has been associated with a
163 <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> instance.</p>
164 <p>This method may be called from any thread.</p>
165 <div class="refsect3">
166 <a name="udisks-linux-nvme-controller-refresh-smart-sync.parameters"></a><h4>Parameters</h4>
167 <div class="informaltable"><table class="informaltable" width="100%" border="0">
168 <colgroup>
169 <col width="150px" class="parameters_name">
170 <col class="parameters_description">
171 <col width="200px" class="parameters_annotations">
172 </colgroup>
173 <tbody>
174 <tr>
175 <td class="parameter_name"><p>ctrl</p></td>
176 <td class="parameter_description"><p>The <a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a> to refresh.</p></td>
177 <td class="parameter_annotations"> </td>
178 </tr>
179 <tr>
180 <td class="parameter_name"><p>cancellable</p></td>
181 <td class="parameter_description"><p>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>.</p></td>
182 <td class="parameter_annotations"> </td>
183 </tr>
184 <tr>
185 <td class="parameter_name"><p>error</p></td>
186 <td class="parameter_description"><p>Return location for error.</p></td>
187 <td class="parameter_annotations"> </td>
188 </tr>
189 </tbody>
190 </table></div>
191 </div>
192 <div class="refsect3">
193 <a name="udisks-linux-nvme-controller-refresh-smart-sync.returns"></a><h4>Returns</h4>
194 <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em>
195 is set.</p>
196 </div>
197 </div>
198 </div>
199 <div class="refsect1">
200 <a name="UDisksLinuxNVMeController.other_details"></a><h2>Types and Values</h2>
201 <div class="refsect2">
202 <a name="UDisksLinuxNVMeController-struct"></a><h3>UDisksLinuxNVMeController</h3>
203 <pre class="programlisting">typedef struct _UDisksLinuxNVMeController UDisksLinuxNVMeController;</pre>
204 <p>The <a class="link" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController"><span class="type">UDisksLinuxNVMeController</span></a> structure contains only private data and should
205 only be accessed using the provided API.</p>
206 </div>
207 </div>
208 </div>
209 <div class="footer">
210 <hr>Generated by GTK-Doc V1.35.1</div>
211 </body>
212 </html>