summaryrefslogtreecommitdiff
path: root/docs/libnm-glib/html/NMIP6Config.html
blob: 2be20459995dc0d0461209cc8a1970635555c323 (plain)
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMIP6Config</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libnm-glib Reference Manual">
<link rel="up" href="ch01.html" title="libnm-glib Objects">
<link rel="prev" href="NMIP4Config.html" title="NMIP4Config">
<link rel="next" href="NMDHCP4Config.html" title="NMDHCP4Config">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="NMIP4Config.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libnm-glib Reference Manual</th>
<td><a accesskey="n" href="NMDHCP4Config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NMIP6Config.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#NMIP6Config.description" class="shortcut">Description</a>
                   | 
                  <a href="#NMIP6Config.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#NMIP6Config.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="NMIP6Config">
<a name="NMIP6Config"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMIP6Config.top_of_page"></a>NMIP6Config</span></h2>
<p>NMIP6Config</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="NMIP6Config.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="NMIP6Config.html#NMIP6Config-struct" title="NMIP6Config">NMIP6Config</a>;
                    <a class="link" href="NMIP6Config.html#NMIP6ConfigClass" title="NMIP6ConfigClass">NMIP6ConfigClass</a>;
#define             <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-ADDRESSES:CAPS" title="NM_IP6_CONFIG_ADDRESSES">NM_IP6_CONFIG_ADDRESSES</a>
#define             <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-NAMESERVERS:CAPS" title="NM_IP6_CONFIG_NAMESERVERS">NM_IP6_CONFIG_NAMESERVERS</a>
#define             <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-DOMAINS:CAPS" title="NM_IP6_CONFIG_DOMAINS">NM_IP6_CONFIG_DOMAINS</a>
#define             <a class="link" href="NMIP6Config.html#NM-IP6-CONFIG-ROUTES:CAPS" title="NM_IP6_CONFIG_ROUTES">NM_IP6_CONFIG_ROUTES</a>
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           <a class="link" href="NMIP6Config.html#nm-ip6-config-new" title="nm_ip6_config_new ()">nm_ip6_config_new</a>                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      <a class="link" href="NMIP6Config.html#nm-ip6-config-get-addresses" title="nm_ip6_config_get_addresses ()">nm_ip6_config_get_addresses</a>         (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      <a class="link" href="NMIP6Config.html#nm-ip6-config-get-nameservers" title="nm_ip6_config_get_nameservers ()">nm_ip6_config_get_nameservers</a>       (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *   <a class="link" href="NMIP6Config.html#nm-ip6-config-get-domains" title="nm_ip6_config_get_domains ()">nm_ip6_config_get_domains</a>           (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      <a class="link" href="NMIP6Config.html#nm-ip6-config-get-routes" title="nm_ip6_config_get_routes ()">nm_ip6_config_get_routes</a>            (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="NMIP6Config.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a>
         +----NMIP6Config
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="NMIP6Config.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="NMIP6Config.html#NMIP6Config--addresses" title='The "addresses" property'>addresses</a>"                <span class="type">nm-ip6-address-object-array*</span>  : Read
  "<a class="link" href="NMIP6Config.html#NMIP6Config--domains" title='The "domains" property'>domains</a>"                  <span class="type">nm-string-array*</span>      : Read
  "<a class="link" href="NMIP6Config.html#NMIP6Config--nameservers" title='The "nameservers" property'>nameservers</a>"              <span class="type">nm-ip6-address-array*</span>  : Read
  "<a class="link" href="NMIP6Config.html#NMIP6Config--routes" title='The "routes" property'>routes</a>"                   <span class="type">nm-ip6-route-object-array*</span>  : Read
</pre>
</div>
<div class="refsect1" title="Description">
<a name="NMIP6Config.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="NMIP6Config.details"></a><h2>Details</h2>
<div class="refsect2" title="NMIP6Config">
<a name="NMIP6Config-struct"></a><h3>NMIP6Config</h3>
<pre class="programlisting">typedef struct _NMIP6Config NMIP6Config;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NMIP6ConfigClass">
<a name="NMIP6ConfigClass"></a><h3>NMIP6ConfigClass</h3>
<pre class="programlisting">typedef struct {
	NMObjectClass parent;

	/* Padding for future expansion */
	void (*_reserved1) (void);
	void (*_reserved2) (void);
	void (*_reserved3) (void);
	void (*_reserved4) (void);
	void (*_reserved5) (void);
	void (*_reserved6) (void);
} NMIP6ConfigClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_IP6_CONFIG_ADDRESSES">
<a name="NM-IP6-CONFIG-ADDRESSES:CAPS"></a><h3>NM_IP6_CONFIG_ADDRESSES</h3>
<pre class="programlisting">#define NM_IP6_CONFIG_ADDRESSES "addresses"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_IP6_CONFIG_NAMESERVERS">
<a name="NM-IP6-CONFIG-NAMESERVERS:CAPS"></a><h3>NM_IP6_CONFIG_NAMESERVERS</h3>
<pre class="programlisting">#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_IP6_CONFIG_DOMAINS">
<a name="NM-IP6-CONFIG-DOMAINS:CAPS"></a><h3>NM_IP6_CONFIG_DOMAINS</h3>
<pre class="programlisting">#define NM_IP6_CONFIG_DOMAINS "domains"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="NM_IP6_CONFIG_ROUTES">
<a name="NM-IP6-CONFIG-ROUTES:CAPS"></a><h3>NM_IP6_CONFIG_ROUTES</h3>
<pre class="programlisting">#define NM_IP6_CONFIG_ROUTES "routes"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="nm_ip6_config_new ()">
<a name="nm-ip6-config-new"></a><h3>nm_ip6_config_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           nm_ip6_config_new                   (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre>
<p>
Creates a new <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the DBus object path of the device
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new IP6 configuration
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="nm_ip6_config_get_addresses ()">
<a name="nm-ip6-config-get-addresses"></a><h3>nm_ip6_config_get_addresses ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      nm_ip6_config_get_addresses         (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre>
<p>
Gets the IP6 addresses (containing the address, prefix, and gateway).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <span class="type">NMSettingIP6Address</span>es. This is the internal copy
used by the configuration and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="nm_ip6_config_get_nameservers ()">
<a name="nm-ip6-config-get-nameservers"></a><h3>nm_ip6_config_get_nameservers ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      nm_ip6_config_get_nameservers       (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre>
<p>
Gets the domain name servers (DNS).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing elements of type 'struct in6_addr' which contain
the addresses of nameservers of the configuration.  This is the internal copy
used by the configuration and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="nm_ip6_config_get_domains ()">
<a name="nm-ip6-config-get-domains"></a><h3>nm_ip6_config_get_domains ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *   nm_ip6_config_get_domains           (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre>
<p>
Gets the domain names.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domains as strings. This is the 
internal copy used by the configuration, and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="nm_ip6_config_get_routes ()">
<a name="nm-ip6-config-get-routes"></a><h3>nm_ip6_config_get_routes ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *      nm_ip6_config_get_routes            (<em class="parameter"><code><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> *config</code></em>);</pre>
<p>
Gets the routes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>a <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> containing <span class="type">NMSettingIP6Route</span>s. This is the 
internal copy used by the configuration, and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="NMIP6Config.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "addresses" property'>
<a name="NMIP6Config--addresses"></a><h3>The <code class="literal">"addresses"</code> property</h3>
<pre class="programlisting">  "addresses"                <span class="type">nm-ip6-address-object-array*</span>  : Read</pre>
<p>
The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the IPv6 addresses;  use
<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html#nm-utils-ip6-addresses-from-gvalue"><code class="function">nm_utils_ip6_addresses_from_gvalue()</code></a> to return a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
<span class="type">NMSettingIP6Address</span> objects that is more usable than the raw data.
</p>
</div>
<hr>
<div class="refsect2" title='The "domains" property'>
<a name="NMIP6Config--domains"></a><h3>The <code class="literal">"domains"</code> property</h3>
<pre class="programlisting">  "domains"                  <span class="type">nm-string-array*</span>      : Read</pre>
<p>
The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing domain strings of the configuration.
</p>
</div>
<hr>
<div class="refsect2" title='The "nameservers" property'>
<a name="NMIP6Config--nameservers"></a><h3>The <code class="literal">"nameservers"</code> property</h3>
<pre class="programlisting">  "nameservers"              <span class="type">nm-ip6-address-array*</span>  : Read</pre>
<p>
The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing elements of type 'struct ip6_addr' which
contain the addresses of nameservers of the configuration.
</p>
</div>
<hr>
<div class="refsect2" title='The "routes" property'>
<a name="NMIP6Config--routes"></a><h3>The <code class="literal">"routes"</code> property</h3>
<pre class="programlisting">  "routes"                   <span class="type">nm-ip6-route-object-array*</span>  : Read</pre>
<p>
The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing the IPv6 routes;  use
<a href="http://projects.gnome.org/NetworkManager/developers/libnm-util/08/libnm-util-nm-utils.html#nm-utils-ip6-routes-from-gvalue"><code class="function">nm_utils_ip6_routes_from_gvalue()</code></a> to return a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
<span class="type">NMSettingIP6Address</span> objects that is more usable than the raw data.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>