From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingIP6Config.html | 843 ++++++++++++++++++++++++++- 1 file changed, 814 insertions(+), 29 deletions(-) (limited to 'docs/libnm-util/html/NMSettingIP6Config.html') diff --git a/docs/libnm-util/html/NMSettingIP6Config.html b/docs/libnm-util/html/NMSettingIP6Config.html index 060c80fe..0fe4cc5b 100644 --- a/docs/libnm-util/html/NMSettingIP6Config.html +++ b/docs/libnm-util/html/NMSettingIP6Config.html @@ -35,13 +35,16 @@

NMSettingIP6Config

-

NMSettingIP6Config

+

NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties

Synopsis

-
#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
+
+#include <nm-setting-ip6-config.h>
+
+#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
 enum                NMSettingIP6ConfigError;
 #define             NM_TYPE_SETTING_IP6_CONFIG_ERROR
 #define             NM_SETTING_IP6_CONFIG_ERROR
@@ -77,11 +80,11 @@ const struct in6_addr * guint32 prefix);
 const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
 void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gw);
+                                                         const struct in6_addr *gateway);
 typedef             NMIP6Route;
 GType               nm_ip6_route_get_type               (void);
 NMIP6Route *            nm_ip6_route_new                (void);
-NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *route);
+NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *source);
 void                nm_ip6_route_ref                    (NMIP6Route *route);
 void                nm_ip6_route_unref                  (NMIP6Route *route);
 gboolean            nm_ip6_route_compare                (NMIP6Route *route,
@@ -192,6 +195,8 @@ const char *            
 
Description

 

+The NMSettingIP6Config object is a NMSetting subclass that describes
+properties related to IPv6 addressing, routing, and Domain Name Service
@@ -206,16 +211,40 @@ const char *

enum NMSettingIP6ConfigError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN = 0,
 	NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY,
 	NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY,
 	NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
 } NMSettingIP6ConfigError;
 

-

-

+

++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
the property's value is
+not valid with the given IPv6 method
+
@@ -238,7 +267,15 @@ const char *

nm_setting_ip6_config_error_quark ()

GQuark              nm_setting_ip6_config_error_quark   (void);

+Registers an error quark for NMSettingIP6Config if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingIP6Config errors.
@@ -318,6 +355,8 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_IGNORE "ignore"

+IPv6 is not required or is handled by some other mechanism, and NetworkManager +should not configure IPv6 for this connection.

@@ -326,6 +365,9 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_AUTO "auto"

+IPv6 configuration should be automatically determined via a method appropriate +for the hardware interface, ie router advertisements, DHCP, or PPP or some +other device-specific manner.

@@ -334,6 +376,8 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_DHCP "dhcp"

+IPv6 configuration should be automatically determined via DHCPv6 only and +router advertisements should be ignored.

@@ -342,6 +386,8 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"

+IPv6 configuration should be automatically configured for link-local-only +operation.

@@ -350,6 +396,8 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_MANUAL "manual"

+All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.

@@ -358,6 +406,13 @@ const char * #define NM_SETTING_IP6_CONFIG_METHOD_SHARED "shared"

+This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and router +advertisements, a caching DNS server, and Network Address Translation (NAT) +functionality will be started on this connection's interface to allow other +devices to connect through that interface to the default network. (not yet +supported for IPv6)

@@ -380,28 +435,71 @@ const char *

nm_ip6_address_new ()

NMIP6Address *          nm_ip6_address_new              (void);

+Creates and returns a new NMIP6Address object.

+
++ + + + +

Returns :

the new empty NMIP6Address object. [transfer full] +

nm_ip6_address_dup ()

NMIP6Address *          nm_ip6_address_dup              (NMIP6Address *source);

+Copies a given NMIP6Address object and returns the copy.

+
++ + + + + + + + + + +

source :

the NMIP6Address object to copy

Returns :

the copy of the given NMIP6Address copy. [transfer full] +

nm_ip6_address_ref ()

void                nm_ip6_address_ref                  (NMIP6Address *address);

+Increases the reference count of the object.

+
++ + + + +

address :

the NMIP6Address +

nm_ip6_address_unref ()

void                nm_ip6_address_unref                (NMIP6Address *address);

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
++ + + + +

address :

the NMIP6Address +
@@ -409,14 +507,50 @@ const char * gboolean nm_ip6_address_compare (NMIP6Address *address, NMIP6Address *other);

+Determines if two NMIP6Address objects contain the same values.

+
++ + + + + + + + + + + + + + +

address :

the NMIP6Address +

other :

the NMIP6Address to compare address to.

Returns :

 +TRUE if the objects contain the same values, FALSE if they do not.

nm_ip6_address_get_address ()

const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);

+Gets the IPv6 address property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

Returns :

the IPv6 address. [transfer none] +
@@ -424,14 +558,44 @@ const char * void nm_ip6_address_set_address (NMIP6Address *address, const struct in6_addr *addr);

+Sets the IPv6 address property of this object.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

addr :

the IPv6 address

nm_ip6_address_get_prefix ()

guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);

+Gets the IPv6 address prefix property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

Returns :

the IPv6 address prefix
@@ -439,22 +603,68 @@ const char * void nm_ip6_address_set_prefix (NMIP6Address *address, guint32 prefix);

+Sets the IPv6 address prefix.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

prefix :

the address prefix, a number between 0 and 128 inclusive

nm_ip6_address_get_gateway ()

const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);

+Gets the IPv6 default gateway property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

Returns :

the IPv6 gateway address. [transfer none] +

nm_ip6_address_set_gateway ()

void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gw);
+ const struct in6_addr *gateway);

+Sets the IPv6 default gateway property of this address object.

+
++ + + + + + + + + + +

address :

the NMIP6Address +

gateway :

the IPv6 default gateway
@@ -476,28 +686,71 @@ const char *

nm_ip6_route_new ()

NMIP6Route *            nm_ip6_route_new                (void);

+Creates and returns a new NMIP6Route object.

+
++ + + + +

Returns :

the new empty NMIP6Route object. [transfer full] +

nm_ip6_route_dup ()

-
NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *route);
+
NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *source);

+Copies a given NMIP6Route object and returns the copy.

+
++ + + + + + + + + + +

source :

the NMIP6Route object to copy

Returns :

the copy of the given NMIP6Route copy. [transfer full] +

nm_ip6_route_ref ()

void                nm_ip6_route_ref                    (NMIP6Route *route);

+Increases the reference count of the object.

+
++ + + + +

route :

the NMIP6Route +

nm_ip6_route_unref ()

void                nm_ip6_route_unref                  (NMIP6Route *route);

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
++ + + + +

route :

the NMIP6Route +
@@ -505,14 +758,49 @@ const char * gboolean nm_ip6_route_compare (NMIP6Route *route, NMIP6Route *other);

+Determines if two NMIP6Route objects contain the same values.

+
++ + + + + + + + + + + + + + +

route :

the NMIP6Route +

other :

the NMIP6Route to compare route to.

Returns :

 +TRUE if the objects contain the same values, FALSE if they do not.

nm_ip6_route_get_dest ()

const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);

+Gets the IPv6 destination address property of this route object.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

Returns :

the IPv6 address
@@ -520,14 +808,44 @@ const char * void nm_ip6_route_set_dest (NMIP6Route *route, const struct in6_addr *dest);

+Sets the IPv6 destination address property of this route object.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

dest :

the destination address

nm_ip6_route_get_prefix ()

guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);

+Gets the IPv6 prefix (ie "32" or "64" etc) of this route.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

Returns :

the IPv6 prefix
@@ -535,14 +853,44 @@ const char * void nm_ip6_route_set_prefix (NMIP6Route *route, guint32 prefix);

+Sets the IPv6 prefix of this route.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

prefix :

the prefix, a number between 1 and 128 inclusive

nm_ip6_route_get_next_hop ()

const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);

+Gets the IPv6 address of the next hop of this route.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

Returns :

the IPv6 address
@@ -550,14 +898,45 @@ const char * void nm_ip6_route_set_next_hop (NMIP6Route *route, const struct in6_addr *next_hop);

+Sets the IPv6 address of the next hop of this route.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

next_hop :

the IPv6 address of the next hop

nm_ip6_route_get_metric ()

guint32             nm_ip6_route_get_metric             (NMIP6Route *route);

+Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

Returns :

the route metric
@@ -565,7 +944,23 @@ const char * void nm_ip6_route_set_metric (NMIP6Route *route, guint32 metric);

+Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

+
++ + + + + + + + + + +

route :

the NMIP6Route +

metric :

the route metric
@@ -602,30 +997,80 @@ const char *

nm_setting_ip6_config_new ()

NMSetting *             nm_setting_ip6_config_new       (void);

+Creates a new NMSettingIP6Config object with default values.

+
++ + + + +

Returns :

the new empty NMSettingIP6Config object. [transfer full] +

nm_setting_ip6_config_get_method ()

const char *            nm_setting_ip6_config_get_method
                                                         (NMSettingIP6Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

the "method" property of the setting

nm_setting_ip6_config_get_num_dns ()

guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

the number of configured DNS servers

nm_setting_ip6_config_get_dns ()

const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the DNS server to return

Returns :

the IPv6 address of the DNS server at index i. [transfer none] +
@@ -633,7 +1078,28 @@ const char * gboolean nm_setting_ip6_config_add_dns (NMSettingIP6Config *setting, const struct in6_addr *dns);

+Adds a new DNS server to the setting.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

dns :

the IPv6 address of the DNS server to add

Returns :

 +TRUE if the DNS server was added; FALSE if the server was already +known
@@ -641,22 +1107,58 @@ const char * void nm_setting_ip6_config_remove_dns (NMSettingIP6Config *setting, guint32 i);

+Removes the DNS server at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the DNS server to remove

nm_setting_ip6_config_clear_dns ()

void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);

+Removes all configured DNS servers.

+
++ + + + +

setting :

the NMSettingIP6Config +

nm_setting_ip6_config_get_num_dns_searches ()

guint32             nm_setting_ip6_config_get_num_dns_searches
                                                         (NMSettingIP6Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

the number of configured DNS search domains
@@ -664,8 +1166,25 @@ const char * const char * nm_setting_ip6_config_get_dns_search (NMSettingIP6Config *setting, guint32 i); -

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i +
@@ -674,7 +1193,28 @@ const char * NMSettingIP6Config *setting, const char *dns_search);

+Adds a new DNS search domain to the setting.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

dns_search :

the search domain to add

Returns :

 +TRUE if the DNS search domain was added; FALSE if the search +domain was already known
@@ -683,7 +1223,22 @@ const char * NMSettingIP6Config *setting, guint32 i);

+Removes the DNS search domain at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the DNS search domain
@@ -691,15 +1246,36 @@ const char * void nm_setting_ip6_config_clear_dns_searches (NMSettingIP6Config *setting);

+Removes all configured DNS search domains.

+
++ + + + +

setting :

the NMSettingIP6Config +

nm_setting_ip6_config_get_num_addresses ()

guint32             nm_setting_ip6_config_get_num_addresses
                                                         (NMSettingIP6Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

the number of configured addresses
@@ -707,8 +1283,25 @@ const char * NMIP6Address * nm_setting_ip6_config_get_address (NMSettingIP6Config *setting, guint32 i); -

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the address to return

Returns :

the address at index i +
@@ -716,7 +1309,29 @@ const char * gboolean nm_setting_ip6_config_add_address (NMSettingIP6Config *setting, NMIP6Address *address);

+Adds a new IPv6 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

address :

the new address to add

Returns :

 +TRUE if the address was added; FALSE if the address was already +known.
@@ -725,7 +1340,22 @@ const char * NMSettingIP6Config *setting, guint32 i);

+Removes the address at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the address to remove
@@ -733,23 +1363,61 @@ const char * void nm_setting_ip6_config_clear_addresses (NMSettingIP6Config *setting);

+Removes all configured addresses.

+
++ + + + +

setting :

the NMSettingIP6Config +

nm_setting_ip6_config_get_num_routes ()

guint32             nm_setting_ip6_config_get_num_routes
                                                         (NMSettingIP6Config *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

the number of configured routes

nm_setting_ip6_config_get_route ()

NMIP6Route *            nm_setting_ip6_config_get_route (NMSettingIP6Config *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the route to return

Returns :

the route at index i +
@@ -757,7 +1425,28 @@ const char * gboolean nm_setting_ip6_config_add_route (NMSettingIP6Config *setting, NMIP6Route *route);

+Adds a new IPv6 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingIP6Config +

route :

the route to add

Returns :

 +TRUE if the route was added; FALSE if the route was already known.
@@ -765,14 +1454,38 @@ const char * void nm_setting_ip6_config_remove_route (NMSettingIP6Config *setting, guint32 i);

+Removes the route at index i.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

i :

index number of the route

nm_setting_ip6_config_clear_routes ()

void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);

+Removes all configured routes.

+
++ + + + +

setting :

the NMSettingIP6Config +
@@ -780,7 +1493,25 @@ const char * gboolean nm_setting_ip6_config_get_ignore_auto_routes (NMSettingIP6Config *setting);

+Returns the value contained in the "ignore-auto-routes" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

 +TRUE if automatically configured (ie via DHCP) routes should be +ignored.
@@ -788,7 +1519,25 @@ const char * gboolean nm_setting_ip6_config_get_ignore_auto_dns (NMSettingIP6Config *setting);

+Returns the value contained in the "ignore-auto-dns" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

 +TRUE if automatically configured (ie via DHCP or router +advertisements) DNS information should be ignored.
@@ -796,14 +1545,50 @@ const char * gboolean nm_setting_ip6_config_get_never_default (NMSettingIP6Config *setting);

+Returns the value contained in the "never-default" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

 +TRUE if this connection should never be the default connection +for IPv6 addressing

nm_setting_ip6_config_get_may_fail ()

gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);

+Returns the value contained in the "may-fail" +property.

+
++ + + + + + + + + + +

setting :

the NMSettingIP6Config +

Returns :

 +TRUE if this connection doesn't require IPv6 addressing to complete +for the connection to succeed.
@@ -886,7 +1671,7 @@ example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.

-

Default value: FALSE

+

Default value: TRUE

-- cgit 1.3.0-6-gf8a5