Debian Codegraph @

doc/reference/html/OobsService.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>OobsService</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
8 <link rel="up" href="ch05.html" title="System boot management">
9 <link rel="prev" href="OobsServicesConfig.html" title="OobsServicesConfig">
10 <link rel="next" href="ch06.html" title="Network interfaces management">
11 <meta name="generator" content="GTK-Doc V1.15 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="OobsServicesConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
21 <td><a accesskey="n" href="ch06.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#OobsService.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsService.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsService.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsService.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry" title="OobsService">
34 <a name="OobsService"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="OobsService.top_of_page"></a>OobsService</span></h2>
38 <p>OobsService — Object that represents an individual init.d service</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="OobsService.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="OobsService.html#OobsService-struct" title="OobsService">OobsService</a>;
45 <a class="link" href="OobsService.html#OobsServiceClass" title="OobsServiceClass">OobsServiceClass</a>;
46 enum <a class="link" href="OobsService.html#OobsServiceStatus" title="enum OobsServiceStatus">OobsServiceStatus</a>;
47 <span class="returnvalue">void</span> <a class="link" href="OobsService.html#oobs-service-set-runlevel-configuration" title="oobs_service_set_runlevel_configuration ()">oobs_service_set_runlevel_configuration</a>
48 (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>,
49 <em class="parameter"><code><a class="link" href="OobsServicesConfig.html#OobsServicesRunlevel" title="OobsServicesRunlevel"><span class="type">OobsServicesRunlevel</span></a> *runlevel</code></em>,
50 <em class="parameter"><code><a class="link" href="OobsService.html#OobsServiceStatus" title="enum OobsServiceStatus"><span class="type">OobsServiceStatus</span></a> status</code></em>,
51 <em class="parameter"><code><span class="type">gint</span> priority</code></em>);
52 <span class="returnvalue">void</span> <a class="link" href="OobsService.html#oobs-service-get-runlevel-configuration" title="oobs_service_get_runlevel_configuration ()">oobs_service_get_runlevel_configuration</a>
53 (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>,
54 <em class="parameter"><code><a class="link" href="OobsServicesConfig.html#OobsServicesRunlevel" title="OobsServicesRunlevel"><span class="type">OobsServicesRunlevel</span></a> *runlevel</code></em>,
55 <em class="parameter"><code><a class="link" href="OobsService.html#OobsServiceStatus" title="enum OobsServiceStatus"><span class="type">OobsServiceStatus</span></a> *status</code></em>,
56 <em class="parameter"><code><span class="type">gint</span> *priority</code></em>);
57 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsService.html#oobs-service-get-name" title="oobs_service_get_name ()">oobs_service_get_name</a> (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>);
58 </pre>
59 </div>
60 <div class="refsect1" title="Object Hierarchy">
61 <a name="OobsService.object-hierarchy"></a><h2>Object Hierarchy</h2>
62 <pre class="synopsis">
63 GObject
64 +----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a>
65 +----OobsService
66 </pre>
67 </div>
68 <div class="refsect1" title="Properties">
69 <a name="OobsService.properties"></a><h2>Properties</h2>
70 <pre class="synopsis">
71 "<a class="link" href="OobsService.html#OobsService--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
72 </pre>
73 </div>
74 <div class="refsect1" title="Description">
75 <a name="OobsService.description"></a><h2>Description</h2>
76 </div>
77 <div class="refsect1" title="Details">
78 <a name="OobsService.details"></a><h2>Details</h2>
79 <div class="refsect2" title="OobsService">
80 <a name="OobsService-struct"></a><h3>OobsService</h3>
81 <pre class="programlisting">typedef struct _OobsService OobsService;</pre>
82 <p>
83 </p>
84 </div>
85 <hr>
86 <div class="refsect2" title="OobsServiceClass">
87 <a name="OobsServiceClass"></a><h3>OobsServiceClass</h3>
88 <pre class="programlisting">typedef struct {
89 OobsObjectClass parent_class;
90
91 void (*_oobs_padding1) (void);
92 void (*_oobs_padding2) (void);
93 } OobsServiceClass;
94 </pre>
95 <p>
96 </p>
97 </div>
98 <hr>
99 <div class="refsect2" title="enum OobsServiceStatus">
100 <a name="OobsServiceStatus"></a><h3>enum OobsServiceStatus</h3>
101 <pre class="programlisting">typedef enum
102 {
103 OOBS_SERVICE_START,
104 OOBS_SERVICE_STOP,
105 /* For services not listed in that runlevel */
106 OOBS_SERVICE_IGNORE
107 } OobsServiceStatus;
108 </pre>
109 <p>
110 </p>
111 </div>
112 <hr>
113 <div class="refsect2" title="oobs_service_set_runlevel_configuration ()">
114 <a name="oobs-service-set-runlevel-configuration"></a><h3>oobs_service_set_runlevel_configuration ()</h3>
115 <pre class="programlisting"><span class="returnvalue">void</span> oobs_service_set_runlevel_configuration
116 (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>,
117 <em class="parameter"><code><a class="link" href="OobsServicesConfig.html#OobsServicesRunlevel" title="OobsServicesRunlevel"><span class="type">OobsServicesRunlevel</span></a> *runlevel</code></em>,
118 <em class="parameter"><code><a class="link" href="OobsService.html#OobsServiceStatus" title="enum OobsServiceStatus"><span class="type">OobsServiceStatus</span></a> status</code></em>,
119 <em class="parameter"><code><span class="type">gint</span> priority</code></em>);</pre>
120 <p>
121 Sets the configuration of a service for a given runlevel.
122 </p>
123 <div class="variablelist"><table border="0">
124 <col align="left" valign="top">
125 <tbody>
126 <tr>
127 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
128 <td>An <a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a>.
129 </td>
130 </tr>
131 <tr>
132 <td><p><span class="term"><em class="parameter"><code>runlevel</code></em> :</span></p></td>
133 <td>A <a class="link" href="OobsServicesConfig.html#OobsServicesRunlevel" title="OobsServicesRunlevel"><span class="type">OobsServicesRunlevel</span></a>.
134 </td>
135 </tr>
136 <tr>
137 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
138 <td>status for the service in the given runlevel
139 </td>
140 </tr>
141 <tr>
142 <td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
143 <td>priority for the service in the given runlevel.
144 Use 0 to either keep the previous priority, or get the default value in case the script is new.
145 </td>
146 </tr>
147 </tbody>
148 </table></div>
149 </div>
150 <hr>
151 <div class="refsect2" title="oobs_service_get_runlevel_configuration ()">
152 <a name="oobs-service-get-runlevel-configuration"></a><h3>oobs_service_get_runlevel_configuration ()</h3>
153 <pre class="programlisting"><span class="returnvalue">void</span> oobs_service_get_runlevel_configuration
154 (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>,
155 <em class="parameter"><code><a class="link" href="OobsServicesConfig.html#OobsServicesRunlevel" title="OobsServicesRunlevel"><span class="type">OobsServicesRunlevel</span></a> *runlevel</code></em>,
156 <em class="parameter"><code><a class="link" href="OobsService.html#OobsServiceStatus" title="enum OobsServiceStatus"><span class="type">OobsServiceStatus</span></a> *status</code></em>,
157 <em class="parameter"><code><span class="type">gint</span> *priority</code></em>);</pre>
158 <p>
159 Gets the status and priority of a service in a given runlevel.
160 </p>
161 <div class="variablelist"><table border="0">
162 <col align="left" valign="top">
163 <tbody>
164 <tr>
165 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
166 <td>An <a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a>.
167 </td>
168 </tr>
169 <tr>
170 <td><p><span class="term"><em class="parameter"><code>runlevel</code></em> :</span></p></td>
171 <td>An <span class="type">OobsServiceRunlevel</span>.
172 </td>
173 </tr>
174 <tr>
175 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
176 <td>return value for the current service status.
177 </td>
178 </tr>
179 <tr>
180 <td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
181 <td>return value for the current service priority.
182 </td>
183 </tr>
184 </tbody>
185 </table></div>
186 </div>
187 <hr>
188 <div class="refsect2" title="oobs_service_get_name ()">
189 <a name="oobs-service-get-name"></a><h3>oobs_service_get_name ()</h3>
190 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_service_get_name (<em class="parameter"><code><a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a> *service</code></em>);</pre>
191 <p>
192 Returns the service name
193 </p>
194 <div class="variablelist"><table border="0">
195 <col align="left" valign="top">
196 <tbody>
197 <tr>
198 <td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
199 <td>An <a class="link" href="OobsService.html" title="OobsService"><span class="type">OobsService</span></a>.
200 </td>
201 </tr>
202 <tr>
203 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204 <td> A pointer to the service name as a string. This
205 string must not be freed, modified or stored.
206 </td>
207 </tr>
208 </tbody>
209 </table></div>
210 </div>
211 </div>
212 <div class="refsect1" title="Property Details">
213 <a name="OobsService.property-details"></a><h2>Property Details</h2>
214 <div class="refsect2" title='The "name" property'>
215 <a name="OobsService--name"></a><h3>The <code class="literal">"name"</code> property</h3>
216 <pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
217 <p>Name of the service.</p>
218 <p>Default value: NULL</p>
219 </div>
220 </div>
221 <div class="refsect1" title="See Also">
222 <a name="OobsService.see-also"></a><h2>See Also</h2>
223 <a class="link" href="OobsServicesConfig.html" title="OobsServicesConfig"><span class="type">OobsServicesConfig</span></a>
224 </div>
225 </div>
226 <div class="footer">
227 <hr>
228 Generated by GTK-Doc V1.15</div>
229 </body>
230 </html>