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
|
<?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="OobsService">
<refmeta>
<refentrytitle role="top_of_page" id="OobsService.top_of_page">OobsService</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsService</refname>
<refpurpose>Object that represents an individual init.d service.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsService.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="OobsServiceStatus">OobsServiceStatus</link>;
<link linkend="OobsService-struct">OobsService</link>;
<link linkend="void">void</link> <link linkend="oobs-service-set-runlevel-configuration">oobs_service_set_runlevel_configuration</link>
(<link linkend="OobsService">OobsService</link> *service,
<link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link> *runlevel,
<link linkend="OobsServiceStatus">OobsServiceStatus</link> status,
<link linkend="gint">gint</link> priority);
<link linkend="void">void</link> <link linkend="oobs-service-get-runlevel-configuration">oobs_service_get_runlevel_configuration</link>
(<link linkend="OobsService">OobsService</link> *service,
<link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link> *runlevel,
<link linkend="OobsServiceStatus">OobsServiceStatus</link> *status,
<link linkend="gint">gint</link> *priority);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-service-get-name">oobs_service_get_name</link> (<link linkend="OobsService">OobsService</link> *service);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsService.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsService
</synopsis>
</refsect1>
<refsect1 id="OobsService.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsService--name">name</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="OobsService.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsService.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsServiceStatus" role="enum">
<title>enum OobsServiceStatus</title>
<indexterm zone="OobsServiceStatus"><primary>OobsServiceStatus</primary></indexterm><programlisting>typedef enum
{
OOBS_SERVICE_START,
OOBS_SERVICE_STOP,
OOBS_SERVICE_IGNORE
} OobsServiceStatus;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsService-struct" role="struct">
<title>OobsService</title>
<indexterm zone="OobsService-struct"><primary>OobsService</primary></indexterm><programlisting>typedef struct _OobsService OobsService;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-service-set-runlevel-configuration" role="function">
<title>oobs_service_set_runlevel_configuration ()</title>
<indexterm zone="oobs-service-set-runlevel-configuration"><primary>oobs_service_set_runlevel_configuration</primary></indexterm><programlisting><link linkend="void">void</link> oobs_service_set_runlevel_configuration
(<link linkend="OobsService">OobsService</link> *service,
<link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link> *runlevel,
<link linkend="OobsServiceStatus">OobsServiceStatus</link> status,
<link linkend="gint">gint</link> priority);</programlisting>
<para>
Sets the configuration of a service for a given runlevel.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> An <link linkend="OobsService"><type>OobsService</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>runlevel</parameter> :</term>
<listitem><simpara> A <link linkend="OobsServicesRunlevel"><type>OobsServicesRunlevel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> status for the service in the given runlevel
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>priority</parameter> :</term>
<listitem><simpara> priority for the service in the given runlevel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-service-get-runlevel-configuration" role="function">
<title>oobs_service_get_runlevel_configuration ()</title>
<indexterm zone="oobs-service-get-runlevel-configuration"><primary>oobs_service_get_runlevel_configuration</primary></indexterm><programlisting><link linkend="void">void</link> oobs_service_get_runlevel_configuration
(<link linkend="OobsService">OobsService</link> *service,
<link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link> *runlevel,
<link linkend="OobsServiceStatus">OobsServiceStatus</link> *status,
<link linkend="gint">gint</link> *priority);</programlisting>
<para>
Gets the status and priority of a service in a given runlevel.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> An <link linkend="OobsService"><type>OobsService</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>runlevel</parameter> :</term>
<listitem><simpara> An <link linkend="OobsServiceRunlevel"><type>OobsServiceRunlevel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> return value for the current service status.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>priority</parameter> :</term>
<listitem><simpara> return value for the current service priority.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-service-get-name" role="function">
<title>oobs_service_get_name ()</title>
<indexterm zone="oobs-service-get-name"><primary>oobs_service_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_service_get_name (<link linkend="OobsService">OobsService</link> *service);</programlisting>
<para>
Returns the service name</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> An <link linkend="OobsService"><type>OobsService</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the service name as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsService.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsService--name"><title>The <literal>"name"</literal> property</title>
<indexterm zone="OobsService--name"><primary>OobsService:name</primary></indexterm><programlisting> "name" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>Name of the service.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
