NMSettingIP4Config

Properties

@@ -207,39 +207,8 @@ properties related to IPv4 addressing, routing, and Domain Name Service

Details

NMIP4Address

typedef struct NMIP4Address NMIP4Address;
-

NMIP4Route

typedef struct NMIP4Route NMIP4Route;
-

NMSettingIP4Config

typedef struct _NMSettingIP4Config NMSettingIP4Config;

NMSettingIP4ConfigClass

typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingIP4ConfigClass;
+NM_SETTING_IP4_CONFIG_SETTING_NAME
+#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
 
 
 
@@ -254,8 +223,11 @@ properties related to IPv4 addressing, routing, and Domain Name Service
 	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/
 } NMSettingIP4ConfigError;

+++ @@ -284,32 +256,34 @@ not valid with the given IP4 method

NM_SETTING_IP4_CONFIG_ADDRESSES

#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
-

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID "dhcp-client-id" +

NM_SETTING_IP4_CONFIG_ERROR

#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-

nm_setting_ip4_config_error_quark ()

GQuark              nm_setting_ip4_config_error_quark   (void);

+Registers an error quark for NMSettingIP4Config if necessary.

NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingIP4Config errors.

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+NM_SETTING_IP4_CONFIG_METHOD
+#define NM_SETTING_IP4_CONFIG_METHOD             "method"
 
 
 
@@ -332,16 +306,16 @@ not valid with the given IP4 method

NM_SETTING_IP4_CONFIG_ERROR

#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark () +

NM_SETTING_IP4_CONFIG_ADDRESSES

#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+NM_SETTING_IP4_CONFIG_ROUTES
+#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
 
 
 
@@ -356,63 +330,86 @@ not valid with the given IP4 method

NM_SETTING_IP4_CONFIG_MAY_FAIL

#define NM_SETTING_IP4_CONFIG_MAY_FAIL "may-fail" +

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"

NM_SETTING_IP4_CONFIG_METHOD

#define NM_SETTING_IP4_CONFIG_METHOD "method" +

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"

NM_SETTING_IP4_CONFIG_METHOD_AUTO

#define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto" +

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"

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

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled" +

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"

-This connection does not use or require IPv4 address and it should be disabled.

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local" +

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"

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

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual" +

NM_SETTING_IP4_CONFIG_MAY_FAIL

#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"

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

NM_SETTING_IP4_CONFIG_METHOD_SHARED

NM_SETTING_IP4_CONFIG_METHOD_AUTO

#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+

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

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
+

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

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
+

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

NM_SETTING_IP4_CONFIG_METHOD_SHARED

#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"

@@ -426,74 +423,131 @@ through that interface to the default network.

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT "never-default" +

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"

+This connection does not use or require IPv4 address and it should be disabled.

NM_SETTING_IP4_CONFIG_ROUTES

#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
+NMIP4Address
+typedef struct NMIP4Address NMIP4Address;

NM_SETTING_IP4_CONFIG_SETTING_NAME

#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
-

nm_ip4_address_new ()

NMIP4Address *      nm_ip4_address_new                  (void);

+Creates and returns a new NMIP4Address object.

++++ + + + + +

Returns :

the new empty NMIP4Address object. [transfer full] +

nm_ip4_address_compare ()

gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);

nm_ip4_address_dup ()

NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

-Determines if two NMIP4Address objects contain the same values. +Copies a given NMIP4Address object and returns the copy.

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

`address` :	the NMIP4Address -
`other` :	the NMIP4Address to compare `address` to.	`source` :	the NMIP4Address object to copy
Returns :	-`TRUE` if the objects contain the same values, `FALSE` if they do not.	the copy of the given NMIP4Address copy. [transfer full] +

nm_ip4_address_dup ()

NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

nm_ip4_address_ref ()

void                nm_ip4_address_ref                  (NMIP4Address *address);

-Copies a given NMIP4Address object and returns the copy. +Increases the reference count of the object. +

++++ + + + + +

address :

the NMIP4Address +

nm_ip4_address_unref ()

void                nm_ip4_address_unref                (NMIP4Address *address);

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

+++ + + + + +

address :

the NMIP4Address +

nm_ip4_address_compare ()

gboolean            nm_ip4_address_compare              (NMIP4Address *address,
+                                                         NMIP4Address *other);

+Determines if two NMIP4Address objects contain the same values. +

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

`source` :	the NMIP4Address object to copy	`address` :	the NMIP4Address +
`other` :	the NMIP4Address to compare `address` to.
Returns :	the copy of the given NMIP4Address copy. [transfer full] -	+`TRUE` if the objects contain the same values, `FALSE` if they do not.

@@ -505,8 +559,11 @@ Copies a given Gets the IPv4 address property of this address object.

+++ @@ -522,13 +579,17 @@ Gets the IPv4 address property of this address object.

nm_ip4_address_get_gateway ()

guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

nm_ip4_address_set_address ()

void                nm_ip4_address_set_address          (NMIP4Address *address,
+                                                         guint32 addr);

-Gets the IPv4 default gateway property of this address object. +Sets the IPv4 address property of this object.

address :

+++ @@ -536,8 +597,8 @@ Gets the IPv4 default gateway property of this address object. - - + +

`address` :
Returns :	the IPv4 gateway address in network byte order	`addr` :	the IPv4 address in network byte order

@@ -550,8 +611,11 @@ Gets the IPv4 default gateway property of this address object. Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address object.

+++ @@ -567,46 +631,42 @@ object.

nm_ip4_address_new ()

NMIP4Address *      nm_ip4_address_new                  (void);

-Creates and returns a new NMIP4Address object. -

address :

-- - - - -

Returns :

the new empty NMIP4Address object. [transfer full] -

nm_ip4_address_ref ()

void                nm_ip4_address_ref                  (NMIP4Address *address);

nm_ip4_address_set_prefix ()

void                nm_ip4_address_set_prefix           (NMIP4Address *address,
+                                                         guint32 prefix);

-Increases the reference count of the object. +Sets the IPv4 address prefix.

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

`address` :	the NMIP4Address
`prefix` :	the address prefix, a number between 1 and 32 inclusive

nm_ip4_address_set_address ()

void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);

nm_ip4_address_get_gateway ()

guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

-Sets the IPv4 address property of this object. +Gets the IPv4 default gateway property of this address object.

+++ @@ -614,8 +674,8 @@ Sets the IPv4 address property of this object. - - + +

`address` :
`addr` :	the IPv4 address in network byte order	Returns :	the IPv4 gateway address in network byte order

@@ -628,8 +688,11 @@ Sets the IPv4 address property of this object.

Sets the IPv4 default gateway property of this address object.

+++ @@ -645,40 +708,91 @@ Sets the IPv4 default gateway property of this address object.

nm_ip4_address_set_prefix ()

void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);

NMIP4Route

typedef struct NMIP4Route NMIP4Route;
+

-Sets the IPv4 address prefix.

address :

+ +

nm_ip4_route_new ()

NMIP4Route *        nm_ip4_route_new                    (void);

+Creates and returns a new NMIP4Route object. +

++++ + + + + +

Returns :

the new empty NMIP4Route object. [transfer full] +

nm_ip4_route_dup ()

NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);

+Copies a given NMIP4Route object and returns the copy. +

+++ - - + + - - + +

`address` :	the NMIP4Address -	`source` :	the NMIP4Route object to copy
`prefix` :	the address prefix, a number between 1 and 32 inclusive	Returns :	the copy of the given NMIP4Route copy. [transfer full] +

nm_ip4_address_unref ()

void                nm_ip4_address_unref                (NMIP4Address *address);

nm_ip4_route_ref ()

void                nm_ip4_route_ref                    (NMIP4Route *route);

+Increases the reference count of the object. +

++++ + + + + +

route :

the NMIP4Route +

nm_ip4_route_unref ()

void                nm_ip4_route_unref                  (NMIP4Route *route);

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

+++ - - +

address :

the NMIP4Address +

route :

the NMIP4Route

@@ -691,8 +805,11 @@ reaches zero, the object will be destroyed.

Determines if two NMIP4Route objects contain the same values.

+++ @@ -713,35 +830,42 @@ Determines if two

nm_ip4_route_dup ()

NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);

nm_ip4_route_get_dest ()

guint32             nm_ip4_route_get_dest               (NMIP4Route *route);

-Copies a given NMIP4Route object and returns the copy. +Gets the IPv4 destination address property of this route object.

route :

+++ - - + + - +

`source` :	the NMIP4Route object to copy	`route` :	the NMIP4Route +
Returns :	the copy of the given NMIP4Route copy. [transfer full] -	the IPv4 address in network byte order

nm_ip4_route_get_dest ()

guint32             nm_ip4_route_get_dest               (NMIP4Route *route);

nm_ip4_route_set_dest ()

void                nm_ip4_route_set_dest               (NMIP4Route *route,
+                                                         guint32 dest);

-Gets the IPv4 destination address property of this route object. +Sets the IPv4 destination address property of this route object.

+++ @@ -749,22 +873,24 @@ Gets the IPv4 destination address property of this route object. - - + +

`route` :
Returns :	the IPv4 address in network byte order	`dest` :	the destination address in network byte order

nm_ip4_route_get_metric ()

guint32             nm_ip4_route_get_metric             (NMIP4Route *route);

nm_ip4_route_get_prefix ()

guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);

-Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes. +Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

+++ @@ -773,20 +899,24 @@ Gets the route metric property of this route object; lower values indicate - +

`route` :
Returns :	the route metric	the IPv4 prefix

nm_ip4_route_get_next_hop ()

guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);

nm_ip4_route_set_prefix ()

void                nm_ip4_route_set_prefix             (NMIP4Route *route,
+                                                         guint32 prefix);

-Gets the IPv4 address of the next hop of this route. +Sets the IPv4 prefix of this route.

+++ @@ -794,21 +924,24 @@ Gets the IPv4 address of the next hop of this route. - - + +

`route` :
Returns :	the IPv4 address in network byte order	`prefix` :	the prefix, a number between 1 and 32 inclusive

nm_ip4_route_get_prefix ()

guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);

nm_ip4_route_get_next_hop ()

guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);

-Gets the IPv4 prefix (ie "24" or "30" etc) of this route. +Gets the IPv4 address of the next hop of this route.

+++ @@ -817,53 +950,50 @@ Gets the IPv4 prefix (ie "24" or "30" etc) of this route. - +

`route` :
Returns :	the IPv4 prefix	the IPv4 address in network byte order

nm_ip4_route_new ()

NMIP4Route *        nm_ip4_route_new                    (void);

-Creates and returns a new NMIP4Route object. -

-- - - - -

Returns :

the new empty NMIP4Route object. [transfer full] -

nm_ip4_route_ref ()

void                nm_ip4_route_ref                    (NMIP4Route *route);

nm_ip4_route_set_next_hop ()

void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
+                                                         guint32 next_hop);

-Increases the reference count of the object. +Sets the IPv4 address of the next hop of this route.

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

`route` :	the NMIP4Route
`next_hop` :	the IPv4 address of the next hop in network byte order

nm_ip4_route_set_dest ()

void                nm_ip4_route_set_dest               (NMIP4Route *route,
-                                                         guint32 dest);

nm_ip4_route_get_metric ()

guint32             nm_ip4_route_get_metric             (NMIP4Route *route);

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

+++ @@ -871,8 +1001,8 @@ Sets the IPv4 destination address property of this route object. - - + +

`route` :
`dest` :	the destination address in network byte order	Returns :	the route metric

@@ -886,8 +1016,11 @@ Sets the IPv4 destination address property of this route object. Sets the route metric property of this route object; lower values indicate "better" or more preferred routes.

+++ @@ -903,78 +1036,55 @@ Sets the route metric property of this route object; lower values indicate

nm_ip4_route_set_next_hop ()

void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);

NMSettingIP4Config

typedef struct _NMSettingIP4Config NMSettingIP4Config;

-Sets the IPv4 address of the next hop of this route.

route :

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

`route` :	the NMIP4Route -
`next_hop` :	the IPv4 address of the next hop in network byte order

nm_ip4_route_set_prefix ()

void                nm_ip4_route_set_prefix             (NMIP4Route *route,
-                                                         guint32 prefix);

NMSettingIP4ConfigClass

typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingIP4ConfigClass;
+

-Sets the IPv4 prefix of this route.

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

`route` :	the NMIP4Route -
`prefix` :	the prefix, a number between 1 and 32 inclusive

nm_ip4_route_unref ()

void                nm_ip4_route_unref                  (NMIP4Route *route);

nm_setting_ip4_config_new ()

NMSetting *         nm_setting_ip4_config_new           (void);

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. +Creates a new NMSettingIP4Config object with default values.

+++ - - +

route :

the NMIP4Route +

Returns :

the new empty NMSettingIP4Config object. [transfer full]

nm_setting_ip4_config_add_address ()

gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);

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

nm_setting_ip4_config_get_method ()

const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);

+++ @@ -982,28 +1092,21 @@ given address is duplicated internally and is not changed by this function. - - - - - +

`setting` :
`address` :	the new address to add
Returns :	-`TRUE` if the address was added; `FALSE` if the address was already -known.	the "method" property of the setting

nm_setting_ip4_config_add_dns ()

gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
-                                                         guint32 dns);

-Adds a new DNS server to the setting. -

nm_setting_ip4_config_get_num_dns ()

guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);

+++ @@ -1011,29 +1114,22 @@ Adds a new DNS server to the setting. - - - - - +

`setting` :
`dns` :	the IPv4 address (network byte order) of the DNS server to add
Returns :	-`TRUE` if the DNS server was added; `FALSE` if the server was already -known	the number of configured DNS servers

nm_setting_ip4_config_add_dns_search ()

gboolean            nm_setting_ip4_config_add_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);

-Adds a new DNS search domain to the setting. -

nm_setting_ip4_config_get_dns ()

guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
+                                                         guint32 i);

+++ @@ -1041,29 +1137,31 @@ Adds a new DNS search domain to the setting. - - + + - +

`setting` :
`dns_search` :	the search domain to add	`i` :	index number of the DNS server to return
Returns :	-`TRUE` if the DNS search domain was added; `FALSE` if the search -domain was already known	the IPv4 address (network byte order) of the DNS server at index +`i` +

nm_setting_ip4_config_add_route ()

gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);

nm_setting_ip4_config_add_dns ()

gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
+                                                         guint32 dns);

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

+++ @@ -1071,32 +1169,42 @@ given route is duplicated internally and is not changed by this function. - - + + +TRUE if the DNS server was added; FALSE if the server was already +known

`setting` :
`route` :	the route to add	`dns` :	the IPv4 address (network byte order) of the DNS server to add
Returns :	-`TRUE` if the route was added; `FALSE` if the route was already known.

nm_setting_ip4_config_clear_addresses ()

void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);

nm_setting_ip4_config_remove_dns ()

void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Removes all configured addresses. +Removes the DNS server at index i.

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

`setting` :	the NMSettingIP4Config
`i` :	index number of the DNS server to remove

@@ -1106,8 +1214,11 @@ Removes all configured addresses.

Removes all configured DNS servers.

+++

setting :

the NMSettingIP4Config @@ -1117,59 +1228,38 @@ Removes all configured DNS servers.

nm_setting_ip4_config_clear_dns_searches ()

void                nm_setting_ip4_config_clear_dns_searches
+nm_setting_ip4_config_get_num_dns_searches ()
+guint32             nm_setting_ip4_config_get_num_dns_searches
                                                         (NMSettingIP4Config *setting);
-
-Removes all configured DNS search domains.
-
-
+

+-
-
-
-
-
 
setting : the NMSettingIP4Config
-
-

nm_setting_ip4_config_clear_routes ()

void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);

-Removes all configured routes. -

-- ++ + + - -

setting :

the NMSettingIP4Config

nm_setting_ip4_config_error_quark ()

GQuark              nm_setting_ip4_config_error_quark   (void);

-Registers an error quark for NMSettingIP4Config if necessary. -

-- + + - - + + +

Returns :	the error quark used for NMSettingIP4Config errors.
the number of configured DNS search domains

nm_setting_ip4_config_get_address ()

NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
+nm_setting_ip4_config_get_dns_search ()
+const char *        nm_setting_ip4_config_get_dns_search
+                                                        (NMSettingIP4Config *setting,
                                                          guint32 i);
-
+

+++
@@ -1178,11 +1268,11 @@ Registers an error quark for 
 
-
+
-
@@ -1190,15 +1280,18 @@ Registers an error quark for 
 
 
-nm_setting_ip4_config_get_dhcp_client_id ()
-const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
+nm_setting_ip4_config_add_dns_search ()
+gboolean            nm_setting_ip4_config_add_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         const char *dns_search);
 
-Returns the value contained in the "dhcp-client-id"
-property.
+Adds a new DNS search domain to the setting.
 
-

 


 
 
 setting :

 i : index number of the address to return index number of the DNS search domain to return
 
 
 Returns : the address at index i
+ the DNS search domain at index i
 
 
 
+

+++
@@ -1206,24 +1299,32 @@ property.
 
+
+
+
+
-
+
 


 
 
 setting :
 
 dns_search : the search domain to add

 Returns : the configured Client ID to send to the DHCP server when requesting
-addresses via DHCP. 
+TRUE if the DNS search domain was added; FALSE if the search
+domain was already known

nm_setting_ip4_config_get_dhcp_hostname ()

const char *        nm_setting_ip4_config_get_dhcp_hostname
-                                                        (NMSettingIP4Config *setting);

nm_setting_ip4_config_remove_dns_search ()

void                nm_setting_ip4_config_remove_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "dhcp-hostname" -property. +Removes the DNS search domain at index i.

+++ @@ -1231,46 +1332,42 @@ property. - - + +

`setting` :
Returns :	the configured hostname to send to the DHCP server	`i` :	index number of the DNS search domain

nm_setting_ip4_config_get_dhcp_send_hostname ()

gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+nm_setting_ip4_config_clear_dns_searches ()
+void                nm_setting_ip4_config_clear_dns_searches
                                                         (NMSettingIP4Config *setting);
 
-Returns the value contained in the "dhcp-send-hostname"
-property.
+Removes all configured DNS search domains.
 
-
+

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


 setting :
 the NMSettingIP4Config
 
Returns : 
-TRUE if NetworkManager should send the machine hostname to the
-DHCP server when requesting addresses to allow the server to automatically
-update DNS information for this machine.

nm_setting_ip4_config_get_dns ()

guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_num_addresses ()

guint32             nm_setting_ip4_config_get_num_addresses
+                                                        (NMSettingIP4Config *setting);

+++ @@ -1278,26 +1375,22 @@ update DNS information for this machine. - - - - - +

`setting` :
`i` :	index number of the DNS server to return
Returns :	the IPv4 address (network byte order) of the DNS server at index -`i` -	the number of configured addresses

nm_setting_ip4_config_get_dns_search ()

const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
+nm_setting_ip4_config_get_address ()
+NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
                                                          guint32 i);
-
+

+++
@@ -1306,11 +1399,11 @@ update DNS information for this machine.
-
+
-
@@ -1318,15 +1411,18 @@ update DNS information for this machine.

-nm_setting_ip4_config_get_ignore_auto_dns ()
-gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
+nm_setting_ip4_config_add_address ()
+gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
+                                                         NMIP4Address *address);
 
-Returns the value contained in the "ignore-auto-dns"
-property.
+Adds a new IPv4 address and associated information to the setting.  The
+given address is duplicated internally and is not changed by this function.
 
-

 


 
 
 setting :
 
 
 i : index number of the DNS search domain to return index number of the address to return
 
 
 Returns : the DNS search domain at index i
+ the address at index i
 
 
 
 
 
 
+

+++
@@ -1334,25 +1430,32 @@ property.
 
+
+
+
+
+TRUE if the address was added; FALSE if the address was already
+known.
 


 
 
 setting :
 
 address : the new address to add

 Returns :
 
-TRUE if automatically configured (ie via DHCP) DNS information
-should be ignored.

nm_setting_ip4_config_get_ignore_auto_routes ()

gboolean            nm_setting_ip4_config_get_ignore_auto_routes
-                                                        (NMSettingIP4Config *setting);

nm_setting_ip4_config_remove_address ()

void                nm_setting_ip4_config_remove_address
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "ignore-auto-routes" -property. +Removes the address at index i.

+++ @@ -1360,24 +1463,42 @@ property. - - + +

`setting` :
Returns :	-`TRUE` if automatically configured (ie via DHCP) routes should be -ignored.	`i` :	index number of the address to remove

nm_setting_ip4_config_get_may_fail ()

gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);

nm_setting_ip4_config_clear_addresses ()

void                nm_setting_ip4_config_clear_addresses
+                                                        (NMSettingIP4Config *setting);

-Returns the value contained in the "may-fail" -property. +Removes all configured addresses.

++++ + + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_routes ()

guint32             nm_setting_ip4_config_get_num_routes
+                                                        (NMSettingIP4Config *setting);

+++ @@ -1386,19 +1507,21 @@ property. - +

`setting` :
Returns :	-`TRUE` if this connection doesn't require IPv4 addressing to complete -for the connection to succeed.	the number of configured routes

nm_setting_ip4_config_get_method ()

const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);

nm_setting_ip4_config_get_route ()

NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
+                                                         guint32 i);

+++ @@ -1406,23 +1529,31 @@ for the connection to succeed. + + + + - +

`setting` :
`i` :	index number of the route to return
Returns :	the "method" property of the setting	the route at index `i` +

nm_setting_ip4_config_get_never_default ()

gboolean            nm_setting_ip4_config_get_never_default
-                                                        (NMSettingIP4Config *setting);

nm_setting_ip4_config_add_route ()

gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
+                                                         NMIP4Route *route);

-Returns the value contained in the "never-default" -property. +Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

+++ @@ -1430,21 +1561,30 @@ property. + + + + +TRUE if the route was added; FALSE if the route was already known.

`setting` :
`route` :	the route to add
Returns :	-`TRUE` if this connection should never be the default connection -for IPv4 addressing

nm_setting_ip4_config_get_num_addresses ()

guint32             nm_setting_ip4_config_get_num_addresses
-                                                        (NMSettingIP4Config *setting);

nm_setting_ip4_config_remove_route ()

void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
+                                                         guint32 i);

+Removes the route at index i. +

+++ @@ -1452,38 +1592,45 @@ for IPv4 addressing - - + +

`setting` :
Returns :	the number of configured addresses	`i` :	index number of the route

nm_setting_ip4_config_get_num_dns ()

guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);

nm_setting_ip4_config_clear_routes ()

void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);

+Removes all configured routes. +

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

`setting` :	the NMSettingIP4Config
Returns :	the number of configured DNS servers

nm_setting_ip4_config_get_num_dns_searches ()

guint32             nm_setting_ip4_config_get_num_dns_searches
+nm_setting_ip4_config_get_ignore_auto_routes ()
+gboolean            nm_setting_ip4_config_get_ignore_auto_routes
                                                         (NMSettingIP4Config *setting);
-
+
+Returns the value contained in the "ignore-auto-routes"
+property.
+
+

+++
@@ -1492,18 +1639,27 @@ for IPv4 addressing
-
+
 


 
 
 setting :
 
 
 Returns : the number of configured DNS search domains 
+TRUE if automatically configured (ie via DHCP) routes should be
+ignored.

nm_setting_ip4_config_get_num_routes ()

guint32             nm_setting_ip4_config_get_num_routes
+nm_setting_ip4_config_get_ignore_auto_dns ()
+gboolean            nm_setting_ip4_config_get_ignore_auto_dns
                                                         (NMSettingIP4Config *setting);
-
+
+Returns the value contained in the "ignore-auto-dns"
+property.
+
+

+++
@@ -1512,18 +1668,27 @@ for IPv4 addressing
-
+
 


 
 
 setting :
 
 
 Returns : the number of configured routes 
+TRUE if automatically configured (ie via DHCP) DNS information
+should be ignored.

nm_setting_ip4_config_get_route ()

NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_dhcp_client_id ()

const char *        nm_setting_ip4_config_get_dhcp_client_id
+                                                        (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-client-id" +property. +

+++ @@ -1531,44 +1696,27 @@ for IPv4 addressing - - - - - +

`setting` :
`i` :	index number of the route to return
Returns :	the route at index `i` -	the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.

nm_setting_ip4_config_new ()

NMSetting *         nm_setting_ip4_config_new           (void);

-Creates a new NMSettingIP4Config object with default values. -

-- - - - -

Returns :

the new empty NMSettingIP4Config object. [transfer full] -

nm_setting_ip4_config_remove_address ()

void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_dhcp_send_hostname ()

gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+                                                        (NMSettingIP4Config *setting);

-Removes the address at index i. +Returns the value contained in the "dhcp-send-hostname" +property.

+++ @@ -1576,22 +1724,29 @@ Removes the address at index i. - - + +

`setting` :
`i` :	index number of the address to remove	Returns :	+`TRUE` if NetworkManager should send the machine hostname to the +DHCP server when requesting addresses to allow the server to automatically +update DNS information for this machine.

nm_setting_ip4_config_remove_dns ()

void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_dhcp_hostname ()

const char *        nm_setting_ip4_config_get_dhcp_hostname
+                                                        (NMSettingIP4Config *setting);

-Removes the DNS server at index i. +Returns the value contained in the "dhcp-hostname" +property.

+++ @@ -1599,23 +1754,26 @@ Removes the DNS server at index i. - - + +

`setting` :
`i` :	index number of the DNS server to remove	Returns :	the configured hostname to send to the DHCP server

nm_setting_ip4_config_remove_dns_search ()

void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_never_default ()

gboolean            nm_setting_ip4_config_get_never_default
+                                                        (NMSettingIP4Config *setting);

-Removes the DNS search domain at index i. +Returns the value contained in the "never-default" +property.

+++ @@ -1623,22 +1781,27 @@ Removes the DNS search domain at index i - - + +

`setting` :
`i` :	index number of the DNS search domain	Returns :	+`TRUE` if this connection should never be the default connection +for IPv4 addressing

nm_setting_ip4_config_remove_route ()

void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);

nm_setting_ip4_config_get_may_fail ()

gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);

-Removes the route at index i. +Returns the value contained in the "may-fail" +property.

+++ @@ -1646,8 +1809,10 @@ Removes the route at index i. - - + +

`setting` :
`i` :	index number of the route	Returns :	+`TRUE` if this connection doesn't require IPv4 addressing to complete +for the connection to succeed.

@@ -1813,6 +1978,6 @@ or 'disabled' methods because there is no upstream network.

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

Synopsis

Object Hierarchy

Properties

Details

NMIP4Address

NMIP4Route

NMSettingIP4Config

NMSettingIP4ConfigClass

NM_SETTING_IP4_CONFIG_SETTING_NAME

NM_SETTING_IP4_CONFIG_ADDRESSES

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

NM_SETTING_IP4_CONFIG_ERROR

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

nm_setting_ip4_config_error_quark ()

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

NM_SETTING_IP4_CONFIG_METHOD

NM_SETTING_IP4_CONFIG_ERROR

NM_SETTING_IP4_CONFIG_ADDRESSES

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

NM_SETTING_IP4_CONFIG_ROUTES

NM_SETTING_IP4_CONFIG_MAY_FAIL

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

NM_SETTING_IP4_CONFIG_METHOD

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

NM_SETTING_IP4_CONFIG_METHOD_AUTO

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

NM_SETTING_IP4_CONFIG_MAY_FAIL

NM_SETTING_IP4_CONFIG_METHOD_SHARED

NM_SETTING_IP4_CONFIG_METHOD_AUTO

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

NM_SETTING_IP4_CONFIG_METHOD_SHARED

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

NM_SETTING_IP4_CONFIG_ROUTES

NMIP4Address

NM_SETTING_IP4_CONFIG_SETTING_NAME

nm_ip4_address_new ()

nm_ip4_address_compare ()

nm_ip4_address_dup ()

nm_ip4_address_dup ()

nm_ip4_address_ref ()

nm_ip4_address_unref ()

nm_ip4_address_compare ()

nm_ip4_address_get_gateway ()

nm_ip4_address_set_address ()

nm_ip4_address_new ()

nm_ip4_address_ref ()

nm_ip4_address_set_prefix ()

nm_ip4_address_set_address ()

nm_ip4_address_get_gateway ()

nm_ip4_address_set_prefix ()

NMIP4Route

nm_ip4_route_new ()

nm_ip4_route_dup ()

nm_ip4_address_unref ()

nm_ip4_route_ref ()

nm_ip4_route_unref ()

nm_ip4_route_dup ()

nm_ip4_route_get_dest ()

nm_ip4_route_get_dest ()

nm_ip4_route_set_dest ()

nm_ip4_route_get_metric ()

nm_ip4_route_get_prefix ()

nm_ip4_route_get_next_hop ()

nm_ip4_route_set_prefix ()

nm_ip4_route_get_prefix ()

nm_ip4_route_get_next_hop ()

nm_ip4_route_new ()

nm_ip4_route_ref ()

nm_ip4_route_set_next_hop ()

nm_ip4_route_set_dest ()

nm_ip4_route_get_metric ()

nm_ip4_route_set_next_hop ()

NMSettingIP4Config