NMIPConfig

NMIPConfig

Synopsis

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

Object Hierarchy

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

Implemented Interfaces

NMIPConfig implements GInitable and GAsyncInitable.

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

Description

Details

NMIPConfig

typedef struct _NMIPConfig NMIPConfig;

NMIPConfigClass

typedef struct {
	NMObjectClass parent;
} NMIPConfigClass;


NM_IP_CONFIG_FAMILY

#define NM_IP_CONFIG_FAMILY "family"


NM_IP_CONFIG_GATEWAY

#define NM_IP_CONFIG_GATEWAY "gateway"


NM_IP_CONFIG_ADDRESSES

#define NM_IP_CONFIG_ADDRESSES "addresses"


NM_IP_CONFIG_ROUTES

#define NM_IP_CONFIG_ROUTES "routes"


NM_IP_CONFIG_NAMESERVERS

#define NM_IP_CONFIG_NAMESERVERS "nameservers"


NM_IP_CONFIG_DOMAINS

#define NM_IP_CONFIG_DOMAINS "domains"


NM_IP_CONFIG_SEARCHES

#define NM_IP_CONFIG_SEARCHES "searches"


NM_IP_CONFIG_WINS_SERVERS

#define NM_IP_CONFIG_WINS_SERVERS "wins-servers"


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. The library never modifies the returned array and thus it is safe for callers to reference and keep using it. [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. The library never modifies the returned array and thus it is safe for callers to reference and keep using it. [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 "domains" property

  "domains"                  GStrv                 : Read

The array containing domain strings of the configuration.


The "family" property

  "family"                   gint                  : Read

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

Allowed values: [0,255]

Default value: 0


The "gateway" property

  "gateway"                  gchar*                : Read

The IP gateway address of the configuration as string.

Default value: NULL


The "nameservers" property

  "nameservers"              GStrv                 : Read

The array containing name server IP addresses of the configuration.


The "routes" property

  "routes"                   GPtrArray*            : Read

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


The "searches" property

  "searches"                 GStrv                 : Read

The array containing DNS search strings of the configuration.


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.)