Debian Codegraph @

doc/reference/html/OobsIfacesConfig.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>OobsIfacesConfig</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="ch06.html" title="Network interfaces management">
10 <link rel="next" href="liboobs-Oobs.html" title="OobsIface">
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="ch06.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="liboobs-Oobs.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="#OobsIfacesConfig.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsIfacesConfig.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsIfacesConfig.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry" title="OobsIfacesConfig">
32 <a name="OobsIfacesConfig"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="OobsIfacesConfig.top_of_page"></a>OobsIfacesConfig</span></h2>
36 <p>OobsIfacesConfig — Object that represents network interfaces configuration</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv" title="Synopsis">
41 <a name="OobsIfacesConfig.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">enum <a class="link" href="OobsIfacesConfig.html#OobsIfaceType" title="enum OobsIfaceType">OobsIfaceType</a>;
43 <a class="link" href="OobsIfacesConfig.html#OobsIfacesConfig-struct" title="OobsIfacesConfig">OobsIfacesConfig</a>;
44 <a class="link" href="OobsIfacesConfig.html#OobsIfacesConfigClass" title="OobsIfacesConfigClass">OobsIfacesConfigClass</a>;
45 <span class="returnvalue">GType</span> <a class="link" href="OobsIfacesConfig.html#oobs-iface-type-get-type" title="oobs_iface_type_get_type ()">oobs_iface_type_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
46 <a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* <a class="link" href="OobsIfacesConfig.html#oobs-ifaces-config-get" title="oobs_ifaces_config_get ()">oobs_ifaces_config_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
47 <a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* <a class="link" href="OobsIfacesConfig.html#oobs-ifaces-config-get-ifaces" title="oobs_ifaces_config_get_ifaces ()">oobs_ifaces_config_get_ifaces</a> (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>,
48 <em class="parameter"><code><a class="link" href="OobsIfacesConfig.html#OobsIfaceType" title="enum OobsIfaceType"><span class="type">OobsIfaceType</span></a> type</code></em>);
49 <span class="returnvalue">GList</span>* <a class="link" href="OobsIfacesConfig.html#oobs-ifaces-config-get-available-configuration-methods" title="oobs_ifaces_config_get_available_configuration_methods ()">oobs_ifaces_config_get_available_configuration_methods</a>
50 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);
51 <span class="returnvalue">GList</span>* <a class="link" href="OobsIfacesConfig.html#oobs-ifaces-config-get-available-key-types" title="oobs_ifaces_config_get_available_key_types ()">oobs_ifaces_config_get_available_key_types</a>
52 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);
53 <span class="returnvalue">GList</span>* <a class="link" href="OobsIfacesConfig.html#oobs-ifaces-config-get-available-ppp-types" title="oobs_ifaces_config_get_available_ppp_types ()">oobs_ifaces_config_get_available_ppp_types</a>
54 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);
55 </pre>
56 </div>
57 <div class="refsect1" title="Object Hierarchy">
58 <a name="OobsIfacesConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
59 <pre class="synopsis">
60 GObject
61 +----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a>
62 +----OobsIfacesConfig
63 </pre>
64 </div>
65 <div class="refsect1" title="Description">
66 <a name="OobsIfacesConfig.description"></a><h2>Description</h2>
67 </div>
68 <div class="refsect1" title="Details">
69 <a name="OobsIfacesConfig.details"></a><h2>Details</h2>
70 <div class="refsect2" title="enum OobsIfaceType">
71 <a name="OobsIfaceType"></a><h3>enum OobsIfaceType</h3>
72 <pre class="programlisting">typedef enum {
73 OOBS_IFACE_TYPE_ETHERNET,
74 OOBS_IFACE_TYPE_WIRELESS,
75 OOBS_IFACE_TYPE_IRLAN,
76 OOBS_IFACE_TYPE_PLIP,
77 OOBS_IFACE_TYPE_PPP
78 } OobsIfaceType;
79 </pre>
80 <p>
81 </p>
82 </div>
83 <hr>
84 <div class="refsect2" title="OobsIfacesConfig">
85 <a name="OobsIfacesConfig-struct"></a><h3>OobsIfacesConfig</h3>
86 <pre class="programlisting">typedef struct _OobsIfacesConfig OobsIfacesConfig;</pre>
87 <p>
88 </p>
89 </div>
90 <hr>
91 <div class="refsect2" title="OobsIfacesConfigClass">
92 <a name="OobsIfacesConfigClass"></a><h3>OobsIfacesConfigClass</h3>
93 <pre class="programlisting">typedef struct {
94 OobsObjectClass parent_class;
95
96 void (*_oobs_padding1) (void);
97 void (*_oobs_padding2) (void);
98 void (*_oobs_padding3) (void);
99 void (*_oobs_padding4) (void);
100 } OobsIfacesConfigClass;
101 </pre>
102 <p>
103 </p>
104 </div>
105 <hr>
106 <div class="refsect2" title="oobs_iface_type_get_type ()">
107 <a name="oobs-iface-type-get-type"></a><h3>oobs_iface_type_get_type ()</h3>
108 <pre class="programlisting"><span class="returnvalue">GType</span> oobs_iface_type_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
109 <p>
110 </p>
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
113 <tbody><tr>
114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
115 <td>
116 </td>
117 </tr></tbody>
118 </table></div>
119 </div>
120 <hr>
121 <div class="refsect2" title="oobs_ifaces_config_get ()">
122 <a name="oobs-ifaces-config-get"></a><h3>oobs_ifaces_config_get ()</h3>
123 <pre class="programlisting"><a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* oobs_ifaces_config_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
124 <p>
125 Returns the <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> singleton, which represents
126 the network interfaces and their configuration.
127 </p>
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
130 <tbody><tr>
131 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132 <td> the singleton <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> object.
133 </td>
134 </tr></tbody>
135 </table></div>
136 </div>
137 <hr>
138 <div class="refsect2" title="oobs_ifaces_config_get_ifaces ()">
139 <a name="oobs-ifaces-config-get-ifaces"></a><h3>oobs_ifaces_config_get_ifaces ()</h3>
140 <pre class="programlisting"><a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* oobs_ifaces_config_get_ifaces (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>,
141 <em class="parameter"><code><a class="link" href="OobsIfacesConfig.html#OobsIfaceType" title="enum OobsIfaceType"><span class="type">OobsIfaceType</span></a> type</code></em>);</pre>
142 <p>
143 Returns an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing the interfaces that match the
144 type defined by <em class="parameter"><code>type</code></em>.
145 </p>
146 <div class="variablelist"><table border="0">
147 <col align="left" valign="top">
148 <tbody>
149 <tr>
150 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
151 <td>An <a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a>.
152 </td>
153 </tr>
154 <tr>
155 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
156 <td>An <a class="link" href="OobsIfacesConfig.html#OobsIfaceType" title="enum OobsIfaceType"><span class="type">OobsIfaceType</span></a>.
157 </td>
158 </tr>
159 <tr>
160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161 <td> An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>, you must not unref this object.
162 </td>
163 </tr>
164 </tbody>
165 </table></div>
166 </div>
167 <hr>
168 <div class="refsect2" title="oobs_ifaces_config_get_available_configuration_methods ()">
169 <a name="oobs-ifaces-config-get-available-configuration-methods"></a><h3>oobs_ifaces_config_get_available_configuration_methods ()</h3>
170 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_ifaces_config_get_available_configuration_methods
171 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);</pre>
172 <p>
173 Retrieves the list of available configuration methods for ethernet
174 based interfaces.
175 </p>
176 <div class="variablelist"><table border="0">
177 <col align="left" valign="top">
178 <tbody>
179 <tr>
180 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
181 <td>An <span class="type">OobsIfaceConfig</span>.
182 </td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
186 <td> A <span class="type">GList</span> of strings. This must not be modified or freed.
187 </td>
188 </tr>
189 </tbody>
190 </table></div>
191 </div>
192 <hr>
193 <div class="refsect2" title="oobs_ifaces_config_get_available_key_types ()">
194 <a name="oobs-ifaces-config-get-available-key-types"></a><h3>oobs_ifaces_config_get_available_key_types ()</h3>
195 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_ifaces_config_get_available_key_types
196 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);</pre>
197 <p>
198 Retrieves the list of available key types methods for wireless
199 interfaces.
200 </p>
201 <div class="variablelist"><table border="0">
202 <col align="left" valign="top">
203 <tbody>
204 <tr>
205 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
206 <td>An <span class="type">OobsIfaceConfig</span>.
207 </td>
208 </tr>
209 <tr>
210 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
211 <td> A <span class="type">GList</span> of strings. This must not be modified or freed.
212 </td>
213 </tr>
214 </tbody>
215 </table></div>
216 </div>
217 <hr>
218 <div class="refsect2" title="oobs_ifaces_config_get_available_ppp_types ()">
219 <a name="oobs-ifaces-config-get-available-ppp-types"></a><h3>oobs_ifaces_config_get_available_ppp_types ()</h3>
220 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_ifaces_config_get_available_ppp_types
221 (<em class="parameter"><code><a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig"><span class="type">OobsIfacesConfig</span></a> *config</code></em>);</pre>
222 <p>
223 Retrieves the list of available PPP interface types.
224 </p>
225 <div class="variablelist"><table border="0">
226 <col align="left" valign="top">
227 <tbody>
228 <tr>
229 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
230 <td>An <span class="type">OobsIfaceConfig</span>.
231 </td>
232 </tr>
233 <tr>
234 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
235 <td> A <span class="type">GList</span> of strings. This must not be modified or freed.
236 </td>
237 </tr>
238 </tbody>
239 </table></div>
240 </div>
241 </div>
242 <div class="refsect1" title="See Also">
243 <a name="OobsIfacesConfig.see-also"></a><h2>See Also</h2>
244 <a class="link" href="liboobs-Oobs.html#OobsIface"><span class="type">OobsIface</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>,
245 <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>
246 </div>
247 </div>
248 <div class="footer">
249 <hr>
250 Generated by GTK-Doc V1.15</div>
251 </body>
252 </html>