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
|
<?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="OobsIface">
<refmeta>
<refentrytitle role="top_of_page" id="OobsIface.top_of_page">OobsIface</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsIface</refname>
<refpurpose>Base object for network interfaces.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsIface.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsIface-struct">OobsIface</link>;
<link linkend="gboolean">gboolean</link> <link linkend="oobs-iface-get-auto">oobs_iface_get_auto</link> (<link linkend="OobsIface">OobsIface</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-set-auto">oobs_iface_set_auto</link> (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_auto);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-iface-get-active">oobs_iface_get_active</link> (<link linkend="OobsIface">OobsIface</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-set-active">oobs_iface_set_active</link> (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_active);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-get-device-name">oobs_iface_get_device_name</link> (<link linkend="OobsIface">OobsIface</link> *iface);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-iface-get-configured">oobs_iface_get_configured</link> (<link linkend="OobsIface">OobsIface</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-set-configured">oobs_iface_set_configured</link> (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_configured);
<link linkend="gboolean">gboolean</link> <link linkend="oobs-iface-has-gateway">oobs_iface_has_gateway</link> (<link linkend="OobsIface">OobsIface</link> *iface);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsIface.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsIface
+----<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link>
+----<link linkend="OobsIfacePlip">OobsIfacePlip</link>
</synopsis>
</refsect1>
<refsect1 id="OobsIface.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsIface--active">active</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="OobsIface--auto">auto</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="OobsIface--configured">configured</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="OobsIface--device">device</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="OobsIface.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="OobsIface-state-changed">state-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="OobsIface.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsIface.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsIface-struct" role="struct">
<title>OobsIface</title>
<indexterm zone="OobsIface-struct"><primary>OobsIface</primary></indexterm><programlisting>typedef struct _OobsIface OobsIface;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-iface-get-auto" role="function">
<title>oobs_iface_get_auto ()</title>
<indexterm zone="oobs-iface-get-auto"><primary>oobs_iface_get_auto</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_iface_get_auto (<link linkend="OobsIface">OobsIface</link> *iface);</programlisting>
<para>
Returns whether the interface is started automatically at boot time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the interface starts during system boot.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-set-auto" role="function">
<title>oobs_iface_set_auto ()</title>
<indexterm zone="oobs-iface-set-auto"><primary>oobs_iface_set_auto</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_set_auto (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_auto);</programlisting>
<para>
Sets whether the interface is started automatically at boot time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_auto</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> to make the interface start at boot time.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-get-active" role="function">
<title>oobs_iface_get_active ()</title>
<indexterm zone="oobs-iface-get-active"><primary>oobs_iface_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_iface_get_active (<link linkend="OobsIface">OobsIface</link> *iface);</programlisting>
<para>
Returns whether the interface is active.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the interface is active.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-set-active" role="function">
<title>oobs_iface_set_active ()</title>
<indexterm zone="oobs-iface-set-active"><primary>oobs_iface_set_active</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_set_active (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_active);</programlisting>
<para>
Sets whether the interface is currently active.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_active</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> to enable the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-get-device-name" role="function">
<title>oobs_iface_get_device_name ()</title>
<indexterm zone="oobs-iface-get-device-name"><primary>oobs_iface_get_device_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_get_device_name (<link linkend="OobsIface">OobsIface</link> *iface);</programlisting>
<para>
Returns the device name for the interface.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string containing the device name.
This string must not be freed or modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-get-configured" role="function">
<title>oobs_iface_get_configured ()</title>
<indexterm zone="oobs-iface-get-configured"><primary>oobs_iface_get_configured</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_iface_get_configured (<link linkend="OobsIface">OobsIface</link> *iface);</programlisting>
<para>
Returns whether the interface has a valid (i.e.: complete)
configuration and is explicitly marked as configured
(see <link linkend="oobs-iface-set-configured"><function>oobs_iface_set_configured()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if its configuration is valid.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-set-configured" role="function">
<title>oobs_iface_set_configured ()</title>
<indexterm zone="oobs-iface-set-configured"><primary>oobs_iface_set_configured</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_set_configured (<link linkend="OobsIface">OobsIface</link> *iface,
<link linkend="gboolean">gboolean</link> is_configured);</programlisting>
<para>
If <parameter>is_configured</parameter> is <link linkend="FALSE:CAPS"><type>FALSE</type></link>, the function explicitly marks the interface
as not configured. If <parameter>is_configured</parameter> is <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the explicit mark will be
removed, but the interface may still have an incomplete/invalid configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_configured</parameter> :</term>
<listitem><simpara> <link linkend="FALSE:CAPS"><type>FALSE</type></link> to explictitly mark the interface as not configured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-has-gateway" role="function">
<title>oobs_iface_has_gateway ()</title>
<indexterm zone="oobs-iface-has-gateway"><primary>oobs_iface_has_gateway</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> oobs_iface_has_gateway (<link linkend="OobsIface">OobsIface</link> *iface);</programlisting>
<para>
Returns whether the interface has a defined gateway.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIface"><type>OobsIface</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the interface has a defined gateway.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsIface.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsIface--active"><title>The <literal>"active"</literal> property</title>
<indexterm zone="OobsIface--active"><primary>OobsIface:active</primary></indexterm><programlisting> "active" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the interface is active.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="OobsIface--auto"><title>The <literal>"auto"</literal> property</title>
<indexterm zone="OobsIface--auto"><primary>OobsIface:auto</primary></indexterm><programlisting> "auto" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the interface starts at boot time.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="OobsIface--configured"><title>The <literal>"configured"</literal> property</title>
<indexterm zone="OobsIface--configured"><primary>OobsIface:configured</primary></indexterm><programlisting> "configured" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the interface is fully configured.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="OobsIface--device"><title>The <literal>"device"</literal> property</title>
<indexterm zone="OobsIface--device"><primary>OobsIface:device</primary></indexterm><programlisting> "device" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>Device name of the iface.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1 id="OobsIface.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="OobsIface-state-changed"><title>The <literal>"state-changed"</literal> signal</title>
<indexterm zone="OobsIface-state-changed"><primary>OobsIface::state-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="OobsIface">OobsIface</link> *oobsiface,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>oobsiface</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
