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
|
<?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="liboobs-OobsHostsConfig">
<refmeta>
<refentrytitle role="top_of_page" id="liboobs-OobsHostsConfig.top_of_page">OobsHostsConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsHostsConfig</refname>
<refpurpose>Object that represents hosts resolution configuration.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="liboobs-OobsHostsConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsHostsConfig">OobsHostsConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-hosts-config-get">oobs_hosts_config_get</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-hosts-config-get-hostname">oobs_hosts_config_get_hostname</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-hosts-config-set-hostname">oobs_hosts_config_set_hostname</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
const <link linkend="gchar">gchar</link> *hostname);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-hosts-config-get-domainname">oobs_hosts_config_get_domainname</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-hosts-config-set-domainname">oobs_hosts_config_set_domainname</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
const <link linkend="gchar">gchar</link> *domainname);
<link linkend="OobsList">OobsList</link>* <link linkend="oobs-hosts-config-get-static-hosts">oobs_hosts_config_get_static_hosts</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);
<link linkend="GList">GList</link>* <link linkend="oobs-hosts-config-get-dns-servers">oobs_hosts_config_get_dns_servers</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-hosts-config-set-dns-servers">oobs_hosts_config_set_dns_servers</link> (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
<link linkend="GList">GList</link> *dns_list);
<link linkend="GList">GList</link>* <link linkend="oobs-hosts-config-get-search-domains">oobs_hosts_config_get_search_domains</link>
(<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-hosts-config-set-search-domains">oobs_hosts_config_set_search_domains</link>
(<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
<link linkend="GList">GList</link> *search_domains_list);
</synopsis>
</refsynopsisdiv>
<refsect1 id="liboobs-OobsHostsConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="liboobs-OobsHostsConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsHostsConfig" role="struct">
<title>OobsHostsConfig</title>
<indexterm zone="OobsHostsConfig"><primary>OobsHostsConfig</primary></indexterm><programlisting>typedef struct {
OobsObject parent;
} OobsHostsConfig;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-hosts-config-get" role="function">
<title>oobs_hosts_config_get ()</title>
<indexterm zone="oobs-hosts-config-get"><primary>oobs_hosts_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_hosts_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link> singleton, this object
represents the hosts resolution configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-get-hostname" role="function">
<title>oobs_hosts_config_get_hostname ()</title>
<indexterm zone="oobs-hosts-config-get-hostname"><primary>oobs_hosts_config_get_hostname</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_hosts_config_get_hostname (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);</programlisting>
<para>
Returns the hostname for the machine.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the hostname as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-set-hostname" role="function">
<title>oobs_hosts_config_set_hostname ()</title>
<indexterm zone="oobs-hosts-config-set-hostname"><primary>oobs_hosts_config_set_hostname</primary></indexterm><programlisting><link linkend="void">void</link> oobs_hosts_config_set_hostname (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
const <link linkend="gchar">gchar</link> *hostname);</programlisting>
<para>
Sets a new hostname, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hostname</parameter> :</term>
<listitem><simpara> A new hostname.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-get-domainname" role="function">
<title>oobs_hosts_config_get_domainname ()</title>
<indexterm zone="oobs-hosts-config-get-domainname"><primary>oobs_hosts_config_get_domainname</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_hosts_config_get_domainname (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);</programlisting>
<para>
Returns the domain name for the machine.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the domain name as a string. This
string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-set-domainname" role="function">
<title>oobs_hosts_config_set_domainname ()</title>
<indexterm zone="oobs-hosts-config-set-domainname"><primary>oobs_hosts_config_set_domainname</primary></indexterm><programlisting><link linkend="void">void</link> oobs_hosts_config_set_domainname (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
const <link linkend="gchar">gchar</link> *domainname);</programlisting>
<para>
Sets a new domain name, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domainname</parameter> :</term>
<listitem><simpara> A new domain name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-get-static-hosts" role="function">
<title>oobs_hosts_config_get_static_hosts ()</title>
<indexterm zone="oobs-hosts-config-get-static-hosts"><primary>oobs_hosts_config_get_static_hosts</primary></indexterm><programlisting><link linkend="OobsList">OobsList</link>* oobs_hosts_config_get_static_hosts (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);</programlisting>
<para>
Returns an <link linkend="OobsList"><type>OobsList</type></link> containing objects of type <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsList"><type>OobsList</type></link> containing the static hosts configuration.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-get-dns-servers" role="function">
<title>oobs_hosts_config_get_dns_servers ()</title>
<indexterm zone="oobs-hosts-config-get-dns-servers"><primary>oobs_hosts_config_get_dns_servers</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_hosts_config_get_dns_servers (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);</programlisting>
<para>
Returns a <link linkend="GList"><type>GList</type></link> containing the IP addresses of the DNS servers.
The returned list must be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of gchar pointers
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-set-dns-servers" role="function">
<title>oobs_hosts_config_set_dns_servers ()</title>
<indexterm zone="oobs-hosts-config-set-dns-servers"><primary>oobs_hosts_config_set_dns_servers</primary></indexterm><programlisting><link linkend="void">void</link> oobs_hosts_config_set_dns_servers (<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
<link linkend="GList">GList</link> *dns_list);</programlisting>
<para>
Overwrites the list of DNS servers. The previous list and its contents will
be freed, so any merging will have to be done by hand.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dns_list</parameter> :</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> containing strings with the IP addresses of the DNS servers.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-get-search-domains" role="function">
<title>oobs_hosts_config_get_search_domains ()</title>
<indexterm zone="oobs-hosts-config-get-search-domains"><primary>oobs_hosts_config_get_search_domains</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_hosts_config_get_search_domains
(<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config);</programlisting>
<para>
Returns a <link linkend="GList"><type>GList</type></link> containing the search domains.
The returned list musts be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of gchar pointers.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-hosts-config-set-search-domains" role="function">
<title>oobs_hosts_config_set_search_domains ()</title>
<indexterm zone="oobs-hosts-config-set-search-domains"><primary>oobs_hosts_config_set_search_domains</primary></indexterm><programlisting><link linkend="void">void</link> oobs_hosts_config_set_search_domains
(<link linkend="OobsHostsConfig">OobsHostsConfig</link> *config,
<link linkend="GList">GList</link> *search_domains_list);</programlisting>
<para>
Overwrites the list of search domains. The previous list and its contents will
be freed, so any merging will have to be done by hand.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsHostsConfig"><type>OobsHostsConfig</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>search_domains_list</parameter> :</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> containing strings with the search domains.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
