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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsSession">
<refmeta>
<refentrytitle role="top_of_page" id="OobsSession.top_of_page">OobsSession</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsSession</refname>
<refpurpose>Manager of the connection to the backends.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsSession.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="OobsResult">OobsResult</link>;
<link linkend="OobsPlatform">OobsPlatform</link>;
<link linkend="OobsSession-struct">OobsSession</link>;
<link linkend="OobsSession">OobsSession</link>* <link linkend="oobs-session-get">oobs_session_get</link> (void);
<link linkend="OobsResult">OobsResult</link> <link linkend="oobs-session-commit">oobs_session_commit</link> (<link linkend="OobsSession">OobsSession</link> *session);
<link linkend="OobsResult">OobsResult</link> <link linkend="oobs-session-get-supported-platforms">oobs_session_get_supported_platforms</link>
(<link linkend="OobsSession">OobsSession</link> *session,
<link linkend="GList">GList</link> **platforms);
<link linkend="OobsResult">OobsResult</link> <link linkend="oobs-session-get-platform">oobs_session_get_platform</link> (<link linkend="OobsSession">OobsSession</link> *session,
<link linkend="gchar">gchar</link> **platform);
<link linkend="OobsResult">OobsResult</link> <link linkend="oobs-session-set-platform">oobs_session_set_platform</link> (<link linkend="OobsSession">OobsSession</link> *session,
const <link linkend="gchar">gchar</link> *platform);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-session-get-connected">oobs_session_get_connected</link> (<link linkend="OobsSession">OobsSession</link> *session);
<link linkend="void">void</link> <link linkend="oobs-session-process-requests">oobs_session_process_requests</link> (<link linkend="OobsSession">OobsSession</link> *session);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsSession.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsSession
</synopsis>
</refsect1>
<refsect1 id="OobsSession.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsSession--platform">platform</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsSession.description" role="desc">
<title role="desc.title">Description</title>
<para>
OobsSession is a singleton object, defines and abstracts the connection to system-tools-backends.
</para>
</refsect1>
<refsect1 id="OobsSession.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsResult" role="enum">
<title>enum OobsResult</title>
<indexterm zone="OobsResult"><primary>OobsResult</primary></indexterm><programlisting>typedef enum {
OOBS_RESULT_OK,
OOBS_RESULT_ACCESS_DENIED,
OOBS_RESULT_NO_PLATFORM,
OOBS_RESULT_MALFORMED_DATA,
OOBS_RESULT_ERROR
} OobsResult;
</programlisting>
<para>
Defines the result of an operation.
</para><variablelist role="enum">
<varlistentry id="OOBS-RESULT-OK:CAPS" role="constant">
<term><literal>OOBS_RESULT_OK</literal></term>
<listitem><simpara>Success.
</simpara></listitem>
</varlistentry>
<varlistentry id="OOBS-RESULT-ACCESS-DENIED:CAPS" role="constant">
<term><literal>OOBS_RESULT_ACCESS_DENIED</literal></term>
<listitem><simpara>Access to the backends denied, either by policies of for being unable to get enough privileges
</simpara></listitem>
</varlistentry>
<varlistentry id="OOBS-RESULT-NO-PLATFORM:CAPS" role="constant">
<term><literal>OOBS_RESULT_NO_PLATFORM</literal></term>
<listitem><simpara>No detected platform, see <link linkend="oobs-session-set-platform"><function>oobs_session_set_platform()</function></link>.
</simpara></listitem>
</varlistentry>
<varlistentry id="OOBS-RESULT-MALFORMED-DATA:CAPS" role="constant">
<term><literal>OOBS_RESULT_MALFORMED_DATA</literal></term>
<listitem><simpara>Tried to send some kind of malformed data to the backends
</simpara></listitem>
</varlistentry>
<varlistentry id="OOBS-RESULT-ERROR:CAPS" role="constant">
<term><literal>OOBS_RESULT_ERROR</literal></term>
<listitem><simpara>Unmanaged error.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="OobsPlatform" role="struct">
<title>OobsPlatform</title>
<indexterm zone="OobsPlatform"><primary>OobsPlatform</primary></indexterm><programlisting>typedef struct {
const gchar *id;
const gchar *name;
const gchar *version;
const gchar *codename;
} OobsPlatform;
</programlisting>
<para>
Represents a platform where system-tools-backends may run.
</para><variablelist role="struct">
<varlistentry>
<term>const <link linkend="gchar">gchar</link> *<structfield>id</structfield>;</term>
<listitem><simpara>Unique string representing the platform, see <link linkend="oobs-session-set-platform"><function>oobs_session_set_platform()</function></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>const <link linkend="gchar">gchar</link> *<structfield>name</structfield>;</term>
<listitem><simpara>Name of the platform.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>const <link linkend="gchar">gchar</link> *<structfield>version</structfield>;</term>
<listitem><simpara>Platform version (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
</simpara></listitem>
</varlistentry>
<varlistentry>
<term>const <link linkend="gchar">gchar</link> *<structfield>codename</structfield>;</term>
<listitem><simpara>Codename for the platform and version (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="OobsSession-struct" role="struct">
<title>OobsSession</title>
<indexterm zone="OobsSession-struct"><primary>OobsSession</primary></indexterm><programlisting>typedef struct _OobsSession OobsSession;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-session-get" role="function">
<title>oobs_session_get ()</title>
<indexterm zone="oobs-session-get"><primary>oobs_session_get</primary></indexterm><programlisting><link linkend="OobsSession">OobsSession</link>* oobs_session_get (void);</programlisting>
<para>
Returns the <link linkend="OobsSession"><type>OobsSession</type></link> singleton, which represents
the session with the system tools backends.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobSession"><type>OobSession</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-commit" role="function">
<title>oobs_session_commit ()</title>
<indexterm zone="oobs-session-commit"><primary>oobs_session_commit</primary></indexterm><programlisting><link linkend="OobsResult">OobsResult</link> oobs_session_commit (<link linkend="OobsSession">OobsSession</link> *session);</programlisting>
<para>
Commits inmediately all the changes to the configuration
objects that have been requested through this <link linkend="OobsSession"><type>OobsSession</type></link>.
Note that it will stop if it finds any error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> an <link linkend="OobsSession"><type>OobsSession</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsResult"><type>OobsResult</type></link> representing the error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-get-supported-platforms" role="function">
<title>oobs_session_get_supported_platforms ()</title>
<indexterm zone="oobs-session-get-supported-platforms"><primary>oobs_session_get_supported_platforms</primary></indexterm><programlisting><link linkend="OobsResult">OobsResult</link> oobs_session_get_supported_platforms
(<link linkend="OobsSession">OobsSession</link> *session,
<link linkend="GList">GList</link> **platforms);</programlisting>
<para>
Retrieves the list of supported platforms, this is only necessary when
+ <link linkend="oobs-session-get-platform"><function>oobs_session_get_platform()</function></link> has returned <link linkend="OOBS-RESULT-NO-PLATFORM:CAPS"><type>OOBS_RESULT_NO_PLATFORM</type></link>. To
specify a platform, you must use <link linkend="oobs-session-set-platform"><function>oobs_session_set_platform()</function></link>, being
the platform string in that function the platform->id value inside
the <link linkend="OobsPlatform"><type>OobsPlatform</type></link> struct.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSession"><type>OobsSession</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>platforms</parameter> :</term>
<listitem><simpara> return location for the list of platforms. It's a
<link linkend="GList"><type>GList</type></link> of <link linkend="OobsPlatform"><type>OobsPlatform</type></link> structs. You must free
this list with <link linkend="g-list-free"><function>g_list_free()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsResult"><type>OobsResult</type></link> representing the error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-get-platform" role="function">
<title>oobs_session_get_platform ()</title>
<indexterm zone="oobs-session-get-platform"><primary>oobs_session_get_platform</primary></indexterm><programlisting><link linkend="OobsResult">OobsResult</link> oobs_session_get_platform (<link linkend="OobsSession">OobsSession</link> *session,
<link linkend="gchar">gchar</link> **platform);</programlisting>
<para>
Retrieves the platform your system has been identified with, or
<link linkend="NULL:CAPS"><type>NULL</type></link> in case your platform is not recognized or other error happens.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSession"><type>OobsSession</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>platform</parameter> :</term>
<listitem><simpara> location to store the current platform, or <link linkend="NULL:CAPS"><type>NULL</type></link>. This
string is of internal use, and must not be freed or modified.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsResult"><type>OobsResult</type></link> representing the error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-set-platform" role="function">
<title>oobs_session_set_platform ()</title>
<indexterm zone="oobs-session-set-platform"><primary>oobs_session_set_platform</primary></indexterm><programlisting><link linkend="OobsResult">OobsResult</link> oobs_session_set_platform (<link linkend="OobsSession">OobsSession</link> *session,
const <link linkend="gchar">gchar</link> *platform);</programlisting>
<para>
Identifies your platform as the one set in <parameter>platform</parameter>. This is only necessary if
your platform could not be guessed (and thus <link linkend="oobs-session-get-platform"><function>oobs_session_get_platform()</function></link> would
return <link linkend="OOBS-RESULT-NO-PLATFORM:CAPS"><type>OOBS_RESULT_NO_PLATFORM</type></link> in this case).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSession"><type>OobsSession</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>platform</parameter> :</term>
<listitem><simpara> A string defining the platform. see
<link linkend="oobs-session-get-platforms-list"><function>oobs_session_get_platforms_list()</function></link> to know where to get this string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsResult"><type>OobsResult</type></link> representing the error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-get-connected" role="function">
<title>oobs_session_get_connected ()</title>
<indexterm zone="oobs-session-get-connected"><primary>oobs_session_get_connected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_session_get_connected (<link linkend="OobsSession">OobsSession</link> *session);</programlisting>
<para>
Returns whether the connection with the backends is established.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSession"><type>OobsSession</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if there's connection with the backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-session-process-requests" role="function">
<title>oobs_session_process_requests ()</title>
<indexterm zone="oobs-session-process-requests"><primary>oobs_session_process_requests</primary></indexterm><programlisting><link linkend="void">void</link> oobs_session_process_requests (<link linkend="OobsSession">OobsSession</link> *session);</programlisting>
<para>
Blocks until all pending asynchronous requests have been processed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> An <link linkend="OobsSession"><type>OobsSession</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsSession.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsSession--platform"><title>The <literal>"platform"</literal> property</title>
<indexterm zone="OobsSession--platform"><primary>OobsSession:platform</primary></indexterm><programlisting> "platform" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Name of the platform the session is running on.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1 id="OobsSession.see-also">
<title>See Also</title>
<para>
<link linkend="OobsObject"><type>OobsObject</type></link>
</para>
</refsect1>
</refentry>
|
