Debian Codegraph @

doc/reference/html/OobsStaticHost.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>OobsStaticHost</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="OobsHostsConfig.html" title="OobsHostsConfig">
10 <meta name="generator" content="GTK-Doc V1.15 (XML mode)">
11 <link rel="stylesheet" href="style.css" type="text/css">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
15 <tr valign="middle">
16 <td><a accesskey="p" href="OobsHostsConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
17 <td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
19 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
20 <td> </td>
21 </tr>
22 <tr><td colspan="5" class="shortcuts">
23 <a href="#OobsStaticHost.synopsis" class="shortcut">Top</a>
24  | 
25 <a href="#OobsStaticHost.description" class="shortcut">Description</a>
26  | 
27 <a href="#OobsStaticHost.object-hierarchy" class="shortcut">Object Hierarchy</a>
28  | 
29 <a href="#OobsStaticHost.properties" class="shortcut">Properties</a>
30 </td></tr>
31 </table>
32 <div class="refentry" title="OobsStaticHost">
33 <a name="OobsStaticHost"></a><div class="titlepage"></div>
34 <div class="refnamediv"><table width="100%"><tr>
35 <td valign="top">
36 <h2><span class="refentrytitle"><a name="OobsStaticHost.top_of_page"></a>OobsStaticHost</span></h2>
37 <p>OobsStaticHost — Object that represents an individual static host settings</p>
38 </td>
39 <td valign="top" align="right"></td>
40 </tr></table></div>
41 <div class="refsynopsisdiv" title="Synopsis">
42 <a name="OobsStaticHost.synopsis"></a><h2>Synopsis</h2>
43 <pre class="synopsis"> <a class="link" href="OobsStaticHost.html#OobsStaticHost-struct" title="OobsStaticHost">OobsStaticHost</a>;
44 <a class="link" href="OobsStaticHost.html#OobsStaticHostClass" title="OobsStaticHostClass">OobsStaticHostClass</a>;
45 <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="returnvalue">OobsStaticHost</span></a>* <a class="link" href="OobsStaticHost.html#oobs-static-host-new" title="oobs_static_host_new ()">oobs_static_host_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *ip_address</code></em>,
46 <em class="parameter"><code><span class="type">GList</span> *aliases</code></em>);
47 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsStaticHost.html#oobs-static-host-get-ip-address" title="oobs_static_host_get_ip_address ()">oobs_static_host_get_ip_address</a> (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>);
48 <span class="returnvalue">void</span> <a class="link" href="OobsStaticHost.html#oobs-static-host-set-ip-address" title="oobs_static_host_set_ip_address ()">oobs_static_host_set_ip_address</a> (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>,
49 <em class="parameter"><code>const <span class="type">gchar</span> *ip_address</code></em>);
50 <span class="returnvalue">GList</span>* <a class="link" href="OobsStaticHost.html#oobs-static-host-get-aliases" title="oobs_static_host_get_aliases ()">oobs_static_host_get_aliases</a> (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>);
51 <span class="returnvalue">void</span> <a class="link" href="OobsStaticHost.html#oobs-static-host-set-aliases" title="oobs_static_host_set_aliases ()">oobs_static_host_set_aliases</a> (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>,
52 <em class="parameter"><code><span class="type">GList</span> *aliases</code></em>);
53 </pre>
54 </div>
55 <div class="refsect1" title="Object Hierarchy">
56 <a name="OobsStaticHost.object-hierarchy"></a><h2>Object Hierarchy</h2>
57 <pre class="synopsis">
58 GObject
59 +----OobsStaticHost
60 </pre>
61 </div>
62 <div class="refsect1" title="Properties">
63 <a name="OobsStaticHost.properties"></a><h2>Properties</h2>
64 <pre class="synopsis">
65 "<a class="link" href="OobsStaticHost.html#OobsStaticHost--ip-address" title='The "ip-address" property'>ip-address</a>" <span class="type">gchar</span>* : Read / Write
66 </pre>
67 </div>
68 <div class="refsect1" title="Description">
69 <a name="OobsStaticHost.description"></a><h2>Description</h2>
70 </div>
71 <div class="refsect1" title="Details">
72 <a name="OobsStaticHost.details"></a><h2>Details</h2>
73 <div class="refsect2" title="OobsStaticHost">
74 <a name="OobsStaticHost-struct"></a><h3>OobsStaticHost</h3>
75 <pre class="programlisting">typedef struct _OobsStaticHost OobsStaticHost;</pre>
76 <p>
77 </p>
78 </div>
79 <hr>
80 <div class="refsect2" title="OobsStaticHostClass">
81 <a name="OobsStaticHostClass"></a><h3>OobsStaticHostClass</h3>
82 <pre class="programlisting">typedef struct {
83 GObjectClass parent_class;
84
85 void (*_oobs_padding1) (void);
86 void (*_oobs_padding2) (void);
87 } OobsStaticHostClass;
88 </pre>
89 <p>
90 </p>
91 </div>
92 <hr>
93 <div class="refsect2" title="oobs_static_host_new ()">
94 <a name="oobs-static-host-new"></a><h3>oobs_static_host_new ()</h3>
95 <pre class="programlisting"><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="returnvalue">OobsStaticHost</span></a>* oobs_static_host_new (<em class="parameter"><code>const <span class="type">gchar</span> *ip_address</code></em>,
96 <em class="parameter"><code><span class="type">GList</span> *aliases</code></em>);</pre>
97 <p>
98 Returns a new <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> defining both the IP address
99 and the list of hostnames that will point to the IP address.
100 </p>
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
103 <tbody>
104 <tr>
105 <td><p><span class="term"><em class="parameter"><code>ip_address</code></em> :</span></p></td>
106 <td>IP address for the static host.
107 </td>
108 </tr>
109 <tr>
110 <td><p><span class="term"><em class="parameter"><code>aliases</code></em> :</span></p></td>
111 <td>
112 <span class="type">GList</span> of aliases to <span class="type">ip_address</span>.
113 </td>
114 </tr>
115 <tr>
116 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
117 <td> A new <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
118 </td>
119 </tr>
120 </tbody>
121 </table></div>
122 </div>
123 <hr>
124 <div class="refsect2" title="oobs_static_host_get_ip_address ()">
125 <a name="oobs-static-host-get-ip-address"></a><h3>oobs_static_host_get_ip_address ()</h3>
126 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_static_host_get_ip_address (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>);</pre>
127 <p>
128 Returns the static host IP address.
129 </p>
130 <div class="variablelist"><table border="0">
131 <col align="left" valign="top">
132 <tbody>
133 <tr>
134 <td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
135 <td>An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
136 </td>
137 </tr>
138 <tr>
139 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
140 <td> A pointer to the static host IP address as a string.
141 This string must not be freed, modified or stored.
142 </td>
143 </tr>
144 </tbody>
145 </table></div>
146 </div>
147 <hr>
148 <div class="refsect2" title="oobs_static_host_set_ip_address ()">
149 <a name="oobs-static-host-set-ip-address"></a><h3>oobs_static_host_set_ip_address ()</h3>
150 <pre class="programlisting"><span class="returnvalue">void</span> oobs_static_host_set_ip_address (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>,
151 <em class="parameter"><code>const <span class="type">gchar</span> *ip_address</code></em>);</pre>
152 <p>
153 Sets the IP address of <span class="type">static_host</span> to be <span class="type">ip_address</span>,
154 overwriting the previous one.
155 </p>
156 <div class="variablelist"><table border="0">
157 <col align="left" valign="top">
158 <tbody>
159 <tr>
160 <td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
161 <td>An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
162 </td>
163 </tr>
164 <tr>
165 <td><p><span class="term"><em class="parameter"><code>ip_address</code></em> :</span></p></td>
166 <td>A new IP address for <span class="type">static_host</span>
167 </td>
168 </tr>
169 </tbody>
170 </table></div>
171 </div>
172 <hr>
173 <div class="refsect2" title="oobs_static_host_get_aliases ()">
174 <a name="oobs-static-host-get-aliases"></a><h3>oobs_static_host_get_aliases ()</h3>
175 <pre class="programlisting"><span class="returnvalue">GList</span>* oobs_static_host_get_aliases (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>);</pre>
176 <p>
177 Returns the hostname aliases for the <span class="type">static_host</span> IP address.
178 The returned list must be freed with <code class="function">g_list_free()</code>.
179 </p>
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
182 <tbody>
183 <tr>
184 <td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
185 <td>An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
186 </td>
187 </tr>
188 <tr>
189 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
190 <td> A <span class="type">GList</span> of gchar pointers containing the host aliases.
191 </td>
192 </tr>
193 </tbody>
194 </table></div>
195 </div>
196 <hr>
197 <div class="refsect2" title="oobs_static_host_set_aliases ()">
198 <a name="oobs-static-host-set-aliases"></a><h3>oobs_static_host_set_aliases ()</h3>
199 <pre class="programlisting"><span class="returnvalue">void</span> oobs_static_host_set_aliases (<em class="parameter"><code><a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> *static_host</code></em>,
200 <em class="parameter"><code><span class="type">GList</span> *aliases</code></em>);</pre>
201 <p>
202 Sets a new list of aliases for the <span class="type">static_host</span>
203 IP address. overwriting the previous one.
204 </p>
205 <div class="variablelist"><table border="0">
206 <col align="left" valign="top">
207 <tbody>
208 <tr>
209 <td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
210 <td>An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
211 </td>
212 </tr>
213 <tr>
214 <td><p><span class="term"><em class="parameter"><code>aliases</code></em> :</span></p></td>
215 <td>a <span class="type">GList</span> of gchar pointers containing the host aliases.
216 </td>
217 </tr>
218 </tbody>
219 </table></div>
220 </div>
221 </div>
222 <div class="refsect1" title="Property Details">
223 <a name="OobsStaticHost.property-details"></a><h2>Property Details</h2>
224 <div class="refsect2" title='The "ip-address" property'>
225 <a name="OobsStaticHost--ip-address"></a><h3>The <code class="literal">"ip-address"</code> property</h3>
226 <pre class="programlisting"> "ip-address" <span class="type">gchar</span>* : Read / Write</pre>
227 <p>IP address of the static host definition.</p>
228 <p>Default value: NULL</p>
229 </div>
230 </div>
231 <div class="refsect1" title="See Also">
232 <a name="OobsStaticHost.see-also"></a><h2>See Also</h2>
233 <a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig"><span class="type">OobsHostsConfig</span></a>
234 </div>
235 </div>
236 <div class="footer">
237 <hr>
238 Generated by GTK-Doc V1.15</div>
239 </body>
240 </html>