Properties

@@ -211,15 +206,46 @@ properties related to IPv4 addressing, routing, and Domain Name Service

Details

NM_SETTING_IP4_CONFIG_SETTING_NAME

#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
+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;

enum NMSettingIP4ConfigError

typedef enum {
 	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,
 	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,
@@ -257,39 +283,32 @@ not valid with the given IP4 method

NM_TYPE_SETTING_IP4_CONFIG_ERROR

#define NM_TYPE_SETTING_IP4_CONFIG_ERROR (nm_setting_ip4_config_error_get_type ()) +

NM_SETTING_IP4_CONFIG_ADDRESSES

#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"

NM_SETTING_IP4_CONFIG_ERROR

#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark () +

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"

nm_setting_ip4_config_error_quark ()

GQuark              nm_setting_ip4_config_error_quark   (void);

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+

-Registers an error quark for NMSettingIP4Config if necessary.

-- - - - -

Returns :

the error quark used for NMSettingIP4Config errors.

NM_SETTING_IP4_CONFIG_METHOD

#define NM_SETTING_IP4_CONFIG_METHOD             "method"
+NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
+#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
 
 
 
@@ -312,159 +331,140 @@ Registers an error quark for 
 
 
-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"
+NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
+#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
 
 
 
 
 
 
-NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
-#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+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"
 
 
+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_DHCP_SEND_HOSTNAME
-#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+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_DHCP_HOSTNAME
-#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+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_NEVER_DEFAULT
-#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
+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_MAY_FAIL
-#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
+NM_SETTING_IP4_CONFIG_METHOD_SHARED
+#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
 
 
+This connection specifies configuration that allows other computers to
+connect through it to the default network (usually the Internet).  The
+connection's interface will be assigned a private address, and a DHCP server,
+caching DNS server, and Network Address Translation (NAT) functionality will
+be started on this connection's interface to allow other devices to connect
+through that interface to the default network.
 
 
 
 
-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"
+NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
+#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
 
 
-This connection specifies configuration that allows other computers to
-connect through it to the default network (usually the Internet).  The
-connection's interface will be assigned a private address, and a DHCP server,
-caching DNS server, and Network Address Translation (NAT) functionality will
-be started on this connection's interface to allow other devices to connect
-through that interface to the default network.
 
 
 
 
-NM_SETTING_IP4_CONFIG_METHOD_DISABLED
-#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
+NM_SETTING_IP4_CONFIG_ROUTES
+#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
 
 
-This connection does not use or require IPv4 address and it should be disabled.
 
 
 
 
-NMIP4Address
-typedef struct NMIP4Address NMIP4Address;
+NM_SETTING_IP4_CONFIG_SETTING_NAME
+#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
 
 
 
 
 
 
-nm_ip4_address_get_type ()
-GType               nm_ip4_address_get_type             (void);
-
-
-
-
-
-nm_ip4_address_new ()
-NMIP4Address *      nm_ip4_address_new                  (void);
+nm_ip4_address_compare ()
+gboolean            nm_ip4_address_compare              (NMIP4Address *address,
+                                                         NMIP4Address *other);
 
-Creates and returns a new NMIP4Address object.
+Determines if two NMIP4Address objects contain the same values.
 
 -
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
 
Returns : the new empty NMIP4Address object. [transfer full]
+
address : the NMIP4Address
 
other : the NMIP4Address to compare address to.
Returns : 
+TRUE if the objects contain the same values, FALSE if they do not.
 
 
 
@@ -491,44 +491,55 @@ Copies a given 
 
 
-nm_ip4_address_ref ()
-void                nm_ip4_address_ref                  (NMIP4Address *address);
+nm_ip4_address_get_address ()
+guint32             nm_ip4_address_get_address          (NMIP4Address *address);
 
-Increases the reference count of the object.
+Gets the IPv4 address property of this address object.
 
 -
+
+
-
+
+
+
+
+
+
 

 address :
 the NMIP4Address
 
Returns : the IPv4 address in network byte order
 
 
 
 
-nm_ip4_address_unref ()
-void                nm_ip4_address_unref                (NMIP4Address *address);
+nm_ip4_address_get_gateway ()
+guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
 
-Decreases the reference count of the object.  If the reference count
-reaches zero, the object will be destroyed.
+Gets the IPv4 default gateway property of this address object.
 
 -
+
+
-
+
+
+
+
+
+
 

 address :
 the NMIP4Address
 
Returns : the IPv4 gateway address in network byte order
 
 
 
 
-nm_ip4_address_compare ()
-gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);
+nm_ip4_address_get_prefix ()
+guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);
 
-Determines if two NMIP4Address objects contain the same values.
+Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address
+object.
 
 @@ -539,37 +550,42 @@ Determines if two 
 
 
-
-
-
-
-
+
 
other : the NMIP4Address to compare address to.

 Returns : 
-TRUE if the objects contain the same values, FALSE if they do not. the IPv4 address prefix
 
 
 

 

 
 
-nm_ip4_address_get_address ()
-guint32             nm_ip4_address_get_address          (NMIP4Address *address);
+nm_ip4_address_new ()
+NMIP4Address *      nm_ip4_address_new                  (void);
 
-Gets the IPv4 address property of this address object.
+Creates and returns a new NMIP4Address object.
 
 -
-
+
+
+
+
+
 
Returns : the new empty NMIP4Address object. [transfer full]
+
+
+
+
+nm_ip4_address_ref ()
+void                nm_ip4_address_ref                  (NMIP4Address *address);
+
+Increases the reference count of the object.
+
+
++
-
-
-
-
-
-
+

 address :
 the NMIP4Address
 
Returns : the IPv4 address in network byte order
 
 
 
@@ -597,11 +613,11 @@ Sets the IPv4 address property of this object.

-
nm_ip4_address_get_prefix ()
-
guint32 nm_ip4_address_get_prefix (NMIP4Address *address);
+
nm_ip4_address_set_gateway ()
+
void nm_ip4_address_set_gateway (NMIP4Address *address, + guint32 gateway);

-Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address -object. +Sets the IPv4 default gateway property of this address object.

@@ -612,8 +628,8 @@ object. - - + +

Returns :
the IPv4 address prefix
gateway :
the IPv4 default gateway in network byte order

@@ -643,78 +659,47 @@ Sets the IPv4 address prefix.

-
nm_ip4_address_get_gateway ()
-
guint32 nm_ip4_address_get_gateway (NMIP4Address *address);
+
nm_ip4_address_unref ()
+
void nm_ip4_address_unref (NMIP4Address *address);

-Gets the IPv4 default gateway property of this address object. +Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

- - + - - - - - - +

address :
the NMIP4Address
Returns :
the IPv4 gateway address in network byte order

-
nm_ip4_address_set_gateway ()
-
void nm_ip4_address_set_gateway (NMIP4Address *address, - guint32 gateway);
+
nm_ip4_route_compare ()
+
gboolean nm_ip4_route_compare (NMIP4Route *route, + NMIP4Route *other);

-Sets the IPv4 default gateway property of this address object. +Determines if two NMIP4Route objects contain the same values.

- - + - - + + - -

address :
the NMIP4Address +
route :
the NMIP4Route

gateway :
the IPv4 default gateway in network byte order
other :
the NMIP4Route to compare route to.
-
-
-
-
NMIP4Route
-
typedef struct NMIP4Route NMIP4Route; -
-
-
-
-
-
-
nm_ip4_route_get_type ()
-
GType nm_ip4_route_get_type (void);
-
-
-
-
-
-
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] -
+TRUE if the objects contain the same values, FALSE if they do not.

@@ -741,44 +726,55 @@ Copies a given

-
nm_ip4_route_ref ()
-
void nm_ip4_route_ref (NMIP4Route *route);
+
nm_ip4_route_get_dest ()
+
guint32 nm_ip4_route_get_dest (NMIP4Route *route);

-Increases the reference count of the object. +Gets the IPv4 destination address property of this route object.

- + + - + + + + + +

route :
the NMIP4Route
Returns :
the IPv4 address in network byte order

-
nm_ip4_route_unref ()
-
void nm_ip4_route_unref (NMIP4Route *route);
+
nm_ip4_route_get_metric ()
+
guint32 nm_ip4_route_get_metric (NMIP4Route *route);

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. +Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

- + + - + + + + + +

route :
the NMIP4Route
Returns :
the route metric

-
nm_ip4_route_compare ()
-
gboolean nm_ip4_route_compare (NMIP4Route *route, - NMIP4Route *other);
+
nm_ip4_route_get_next_hop ()
+
guint32 nm_ip4_route_get_next_hop (NMIP4Route *route);

-Determines if two NMIP4Route objects contain the same values. +Gets the IPv4 address of the next hop of this route.

@@ -789,23 +785,18 @@ Determines if two - - - - - +

other :
the NMIP4Route to compare route to.

Returns :
-TRUE if the objects contain the same values, FALSE if they do not. the IPv4 address in network byte order

-
nm_ip4_route_get_dest ()
-
guint32 nm_ip4_route_get_dest (NMIP4Route *route);
+
nm_ip4_route_get_prefix ()
+
guint32 nm_ip4_route_get_prefix (NMIP4Route *route);

-Gets the IPv4 destination address property of this route object. +Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

@@ -817,63 +808,50 @@ Gets the IPv4 destination address property of this route object. - +

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

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

-Sets the IPv4 destination address property of this route object. +Creates and returns a new NMIP4Route object.

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

route :
the NMIP4Route +
Returns :
the new empty NMIP4Route object. [transfer full]
dest :
the destination address in network byte order

-
nm_ip4_route_get_prefix ()
-
guint32 nm_ip4_route_get_prefix (NMIP4Route *route);
+
nm_ip4_route_ref ()
+
void nm_ip4_route_ref (NMIP4Route *route);

-Gets the IPv4 prefix (ie "24" or "30" etc) of this route. +Increases the reference count of the object.

- - + - - - - - - +

route :
the NMIP4Route
Returns :
the IPv4 prefix

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

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

@@ -884,18 +862,20 @@ Sets the IPv4 prefix of this route. - - + +

prefix :
the prefix, a number between 1 and 32 inclusive
dest :
the destination address in network byte order

-
nm_ip4_route_get_next_hop ()
-
guint32 nm_ip4_route_get_next_hop (NMIP4Route *route);
+
nm_ip4_route_set_metric ()
+
void nm_ip4_route_set_metric (NMIP4Route *route, + guint32 metric);

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

@@ -906,8 +886,8 @@ Gets the IPv4 address of the next hop of this route. - - + +

Returns :
the IPv4 address in network byte order
metric :
the route metric

@@ -937,11 +917,11 @@ Sets the IPv4 address of the next hop of this route.

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

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

@@ -952,88 +932,40 @@ Gets the route metric property of this route object; lower values indicate - - + +

Returns :
the route metric
prefix :
the prefix, a number between 1 and 32 inclusive

-
nm_ip4_route_set_metric ()
-
void nm_ip4_route_set_metric (NMIP4Route *route, - guint32 metric);
+
nm_ip4_route_unref ()
+
void nm_ip4_route_unref (NMIP4Route *route);

-Sets the route metric property of this route object; lower values indicate -"better" or more preferred routes. +Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

- - + - - - - - - +

route :
the NMIP4Route
metric :
the route metric

-
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_get_type ()
-
GType nm_setting_ip4_config_get_type (void);
-
-
-
-
-
-
nm_setting_ip4_config_new ()
-
NMSetting * nm_setting_ip4_config_new (void);
+
nm_setting_ip4_config_add_address ()
+
gboolean nm_setting_ip4_config_add_address (NMSettingIP4Config *setting, + NMIP4Address *address);

-Creates a new NMSettingIP4Config object with default values. +Adds a new IPv4 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

- - - - -

Returns :
the new empty NMSettingIP4Config object. [transfer full] -
-
-
-
-
nm_setting_ip4_config_get_method ()
-
const char * nm_setting_ip4_config_get_method (NMSettingIP4Config *setting);
-
- @@ -1041,16 +973,26 @@ Creates a new address :
+ + + - +

setting :
the new address to add

Returns :
the "method" property of the setting +TRUE if the address was added; FALSE if the address was already +known.

-
nm_setting_ip4_config_get_num_dns ()
-
guint32 nm_setting_ip4_config_get_num_dns (NMSettingIP4Config *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. +

@@ -1060,17 +1002,27 @@ Creates a new dns :
+ + + - +

the IPv4 address (network byte order) of the DNS server to add

Returns :
the number of configured DNS servers +TRUE if the DNS server was added; FALSE if the server was already +known

-
nm_setting_ip4_config_get_dns ()
-
guint32 nm_setting_ip4_config_get_dns (NMSettingIP4Config *setting, - guint32 i);
+
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. +

@@ -1080,25 +1032,26 @@ Creates a new i :
- + + - +

index number of the DNS server to return
dns_search :
the search domain to add

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

-
nm_setting_ip4_config_add_dns ()
-
gboolean nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting, - guint32 dns);
+
nm_setting_ip4_config_add_route ()
+
gboolean nm_setting_ip4_config_add_route (NMSettingIP4Config *setting, + NMIP4Route *route);

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

@@ -1109,39 +1062,32 @@ Adds a new DNS server to the setting. - - + + +TRUE if the route was added; FALSE if the route was already known.

dns :
the IPv4 address (network byte order) of the DNS server to add
route :
the route to add

Returns :
-TRUE if the DNS server was added; FALSE if the server was already -known

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

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

- - + - - - - - - +

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

@@ -1162,29 +1108,56 @@ Removes all configured DNS servers.

-
nm_setting_ip4_config_get_num_dns_searches ()
-
guint32 nm_setting_ip4_config_get_num_dns_searches +
nm_setting_ip4_config_clear_dns_searches ()
+
void nm_setting_ip4_config_clear_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 number of configured DNS search domains
the error quark used for NMSettingIP4Config errors.

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

@@ -1196,11 +1169,11 @@ Removes all configured DNS servers. - + - @@ -1208,12 +1181,12 @@ Removes all configured DNS servers.
-
nm_setting_ip4_config_add_dns_search ()
-
gboolean nm_setting_ip4_config_add_dns_search - (NMSettingIP4Config *setting, - const char *dns_search);
+
nm_setting_ip4_config_get_dhcp_client_id ()
+
const char * nm_setting_ip4_config_get_dhcp_client_id + (NMSettingIP4Config *setting);

-Adds a new DNS search domain to the setting. +Returns the value contained in the "dhcp-client-id" +property.

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

@@ -1224,26 +1197,21 @@ Adds a new DNS search domain to the setting. - - - - - +

dns_search :
the search domain to add

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

-
nm_setting_ip4_config_remove_dns_search ()
-
void nm_setting_ip4_config_remove_dns_search - (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 search domain at index i. +Returns the value contained in the "dhcp-hostname" +property.

@@ -1254,34 +1222,44 @@ Removes the DNS search domain at index i - - + +

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

-
nm_setting_ip4_config_clear_dns_searches ()
-
void nm_setting_ip4_config_clear_dns_searches +
nm_setting_ip4_config_get_dhcp_send_hostname ()
+
gboolean nm_setting_ip4_config_get_dhcp_send_hostname (NMSettingIP4Config *setting);

-Removes all configured DNS search domains. +Returns the value contained in the "dhcp-send-hostname" +property.

- + + - + + + + + +

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_num_addresses ()
-
guint32 nm_setting_ip4_config_get_num_addresses - (NMSettingIP4Config *setting);
+
nm_setting_ip4_config_get_dns ()
+
guint32 nm_setting_ip4_config_get_dns (NMSettingIP4Config *setting, + guint32 i);

@@ -1291,16 +1269,23 @@ Removes all configured DNS search domains. + + + + - +

i :
index number of the DNS server to return

Returns :
the number of configured addresses the IPv4 address (network byte order) of the DNS server at index +i +

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

@@ -1312,11 +1297,11 @@ Removes all configured DNS search domains. - + - @@ -1324,12 +1309,12 @@ Removes all configured DNS search domains.
-
nm_setting_ip4_config_add_address ()
-
gboolean nm_setting_ip4_config_add_address (NMSettingIP4Config *setting, - NMIP4Address *address);
+
nm_setting_ip4_config_get_ignore_auto_dns ()
+
gboolean nm_setting_ip4_config_get_ignore_auto_dns + (NMSettingIP4Config *setting);

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

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

@@ -1340,26 +1325,22 @@ given address is duplicated internally and is not changed by this function. - - - - +TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.

address :
the new address to add

Returns :
-TRUE if the address was added; FALSE if the address was already -known.

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

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

@@ -1370,36 +1351,24 @@ Removes the address at index i. - - + +

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

-
nm_setting_ip4_config_clear_addresses ()
-
void nm_setting_ip4_config_clear_addresses - (NMSettingIP4Config *setting);
+
nm_setting_ip4_config_get_may_fail ()
+
gboolean nm_setting_ip4_config_get_may_fail (NMSettingIP4Config *setting);

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

- - - - -

setting :
the NMSettingIP4Config -
-
-
-
-
nm_setting_ip4_config_get_num_routes ()
-
guint32 nm_setting_ip4_config_get_num_routes - (NMSettingIP4Config *setting);
-
- @@ -1408,16 +1377,17 @@ Removes all configured addresses. - +

setting :

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

-
nm_setting_ip4_config_get_route ()
-
NMIP4Route * nm_setting_ip4_config_get_route (NMSettingIP4Config *setting, - guint32 i);
+
nm_setting_ip4_config_get_method ()
+
const char * nm_setting_ip4_config_get_method (NMSettingIP4Config *setting);

@@ -1427,25 +1397,20 @@ Removes all configured addresses. - - - - - +

i :
index number of the route to return

Returns :
the route at index i - the "method" property of the setting

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

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

@@ -1456,25 +1421,19 @@ given route is duplicated internally and is not changed by this function. - - - - +TRUE if this connection should never be the default connection +for IPv4 addressing

route :
the route to add

Returns :
-TRUE if the route was added; FALSE if the route was already known.

-
nm_setting_ip4_config_remove_route ()
-
void nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting, - guint32 i);
-
-Removes the route at index i. -
+
nm_setting_ip4_config_get_num_addresses ()
+
guint32 nm_setting_ip4_config_get_num_addresses + (NMSettingIP4Config *setting);

@@ -1484,37 +1443,36 @@ Removes the route at index i. - - + +

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

-
nm_setting_ip4_config_clear_routes ()
-
void nm_setting_ip4_config_clear_routes (NMSettingIP4Config *setting);
-
-Removes all configured routes. -
+
nm_setting_ip4_config_get_num_dns ()
+
guint32 nm_setting_ip4_config_get_num_dns (NMSettingIP4Config *setting);

- + + - + + + + + +

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

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

@@ -1525,22 +1483,16 @@ property. - +

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

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

@@ -1551,22 +1503,16 @@ property. - +

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

-
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. -
+
nm_setting_ip4_config_get_route ()
+
NMIP4Route * nm_setting_ip4_config_get_route (NMSettingIP4Config *setting, + guint32 i);

@@ -1576,21 +1522,41 @@ property. + + + + - +

i :
index number of the route to return

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

-
nm_setting_ip4_config_get_dhcp_send_hostname ()
-
gboolean nm_setting_ip4_config_get_dhcp_send_hostname - (NMSettingIP4Config *setting);
+
nm_setting_ip4_config_new ()
+
NMSetting * nm_setting_ip4_config_new (void);

-Returns the value contained in the "dhcp-send-hostname" -property. +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);
+
+Removes the address at index i.

@@ -1601,23 +1567,19 @@ property. - - + +

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.
i :
index number of the address to remove

-
nm_setting_ip4_config_get_dhcp_hostname ()
-
const char * nm_setting_ip4_config_get_dhcp_hostname - (NMSettingIP4Config *setting);
+
nm_setting_ip4_config_remove_dns ()
+
void nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting, + guint32 i);

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

@@ -1628,20 +1590,20 @@ property. - - + +

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

-
nm_setting_ip4_config_get_never_default ()
-
gboolean nm_setting_ip4_config_get_never_default - (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 "never-default" -property. +Removes the DNS search domain at index i.

@@ -1652,21 +1614,19 @@ property. - - + +

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

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

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

@@ -1677,10 +1637,8 @@ property. - - + +

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

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

- Generated by GTK-Doc V1.17
+ Generated by GTK-Doc V1.18

Returns :	the new empty NMIP4Address object. [transfer full] +
`address` :	the NMIP4Address
`other` :	the NMIP4Address to compare `address` to.
Returns :	+`TRUE` if the objects contain the same values, `FALSE` if they do not.

`address` :	the NMIP4Address +	`route` :	the NMIP4Route
`gateway` :	the IPv4 default gateway in network byte order	`other` :	the NMIP4Route to compare `route` to.

Returns :	the new empty NMIP4Route object. [transfer full] -
+`TRUE` if the objects contain the same values, `FALSE` if they do not.

`route` :	the NMIP4Route +
Returns :	the new empty NMIP4Route object. [transfer full]
`dest` :	the destination address in network byte order

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

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

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

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

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

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

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

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

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

Synopsis

Object Hierarchy

Properties

Details

NM_SETTING_IP4_CONFIG_SETTING_NAME

NMIP4Address

NMIP4Route

NMSettingIP4Config

NMSettingIP4ConfigClass

enum NMSettingIP4ConfigError

enum NMSettingIP4ConfigError

NM_TYPE_SETTING_IP4_CONFIG_ERROR

NM_SETTING_IP4_CONFIG_ADDRESSES

NM_SETTING_IP4_CONFIG_ERROR

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

nm_setting_ip4_config_error_quark ()

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

NM_SETTING_IP4_CONFIG_METHOD

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

NM_SETTING_IP4_CONFIG_ADDRESSES

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

NM_SETTING_IP4_CONFIG_ROUTES

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_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_get_type ()

nm_ip4_address_new ()

nm_ip4_address_compare ()

nm_ip4_address_ref ()

nm_ip4_address_get_address ()

nm_ip4_address_unref ()

nm_ip4_address_get_gateway ()

nm_ip4_address_compare ()

nm_ip4_address_get_prefix ()

nm_ip4_address_get_address ()

nm_ip4_address_new ()

nm_ip4_address_ref ()

nm_ip4_address_get_prefix ()

nm_ip4_address_set_gateway ()

nm_ip4_address_get_gateway ()

nm_ip4_address_unref ()

nm_ip4_address_set_gateway ()

nm_ip4_route_compare ()

NMIP4Route

nm_ip4_route_get_type ()

nm_ip4_route_new ()

nm_ip4_route_ref ()

nm_ip4_route_get_dest ()

nm_ip4_route_unref ()

nm_ip4_route_get_metric ()

nm_ip4_route_compare ()

nm_ip4_route_get_next_hop ()

nm_ip4_route_get_dest ()

nm_ip4_route_get_prefix ()

nm_ip4_route_set_dest ()

nm_ip4_route_new ()

nm_ip4_route_get_prefix ()

nm_ip4_route_ref ()

nm_ip4_route_set_prefix ()