Debian Codegraph @

doc/reference/html/liboobs-Oobs.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>OobsIface</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="ch06.html" title="Network interfaces management">
9 <link rel="prev" href="OobsIfacesConfig.html" title="OobsIfacesConfig">
10 <link rel="next" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet">
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="OobsIfacesConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch06.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="OobsIfaceEthernet.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="#liboobs-Oobs.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#liboobs-Oobs.description" class="shortcut">Description</a>
27  | 
28 <a href="#liboobs-Oobs.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#liboobs-Oobs.properties" class="shortcut">Properties</a>
31  | 
32 <a href="#liboobs-Oobs.signals" class="shortcut">Signals</a>
33 </td></tr>
34 </table>
35 <div class="refentry" title="OobsIface">
36 <a name="liboobs-Oobs"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="liboobs-Oobs.top_of_page"></a>OobsIface</span></h2>
40 <p>OobsIface — Base object for network interfaces</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv" title="Synopsis">
45 <a name="liboobs-Oobs.synopsis"></a><h2>Synopsis</h2>
46 <a name="OobsIface"></a><pre class="synopsis"> <a class="link" href="liboobs-Oobs.html#OobsIface-struct" title="OobsIface">OobsIface</a>;
47 <a class="link" href="liboobs-Oobs.html#OobsIfaceClass" title="OobsIfaceClass">OobsIfaceClass</a>;
48 <span class="returnvalue">gboolean</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-get-auto" title="oobs_iface_get_auto ()">oobs_iface_get_auto</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-set-auto" title="oobs_iface_set_auto ()">oobs_iface_set_auto</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
50 <em class="parameter"><code><span class="type">gboolean</span> is_auto</code></em>);
51 <span class="returnvalue">gboolean</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-get-active" title="oobs_iface_get_active ()">oobs_iface_get_active</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);
52 <span class="returnvalue">void</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-set-active" title="oobs_iface_set_active ()">oobs_iface_set_active</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
53 <em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);
54 const <span class="returnvalue">gchar</span>* <a class="link" href="liboobs-Oobs.html#oobs-iface-get-device-name" title="oobs_iface_get_device_name ()">oobs_iface_get_device_name</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);
55 <span class="returnvalue">gboolean</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-get-configured" title="oobs_iface_get_configured ()">oobs_iface_get_configured</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);
56 <span class="returnvalue">void</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-set-configured" title="oobs_iface_set_configured ()">oobs_iface_set_configured</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
57 <em class="parameter"><code><span class="type">gboolean</span> is_configured</code></em>);
58 <span class="returnvalue">gboolean</span> <a class="link" href="liboobs-Oobs.html#oobs-iface-has-gateway" title="oobs_iface_has_gateway ()">oobs_iface_has_gateway</a> (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);
59 </pre>
60 </div>
61 <div class="refsect1" title="Object Hierarchy">
62 <a name="liboobs-Oobs.object-hierarchy"></a><h2>Object Hierarchy</h2>
63 <pre class="synopsis">
64 GObject
65 +----OobsIface
66 +----<a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet">OobsIfaceEthernet</a>
67 +----<a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip">OobsIfacePlip</a>
68 +----<a class="link" href="OobsIfacePPP.html" title="OobsIfacePPP">OobsIfacePPP</a>
69 </pre>
70 </div>
71 <div class="refsect1" title="Properties">
72 <a name="liboobs-Oobs.properties"></a><h2>Properties</h2>
73 <pre class="synopsis">
74 "<a class="link" href="liboobs-Oobs.html#OobsIface--active" title='The "active" property'>active</a>" <span class="type">gboolean</span> : Read / Write
75 "<a class="link" href="liboobs-Oobs.html#OobsIface--auto" title='The "auto" property'>auto</a>" <span class="type">gboolean</span> : Read / Write
76 "<a class="link" href="liboobs-Oobs.html#OobsIface--configured" title='The "configured" property'>configured</a>" <span class="type">gboolean</span> : Read / Write
77 "<a class="link" href="liboobs-Oobs.html#OobsIface--device" title='The "device" property'>device</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
78 </pre>
79 </div>
80 <div class="refsect1" title="Signals">
81 <a name="liboobs-Oobs.signals"></a><h2>Signals</h2>
82 <pre class="synopsis">
83 "<a class="link" href="liboobs-Oobs.html#OobsIface-state-changed" title='The "state-changed" signal'>state-changed</a>" : Run Last
84 </pre>
85 </div>
86 <div class="refsect1" title="Description">
87 <a name="liboobs-Oobs.description"></a><h2>Description</h2>
88 </div>
89 <div class="refsect1" title="Details">
90 <a name="liboobs-Oobs.details"></a><h2>Details</h2>
91 <div class="refsect2" title="OobsIface">
92 <a name="OobsIface-struct"></a><h3>OobsIface</h3>
93 <pre class="programlisting">typedef struct _OobsIface OobsIface;</pre>
94 <p>
95 </p>
96 </div>
97 <hr>
98 <div class="refsect2" title="OobsIfaceClass">
99 <a name="OobsIfaceClass"></a><h3>OobsIfaceClass</h3>
100 <pre class="programlisting">typedef struct {
101 GObjectClass parent_class;
102
103 gboolean (*is_configured) (OobsIface*);
104 gboolean (*has_gateway) (OobsIface*);
105 void (*state_changed) (OobsIface *iface);
106
107 void (*_oobs_padding2) (void);
108 } OobsIfaceClass;
109 </pre>
110 <p>
111 </p>
112 </div>
113 <hr>
114 <div class="refsect2" title="oobs_iface_get_auto ()">
115 <a name="oobs-iface-get-auto"></a><h3>oobs_iface_get_auto ()</h3>
116 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_iface_get_auto (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);</pre>
117 <p>
118 Returns whether the interface is started automatically at boot time.
119 </p>
120 <div class="variablelist"><table border="0">
121 <col align="left" valign="top">
122 <tbody>
123 <tr>
124 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
125 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
126 </td>
127 </tr>
128 <tr>
129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
130 <td> <span class="type">TRUE</span> if the interface starts during system boot.
131 </td>
132 </tr>
133 </tbody>
134 </table></div>
135 </div>
136 <hr>
137 <div class="refsect2" title="oobs_iface_set_auto ()">
138 <a name="oobs-iface-set-auto"></a><h3>oobs_iface_set_auto ()</h3>
139 <pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_set_auto (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
140 <em class="parameter"><code><span class="type">gboolean</span> is_auto</code></em>);</pre>
141 <p>
142 Sets whether the interface is started automatically at boot time.
143 </p>
144 <div class="variablelist"><table border="0">
145 <col align="left" valign="top">
146 <tbody>
147 <tr>
148 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
149 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
150 </td>
151 </tr>
152 <tr>
153 <td><p><span class="term"><em class="parameter"><code>is_auto</code></em> :</span></p></td>
154 <td>
155 <span class="type">TRUE</span> to make the interface start at boot time.
156 </td>
157 </tr>
158 </tbody>
159 </table></div>
160 </div>
161 <hr>
162 <div class="refsect2" title="oobs_iface_get_active ()">
163 <a name="oobs-iface-get-active"></a><h3>oobs_iface_get_active ()</h3>
164 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_iface_get_active (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);</pre>
165 <p>
166 Returns whether the interface is active.
167 </p>
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
170 <tbody>
171 <tr>
172 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
173 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
174 </td>
175 </tr>
176 <tr>
177 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
178 <td> <span class="type">TRUE</span> if the interface is active.
179 </td>
180 </tr>
181 </tbody>
182 </table></div>
183 </div>
184 <hr>
185 <div class="refsect2" title="oobs_iface_set_active ()">
186 <a name="oobs-iface-set-active"></a><h3>oobs_iface_set_active ()</h3>
187 <pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_set_active (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
188 <em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);</pre>
189 <p>
190 Sets whether the interface is currently active.
191 </p>
192 <div class="variablelist"><table border="0">
193 <col align="left" valign="top">
194 <tbody>
195 <tr>
196 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
197 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
198 </td>
199 </tr>
200 <tr>
201 <td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
202 <td>
203 <span class="type">TRUE</span> to enable the interface.
204 </td>
205 </tr>
206 </tbody>
207 </table></div>
208 </div>
209 <hr>
210 <div class="refsect2" title="oobs_iface_get_device_name ()">
211 <a name="oobs-iface-get-device-name"></a><h3>oobs_iface_get_device_name ()</h3>
212 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_iface_get_device_name (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);</pre>
213 <p>
214 Returns the device name for the interface.
215 </p>
216 <div class="variablelist"><table border="0">
217 <col align="left" valign="top">
218 <tbody>
219 <tr>
220 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
221 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
222 </td>
223 </tr>
224 <tr>
225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
226 <td> A string containing the device name.
227 This string must not be freed or modified.
228 </td>
229 </tr>
230 </tbody>
231 </table></div>
232 </div>
233 <hr>
234 <div class="refsect2" title="oobs_iface_get_configured ()">
235 <a name="oobs-iface-get-configured"></a><h3>oobs_iface_get_configured ()</h3>
236 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_iface_get_configured (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);</pre>
237 <p>
238 Returns whether the interface has a valid (i.e.: complete)
239 configuration and is explicitly marked as configured
240 (see <a class="link" href="liboobs-Oobs.html#oobs-iface-set-configured" title="oobs_iface_set_configured ()"><code class="function">oobs_iface_set_configured()</code></a>).
241 </p>
242 <div class="variablelist"><table border="0">
243 <col align="left" valign="top">
244 <tbody>
245 <tr>
246 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
247 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
248 </td>
249 </tr>
250 <tr>
251 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
252 <td> <span class="type">TRUE</span> if its configuration is valid.
253 </td>
254 </tr>
255 </tbody>
256 </table></div>
257 </div>
258 <hr>
259 <div class="refsect2" title="oobs_iface_set_configured ()">
260 <a name="oobs-iface-set-configured"></a><h3>oobs_iface_set_configured ()</h3>
261 <pre class="programlisting"><span class="returnvalue">void</span> oobs_iface_set_configured (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>,
262 <em class="parameter"><code><span class="type">gboolean</span> is_configured</code></em>);</pre>
263 <p>
264 If <em class="parameter"><code>is_configured</code></em> is <span class="type">FALSE</span>, the function explicitly marks the interface
265 as not configured. If <em class="parameter"><code>is_configured</code></em> is <span class="type">TRUE</span>, the explicit mark will be
266 removed, but the interface may still have an incomplete/invalid configuration.
267 </p>
268 <div class="variablelist"><table border="0">
269 <col align="left" valign="top">
270 <tbody>
271 <tr>
272 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
273 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
274 </td>
275 </tr>
276 <tr>
277 <td><p><span class="term"><em class="parameter"><code>is_configured</code></em> :</span></p></td>
278 <td>
279 <span class="type">FALSE</span> to explictitly mark the interface as not configured.
280 </td>
281 </tr>
282 </tbody>
283 </table></div>
284 </div>
285 <hr>
286 <div class="refsect2" title="oobs_iface_has_gateway ()">
287 <a name="oobs-iface-has-gateway"></a><h3>oobs_iface_has_gateway ()</h3>
288 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_iface_has_gateway (<em class="parameter"><code><a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *iface</code></em>);</pre>
289 <p>
290 Returns whether the interface has a defined gateway.
291 </p>
292 <div class="variablelist"><table border="0">
293 <col align="left" valign="top">
294 <tbody>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>iface</code></em> :</span></p></td>
297 <td>An <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a>.
298 </td>
299 </tr>
300 <tr>
301 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
302 <td> <span class="type">TRUE</span> if the interface has a defined gateway.
303 </td>
304 </tr>
305 </tbody>
306 </table></div>
307 </div>
308 </div>
309 <div class="refsect1" title="Property Details">
310 <a name="liboobs-Oobs.property-details"></a><h2>Property Details</h2>
311 <div class="refsect2" title='The "active" property'>
312 <a name="OobsIface--active"></a><h3>The <code class="literal">"active"</code> property</h3>
313 <pre class="programlisting"> "active" <span class="type">gboolean</span> : Read / Write</pre>
314 <p>Whether the interface is active.</p>
315 <p>Default value: FALSE</p>
316 </div>
317 <hr>
318 <div class="refsect2" title='The "auto" property'>
319 <a name="OobsIface--auto"></a><h3>The <code class="literal">"auto"</code> property</h3>
320 <pre class="programlisting"> "auto" <span class="type">gboolean</span> : Read / Write</pre>
321 <p>Whether the interface starts at boot time.</p>
322 <p>Default value: FALSE</p>
323 </div>
324 <hr>
325 <div class="refsect2" title='The "configured" property'>
326 <a name="OobsIface--configured"></a><h3>The <code class="literal">"configured"</code> property</h3>
327 <pre class="programlisting"> "configured" <span class="type">gboolean</span> : Read / Write</pre>
328 <p>Whether the interface is fully configured.</p>
329 <p>Default value: FALSE</p>
330 </div>
331 <hr>
332 <div class="refsect2" title='The "device" property'>
333 <a name="OobsIface--device"></a><h3>The <code class="literal">"device"</code> property</h3>
334 <pre class="programlisting"> "device" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
335 <p>Device name of the iface.</p>
336 <p>Default value: NULL</p>
337 </div>
338 </div>
339 <div class="refsect1" title="Signal Details">
340 <a name="liboobs-Oobs.signal-details"></a><h2>Signal Details</h2>
341 <div class="refsect2" title='The "state-changed" signal'>
342 <a name="OobsIface-state-changed"></a><h3>The <code class="literal">"state-changed"</code> signal</h3>
343 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</span></a> *oobsiface,
344 <span class="type">gpointer</span> user_data) : Run Last</pre>
345 <p>
346 </p>
347 <div class="variablelist"><table border="0">
348 <col align="left" valign="top">
349 <tbody>
350 <tr>
351 <td><p><span class="term"><em class="parameter"><code>oobsiface</code></em> :</span></p></td>
352 <td>the object which received the signal.
353 </td>
354 </tr>
355 <tr>
356 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
357 <td>user data set when the signal handler was connected.</td>
358 </tr>
359 </tbody>
360 </table></div>
361 </div>
362 </div>
363 <div class="refsect1" title="See Also">
364 <a name="liboobs-Oobs.see-also"></a><h2>See Also</h2>
365 <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a>, <a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet"><span class="type">OobsIfaceEthernet</span></a>, <a class="link" href="OobsIfaceIRLan.html" title="OobsIfaceIRLan"><span class="type">OobsIfaceIRLan</span></a>,
366 <a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip"><span class="type">OobsIfacePlip</span></a>, <a class="link" href="OobsIfacePPP.html" title="OobsIfacePPP"><span class="type">OobsIfacePPP</span></a>, <a class="link" href="OobsIfaceWireless.html" title="OobsIfaceWireless"><span class="type">OobsIfaceWireless</span></a>
367 </div>
368 </div>
369 <div class="footer">
370 <hr>
371 Generated by GTK-Doc V1.15</div>
372 </body>
373 </html>