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/NMIP4Config.html | 762 +++++++++++++++++++--------------- 1 file changed, 427 insertions(+), 335 deletions(-) (limited to 'docs/libnm-glib/html/NMIP4Config.html') diff --git a/docs/libnm-glib/html/NMIP4Config.html b/docs/libnm-glib/html/NMIP4Config.html index 6396397d..fec85cac 100644 --- a/docs/libnm-glib/html/NMIP4Config.html +++ b/docs/libnm-glib/html/NMIP4Config.html @@ -2,36 +2,28 @@ -NMIP4Config +libnm-glib Reference Manual: NMIP4Config - + - - - - - - - - - - + + + + + + +
@@ -39,431 +31,531 @@

NMIP4Config

NMIP4Config

- +
-
-

Synopsis

-
                    NMIP4Config;
-                    NMIP4ConfigClass;
-#define             NM_IP4_CONFIG_GATEWAY
-#define             NM_IP4_CONFIG_ADDRESSES
-#define             NM_IP4_CONFIG_ROUTES
-#define             NM_IP4_CONFIG_NAMESERVERS
-#define             NM_IP4_CONFIG_DOMAINS
-#define             NM_IP4_CONFIG_SEARCHES
-#define             NM_IP4_CONFIG_WINS_SERVERS
-GObject *           nm_ip4_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);
-const char *        nm_ip4_config_get_gateway           (NMIP4Config *config);
-const GSList *      nm_ip4_config_get_addresses         (NMIP4Config *config);
-const GSList *      nm_ip4_config_get_routes            (NMIP4Config *config);
-const GArray *      nm_ip4_config_get_nameservers       (NMIP4Config *config);
-const GPtrArray *   nm_ip4_config_get_domains           (NMIP4Config *config);
-const GPtrArray *   nm_ip4_config_get_searches          (NMIP4Config *config);
-const GArray *      nm_ip4_config_get_wins_servers      (NMIP4Config *config);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMIP4Config
-
-
-

Implemented Interfaces

-

-NMIP4Config implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "addresses"                gpointer              : Read
-  "domains"                  NMStringArray*        : Read
-  "gateway"                  gchar*                : Read
-  "nameservers"              NMUintArray*          : Read
-  "routes"                   gpointer              : Read
-  "searches"                 NMStringArray*        : Read
-  "wins-servers"             NMUintArray*          : Read
-
-
-
-

Description

-

-

-
-
-

Details

-
-

NMIP4Config

-
typedef struct _NMIP4Config NMIP4Config;
-

-

-
-
-
-

NMIP4ConfigClass

-
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);
-} NMIP4ConfigClass;
-
-

-

-
-
-
-

NM_IP4_CONFIG_GATEWAY

-
#define NM_IP4_CONFIG_GATEWAY "gateway"
-
-

-

-
-
-
-

NM_IP4_CONFIG_ADDRESSES

-
#define NM_IP4_CONFIG_ADDRESSES "addresses"
-
-

-

-
-
-
-

NM_IP4_CONFIG_ROUTES

-
#define NM_IP4_CONFIG_ROUTES "routes"
-
-

-

-
-
-
-

NM_IP4_CONFIG_NAMESERVERS

-
#define NM_IP4_CONFIG_NAMESERVERS "nameservers"
-
-

-

-
-
-
-

NM_IP4_CONFIG_DOMAINS

-
#define NM_IP4_CONFIG_DOMAINS "domains"
-
-

-

-
-
-
-

NM_IP4_CONFIG_SEARCHES

-
#define NM_IP4_CONFIG_SEARCHES "searches"
-
-

-

-
-
-
-

NM_IP4_CONFIG_WINS_SERVERS

-
#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers"
-
-

-

-
-
-
-

nm_ip4_config_new ()

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

-Creates a new NMIP4Config. -

-
+

Functions

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

connection :

the DBusGConnection + +GObject * + +nm_ip4_config_new ()

object_path :

the DBus object path of the deviceconst char * + +nm_ip4_config_get_gateway () +

Returns :

a new IP4 configuration. [transfer full] +const GSList * + +nm_ip4_config_get_addresses ()
-
-
-
-

nm_ip4_config_get_gateway ()

-
const char *        nm_ip4_config_get_gateway           (NMIP4Config *config);
-

-Gets the IP4 gateway address. -

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

config :

a NMIP4Config +const GSList * + +nm_ip4_config_get_routes ()

Returns :

the IP4 address of the gateway.const GArray * + +nm_ip4_config_get_nameservers () +
const GPtrArray * + +nm_ip4_config_get_domains () +
-

Since 0.9.10

-
-
-
-

nm_ip4_config_get_addresses ()

-
const GSList *      nm_ip4_config_get_addresses         (NMIP4Config *config);
-

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

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

config :

a NMIP4Config +const GPtrArray * + +nm_ip4_config_get_searches ()

Returns :

the GSList containing NMIP4Addresses. -This is the internal copy used by the configuration and must not be modified. [element-type NMIP4Address] +const GArray * + +nm_ip4_config_get_wins_servers ()
-
-
-

nm_ip4_config_get_routes ()

-
const GSList *      nm_ip4_config_get_routes            (NMIP4Config *config);
-

-Gets the routes. -

-
+
+

Properties

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

config :

a NMIP4Config -gpointeraddressesRead

Returns :

the GSList containing -NMIP4Routes. This is the internal copy used by the configuration, -and must not be modified. [element-type NMIP4Route] - +NMStringArray *domainsRead
+gchar *gatewayRead
+NMUintArray *nameserversRead
gpointerroutesRead
+NMStringArray *searchesRead
+NMUintArray *wins-serversRead
-
-
-

nm_ip4_config_get_nameservers ()

-
const GArray *      nm_ip4_config_get_nameservers       (NMIP4Config *config);
-

-Gets the domain name servers (DNS). -

-
+
+

Types and Values

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

config :

a NMIP4Config -#defineNM_IP4_CONFIG_GATEWAY

Returns :

the GArray containing guint32s. -This is the internal copy used by the configuration and must not be -modified. [element-type guint32] -#defineNM_IP4_CONFIG_ADDRESSES
#defineNM_IP4_CONFIG_ROUTES
#defineNM_IP4_CONFIG_NAMESERVERS
#defineNM_IP4_CONFIG_DOMAINS
#defineNM_IP4_CONFIG_SEARCHES
#defineNM_IP4_CONFIG_WINS_SERVERS
-
-
-

nm_ip4_config_get_domains ()

-
const GPtrArray *   nm_ip4_config_get_domains           (NMIP4Config *config);
+
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMIP4Config
+
+
+
+

Description

-Gets the domain names.

-
+ +
+

Functions

+
+

nm_ip4_config_new ()

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

Creates a new NMIP4Config.

+
+

Parameters

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

config :

a NMIP4Config -

connection

the DBusGConnection

 

Returns :

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

object_path

the DBus object path of the device

 
+
+

Returns

+

a new IP4 configuration.

+

[transfer full]

+
+
-

nm_ip4_config_get_searches ()

-
const GPtrArray *   nm_ip4_config_get_searches          (NMIP4Config *config);
-

-Gets the dns searches. -

-
+

nm_ip4_config_get_gateway ()

+
const char *
+nm_ip4_config_get_gateway (NMIP4Config *config);
+

Gets the IP4 gateway address.

+
+

Parameters

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

config :

a NMIP4Config -

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 NMIP4Config

 
+
+
+

Returns

+

the IP4 address of the gateway.

+

+

Since 0.9.10

-

nm_ip4_config_get_wins_servers ()

-
const GArray *      nm_ip4_config_get_wins_servers      (NMIP4Config *config);
-

-Gets the Windows Internet Name Service servers (WINS). -

-
+

nm_ip4_config_get_addresses ()

+
const GSList *
+nm_ip4_config_get_addresses (NMIP4Config *config);
+

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

+
+

Parameters

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

config :

a NMIP4Config -

Returns :

the GArray containing guint32s. +

config

a NMIP4Config

 
+
+
+

Returns

+

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

+

[element-type NMIP4Address]

+
+
+
+
+

nm_ip4_config_get_routes ()

+
const GSList *
+nm_ip4_config_get_routes (NMIP4Config *config);
+

Gets the routes.

+
+

Parameters

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

config

a NMIP4Config

 
+
+
+

Returns

+

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

+

[element-type NMIP4Route]

+
+
+
+
+

nm_ip4_config_get_nameservers ()

+
const GArray *
+nm_ip4_config_get_nameservers (NMIP4Config *config);
+

Gets the domain name servers (DNS).

+
+

Parameters

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

config

a NMIP4Config

 
+
+
+

Returns

+

the GArray containing guint32s. This is the internal copy used by the configuration and must not be -modified. [element-type guint32] - - - +modified.

+

[element-type guint32]

+
+
+
+
+

nm_ip4_config_get_domains ()

+
const GPtrArray *
+nm_ip4_config_get_domains (NMIP4Config *config);
+

Gets the domain names.

+
+

Parameters

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

config

a NMIP4Config

 
+
+
+

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_ip4_config_get_searches ()

+
const GPtrArray *
+nm_ip4_config_get_searches (NMIP4Config *config);
+

Gets the dns searches.

+
+

Parameters

+
+++++ + + + + +

config

a NMIP4Config

 
+
+

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

+
+
+
+

nm_ip4_config_get_wins_servers ()

+
const GArray *
+nm_ip4_config_get_wins_servers (NMIP4Config *config);
+

Gets the Windows Internet Name Service servers (WINS).

+
+

Parameters

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

config

a NMIP4Config

 
+
+
+

Returns

+

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

+

[element-type guint32]

+
+
-

Property Details

+

Types and Values

-

The "addresses" property

-
  "addresses"                gpointer              : Read
+

NM_IP4_CONFIG_GATEWAY

+
#define NM_IP4_CONFIG_GATEWAY "gateway"
+

-The GPtrArray containing NMIP4Addresses of the configuration.

-

The "domains" property

-
  "domains"                  NMStringArray*        : Read
+

NM_IP4_CONFIG_ADDRESSES

+
#define NM_IP4_CONFIG_ADDRESSES "addresses"
+

-The GPtrArray containing domain strings of the configuration.

-

The "gateway" property

-
  "gateway"                  gchar*                : Read
+

NM_IP4_CONFIG_ROUTES

+
#define NM_IP4_CONFIG_ROUTES "routes"
+

-The IP4 gateway address of the configuration as string.

-

Default value: NULL

-

Since 0.9.10

-

The "nameservers" property

-
  "nameservers"              NMUintArray*          : Read
+

NM_IP4_CONFIG_NAMESERVERS

+
#define NM_IP4_CONFIG_NAMESERVERS "nameservers"
+

-The GArray containing name servers (guint32s) of the configuration.

-

The "routes" property

-
  "routes"                   gpointer              : Read
+

NM_IP4_CONFIG_DOMAINS

+
#define NM_IP4_CONFIG_DOMAINS "domains"
+

-The GPtrArray containing NMSettingIP4Routes of the configuration.

-

The "searches" property

-
  "searches"                 NMStringArray*        : Read
+

NM_IP4_CONFIG_SEARCHES

+
#define NM_IP4_CONFIG_SEARCHES "searches"
+

-The GPtrArray containing dns search strings of the configuration.

-

Since 0.9.10

-

The "wins-servers" property

-
  "wins-servers"             NMUintArray*          : Read
+

NM_IP4_CONFIG_WINS_SERVERS

+
#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers"
+

-The GArray containing WINS servers (guint32s) of the configuration.

+
+

Property Details

+
+

The “addresses” property

+
  “addresses”                gpointer
+

+

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”              NMUintArray *
+

+

Flags: Read

+
+
+
+

The “routes” property

+
  “routes”                   gpointer
+

+

Flags: Read

+
+
+
+

The “searches” property

+
  “searches”                 NMStringArray *
+

+

Flags: Read

+

Since 0.9.10

+
+
+
+

The “wins-servers” property

+
  “wins-servers”             NMUintArray *
+

+

Flags: Read

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