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
|
<?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="OobsIfacesConfig">
<refmeta>
<refentrytitle role="top_of_page" id="OobsIfacesConfig.top_of_page">OobsIfacesConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsIfacesConfig</refname>
<refpurpose>Object that represents network interfaces configuration.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsIfacesConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="OobsIfaceType">OobsIfaceType</link>;
#define <link linkend="OOBS-TYPE-IFACE-TYPE:CAPS">OOBS_TYPE_IFACE_TYPE</link>
<link linkend="OobsIfacesConfig-struct">OobsIfacesConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-ifaces-config-get">oobs_ifaces_config_get</link> (void);
<link linkend="OobsList">OobsList</link>* <link linkend="oobs-ifaces-config-get-ifaces">oobs_ifaces_config_get_ifaces</link> (<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config,
<link linkend="OobsIfaceType">OobsIfaceType</link> type);
<link linkend="GList">GList</link>* <link linkend="oobs-ifaces-config-get-available-configuration-methods">oobs_ifaces_config_get_available_configuration_methods</link>
(<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config);
<link linkend="GList">GList</link>* <link linkend="oobs-ifaces-config-get-available-key-types">oobs_ifaces_config_get_available_key_types</link>
(<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsIfacesConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsObject">OobsObject</link>
+----OobsIfacesConfig
</synopsis>
</refsect1>
<refsect1 id="OobsIfacesConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsIfacesConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsIfaceType" role="enum">
<title>enum OobsIfaceType</title>
<indexterm zone="OobsIfaceType"><primary>OobsIfaceType</primary></indexterm><programlisting>typedef enum {
OOBS_IFACE_TYPE_ETHERNET,
OOBS_IFACE_TYPE_WIRELESS,
OOBS_IFACE_TYPE_IRLAN,
OOBS_IFACE_TYPE_PLIP,
OOBS_IFACE_TYPE_PPP
} OobsIfaceType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OOBS-TYPE-IFACE-TYPE:CAPS" role="macro">
<title>OOBS_TYPE_IFACE_TYPE</title>
<indexterm zone="OOBS-TYPE-IFACE-TYPE:CAPS"><primary>OOBS_TYPE_IFACE_TYPE</primary></indexterm><programlisting>#define OOBS_TYPE_IFACE_TYPE (oobs_iface_type_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsIfacesConfig-struct" role="struct">
<title>OobsIfacesConfig</title>
<indexterm zone="OobsIfacesConfig-struct"><primary>OobsIfacesConfig</primary></indexterm><programlisting>typedef struct _OobsIfacesConfig OobsIfacesConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-ifaces-config-get" role="function">
<title>oobs_ifaces_config_get ()</title>
<indexterm zone="oobs-ifaces-config-get"><primary>oobs_ifaces_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_ifaces_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsIfacesConfig"><type>OobsIfacesConfig</type></link> singleton, which represents
the network interfaces and their configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsIfacesConfig"><type>OobsIfacesConfig</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-ifaces-config-get-ifaces" role="function">
<title>oobs_ifaces_config_get_ifaces ()</title>
<indexterm zone="oobs-ifaces-config-get-ifaces"><primary>oobs_ifaces_config_get_ifaces</primary></indexterm><programlisting><link linkend="OobsList">OobsList</link>* oobs_ifaces_config_get_ifaces (<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config,
<link linkend="OobsIfaceType">OobsIfaceType</link> type);</programlisting>
<para>
Returns an <link linkend="OobsList"><type>OobsList</type></link> containing the interfaces that match the
type defined by <parameter>type</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfacesConfig"><type>OobsIfacesConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceType"><type>OobsIfaceType</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link>, you must not unref this object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-ifaces-config-get-available-configuration-methods" role="function">
<title>oobs_ifaces_config_get_available_configuration_methods ()</title>
<indexterm zone="oobs-ifaces-config-get-available-configuration-methods"><primary>oobs_ifaces_config_get_available_configuration_methods</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_ifaces_config_get_available_configuration_methods
(<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config);</programlisting>
<para>
Retrieves the list of available configuration methods for ethernet
based interfaces.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceConfig"><type>OobsIfaceConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings. This must not be modified or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-ifaces-config-get-available-key-types" role="function">
<title>oobs_ifaces_config_get_available_key_types ()</title>
<indexterm zone="oobs-ifaces-config-get-available-key-types"><primary>oobs_ifaces_config_get_available_key_types</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_ifaces_config_get_available_key_types
(<link linkend="OobsIfacesConfig">OobsIfacesConfig</link> *config);</programlisting>
<para>
Retrieves the list of available key types methods for wireless
interfaces.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsIfaceConfig"><type>OobsIfaceConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of strings. This must not be modified or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
