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
|
<?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="OobsStaticHost">
<refmeta>
<refentrytitle role="top_of_page" id="OobsStaticHost.top_of_page">OobsStaticHost</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsStaticHost</refname>
<refpurpose>Object that represents an individual static host settings.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsStaticHost.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsStaticHost-struct">OobsStaticHost</link>;
<link linkend="OobsStaticHost">OobsStaticHost</link>* <link linkend="oobs-static-host-new">oobs_static_host_new</link> (const <link linkend="gchar">gchar</link> *ip_address,
<link linkend="GList">GList</link> *aliases);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-static-host-get-ip-address">oobs_static_host_get_ip_address</link> (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host);
<link linkend="void">void</link> <link linkend="oobs-static-host-set-ip-address">oobs_static_host_set_ip_address</link> (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host,
const <link linkend="gchar">gchar</link> *ip_address);
<link linkend="GList">GList</link>* <link linkend="oobs-static-host-get-aliases">oobs_static_host_get_aliases</link> (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host);
<link linkend="void">void</link> <link linkend="oobs-static-host-set-aliases">oobs_static_host_set_aliases</link> (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host,
<link linkend="GList">GList</link> *aliases);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsStaticHost.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsStaticHost
</synopsis>
</refsect1>
<refsect1 id="OobsStaticHost.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsStaticHost--ip-address">ip-address</link>" <link linkend="gchar">gchar</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsStaticHost.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsStaticHost.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsStaticHost-struct" role="struct">
<title>OobsStaticHost</title>
<indexterm zone="OobsStaticHost-struct"><primary>OobsStaticHost</primary></indexterm><programlisting>typedef struct _OobsStaticHost OobsStaticHost;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-static-host-new" role="function">
<title>oobs_static_host_new ()</title>
<indexterm zone="oobs-static-host-new"><primary>oobs_static_host_new</primary></indexterm><programlisting><link linkend="OobsStaticHost">OobsStaticHost</link>* oobs_static_host_new (const <link linkend="gchar">gchar</link> *ip_address,
<link linkend="GList">GList</link> *aliases);</programlisting>
<para>
Returns a new <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link> defining both the IP address
and the list of hostnames that will point to the IP address.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ip_address</parameter> :</term>
<listitem><simpara> IP address for the static host.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>aliases</parameter> :</term>
<listitem><simpara> <link linkend="GList"><type>GList</type></link> of aliases to <link linkend="ip-address"><type>ip_address</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-static-host-get-ip-address" role="function">
<title>oobs_static_host_get_ip_address ()</title>
<indexterm zone="oobs-static-host-get-ip-address"><primary>oobs_static_host_get_ip_address</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_static_host_get_ip_address (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host);</programlisting>
<para>
Returns the static host IP address.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>static_host</parameter> :</term>
<listitem><simpara> An <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the static host IP address as a string.
This string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-static-host-set-ip-address" role="function">
<title>oobs_static_host_set_ip_address ()</title>
<indexterm zone="oobs-static-host-set-ip-address"><primary>oobs_static_host_set_ip_address</primary></indexterm><programlisting><link linkend="void">void</link> oobs_static_host_set_ip_address (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host,
const <link linkend="gchar">gchar</link> *ip_address);</programlisting>
<para>
Sets the IP address of <link linkend="static-host"><type>static_host</type></link> to be <link linkend="ip-address"><type>ip_address</type></link>,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>static_host</parameter> :</term>
<listitem><simpara> An <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ip_address</parameter> :</term>
<listitem><simpara> A new IP address for <link linkend="static-host"><type>static_host</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-static-host-get-aliases" role="function">
<title>oobs_static_host_get_aliases ()</title>
<indexterm zone="oobs-static-host-get-aliases"><primary>oobs_static_host_get_aliases</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_static_host_get_aliases (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host);</programlisting>
<para>
Returns the hostname aliases for the <link linkend="static-host"><type>static_host</type></link> IP address.
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>static_host</parameter> :</term>
<listitem><simpara> An <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of gchar pointers containing the host aliases.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-static-host-set-aliases" role="function">
<title>oobs_static_host_set_aliases ()</title>
<indexterm zone="oobs-static-host-set-aliases"><primary>oobs_static_host_set_aliases</primary></indexterm><programlisting><link linkend="void">void</link> oobs_static_host_set_aliases (<link linkend="OobsStaticHost">OobsStaticHost</link> *static_host,
<link linkend="GList">GList</link> *aliases);</programlisting>
<para>
Sets a new list of aliases for the <link linkend="static-host"><type>static_host</type></link>
IP address. overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>static_host</parameter> :</term>
<listitem><simpara> An <link linkend="OobsStaticHost"><type>OobsStaticHost</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>aliases</parameter> :</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> of gchar pointers containing the host aliases.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsStaticHost.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsStaticHost--ip-address"><title>The <literal>"ip-address"</literal> property</title>
<indexterm zone="OobsStaticHost--ip-address"><primary>OobsStaticHost:ip-address</primary></indexterm><programlisting> "ip-address" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>IP address of the static host definition.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
