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
401
402
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OobsSession</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="ch01.html" title="Session management">
<link rel="prev" href="ch01.html" title="Session management">
<link rel="next" href="ch02.html" title="Liboobs data management">
<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="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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="ch02.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="#OobsSession.synopsis" class="shortcut">Top</a>
|
<a href="#OobsSession.description" class="shortcut">Description</a>
|
<a href="#OobsSession.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#OobsSession.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="OobsSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsSession.top_of_page"></a>OobsSession</span></h2>
<p>OobsSession — Manager of the connection to the backends.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="OobsSession.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
enum <a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a>;
<a class="link" href="OobsSession.html#OobsPlatform" title="OobsPlatform">OobsPlatform</a>;
<a class="link" href="OobsSession.html#OobsSession-struct" title="OobsSession">OobsSession</a>;
<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a>* <a class="link" href="OobsSession.html#oobs-session-get" title="oobs_session_get ()">oobs_session_get</a> (void);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsSession.html#oobs-session-commit" title="oobs_session_commit ()">oobs_session_commit</a> (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsSession.html#oobs-session-get-supported-platforms" title="oobs_session_get_supported_platforms ()">oobs_session_get_supported_platforms</a>
(<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
GList **platforms);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsSession.html#oobs-session-get-platform" title="oobs_session_get_platform ()">oobs_session_get_platform</a> (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
gchar **platform);
<a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> <a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()">oobs_session_set_platform</a> (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
const gchar *platform);
gboolean <a class="link" href="OobsSession.html#oobs-session-get-connected" title="oobs_session_get_connected ()">oobs_session_get_connected</a> (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);
void <a class="link" href="OobsSession.html#oobs-session-process-requests" title="oobs_session_process_requests ()">oobs_session_process_requests</a> (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----OobsSession
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="OobsSession.html#OobsSession--platform" title='The "platform" property'>platform</a>" gchar* : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.description"></a><h2>Description</h2>
<p>
OobsSession is a singleton object, defines and abstracts the connection to system-tools-backends.
</p>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="OobsResult"></a><h3>enum OobsResult</h3>
<pre class="programlisting">typedef enum {
OOBS_RESULT_OK,
OOBS_RESULT_ACCESS_DENIED,
OOBS_RESULT_NO_PLATFORM,
OOBS_RESULT_MALFORMED_DATA,
OOBS_RESULT_ERROR
} OobsResult;
</pre>
<p>
Defines the result of an operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="OOBS-RESULT-OK:CAPS"></a><span class="term"><code class="literal">OOBS_RESULT_OK</code></span></p></td>
<td>Success.
</td>
</tr>
<tr>
<td><p><a name="OOBS-RESULT-ACCESS-DENIED:CAPS"></a><span class="term"><code class="literal">OOBS_RESULT_ACCESS_DENIED</code></span></p></td>
<td>Access to the backends denied, either by policies of for being unable to get enough privileges
</td>
</tr>
<tr>
<td><p><a name="OOBS-RESULT-NO-PLATFORM:CAPS"></a><span class="term"><code class="literal">OOBS_RESULT_NO_PLATFORM</code></span></p></td>
<td>No detected platform, see <a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()"><code class="function">oobs_session_set_platform()</code></a>.
</td>
</tr>
<tr>
<td><p><a name="OOBS-RESULT-MALFORMED-DATA:CAPS"></a><span class="term"><code class="literal">OOBS_RESULT_MALFORMED_DATA</code></span></p></td>
<td>Tried to send some kind of malformed data to the backends
</td>
</tr>
<tr>
<td><p><a name="OOBS-RESULT-ERROR:CAPS"></a><span class="term"><code class="literal">OOBS_RESULT_ERROR</code></span></p></td>
<td>Unmanaged error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsPlatform"></a><h3>OobsPlatform</h3>
<pre class="programlisting">typedef struct {
const gchar *id;
const gchar *name;
const gchar *version;
const gchar *codename;
} OobsPlatform;
</pre>
<p>
Represents a platform where system-tools-backends may run.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">const gchar *<em class="structfield"><code>id</code></em>;</span></p></td>
<td>Unique string representing the platform, see <a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()"><code class="function">oobs_session_set_platform()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term">const gchar *<em class="structfield"><code>name</code></em>;</span></p></td>
<td>Name of the platform.
</td>
</tr>
<tr>
<td><p><span class="term">const gchar *<em class="structfield"><code>version</code></em>;</span></p></td>
<td>Platform version (or <code class="literal">NULL</code>).
</td>
</tr>
<tr>
<td><p><span class="term">const gchar *<em class="structfield"><code>codename</code></em>;</span></p></td>
<td>Codename for the platform and version (or <code class="literal">NULL</code>).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsSession-struct"></a><h3>OobsSession</h3>
<pre class="programlisting">typedef struct _OobsSession OobsSession;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-get"></a><h3>oobs_session_get ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a>* oobs_session_get (void);</pre>
<p>
Returns the <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> singleton, which represents
the session with the system tools backends.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the singleton <span class="type">OobSession</span> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-commit"></a><h3>oobs_session_commit ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_session_commit (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);</pre>
<p>
Commits inmediately all the changes to the configuration
objects that have been requested through this <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.
Note that it will stop if it finds any error.</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>session</code></em> :</span></p></td>
<td> an <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</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> representing the error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-get-supported-platforms"></a><h3>oobs_session_get_supported_platforms ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_session_get_supported_platforms
(<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
GList **platforms);</pre>
<p>
Retrieves the list of supported platforms, this is only necessary when
+ <a class="link" href="OobsSession.html#oobs-session-get-platform" title="oobs_session_get_platform ()"><code class="function">oobs_session_get_platform()</code></a> has returned <a class="link" href="OobsSession.html#OOBS-RESULT-NO-PLATFORM:CAPS"><span class="type">OOBS_RESULT_NO_PLATFORM</span></a>. To
specify a platform, you must use <a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()"><code class="function">oobs_session_set_platform()</code></a>, being
the platform string in that function the platform->id value inside
the <a class="link" href="OobsSession.html#OobsPlatform" title="OobsPlatform"><span class="type">OobsPlatform</span></a> struct.</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>session</code></em> :</span></p></td>
<td> An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>platforms</code></em> :</span></p></td>
<td> return location for the list of platforms. It's a
<span class="type">GList</span> of <a class="link" href="OobsSession.html#OobsPlatform" title="OobsPlatform"><span class="type">OobsPlatform</span></a> structs. You must free
this list with <code class="function">g_list_free()</code>.
</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> representing the error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-get-platform"></a><h3>oobs_session_get_platform ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_session_get_platform (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
gchar **platform);</pre>
<p>
Retrieves the platform your system has been identified with, or
<span class="type">NULL</span> in case your platform is not recognized or other error happens.</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>session</code></em> :</span></p></td>
<td> An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>platform</code></em> :</span></p></td>
<td> location to store the current platform, or <span class="type">NULL</span>. This
string is of internal use, and must not be freed or modified.
</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> representing the error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-set-platform"></a><h3>oobs_session_set_platform ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html#OobsResult" title="enum OobsResult">OobsResult</a> oobs_session_set_platform (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session,
const gchar *platform);</pre>
<p>
Identifies your platform as the one set in <em class="parameter"><code>platform</code></em>. This is only necessary if
your platform could not be guessed (and thus <a class="link" href="OobsSession.html#oobs-session-get-platform" title="oobs_session_get_platform ()"><code class="function">oobs_session_get_platform()</code></a> would
return <a class="link" href="OobsSession.html#OOBS-RESULT-NO-PLATFORM:CAPS"><span class="type">OOBS_RESULT_NO_PLATFORM</span></a> in this case).</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>session</code></em> :</span></p></td>
<td> An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>platform</code></em> :</span></p></td>
<td> A string defining the platform. see
<code class="function">oobs_session_get_platforms_list()</code> to know where to get this string.
</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> representing the error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-get-connected"></a><h3>oobs_session_get_connected ()</h3>
<pre class="programlisting">gboolean oobs_session_get_connected (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);</pre>
<p>
Returns whether the connection with the backends is established.</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>session</code></em> :</span></p></td>
<td> An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <span class="type">TRUE</span> if there's connection with the backends.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-session-process-requests"></a><h3>oobs_session_process_requests ()</h3>
<pre class="programlisting">void oobs_session_process_requests (<a class="link" href="OobsSession.html" title="OobsSession">OobsSession</a> *session);</pre>
<p>
Blocks until all pending asynchronous requests 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>session</code></em> :</span></p></td>
<td> An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="OobsSession--platform"></a><h3>The <code class="literal">"platform"</code> property</h3>
<pre class="programlisting"> "platform" gchar* : Read / Write</pre>
<p>Name of the platform the session is running on.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsSession.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
