1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OobsObject</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Liboobs (System configuration management) Reference Manual">
<link rel="up" href="ch02.html" title="Liboobs data management">
<link rel="prev" href="ch02.html" title="Liboobs data management">
<link rel="next" href="OobsList.html" title="OobsList">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Session management">
<link rel="chapter" href="ch02.html" title="Liboobs data management">
<link rel="chapter" href="ch03.html" title="Users and groups management">
<link rel="chapter" href="ch04.html" title="Shared folders management">
<link rel="chapter" href="ch05.html" title="Date and time management">
<link rel="chapter" href="ch06.html" title="System boot management">
<link rel="chapter" href="ch07.html" title="Network interfaces management">
<link rel="chapter" href="ch08.html" title="Hosts resolution management">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
<td><a accesskey="n" href="OobsList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#OobsObject.synopsis" class="shortcut">Top</a>
|
<a href="#OobsObject.description" class="shortcut">Description</a>
|
<a href="#OobsObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#OobsObject.properties" class="shortcut">Properties</a>
|
<a href="#OobsObject.signals" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="OobsObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsObject.top_of_page"></a>OobsObject</span></h2>
<p>OobsObject — Base object for all configuration objects.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="OobsObject.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="OobsObject.html#OobsObject-struct" title="OobsObject">OobsObject</a>;
void (<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">*OobsObjectAsyncFunc</a>) (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> result,
gpointer data);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsObject.html#oobs-object-commit" title="oobs_object_commit ()">oobs_object_commit</a> (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsObject.html#oobs-object-commit-async" title="oobs_object_commit_async ()">oobs_object_commit_async</a> (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">OobsObjectAsyncFunc</a> func,
gpointer data);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsObject.html#oobs-object-update" title="oobs_object_update ()">oobs_object_update</a> (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()">oobs_object_update_async</a> (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">OobsObjectAsyncFunc</a> func,
gpointer data);
void <a class="link" href="OobsObject.html#oobs-object-process-requests" title="oobs_object_process_requests ()">oobs_object_process_requests</a> (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----OobsObject
+----<a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig">OobsGroupsConfig</a>
+----<a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig">OobsIfacesConfig</a>
+----<a class="link" href="OobsNFSConfig.html" title="OobsNFSConfig">OobsNFSConfig</a>
+----<a class="link" href="OobsNTPConfig.html" title="OobsNTPConfig">OobsNTPConfig</a>
+----<a class="link" href="OobsServicesConfig.html" title="OobsServicesConfig">OobsServicesConfig</a>
+----<a class="link" href="OobsSMBConfig.html" title="OobsSMBConfig">OobsSMBConfig</a>
+----<a class="link" href="OobsTimeConfig.html" title="OobsTimeConfig">OobsTimeConfig</a>
+----<a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig">OobsUsersConfig</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="OobsObject.html#OobsObject--remote-object" title='The "remote-object" property'>remote-object</a>" gchar* : Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="OobsObject.html#OobsObject-changed" title='The "changed" signal'>changed</a>" : Run Last
"<a class="link" href="OobsObject.html#OobsObject-committed" title='The "committed" signal'>committed</a>" : Run Last
"<a class="link" href="OobsObject.html#OobsObject-updated" title='The "updated" signal'>updated</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.description"></a><h2>Description</h2>
<p>
OobsObject is the base object for all Oobs*Config objects, contains all the necessary methods for updating/committing the configuration. Initially the returned object is empty, you will have to call <a class="link" href="OobsObject.html#oobs-object-update" title="oobs_object_update ()"><code class="function">oobs_object_update()</code></a> or <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()"><code class="function">oobs_object_update_async()</code></a> yourself.
</p>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="OobsObject-struct"></a><h3>OobsObject</h3>
<pre class="programlisting">typedef struct _OobsObject OobsObject;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsObjectAsyncFunc"></a><h3>OobsObjectAsyncFunc ()</h3>
<pre class="programlisting">void (*OobsObjectAsyncFunc) (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> result,
gpointer data);</pre>
<p>
Specifies the type of function passed to <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()"><code class="function">oobs_object_update_async()</code></a> and <a class="link" href="OobsObject.html#oobs-object-commit-async" title="oobs_object_commit_async ()"><code class="function">oobs_object_commit_async()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>
<a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> which was modified/updated.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult"><span class="type">OobsResult</span></a> defining the result of the operation.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>data passed to the function.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-object-commit"></a><h3>oobs_object_commit ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_object_commit (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);</pre>
<p>
Commits to the system all the changes done
to the configuration held by an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult"><span class="type">OobsResult</span></a> enum with the error code.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-object-commit-async"></a><h3>oobs_object_commit_async ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_object_commit_async (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">OobsObjectAsyncFunc</a> func,
gpointer data);</pre>
<p>
Commits to the system all the changes done to the configuration held by an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
This change will be asynchronous, being run the function <em class="parameter"><code>func</code></em> when the change has been done.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td> An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> Aditional data to pass to <em class="parameter"><code>func</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult"><span class="type">OobsResult</span></a> enum with the error code. Due to the asynchronous nature
of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-object-update"></a><h3>oobs_object_update ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_object_update (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);</pre>
<p>
Synchronizes the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
with the actual system configuration. All the changes done
to the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> will be forgotten.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult"><span class="type">OobsResult</span></a> enum with the error code.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-object-update-async"></a><h3>oobs_object_update_async ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_object_update_async (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object,
<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">OobsObjectAsyncFunc</a> func,
gpointer data);</pre>
<p>
Synchronizes the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
with the actual system configuration. All the changes done
to the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> will be forgotten.
The update operation will be asynchronous, being run the
function <em class="parameter"><code>func</code></em> when the update has been done.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td> An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> Aditional data to pass to <em class="parameter"><code>func</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an <a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult"><span class="type">OobsResult</span></a> enum with the error code. Due to the asynchronous nature
of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-object-process-requests"></a><h3>oobs_object_process_requests ()</h3>
<pre class="programlisting">void oobs_object_process_requests (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *object);</pre>
<p>
Blocks until all pending asynchronous requests to this object have been processed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="OobsObject--remote-object"></a><h3>The <code class="literal">"remote-object"</code> property</h3>
<pre class="programlisting"> "remote-object" gchar* : Write / Construct Only</pre>
<p>Name of the remote object at the other side of the connection.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="OobsObject-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *oobsobject,
gpointer user_data) : Run Last</pre>
<p>
The changed signal is emitted when the underlying configuration changes. This is just a notification, if you want to update it you will have to call <a class="link" href="OobsObject.html#oobs-object-update" title="oobs_object_update ()"><code class="function">oobs_object_update()</code></a> or <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()"><code class="function">oobs_object_update_async()</code></a> yourself.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsObject-committed"></a><h3>The <code class="literal">"committed"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *oobsobject,
gpointer user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsObject-updated"></a><h3>The <code class="literal">"updated"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> *oobsobject,
gpointer user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsObject.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>, <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
