From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-glib/html/NMIP6Config.html | 784 +++++++++++++++++++--------------- 1 file changed, 440 insertions(+), 344 deletions(-) (limited to 'docs/libnm-glib/html/NMIP6Config.html') diff --git a/docs/libnm-glib/html/NMIP6Config.html b/docs/libnm-glib/html/NMIP6Config.html index d923c6f7..83f5f473 100644 --- a/docs/libnm-glib/html/NMIP6Config.html +++ b/docs/libnm-glib/html/NMIP6Config.html @@ -2,36 +2,28 @@ -NMIP6Config +libnm-glib Reference Manual: NMIP6Config - + - - - - - - - - - - + + + + + + +
@@ -39,450 +31,554 @@

NMIP6Config

NMIP6Config

- +
-
-

Synopsis

-
                    NMIP6Config;
-                    NMIP6ConfigClass;
-#define             NM_IP6_CONFIG_GATEWAY
-#define             NM_IP6_CONFIG_ADDRESSES
-#define             NM_IP6_CONFIG_ROUTES
-#define             NM_IP6_CONFIG_NAMESERVERS
-#define             NM_IP6_CONFIG_DOMAINS
-#define             NM_IP6_CONFIG_SEARCHES
-GObject *           nm_ip6_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);
-const char *        nm_ip6_config_get_gateway           (NMIP6Config *config);
-const GSList *      nm_ip6_config_get_addresses         (NMIP6Config *config);
-const GSList *      nm_ip6_config_get_routes            (NMIP6Config *config);
-guint32             nm_ip6_config_get_num_nameservers   (NMIP6Config *config);
-const struct in6_addr * nm_ip6_config_get_nameserver    (NMIP6Config *config,
-                                                         guint32 idx);
-const GSList *      nm_ip6_config_get_nameservers       (NMIP6Config *config);
-const GPtrArray *   nm_ip6_config_get_domains           (NMIP6Config *config);
-const GPtrArray *   nm_ip6_config_get_searches          (NMIP6Config *config);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMIP6Config
-
-
-
-

Implemented Interfaces

-

-NMIP6Config implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "addresses"                NMIP6AddressObjectArray*  : Read
-  "domains"                  NMStringArray*        : Read
-  "gateway"                  gchar*                : Read
-  "nameservers"              NMIP6AddressArray*    : Read
-  "routes"                   NMIP6RouteObjectArray*  : Read
-  "searches"                 NMStringArray*        : Read
-
-
-
-

Description

-

-

-
-

Details

-
-

NMIP6Config

-
typedef struct _NMIP6Config NMIP6Config;
-

-

-
-
-
-

NMIP6ConfigClass

-
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;
-
-

-

-
-
-
-

NM_IP6_CONFIG_GATEWAY

-
#define NM_IP6_CONFIG_GATEWAY "gateway"
-
-

-

-
-
-
-

NM_IP6_CONFIG_ADDRESSES

-
#define NM_IP6_CONFIG_ADDRESSES "addresses"
-
-

-

-
-
-
-

NM_IP6_CONFIG_ROUTES

-
#define NM_IP6_CONFIG_ROUTES "routes"
-
-

-

-
-
-
-

NM_IP6_CONFIG_NAMESERVERS

-
#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
-
-

-

-
-
-
-

NM_IP6_CONFIG_DOMAINS

-
#define NM_IP6_CONFIG_DOMAINS "domains"
-
-

-

-
-
-
-

NM_IP6_CONFIG_SEARCHES

-
#define NM_IP6_CONFIG_SEARCHES "searches"
-
-

-

-
-
-
-

nm_ip6_config_new ()

-
GObject *           nm_ip6_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);
-

-Creates a new NMIP6Config. -

-
+

Functions

+
--++ - - + + + + + + + + + + + + + + + + + - - + + - - + + + + + + + + +

connection :

the DBusGConnection + +GObject * + +nm_ip6_config_new () +
const char * + +nm_ip6_config_get_gateway () +
const GSList * + +nm_ip6_config_get_addresses () +
const GSList * + +nm_ip6_config_get_routes () +
+guint32 + +nm_ip6_config_get_num_nameservers ()

object_path :

the DBus object path of the deviceconst struct in6_addr * + +nm_ip6_config_get_nameserver () +

Returns :

a new IP6 configuration. [transfer full] +const GSList * + +nm_ip6_config_get_nameservers () +
const GPtrArray * + +nm_ip6_config_get_domains () +
const GPtrArray * + +nm_ip6_config_get_searches ()
-
-
-

nm_ip6_config_get_gateway ()

-
const char *        nm_ip6_config_get_gateway           (NMIP6Config *config);
-

-Gets the IP6 gateway. -

-
+
+

Properties

+
--+++ - - + + + + + + + + + + + + + + + + + + + + + + + - - + + +

config :

a NMIP6Config - +NMIP6AddressObjectArray *addressesRead
+NMStringArray *domainsRead
+gchar *gatewayRead
+NMIP6AddressArray *nameserversRead
+NMIP6RouteObjectArray *routesRead

Returns :

the IPv6 gateway of the configuration. +NMStringArray *searchesRead
-

Since 0.9.10

-
-
-

nm_ip6_config_get_addresses ()

-
const GSList *      nm_ip6_config_get_addresses         (NMIP6Config *config);
-

-Gets the IP6 addresses (containing the address, prefix, and gateway). -

-
+
+

Types and Values

+
--++ - - + + - - + + + + + + + + + + + + + + + + + +

config :

a NMIP6Config -#defineNM_IP6_CONFIG_GATEWAY

Returns :

the GSList containing -NMIP6Addresses. This is the internal copy used by the configuration -and must not be modified. [element-type NMIP6Address] -#defineNM_IP6_CONFIG_ADDRESSES
#defineNM_IP6_CONFIG_ROUTES
#defineNM_IP6_CONFIG_NAMESERVERS
#defineNM_IP6_CONFIG_DOMAINS
#defineNM_IP6_CONFIG_SEARCHES
-
-
-

nm_ip6_config_get_routes ()

-
const GSList *      nm_ip6_config_get_routes            (NMIP6Config *config);
+
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMIP6Config
+
+
+
+

Description

-Gets the routes.

-
+ +
+

Functions

+
+

nm_ip6_config_new ()

+
GObject *
+nm_ip6_config_new (DBusGConnection *connection,
+                   const char *object_path);
+

Creates a new NMIP6Config.

+
+

Parameters

+
--+++ - - + + + - - + + +

config :

a NMIP6Config -

connection

the DBusGConnection

 

Returns :

the GSList containing -NMIP6Routes. This is the internal copy used by the configuration, -and must not be modified. [element-type NMIP6Route] -

object_path

the DBus object path of the device

 
+
+

Returns

+

a new IP6 configuration.

+

[transfer full]

+
+
-

nm_ip6_config_get_num_nameservers ()

-
guint32             nm_ip6_config_get_num_nameservers   (NMIP6Config *config);
-

-Gets the number of the domain name servers in the configuration. -

-
+

nm_ip6_config_get_gateway ()

+
const char *
+nm_ip6_config_get_gateway (NMIP6Config *config);
+

Gets the IP6 gateway.

+
+

Parameters

+
--+++ - - - - - - - - - - + + + + +

config :

a NMIP6Config -

Returns :

the number of domain name servers

config

a NMIP6Config

 
+
+
+

Returns

+

the IPv6 gateway of the configuration.

+

+

Since 0.9.10

-

nm_ip6_config_get_nameserver ()

-
const struct in6_addr * nm_ip6_config_get_nameserver    (NMIP6Config *config,
-                                                         guint32 idx);
-

-Gets the domain name server at index idx in the configuration. -

-
+

nm_ip6_config_get_addresses ()

+
const GSList *
+nm_ip6_config_get_addresses (NMIP6Config *config);
+

Gets the IP6 addresses (containing the address, prefix, and gateway).

+
+

Parameters

+
--+++ - - - - - - - - - - - - - - + + + + + +

config :

a NMIP6Config -

idx :

index of the nameserver to return

Returns :

the IPv6 address of domain name server at index iidx. [array fixed-size=16][element-type guint8][transfer none] -

config

a NMIP6Config

 
+
+
+

Returns

+

the GSList containing +NMIP6Addresses. This is the internal copy used by the configuration +and must not be modified.

+

[element-type NMIP6Address]

+
+
+
+
+

nm_ip6_config_get_routes ()

+
const GSList *
+nm_ip6_config_get_routes (NMIP6Config *config);
+

Gets the routes.

+
+

Parameters

+
+++++ + + + + +

config

a NMIP6Config

 
+
+
+

Returns

+

the GSList containing +NMIP6Routes. This is the internal copy used by the configuration, +and must not be modified.

+

[element-type NMIP6Route]

+
+
+
+
+

nm_ip6_config_get_num_nameservers ()

+
guint32
+nm_ip6_config_get_num_nameservers (NMIP6Config *config);
+

Gets the number of the domain name servers in the configuration.

+
+

Parameters

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

config

a NMIP6Config

 
+
+
+

Returns

+

the number of domain name servers

+

+

Since 0.9.10

-

nm_ip6_config_get_nameservers ()

-
const GSList *      nm_ip6_config_get_nameservers       (NMIP6Config *config);
-

-Gets the domain name servers (DNS). -

-
+

nm_ip6_config_get_nameserver ()

+
const struct in6_addr *
+nm_ip6_config_get_nameserver (NMIP6Config *config,
+                              guint32 idx);
+

Gets the domain name server at index idx + in the configuration.

+
+

Parameters

+
--+++ - - + + + - - + + +

config :

a NMIP6Config -

config

a NMIP6Config

 

Returns :

a GSList 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.

idx

index of the nameserver to return

 
+
+

Returns

+

the IPv6 address of domain name server at index iidx +.

+

[array fixed-size=16][element-type guint8][transfer none]

+
+

Since 0.9.10

+
-

nm_ip6_config_get_domains ()

-
const GPtrArray *   nm_ip6_config_get_domains           (NMIP6Config *config);
-

-Gets the domain names. -

-
+

nm_ip6_config_get_nameservers ()

+
const GSList *
+nm_ip6_config_get_nameservers (NMIP6Config *config);
+

Gets the domain name servers (DNS).

+
+

Parameters

+
--+++ - - - - - - - - - - + + + + +

config :

a NMIP6Config -

Returns :

the GPtrArray containing domains as strings. -This is the internal copy used by the configuration, and must not be modified. [element-type utf8] -

config

a NMIP6Config

 
+
+

Returns

+

a GSList 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.

+

+
+
-

nm_ip6_config_get_searches ()

-
const GPtrArray *   nm_ip6_config_get_searches          (NMIP6Config *config);
-

-Gets the dns searches. -

-
+

nm_ip6_config_get_domains ()

+
const GPtrArray *
+nm_ip6_config_get_domains (NMIP6Config *config);
+

Gets the domain names.

+
+

Parameters

+
--+++ - - - - - - - - - - + + + + +

config :

a NMIP6Config -

Returns :

the GPtrArray containing dns searches as strings. -This is the internal copy used by the configuration, and must not be modified. [element-type utf8] -

config

a NMIP6Config

 
+
+
+

Returns

+

the GPtrArray containing domains as strings. +This is the internal copy used by the configuration, and must not be modified.

+

[element-type utf8]

+
+ +
+
+

nm_ip6_config_get_searches ()

+
const GPtrArray *
+nm_ip6_config_get_searches (NMIP6Config *config);
+

Gets the dns searches.

+
+

Parameters

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

config

a NMIP6Config

 
+
+
+

Returns

+

the GPtrArray containing dns searches as strings. +This is the internal copy used by the configuration, and must not be modified.

+

[element-type utf8]

+

Since 0.9.10

-

Property Details

+

Types and Values

-

The "addresses" property

-
  "addresses"                NMIP6AddressObjectArray*  : Read
+

NM_IP6_CONFIG_GATEWAY

+
#define NM_IP6_CONFIG_GATEWAY "gateway"
+

-The GPtrArray containing the IPv6 addresses; use -nm_utils_ip6_addresses_from_gvalue() to return a GSList of -NMSettingIP6Address objects that is more usable than the raw data.

-

The "domains" property

-
  "domains"                  NMStringArray*        : Read
+

NM_IP6_CONFIG_ADDRESSES

+
#define NM_IP6_CONFIG_ADDRESSES "addresses"
+

-The GPtrArray containing domain strings of the configuration.

-

The "gateway" property

-
  "gateway"                  gchar*                : Read
+

NM_IP6_CONFIG_ROUTES

+
#define NM_IP6_CONFIG_ROUTES "routes"
+

-The IPv6 gateway as string

-

Default value: NULL

-

Since 0.9.10

-

The "nameservers" property

-
  "nameservers"              NMIP6AddressArray*    : Read
+

NM_IP6_CONFIG_NAMESERVERS

+
#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
+

-The GPtrArray containing elements of type 'struct ip6_addr' which -contain the addresses of nameservers of the configuration.

-

The "routes" property

-
  "routes"                   NMIP6RouteObjectArray*  : Read
+

NM_IP6_CONFIG_DOMAINS

+
#define NM_IP6_CONFIG_DOMAINS "domains"
+

-The GPtrArray containing the IPv6 routes; use -nm_utils_ip6_routes_from_gvalue() to return a GSList of -NMSettingIP6Address objects that is more usable than the raw data.

-

The "searches" property

-
  "searches"                 NMStringArray*        : Read
+

NM_IP6_CONFIG_SEARCHES

+
#define NM_IP6_CONFIG_SEARCHES "searches"
+

-The GPtrArray containing dns search strings of the configuration.

+
+
+
+

Property Details

+
+

The “addresses” property

+
  “addresses”                NMIP6AddressObjectArray *
+

+

Flags: Read

+
+
+
+

The “domains” property

+
  “domains”                  NMStringArray *
+

+

Flags: Read

+
+
+
+

The “gateway” property

+
  “gateway”                  gchar *
+

+

Flags: Read

+

Default value: NULL

+

Since 0.9.10

+
+
+
+

The “nameservers” property

+
  “nameservers”              NMIP6AddressArray *
+

+

Flags: Read

+
+
+
+

The “routes” property

+
  “routes”                   NMIP6RouteObjectArray *
+

+

Flags: Read

+
+
+
+

The “searches” property

+
  “searches”                 NMStringArray *
+

+

Flags: Read

Since 0.9.10

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5