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
|
<?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="OobsIfaceEthernet">
<refmeta>
<refentrytitle role="top_of_page" id="OobsIfaceEthernet.top_of_page">OobsIfaceEthernet</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsIfaceEthernet</refname>
<refpurpose>Object that represents an individual Ethernet interface.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsIfaceEthernet.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsIfaceEthernet-struct">OobsIfaceEthernet</link>;
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-ip-address">oobs_iface_ethernet_get_ip_address</link> (<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-ip-address">oobs_iface_ethernet_set_ip_address</link> (<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-network-mask">oobs_iface_ethernet_get_network_mask</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-network-mask">oobs_iface_ethernet_set_network_mask</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *mask);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-gateway-address">oobs_iface_ethernet_get_gateway_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-gateway-address">oobs_iface_ethernet_set_gateway_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-network-address">oobs_iface_ethernet_get_network_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-network-address">oobs_iface_ethernet_set_network_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-broadcast-address">oobs_iface_ethernet_get_broadcast_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-broadcast-address">oobs_iface_ethernet_set_broadcast_address</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-iface-ethernet-get-configuration-method">oobs_iface_ethernet_get_configuration_method</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);
<link linkend="void">void</link> <link linkend="oobs-iface-ethernet-set-configuration-method">oobs_iface_ethernet_set_configuration_method</link>
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *method);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsIfaceEthernet.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsIface">OobsIface</link>
+----OobsIfaceEthernet
+----<link linkend="OobsIfaceIRLan">OobsIfaceIRLan</link>
+----<link linkend="OobsIfaceWireless">OobsIfaceWireless</link>
</synopsis>
</refsect1>
<refsect1 id="OobsIfaceEthernet.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsIfaceEthernet--broadcast-address">broadcast-address</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceEthernet--config-method">config-method</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceEthernet--gateway-address">gateway-address</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceEthernet--ip-address">ip-address</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceEthernet--ip-mask">ip-mask</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsIfaceEthernet--network-address">network-address</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsIfaceEthernet.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsIfaceEthernet.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsIfaceEthernet-struct" role="struct">
<title>OobsIfaceEthernet</title>
<indexterm zone="OobsIfaceEthernet-struct"><primary>OobsIfaceEthernet</primary></indexterm><programlisting>typedef struct _OobsIfaceEthernet OobsIfaceEthernet;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-iface-ethernet-get-ip-address" role="function">
<title>oobs_iface_ethernet_get_ip_address ()</title>
<indexterm zone="oobs-iface-ethernet-get-ip-address"><primary>oobs_iface_ethernet_get_ip_address</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_ip_address (<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the IP address that this interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the IP address as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-ip-address" role="function">
<title>oobs_iface_ethernet_set_ip_address ()</title>
<indexterm zone="oobs-iface-ethernet-set-ip-address"><primary>oobs_iface_ethernet_set_ip_address</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_ip_address (<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);</programlisting>
<para>
Sets a new IP address for the interface,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter> :</term>
<listitem><simpara> a new IP address for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-get-network-mask" role="function">
<title>oobs_iface_ethernet_get_network_mask ()</title>
<indexterm zone="oobs-iface-ethernet-get-network-mask"><primary>oobs_iface_ethernet_get_network_mask</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_network_mask
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the IP network mask that this interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the network mask as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-network-mask" role="function">
<title>oobs_iface_ethernet_set_network_mask ()</title>
<indexterm zone="oobs-iface-ethernet-set-network-mask"><primary>oobs_iface_ethernet_set_network_mask</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_network_mask
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *mask);</programlisting>
<para>
Sets a new IP network mask for the interface,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter> :</term>
<listitem><simpara> a new IP network mask for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-get-gateway-address" role="function">
<title>oobs_iface_ethernet_get_gateway_address ()</title>
<indexterm zone="oobs-iface-ethernet-get-gateway-address"><primary>oobs_iface_ethernet_get_gateway_address</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_gateway_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the gateway IP address that this interface uses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the gateway address as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-gateway-address" role="function">
<title>oobs_iface_ethernet_set_gateway_address ()</title>
<indexterm zone="oobs-iface-ethernet-set-gateway-address"><primary>oobs_iface_ethernet_set_gateway_address</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_gateway_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);</programlisting>
<para>
Sets a new gateway IP address for the interface,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter> :</term>
<listitem><simpara> a new gateway IP address for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-get-network-address" role="function">
<title>oobs_iface_ethernet_get_network_address ()</title>
<indexterm zone="oobs-iface-ethernet-get-network-address"><primary>oobs_iface_ethernet_get_network_address</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_network_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the network address for this interface.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the network address as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-network-address" role="function">
<title>oobs_iface_ethernet_set_network_address ()</title>
<indexterm zone="oobs-iface-ethernet-set-network-address"><primary>oobs_iface_ethernet_set_network_address</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_network_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);</programlisting>
<para>
Sets a new network address for the interface,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter> :</term>
<listitem><simpara> a new network address for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-get-broadcast-address" role="function">
<title>oobs_iface_ethernet_get_broadcast_address ()</title>
<indexterm zone="oobs-iface-ethernet-get-broadcast-address"><primary>oobs_iface_ethernet_get_broadcast_address</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_broadcast_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the broadcast address for this interface.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the broadcast address as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-broadcast-address" role="function">
<title>oobs_iface_ethernet_set_broadcast_address ()</title>
<indexterm zone="oobs-iface-ethernet-set-broadcast-address"><primary>oobs_iface_ethernet_set_broadcast_address</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_broadcast_address
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *address);</programlisting>
<para>
Sets a new broadcast address for the interface,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter> :</term>
<listitem><simpara> a new broadcast address for the interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-get-configuration-method" role="function">
<title>oobs_iface_ethernet_get_configuration_method ()</title>
<indexterm zone="oobs-iface-ethernet-get-configuration-method"><primary>oobs_iface_ethernet_get_configuration_method</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_iface_ethernet_get_configuration_method
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface);</programlisting>
<para>
Returns the configuration method for the interface.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The configuration method that the interface uses.
This value must not be modified nor freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-iface-ethernet-set-configuration-method" role="function">
<title>oobs_iface_ethernet_set_configuration_method ()</title>
<indexterm zone="oobs-iface-ethernet-set-configuration-method"><primary>oobs_iface_ethernet_set_configuration_method</primary></indexterm><programlisting><link linkend="void">void</link> oobs_iface_ethernet_set_configuration_method
(<link linkend="OobsIfaceEthernet">OobsIfaceEthernet</link> *iface,
const <link linkend="gchar">gchar</link> *method);</programlisting>
<para>
Sets the configuration method that the interface will use. The valid methods are
provided by <link linkend="oobs-ifaces-config-get-available-configuration-methods"><function>oobs_ifaces_config_get_available_configuration_methods()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iface</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceEthernet"><type>OobsIfaceEthernet</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>method</parameter> :</term>
<listitem><simpara> A new configuration method for the interface, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsIfaceEthernet.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsIfaceEthernet--broadcast-address"><title>The <literal>"broadcast-address"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--broadcast-address"><primary>OobsIfaceEthernet:broadcast-address</primary></indexterm><programlisting> "broadcast-address" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Network broadcast for the iface.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceEthernet--config-method"><title>The <literal>"config-method"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--config-method"><primary>OobsIfaceEthernet:config-method</primary></indexterm><programlisting> "config-method" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Network configuration method for the iface.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceEthernet--gateway-address"><title>The <literal>"gateway-address"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--gateway-address"><primary>OobsIfaceEthernet:gateway-address</primary></indexterm><programlisting> "gateway-address" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Gateway address for the iface.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceEthernet--ip-address"><title>The <literal>"ip-address"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--ip-address"><primary>OobsIfaceEthernet:ip-address</primary></indexterm><programlisting> "ip-address" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Address for the iface.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceEthernet--ip-mask"><title>The <literal>"ip-mask"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--ip-mask"><primary>OobsIfaceEthernet:ip-mask</primary></indexterm><programlisting> "ip-mask" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Netmask for the iface.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsIfaceEthernet--network-address"><title>The <literal>"network-address"</literal> property</title>
<indexterm zone="OobsIfaceEthernet--network-address"><primary>OobsIfaceEthernet:network-address</primary></indexterm><programlisting> "network-address" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Network address for the iface.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
