Debian Codegraph @

doc/reference/html/OobsHostsConfig.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>OobsHostsConfig</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="ch07.html" title="Hosts resolution management">
9 <link rel="prev" href="ch07.html" title="Hosts resolution management">
10 <link rel="next" href="OobsStaticHost.html" title="OobsStaticHost">
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="ch07.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch07.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="OobsStaticHost.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="#OobsHostsConfig.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsHostsConfig.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsHostsConfig.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry" title="OobsHostsConfig">
32 <a name="OobsHostsConfig"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="OobsHostsConfig.top_of_page"></a>OobsHostsConfig</span></h2>
36 <p>OobsHostsConfig — Object that represents hosts resolution configuration</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv" title="Synopsis">
41 <a name="OobsHostsConfig.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis"> <a class="link" href="OobsHostsConfig.html#OobsHostsConfig-struct" title="OobsHostsConfig">OobsHostsConfig</a>;
43 <a class="link" href="OobsHostsConfig.html#OobsHostsConfigClass" title="OobsHostsConfigClass">OobsHostsConfigClass</a>;
44 <a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get" title="oobs_hosts_config_get ()">oobs_hosts_config_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
45 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get-hostname" title="oobs_hosts_config_get_hostname ()">oobs_hosts_config_get_hostname</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);
46 <span class="returnvalue">void</span> <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-set-hostname" title="oobs_hosts_config_set_hostname ()">oobs_hosts_config_set_hostname</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
47 <em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);
48 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get-domainname" title="oobs_hosts_config_get_domainname ()">oobs_hosts_config_get_domainname</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-set-domainname" title="oobs_hosts_config_set_domainname ()">oobs_hosts_config_set_domainname</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
50 <em class="parameter"><code>const <span class="type">gchar</span> *domainname</code></em>);
51 <a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get-static-hosts" title="oobs_hosts_config_get_static_hosts ()">oobs_hosts_config_get_static_hosts</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);
52 <span class="returnvalue">GList</span>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get-dns-servers" title="oobs_hosts_config_get_dns_servers ()">oobs_hosts_config_get_dns_servers</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-set-dns-servers" title="oobs_hosts_config_set_dns_servers ()">oobs_hosts_config_set_dns_servers</a> (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
54 <em class="parameter"><code><span class="type">GList</span> *dns_list</code></em>);
55 <span class="returnvalue">GList</span>* <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-get-search-domains" title="oobs_hosts_config_get_search_domains ()">oobs_hosts_config_get_search_domains</a>
56 (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);
57 <span class="returnvalue">void</span> <a class="link" href="OobsHostsConfig.html#oobs-hosts-config-set-search-domains" title="oobs_hosts_config_set_search_domains ()">oobs_hosts_config_set_search_domains</a>
58 (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
59 <em class="parameter"><code><span class="type">GList</span> *search_domains_list</code></em>);
60 </pre>
61 </div>
62 <div class="refsect1" title="Object Hierarchy">
63 <a name="OobsHostsConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
64 <pre class="synopsis">
65 GObject
66 +----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a>
67 +----OobsHostsConfig
68 </pre>
69 </div>
70 <div class="refsect1" title="Description">
71 <a name="OobsHostsConfig.description"></a><h2>Description</h2>
72 </div>
73 <div class="refsect1" title="Details">
74 <a name="OobsHostsConfig.details"></a><h2>Details</h2>
75 <div class="refsect2" title="OobsHostsConfig">
76 <a name="OobsHostsConfig-struct"></a><h3>OobsHostsConfig</h3>
77 <pre class="programlisting">typedef struct _OobsHostsConfig OobsHostsConfig;</pre>
78 <p>
79 </p>
80 </div>
81 <hr>
82 <div class="refsect2" title="OobsHostsConfigClass">
83 <a name="OobsHostsConfigClass"></a><h3>OobsHostsConfigClass</h3>
84 <pre class="programlisting">typedef struct {
85 OobsObjectClass parent_class;
86
87 void (*_oobs_padding1) (void);
88 void (*_oobs_padding2) (void);
89 void (*_oobs_padding3) (void);
90 void (*_oobs_padding4) (void);
91 } OobsHostsConfigClass;
92 </pre>
93 <p>
94 </p>
95 </div>
96 <hr>
97 <div class="refsect2" title="oobs_hosts_config_get ()">
98 <a name="oobs-hosts-config-get"></a><h3>oobs_hosts_config_get ()</h3>
99 <pre class="programlisting"><a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* oobs_hosts_config_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
100 <p>
101 Returns the <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> singleton, this object
102 represents the hosts resolution configuration.
103 </p>
104 <div class="variablelist"><table border="0">
105 <col align="left" valign="top">
106 <tbody><tr>
107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
108 <td> the singleton <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
109 </td>
110 </tr></tbody>
111 </table></div>
112 </div>
113 <hr>
114 <div class="refsect2" title="oobs_hosts_config_get_hostname ()">
115 <a name="oobs-hosts-config-get-hostname"></a><h3>oobs_hosts_config_get_hostname ()</h3>
116 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_hosts_config_get_hostname (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);</pre>
117 <p>
118 Returns the hostname for the machine.
119 </p>
120 <div class="variablelist"><table border="0">
121 <col align="left" valign="top">
122 <tbody>
123 <tr>
124 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
125 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
126 </td>
127 </tr>
128 <tr>
129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
130 <td> A pointer to the hostname as a string. This
131 string must not be freed, modified or stored.
132 </td>
133 </tr>
134 </tbody>
135 </table></div>
136 </div>
137 <hr>
138 <div class="refsect2" title="oobs_hosts_config_set_hostname ()">
139 <a name="oobs-hosts-config-set-hostname"></a><h3>oobs_hosts_config_set_hostname ()</h3>
140 <pre class="programlisting"><span class="returnvalue">void</span> oobs_hosts_config_set_hostname (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
141 <em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);</pre>
142 <p>
143 Sets a new hostname, overwriting the previous one.
144 </p>
145 <div class="variablelist"><table border="0">
146 <col align="left" valign="top">
147 <tbody>
148 <tr>
149 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
150 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
151 </td>
152 </tr>
153 <tr>
154 <td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
155 <td>A new hostname.
156 </td>
157 </tr>
158 </tbody>
159 </table></div>
160 </div>
161 <hr>
162 <div class="refsect2" title="oobs_hosts_config_get_domainname ()">
163 <a name="oobs-hosts-config-get-domainname"></a><h3>oobs_hosts_config_get_domainname ()</h3>
164 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_hosts_config_get_domainname (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);</pre>
165 <p>
166 Returns the domain name for the machine.
167 </p>
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
170 <tbody>
171 <tr>
172 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
173 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
174 </td>
175 </tr>
176 <tr>
177 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
178 <td> A pointer to the domain name as a string. This
179 string must not be freed, modified or stored.
180 </td>
181 </tr>
182 </tbody>
183 </table></div>
184 </div>
185 <hr>
186 <div class="refsect2" title="oobs_hosts_config_set_domainname ()">
187 <a name="oobs-hosts-config-set-domainname"></a><h3>oobs_hosts_config_set_domainname ()</h3>
188 <pre class="programlisting"><span class="returnvalue">void</span> oobs_hosts_config_set_domainname (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
189 <em class="parameter"><code>const <span class="type">gchar</span> *domainname</code></em>);</pre>
190 <p>
191 Sets a new domain name, overwriting the previous one.
192 </p>
193 <div class="variablelist"><table border="0">
194 <col align="left" valign="top">
195 <tbody>
196 <tr>
197 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
198 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
199 </td>
200 </tr>
201 <tr>
202 <td><p><span class="term"><em class="parameter"><code>domainname</code></em> :</span></p></td>
203 <td>A new domain name.
204 </td>
205 </tr>
206 </tbody>
207 </table></div>
208 </div>
209 <hr>
210 <div class="refsect2" title="oobs_hosts_config_get_static_hosts ()">
211 <a name="oobs-hosts-config-get-static-hosts"></a><h3>oobs_hosts_config_get_static_hosts ()</h3>
212 <pre class="programlisting"><a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* oobs_hosts_config_get_static_hosts (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);</pre>
213 <p>
214 Returns an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing objects of type <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
215 </p>
216 <div class="variablelist"><table border="0">
217 <col align="left" valign="top">
218 <tbody>
219 <tr>
220 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
221 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
222 </td>
223 </tr>
224 <tr>
225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
226 <td> An <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing the static hosts configuration.
227 </td>
228 </tr>
229 </tbody>
230 </table></div>
231 </div>
232 <hr>
233 <div class="refsect2" title="oobs_hosts_config_get_dns_servers ()">
234 <a name="oobs-hosts-config-get-dns-servers"></a><h3>oobs_hosts_config_get_dns_servers ()</h3>
235 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_hosts_config_get_dns_servers (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);</pre>
236 <p>
237 Returns a <span class="type">GList</span> containing the IP addresses of the DNS servers.
238 The returned list must be freed with <code class="function">g_list_free()</code>.
239 </p>
240 <div class="variablelist"><table border="0">
241 <col align="left" valign="top">
242 <tbody>
243 <tr>
244 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
245 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
246 </td>
247 </tr>
248 <tr>
249 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250 <td> a <span class="type">GList</span> of gchar pointers
251 </td>
252 </tr>
253 </tbody>
254 </table></div>
255 </div>
256 <hr>
257 <div class="refsect2" title="oobs_hosts_config_set_dns_servers ()">
258 <a name="oobs-hosts-config-set-dns-servers"></a><h3>oobs_hosts_config_set_dns_servers ()</h3>
259 <pre class="programlisting"><span class="returnvalue">void</span> oobs_hosts_config_set_dns_servers (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
260 <em class="parameter"><code><span class="type">GList</span> *dns_list</code></em>);</pre>
261 <p>
262 Overwrites the list of DNS servers. The previous list and its contents will
263 be freed, so any merging will have to be done by hand.
264 </p>
265 <div class="variablelist"><table border="0">
266 <col align="left" valign="top">
267 <tbody>
268 <tr>
269 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
270 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
271 </td>
272 </tr>
273 <tr>
274 <td><p><span class="term"><em class="parameter"><code>dns_list</code></em> :</span></p></td>
275 <td>a <span class="type">GList</span> containing strings with the IP addresses of the DNS servers.
276 </td>
277 </tr>
278 </tbody>
279 </table></div>
280 </div>
281 <hr>
282 <div class="refsect2" title="oobs_hosts_config_get_search_domains ()">
283 <a name="oobs-hosts-config-get-search-domains"></a><h3>oobs_hosts_config_get_search_domains ()</h3>
284 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_hosts_config_get_search_domains
285 (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>);</pre>
286 <p>
287 Returns a <span class="type">GList</span> containing the search domains.
288 The returned list musts be freed with <code class="function">g_list_free()</code>.
289 </p>
290 <div class="variablelist"><table border="0">
291 <col align="left" valign="top">
292 <tbody>
293 <tr>
294 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
295 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>.
296 </td>
297 </tr>
298 <tr>
299 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
300 <td> a <span class="type">GList</span> of gchar pointers.
301 </td>
302 </tr>
303 </tbody>
304 </table></div>
305 </div>
306 <hr>
307 <div class="refsect2" title="oobs_hosts_config_set_search_domains ()">
308 <a name="oobs-hosts-config-set-search-domains"></a><h3>oobs_hosts_config_set_search_domains ()</h3>
309 <pre class="programlisting"><span class="returnvalue">void</span> oobs_hosts_config_set_search_domains
310 (<em class="parameter"><code><a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a> *config</code></em>,
311 <em class="parameter"><code><span class="type">GList</span> *search_domains_list</code></em>);</pre>
312 <p>
313 Overwrites the list of search domains. The previous list and its contents will
314 be freed, so any merging will have to be done by hand.
315 </p>
316 <div class="variablelist"><table border="0">
317 <col align="left" valign="top">
318 <tbody>
319 <tr>
320 <td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
321 <td>An <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>
322 </td>
323 </tr>
324 <tr>
325 <td><p><span class="term"><em class="parameter"><code>search_domains_list</code></em> :</span></p></td>
326 <td>a <span class="type">GList</span> containing strings with the search domains.
327 </td>
328 </tr>
329 </tbody>
330 </table></div>
331 </div>
332 </div>
333 <div class="refsect1" title="See Also">
334 <a name="OobsHostsConfig.see-also"></a><h2>See Also</h2>
335 <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>
336 </div>
337 </div>
338 <div class="footer">
339 <hr>
340 Generated by GTK-Doc V1.15</div>
341 </body>
342 </html>