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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OobsIface</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="ch07.html" title="Network interfaces management">
<link rel="prev" href="OobsIfacesConfig.html" title="OobsIfacesConfig">
<link rel="next" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet">
<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="OobsIfacesConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.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="OobsIfaceEthernet.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="#OobsIface.synopsis" class="shortcut">Top</a>
|
<a href="#OobsIface.description" class="shortcut">Description</a>
|
<a href="#OobsIface.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#OobsIface.properties" class="shortcut">Properties</a>
|
<a href="#OobsIface.signals" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="OobsIface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsIface.top_of_page"></a>OobsIface</span></h2>
<p>OobsIface — Base object for network interfaces.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="OobsIface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="OobsIface.html#OobsIface-struct" title="OobsIface">OobsIface</a>;
gboolean <a class="link" href="OobsIface.html#oobs-iface-get-auto" title="oobs_iface_get_auto ()">oobs_iface_get_auto</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);
void <a class="link" href="OobsIface.html#oobs-iface-set-auto" title="oobs_iface_set_auto ()">oobs_iface_set_auto</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_auto);
gboolean <a class="link" href="OobsIface.html#oobs-iface-get-active" title="oobs_iface_get_active ()">oobs_iface_get_active</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);
void <a class="link" href="OobsIface.html#oobs-iface-set-active" title="oobs_iface_set_active ()">oobs_iface_set_active</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_active);
const gchar* <a class="link" href="OobsIface.html#oobs-iface-get-device-name" title="oobs_iface_get_device_name ()">oobs_iface_get_device_name</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);
gboolean <a class="link" href="OobsIface.html#oobs-iface-get-configured" title="oobs_iface_get_configured ()">oobs_iface_get_configured</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);
void <a class="link" href="OobsIface.html#oobs-iface-set-configured" title="oobs_iface_set_configured ()">oobs_iface_set_configured</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_configured);
gboolean <a class="link" href="OobsIface.html#oobs-iface-has-gateway" title="oobs_iface_has_gateway ()">oobs_iface_has_gateway</a> (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----OobsIface
+----<a class="link" href="OobsIfaceEthernet.html" title="OobsIfaceEthernet">OobsIfaceEthernet</a>
+----<a class="link" href="OobsIfacePlip.html" title="OobsIfacePlip">OobsIfacePlip</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="OobsIface.html#OobsIface--active" title='The "active" property'>active</a>" gboolean : Read / Write
"<a class="link" href="OobsIface.html#OobsIface--auto" title='The "auto" property'>auto</a>" gboolean : Read / Write
"<a class="link" href="OobsIface.html#OobsIface--configured" title='The "configured" property'>configured</a>" gboolean : Read / Write
"<a class="link" href="OobsIface.html#OobsIface--device" title='The "device" property'>device</a>" gchar* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="OobsIface.html#OobsIface-state-changed" title='The "state-changed" signal'>state-changed</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="OobsIface-struct"></a><h3>OobsIface</h3>
<pre class="programlisting">typedef struct _OobsIface OobsIface;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-get-auto"></a><h3>oobs_iface_get_auto ()</h3>
<pre class="programlisting">gboolean oobs_iface_get_auto (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);</pre>
<p>
Returns whether the interface is started automatically at boot time.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</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 the interface starts during system boot.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-set-auto"></a><h3>oobs_iface_set_auto ()</h3>
<pre class="programlisting">void oobs_iface_set_auto (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_auto);</pre>
<p>
Sets whether the interface is started automatically at boot time.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_auto</code></em> :</span></p></td>
<td> <span class="type">TRUE</span> to make the interface start at boot time.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-get-active"></a><h3>oobs_iface_get_active ()</h3>
<pre class="programlisting">gboolean oobs_iface_get_active (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);</pre>
<p>
Returns whether the interface is active.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</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 the interface is active.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-set-active"></a><h3>oobs_iface_set_active ()</h3>
<pre class="programlisting">void oobs_iface_set_active (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_active);</pre>
<p>
Sets whether the interface is currently active.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
<td> <span class="type">TRUE</span> to enable the interface.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-get-device-name"></a><h3>oobs_iface_get_device_name ()</h3>
<pre class="programlisting">const gchar* oobs_iface_get_device_name (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);</pre>
<p>
Returns the device name for the interface.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A string containing the device name.
This string must not be freed or modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-get-configured"></a><h3>oobs_iface_get_configured ()</h3>
<pre class="programlisting">gboolean oobs_iface_get_configured (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);</pre>
<p>
Returns whether the interface has a valid (i.e.: complete)
configuration and is explicitly marked as configured
(see <a class="link" href="OobsIface.html#oobs-iface-set-configured" title="oobs_iface_set_configured ()"><code class="function">oobs_iface_set_configured()</code></a>).</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</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 its configuration is valid.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-set-configured"></a><h3>oobs_iface_set_configured ()</h3>
<pre class="programlisting">void oobs_iface_set_configured (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface,
gboolean is_configured);</pre>
<p>
If <em class="parameter"><code>is_configured</code></em> is <span class="type">FALSE</span>, the function explicitly marks the interface
as not configured. If <em class="parameter"><code>is_configured</code></em> is <span class="type">TRUE</span>, the explicit mark will be
removed, but the interface may still have an incomplete/invalid configuration.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_configured</code></em> :</span></p></td>
<td> <span class="type">FALSE</span> to explictitly mark the interface as not configured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-iface-has-gateway"></a><h3>oobs_iface_has_gateway ()</h3>
<pre class="programlisting">gboolean oobs_iface_has_gateway (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *iface);</pre>
<p>
Returns whether the interface has a defined gateway.</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>iface</code></em> :</span></p></td>
<td> An <a class="link" href="OobsIface.html" title="OobsIface"><span class="type">OobsIface</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 the interface has a defined gateway.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="OobsIface--active"></a><h3>The <code class="literal">"active"</code> property</h3>
<pre class="programlisting"> "active" gboolean : Read / Write</pre>
<p>Whether the interface is active.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsIface--auto"></a><h3>The <code class="literal">"auto"</code> property</h3>
<pre class="programlisting"> "auto" gboolean : Read / Write</pre>
<p>Whether the interface starts at boot time.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsIface--configured"></a><h3>The <code class="literal">"configured"</code> property</h3>
<pre class="programlisting"> "configured" gboolean : Read / Write</pre>
<p>Whether the interface is fully configured.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsIface--device"></a><h3>The <code class="literal">"device"</code> property</h3>
<pre class="programlisting"> "device" gchar* : Read / Write / Construct Only</pre>
<p>Device name of the iface.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsIface.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="OobsIface-state-changed"></a><h3>The <code class="literal">"state-changed"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="OobsIface.html" title="OobsIface">OobsIface</a> *oobsiface,
gpointer user_data) : Run Last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>oobsiface</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
