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/html/NMIPConfig.html | 771 +++++++++++++++++++++++----------------- 1 file changed, 436 insertions(+), 335 deletions(-) (limited to 'docs/libnm/html/NMIPConfig.html') diff --git a/docs/libnm/html/NMIPConfig.html b/docs/libnm/html/NMIPConfig.html index 83ede1e4..a93213ab 100644 --- a/docs/libnm/html/NMIPConfig.html +++ b/docs/libnm/html/NMIPConfig.html @@ -2,36 +2,28 @@ -NMIPConfig +libnm Reference Manual: NMIPConfig - + - - - - - - - - - - + + + + + + +
@@ -39,55 +31,181 @@

NMIPConfig

NMIPConfig

- +
-
-

Synopsis

-
struct              NMIPConfig;
-                    NMIPConfigClass;
-#define             NM_IP_CONFIG_FAMILY
-#define             NM_IP_CONFIG_GATEWAY
-#define             NM_IP_CONFIG_ADDRESSES
-#define             NM_IP_CONFIG_ROUTES
-#define             NM_IP_CONFIG_NAMESERVERS
-#define             NM_IP_CONFIG_DOMAINS
-#define             NM_IP_CONFIG_SEARCHES
-#define             NM_IP_CONFIG_WINS_SERVERS
-int                 nm_ip_config_get_family             (NMIPConfig *config);
-const char *        nm_ip_config_get_gateway            (NMIPConfig *config);
-GPtrArray *         nm_ip_config_get_addresses          (NMIPConfig *config);
-GPtrArray *         nm_ip_config_get_routes             (NMIPConfig *config);
-const char * const * nm_ip_config_get_nameservers       (NMIPConfig *config);
-const char * const * nm_ip_config_get_domains           (NMIPConfig *config);
-const char * const * nm_ip_config_get_searches          (NMIPConfig *config);
-const char * const * nm_ip_config_get_wins_servers      (NMIPConfig *config);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+int + +nm_ip_config_get_family () +
const char * + +nm_ip_config_get_gateway () +
+GPtrArray * + +nm_ip_config_get_addresses () +
+GPtrArray * + +nm_ip_config_get_routes () +
const char * const * + +nm_ip_config_get_nameservers () +
const char * const * + +nm_ip_config_get_domains () +
const char * const * + +nm_ip_config_get_searches () +
const char * const * + +nm_ip_config_get_wins_servers () +
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMIPConfig
-
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GPtrArray *addressesRead
GStrvdomainsRead
gintfamilyRead
+gchar *gatewayRead
GStrvnameserversRead
+GPtrArray *routesRead
GStrvsearchesRead
GStrvwins-serversRead
-

Implemented Interfaces

-

-NMIPConfig implements - GInitable and GAsyncInitable.

+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_IP_CONFIG_FAMILY
#defineNM_IP_CONFIG_GATEWAY
#defineNM_IP_CONFIG_ADDRESSES
#defineNM_IP_CONFIG_ROUTES
#defineNM_IP_CONFIG_NAMESERVERS
#defineNM_IP_CONFIG_DOMAINS
#defineNM_IP_CONFIG_SEARCHES
#defineNM_IP_CONFIG_WINS_SERVERS
-

Properties

-
-  "addresses"                GPtrArray*            : Read
-  "domains"                  GStrv                 : Read
-  "family"                   gint                  : Read
-  "gateway"                  gchar*                : Read
-  "nameservers"              GStrv                 : Read
-  "routes"                   GPtrArray*            : Read
-  "searches"                 GStrv                 : Read
-  "wins-servers"             GStrv                 : Read
+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMIPConfig
@@ -96,25 +214,234 @@ NMIPConfig implements

-

Details

+

Functions

-

struct NMIPConfig

-
struct NMIPConfig;
-

-

+

nm_ip_config_get_family ()

+
int
+nm_ip_config_get_family (NMIPConfig *config);
+

Gets the IP address family

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the IP address family; either AF_INET or +AF_INET6

+

+
-

NMIPConfigClass

-
typedef struct {
-	NMObjectClass parent;
-} NMIPConfigClass;
-
-

-

+

nm_ip_config_get_gateway ()

+
const char *
+nm_ip_config_get_gateway (NMIPConfig *config);
+

Gets the IP gateway address.

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the IP address of the gateway.

+

[transfer none]

+
+

nm_ip_config_get_addresses ()

+
GPtrArray *
+nm_ip_config_get_addresses (NMIPConfig *config);
+

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

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

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

+

[element-type NMIPAddress][transfer none]

+
+
+
+
+

nm_ip_config_get_routes ()

+
GPtrArray *
+nm_ip_config_get_routes (NMIPConfig *config);
+

Gets the routes.

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

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

+

[element-type NMIPRoute][transfer none]

+
+
+
+
+

nm_ip_config_get_nameservers ()

+
const char * const *
+nm_ip_config_get_nameservers (NMIPConfig *config);
+

Gets the domain name servers (DNS).

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the array of nameserver IP addresses.

+

[transfer none]

+
+
+
+
+

nm_ip_config_get_domains ()

+
const char * const *
+nm_ip_config_get_domains (NMIPConfig *config);
+

Gets the domain names.

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the array of domains. +(This is never NULL, though it may be 0-length).

+

[transfer none]

+
+
+
+
+

nm_ip_config_get_searches ()

+
const char * const *
+nm_ip_config_get_searches (NMIPConfig *config);
+

Gets the DNS searches.

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the array of DNS search strings. +(This is never NULL, though it may be 0-length).

+

[transfer none]

+
+
+
+
+

nm_ip_config_get_wins_servers ()

+
const char * const *
+nm_ip_config_get_wins_servers (NMIPConfig *config);
+

Gets the Windows Internet Name Service servers (WINS).

+
+

Parameters

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

config

a NMIPConfig

 
+
+
+

Returns

+

the arry of WINS server IP address strings. +(This is never NULL, though it may be 0-length.).

+

[transfer none]

+
+
+
+
+

Types and Values

+

NM_IP_CONFIG_FAMILY

#define NM_IP_CONFIG_FAMILY "family"
@@ -177,297 +504,71 @@ NMIPConfig implements

-
-
-

nm_ip_config_get_family ()

-
int                 nm_ip_config_get_family             (NMIPConfig *config);
-

-Gets the IP address family -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the IP address family; either AF_INET or -AF_INET6 -
-
-
-
-

nm_ip_config_get_gateway ()

-
const char *        nm_ip_config_get_gateway            (NMIPConfig *config);
-

-Gets the IP gateway address. -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the IP address of the gateway. [transfer none] -
-
-
-
-

nm_ip_config_get_addresses ()

-
GPtrArray *         nm_ip_config_get_addresses          (NMIPConfig *config);
-

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

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the GPtrArray -containing NMIPAddresses. This is the internal copy used by the -configuration and must not be modified. [element-type NMIPAddress][transfer none] -
-
-
-
-

nm_ip_config_get_routes ()

-
GPtrArray *         nm_ip_config_get_routes             (NMIPConfig *config);
-

-Gets the routes. -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the GPtrArray containing -NMIPRoutes. This is the internal copy used by the configuration, and must -not be modified. [element-type NMIPRoute][transfer none] -
-
-
-
-

nm_ip_config_get_nameservers ()

-
const char * const * nm_ip_config_get_nameservers       (NMIPConfig *config);
-

-Gets the domain name servers (DNS). -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the array of nameserver IP addresses. [transfer none] -
-
-
-
-

nm_ip_config_get_domains ()

-
const char * const * nm_ip_config_get_domains           (NMIPConfig *config);
-

-Gets the domain names. -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the array of domains. -(This is never NULL, though it may be 0-length). [transfer none] -
-
-
-
-

nm_ip_config_get_searches ()

-
const char * const * nm_ip_config_get_searches          (NMIPConfig *config);
-

-Gets the DNS searches. -

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the array of DNS search strings. -(This is never NULL, though it may be 0-length). [transfer none] -
-
-
-
-

nm_ip_config_get_wins_servers ()

-
const char * const * nm_ip_config_get_wins_servers      (NMIPConfig *config);
-

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

-
---- - - - - - - - - - - -

config :

a NMIPConfig -

Returns :

the arry of WINS server IP address strings. -(This is never NULL, though it may be 0-length.). [transfer none] -
-

Property Details

-

The "addresses" property

-
  "addresses"                GPtrArray*            : Read
-

-A GPtrArray containing the addresses (NMIPAddress) of the configuration. -

+

The “addresses” property

+
  “addresses”                GPtrArray *
+

+

Flags: Read

-

The "domains" property

-
  "domains"                  GStrv                 : Read
-

-The array containing domain strings of the configuration. -

+

The “domains” property

+
  “domains”                  GStrv
+

+

Flags: Read

-

The "family" property

-
  "family"                   gint                  : Read
-

-The IP address family of the configuration; either -AF_INET or AF_INET6. -

+

The “family” property

+
  “family”                   gint
+

+

Flags: Read

Allowed values: [0,255]

Default value: 0

-

The "gateway" property

-
  "gateway"                  gchar*                : Read
-

-The IP gateway address of the configuration as string. -

+

The “gateway” property

+
  “gateway”                  gchar *
+

+

Flags: Read

Default value: NULL

-

The "nameservers" property

-
  "nameservers"              GStrv                 : Read
-

-The array containing name server IP addresses of the configuration. -

+

The “nameservers” property

+
  “nameservers”              GStrv
+

+

Flags: Read

-

The "routes" property

-
  "routes"                   GPtrArray*            : Read
-

-A GPtrArray containing the routes (NMIPRoute) of the configuration. -

+

The “routes” property

+
  “routes”                   GPtrArray *
+

+

Flags: Read

-

The "searches" property

-
  "searches"                 GStrv                 : Read
-

-The array containing DNS search strings of the configuration. -

+

The “searches” property

+
  “searches”                 GStrv
+

+

Flags: Read

-

The "wins-servers" property

-
  "wins-servers"             GStrv                 : Read
-

-The array containing WINS server IP addresses of the configuration. -(This will always be empty for IPv6 configurations.) -

+

The “wins-servers” property

+
  “wins-servers”             GStrv
+

+

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