From 85563b7fc7ec2cd21e38debb9b28db342e2e8e7c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 21 Apr 2019 21:09:51 +0200 Subject: New upstream version 1.18.0 --- docs/libnm/html/NMSettingIPConfig.html | 3647 ++++++++++++++++++++++++-------- 1 file changed, 2763 insertions(+), 884 deletions(-) (limited to 'docs/libnm/html/NMSettingIPConfig.html') diff --git a/docs/libnm/html/NMSettingIPConfig.html b/docs/libnm/html/NMSettingIPConfig.html index 873cdb84..18c74120 100644 --- a/docs/libnm/html/NMSettingIPConfig.html +++ b/docs/libnm/html/NMSettingIPConfig.html @@ -367,25 +367,35 @@ -const char * + +NMIPRoutingRule * -nm_setting_ip_config_get_method () +nm_ip_routing_rule_new () -guint +NMIPRoutingRule * -nm_setting_ip_config_get_num_dns () +nm_ip_routing_rule_new_clone () -const char * + +NMIPRoutingRule * -nm_setting_ip_config_get_dns () +nm_ip_routing_rule_ref () + + + + +void + + +nm_ip_routing_rule_unref () @@ -393,7 +403,7 @@ gboolean -nm_setting_ip_config_add_dns () +nm_ip_routing_rule_is_sealed () @@ -401,7 +411,15 @@ void -nm_setting_ip_config_remove_dns () +nm_ip_routing_rule_seal () + + + + +int + + +nm_ip_routing_rule_get_addr_family () @@ -409,7 +427,7 @@ gboolean -nm_setting_ip_config_remove_dns_by_value () +nm_ip_routing_rule_get_invert () @@ -417,30 +435,31 @@ void -nm_setting_ip_config_clear_dns () +nm_ip_routing_rule_set_invert () -guint +gint64 -nm_setting_ip_config_get_num_dns_searches () +nm_ip_routing_rule_get_priority () -const char * + +void -nm_setting_ip_config_get_dns_search () +nm_ip_routing_rule_set_priority () -gboolean +guint8 -nm_setting_ip_config_add_dns_search () +nm_ip_routing_rule_get_tos () @@ -448,15 +467,15 @@ void -nm_setting_ip_config_remove_dns_search () +nm_ip_routing_rule_set_tos () -gboolean +guint8 -nm_setting_ip_config_remove_dns_search_by_value () +nm_ip_routing_rule_get_ipproto () @@ -464,46 +483,47 @@ void -nm_setting_ip_config_clear_dns_searches () +nm_ip_routing_rule_set_ipproto () -guint +guint16 -nm_setting_ip_config_get_num_dns_options () +nm_ip_routing_rule_get_source_port_start () -gboolean +guint16 -nm_setting_ip_config_has_dns_options () +nm_ip_routing_rule_get_source_port_end () -const char * + +void -nm_setting_ip_config_get_dns_option () +nm_ip_routing_rule_set_source_port () -int +guint16 -nm_setting_ip_config_next_valid_dns_option () +nm_ip_routing_rule_get_destination_port_start () -gboolean +guint16 -nm_setting_ip_config_add_dns_option () +nm_ip_routing_rule_get_destination_port_end () @@ -511,71 +531,69 @@ void -nm_setting_ip_config_remove_dns_option () +nm_ip_routing_rule_set_destination_port () -gboolean +guint32 -nm_setting_ip_config_remove_dns_option_by_value () +nm_ip_routing_rule_get_fwmark () -void +guint32 -nm_setting_ip_config_clear_dns_options () +nm_ip_routing_rule_get_fwmask () -int +void -nm_setting_ip_config_get_dns_priority () +nm_ip_routing_rule_set_fwmark () -guint +guint8 -nm_setting_ip_config_get_num_addresses () +nm_ip_routing_rule_get_from_len () - -NMIPAddress * +const char * -nm_setting_ip_config_get_address () +nm_ip_routing_rule_get_from () -gboolean +void -nm_setting_ip_config_add_address () +nm_ip_routing_rule_set_from () -void +guint8 -nm_setting_ip_config_remove_address () +nm_ip_routing_rule_get_to_len () - -gboolean +const char * -nm_setting_ip_config_remove_address_by_value () +nm_ip_routing_rule_get_to () @@ -583,38 +601,45 @@ void -nm_setting_ip_config_clear_addresses () +nm_ip_routing_rule_set_to () const char * -nm_setting_ip_config_get_gateway () +nm_ip_routing_rule_get_iifname () -guint +void -nm_setting_ip_config_get_num_routes () +nm_ip_routing_rule_set_iifname () + + + +const char * + + +nm_ip_routing_rule_get_oifname () -NMIPRoute * +void -nm_setting_ip_config_get_route () +nm_ip_routing_rule_set_oifname () -gboolean +guint8 -nm_setting_ip_config_add_route () +nm_ip_routing_rule_get_action () @@ -622,15 +647,15 @@ void -nm_setting_ip_config_remove_route () +nm_ip_routing_rule_set_action () -gboolean +guint32 -nm_setting_ip_config_remove_route_by_value () +nm_ip_routing_rule_get_table () @@ -638,54 +663,61 @@ void -nm_setting_ip_config_clear_routes () +nm_ip_routing_rule_set_table () -gint64 +int -nm_setting_ip_config_get_route_metric () +nm_ip_routing_rule_cmp () -guint32 +gboolean -nm_setting_ip_config_get_route_table () +nm_ip_routing_rule_validate () -gboolean +NMIPRoutingRule * -nm_setting_ip_config_get_ignore_auto_routes () +nm_ip_routing_rule_from_string () -gboolean +char * -nm_setting_ip_config_get_ignore_auto_dns () +nm_ip_routing_rule_to_string () const char * -nm_setting_ip_config_get_dhcp_hostname () +nm_setting_ip_config_get_method () -gboolean +guint -nm_setting_ip_config_get_dhcp_send_hostname () +nm_setting_ip_config_get_num_dns () + + + +const char * + + +nm_setting_ip_config_get_dns () @@ -693,255 +725,599 @@ gboolean -nm_setting_ip_config_get_never_default () +nm_setting_ip_config_add_dns () -gboolean +void -nm_setting_ip_config_get_may_fail () +nm_setting_ip_config_remove_dns () -int +gboolean -nm_setting_ip_config_get_dad_timeout () +nm_setting_ip_config_remove_dns_by_value () -int +void -nm_setting_ip_config_get_dhcp_timeout () +nm_setting_ip_config_clear_dns () - - - -
-

Properties

-
----- - - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - + + - - - - - - - - + + - - - + + - - - + + - - - + + - - - + + - -
-GPtrArray *addressesRead / Write +guint + +nm_setting_ip_config_get_num_dns_searches () +
gintdad-timeoutRead / Write / Constructconst char * + +nm_setting_ip_config_get_dns_search () +
-gchar *dhcp-hostnameRead / Write +gboolean + +nm_setting_ip_config_add_dns_search () +
gbooleandhcp-send-hostnameRead / Write / Construct +void + +nm_setting_ip_config_remove_dns_search () +
gintdhcp-timeoutRead / Write +gboolean + +nm_setting_ip_config_remove_dns_search_by_value () +
GStrvdnsRead / Write +void + +nm_setting_ip_config_clear_dns_searches () +
GStrvdns-optionsRead / Write +guint + +nm_setting_ip_config_get_num_dns_options () +
gintdns-priorityRead / Write / Construct +gboolean + +nm_setting_ip_config_has_dns_options () +
GStrvdns-searchRead / Writeconst char * + +nm_setting_ip_config_get_dns_option () +
-gchar *gatewayRead / Write +int + +nm_setting_ip_config_next_valid_dns_option () +
gbooleanignore-auto-dnsRead / Write / Construct +gboolean + +nm_setting_ip_config_add_dns_option () +
gbooleanignore-auto-routesRead / Write / Construct +void + +nm_setting_ip_config_remove_dns_option () +
gbooleanmay-failRead / Write / Construct
-gchar *methodRead / Write +gboolean + +nm_setting_ip_config_remove_dns_option_by_value () +
gbooleannever-defaultRead / Write / Construct +void + +nm_setting_ip_config_clear_dns_options () +
gint64route-metricRead / Write / Construct +int + +nm_setting_ip_config_get_dns_priority () +
guintroute-tableRead / Write +guint + +nm_setting_ip_config_get_num_addresses () +
-GPtrArray *routesRead / Write +NMIPAddress * + +nm_setting_ip_config_get_address () +
-
-
-

Types and Values

-
---- - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + + + +
#defineNM_IP_ADDRESS_ATTRIBUTE_LABEL +gboolean + +nm_setting_ip_config_add_address () +
#defineNM_IP_ROUTE_ATTRIBUTE_TABLE +void + +nm_setting_ip_config_remove_address () +
#defineNM_IP_ROUTE_ATTRIBUTE_SRC +gboolean + +nm_setting_ip_config_remove_address_by_value () +
#defineNM_IP_ROUTE_ATTRIBUTE_FROM +void + +nm_setting_ip_config_clear_addresses () +
#defineNM_IP_ROUTE_ATTRIBUTE_TOSconst char * + +nm_setting_ip_config_get_gateway () +
#defineNM_IP_ROUTE_ATTRIBUTE_ONLINK +guint + +nm_setting_ip_config_get_num_routes () +
#defineNM_IP_ROUTE_ATTRIBUTE_WINDOW +NMIPRoute * + +nm_setting_ip_config_get_route () +
#defineNM_IP_ROUTE_ATTRIBUTE_CWND +gboolean + +nm_setting_ip_config_add_route () +
#defineNM_IP_ROUTE_ATTRIBUTE_INITCWND +void + +nm_setting_ip_config_remove_route () +
#defineNM_IP_ROUTE_ATTRIBUTE_INITRWND +gboolean + +nm_setting_ip_config_remove_route_by_value () +
#defineNM_IP_ROUTE_ATTRIBUTE_MTU +void + +nm_setting_ip_config_clear_routes () +
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_WINDOW +gint64 + +nm_setting_ip_config_get_route_metric () +
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_CWND +guint32 + +nm_setting_ip_config_get_route_table () +
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_INITCWND +guint + +nm_setting_ip_config_get_num_routing_rules () +
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_INITRWND +NMIPRoutingRule * + +nm_setting_ip_config_get_routing_rule () +
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_MTU +void + +nm_setting_ip_config_add_routing_rule () +
#defineNM_SETTING_IP_CONFIG_DAD_TIMEOUT_MAX +void + +nm_setting_ip_config_remove_routing_rule () +
#defineNM_SETTING_IP_CONFIG_METHOD +void + +nm_setting_ip_config_clear_routing_rules () +
#defineNM_SETTING_IP_CONFIG_DNS +gboolean + +nm_setting_ip_config_get_ignore_auto_routes () +
#defineNM_SETTING_IP_CONFIG_DNS_SEARCH +gboolean + +nm_setting_ip_config_get_ignore_auto_dns () +
#defineNM_SETTING_IP_CONFIG_DNS_OPTIONSconst char * + +nm_setting_ip_config_get_dhcp_hostname () +
#defineNM_SETTING_IP_CONFIG_DNS_PRIORITY +gboolean + +nm_setting_ip_config_get_dhcp_send_hostname () +
#defineNM_SETTING_IP_CONFIG_ADDRESSES +gboolean + +nm_setting_ip_config_get_never_default () +
#defineNM_SETTING_IP_CONFIG_GATEWAY +gboolean + +nm_setting_ip_config_get_may_fail () +
#defineNM_SETTING_IP_CONFIG_ROUTES +int + +nm_setting_ip_config_get_dad_timeout () +
#defineNM_SETTING_IP_CONFIG_ROUTE_METRIC
+int + +nm_setting_ip_config_get_dhcp_timeout () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GPtrArray *addressesRead / Write
gintdad-timeoutRead / Write / Construct
+gchar *dhcp-hostnameRead / Write
gbooleandhcp-send-hostnameRead / Write / Construct
gintdhcp-timeoutRead / Write
GStrvdnsRead / Write
GStrvdns-optionsRead / Write
gintdns-priorityRead / Write / Construct
GStrvdns-searchRead / Write
+gchar *gatewayRead / Write
gbooleanignore-auto-dnsRead / Write / Construct
gbooleanignore-auto-routesRead / Write / Construct
gbooleanmay-failRead / Write / Construct
+gchar *methodRead / Write
gbooleannever-defaultRead / Write / Construct
gint64route-metricRead / Write / Construct
guintroute-tableRead / Write
+GPtrArray *routesRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -980,6 +1356,10 @@ + + + + @@ -1049,7 +1429,10 @@

Object Hierarchy

    GBoxed
     ├── NMIPAddress
-    ╰── NMIPRoute
+    ├── NMIPRoute
+    ╰── NMIPRoutingRule
+    GFlags
+    ╰── NMIPRoutingRuleAsStringFlags
     GObject
     ╰── NMSetting
         ╰── NMSettingIPConfig
@@ -1062,24 +1445,1306 @@
 
#include <nm-setting-ip-config.h>
 

 
-

-
Description

-
NMSettingIPConfig is the abstract base class of
-NMSettingIP4Config and NMSettingIP6Config, providing properties
-related to IP addressing, routing, and Domain Name Service.

+

+
Description

+
NMSettingIPConfig is the abstract base class of
+NMSettingIP4Config and NMSettingIP6Config, providing properties
+related to IP addressing, routing, and Domain Name Service.

+

+

+
Functions

+

+
nm_ip_address_new ()

+
NMIPAddress *
+nm_ip_address_new (int family,
+                   const char *addr,
+                   guint prefix,
+                   GError **error);

+
Creates a new NMIPAddress object.

+

+
Parameters

+
#defineNM_IP_ADDRESS_ATTRIBUTE_LABEL
#defineNM_IP_ROUTE_ATTRIBUTE_TABLE
#defineNM_IP_ROUTE_ATTRIBUTE_SRC
#defineNM_IP_ROUTE_ATTRIBUTE_FROM
#defineNM_IP_ROUTE_ATTRIBUTE_TOS
#defineNM_IP_ROUTE_ATTRIBUTE_ONLINK
#defineNM_IP_ROUTE_ATTRIBUTE_WINDOW
#defineNM_IP_ROUTE_ATTRIBUTE_CWND
#defineNM_IP_ROUTE_ATTRIBUTE_INITCWND
#defineNM_IP_ROUTE_ATTRIBUTE_INITRWND
#defineNM_IP_ROUTE_ATTRIBUTE_MTU
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_WINDOW
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_CWND
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_INITCWND
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_INITRWND
#defineNM_IP_ROUTE_ATTRIBUTE_LOCK_MTU
enumNMIPRoutingRuleAsStringFlags
#defineNM_SETTING_IP_CONFIG_DAD_TIMEOUT_MAX
#defineNM_SETTING_IP_CONFIG_METHOD
#defineNM_SETTING_IP_CONFIG_DNS
#defineNM_SETTING_IP_CONFIG_DNS_SEARCH
#defineNM_SETTING_IP_CONFIG_DNS_OPTIONS
#defineNM_SETTING_IP_CONFIG_DNS_PRIORITY
#defineNM_SETTING_IP_CONFIG_ADDRESSES
#defineNM_SETTING_IP_CONFIG_GATEWAY
#defineNM_SETTING_IP_CONFIG_ROUTES
#defineNM_SETTING_IP_CONFIG_ROUTE_METRIC
#define NM_SETTING_IP_CONFIG_ROUTE_TABLE
#defineNM_SETTING_IP_CONFIG_ROUTING_RULES
#define NM_SETTING_DNS_OPTION_DEBUG
+++++ + + + + + + + + + + + + + + + + + + + + + + +

family

the IP address family (AF_INET or +AF_INET6)

 

addr

the IP address

 

prefix

the address prefix length

 

error

location to store error, or NULL

 
+
+
+

Returns

+

the new NMIPAddress object, or NULL on error.

+

[transfer full]

+
+ +
+
+

nm_ip_address_new_binary ()

+
NMIPAddress *
+nm_ip_address_new_binary (int family,
+                          gconstpointer addr,
+                          guint prefix,
+                          GError **error);
+

Creates a new NMIPAddress object. addr + must point to a buffer of the +correct size for family +.

+
+

Parameters

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

family

the IP address family (AF_INET or +AF_INET6)

 

addr

the IP address

 

prefix

the address prefix length

 

error

location to store error, or NULL

 
+
+
+

Returns

+

the new NMIPAddress object, or NULL on error.

+

[transfer full]

+
+
+
+
+

nm_ip_address_ref ()

+
void
+nm_ip_address_ref (NMIPAddress *address);
+

Increases the reference count of the object.

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+
+
+

nm_ip_address_unref ()

+
void
+nm_ip_address_unref (NMIPAddress *address);
+

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

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+
+
+

nm_ip_address_equal ()

+
gboolean
+nm_ip_address_equal (NMIPAddress *address,
+                     NMIPAddress *other);
+

Determines if two NMIPAddress objects contain the same address and prefix +(attributes are not compared).

+
+

Parameters

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

address

the NMIPAddress

 

other

the NMIPAddress to compare address +to.

 
+
+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+
+
+
+
+

nm_ip_address_dup ()

+
NMIPAddress *
+nm_ip_address_dup (NMIPAddress *address);
+

Creates a copy of address +

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+

Returns

+

a copy of address +.

+

[transfer full]

+
+
+
+
+

nm_ip_address_get_family ()

+
int
+nm_ip_address_get_family (NMIPAddress *address);
+

Gets the IP address family (eg, AF_INET) property of this address +object.

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+

Returns

+

the IP address family

+
+
+
+
+

nm_ip_address_get_address ()

+
const char *
+nm_ip_address_get_address (NMIPAddress *address);
+

Gets the IP address property of this address object.

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+

Returns

+

the IP address

+
+
+
+
+

nm_ip_address_set_address ()

+
void
+nm_ip_address_set_address (NMIPAddress *address,
+                           const char *addr);
+

Sets the IP address property of this address object.

+

addr + must be a valid address of address +'s family. If you aren't sure you +have a valid address, use nm_utils_ipaddr_valid() to check it.

+
+

Parameters

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

address

the NMIPAddress

 

addr

the IP address, as a string

 
+
+
+
+
+

nm_ip_address_get_address_binary ()

+
void
+nm_ip_address_get_address_binary (NMIPAddress *address,
+                                  gpointer addr);
+

Gets the IP address property of this address object.

+

addr + must point to a buffer that is the correct size for address +'s family.

+

[skip]

+
+

Parameters

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

address

the NMIPAddress

 

addr

a buffer in which to store the address in binary format.

 
+
+
+
+
+

nm_ip_address_set_address_binary ()

+
void
+nm_ip_address_set_address_binary (NMIPAddress *address,
+                                  gconstpointer addr);
+

Sets the IP address property of this address object.

+

addr + must point to a buffer that is the correct size for address +'s family.

+

[skip]

+
+

Parameters

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

address

the NMIPAddress

 

addr

the address, in binary format

 
+
+
+
+
+

nm_ip_address_get_prefix ()

+
guint
+nm_ip_address_get_prefix (NMIPAddress *address);
+

Gets the IP address prefix (ie "24" or "30" etc) property of this address +object.

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+

Returns

+

the IP address prefix

+
+
+
+
+

nm_ip_address_set_prefix ()

+
void
+nm_ip_address_set_prefix (NMIPAddress *address,
+                          guint prefix);
+

Sets the IP address prefix property of this address object.

+
+

Parameters

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

address

the NMIPAddress

 

prefix

the IP address prefix

 
+
+
+
+
+

nm_ip_address_get_attribute_names ()

+
char **
+nm_ip_address_get_attribute_names (NMIPAddress *address);
+

Gets an array of attribute names defined on address +.

+
+

Parameters

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

address

the NMIPAddress

 
+
+
+

Returns

+

a NULL-terminated array of attribute names,.

+

[transfer full]

+
+
+
+
+

nm_ip_address_get_attribute ()

+
GVariant *
+nm_ip_address_get_attribute (NMIPAddress *address,
+                             const char *name);
+

Gets the value of the attribute with name name + on address +

+
+

Parameters

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

address

the NMIPAddress

 

name

the name of an address attribute

 
+
+
+

Returns

+

the value of the attribute with name name +on +address +, or NULL if address +has no such attribute.

+

[transfer none]

+
+
+
+
+

nm_ip_address_set_attribute ()

+
void
+nm_ip_address_set_attribute (NMIPAddress *address,
+                             const char *name,
+                             GVariant *value);
+

Sets or clears the named attribute on address + to the given value.

+
+

Parameters

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

address

the NMIPAddress

 

name

the name of an address attribute

 

value

the value.

[transfer none][allow-none]
+
+
+
+
+

nm_ip_route_new ()

+
NMIPRoute *
+nm_ip_route_new (int family,
+                 const char *dest,
+                 guint prefix,
+                 const char *next_hop,
+                 gint64 metric,
+                 GError **error);
+

Creates a new NMIPRoute object.

+
+

Parameters

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

family

the IP address family (AF_INET or +AF_INET6)

 

dest

the IP address of the route's destination

 

prefix

the address prefix length

 

next_hop

the IP address of the next hop (or NULL).

[allow-none]

metric

the route metric (or -1 for "default")

 

error

location to store error, or NULL

 
+
+
+

Returns

+

the new NMIPRoute object, or NULL on error.

+

[transfer full]

+
+
+
+
+

nm_ip_route_new_binary ()

+
NMIPRoute *
+nm_ip_route_new_binary (int family,
+                        gconstpointer dest,
+                        guint prefix,
+                        gconstpointer next_hop,
+                        gint64 metric,
+                        GError **error);
+

Creates a new NMIPRoute object. dest + and next_hop + (if non-NULL) must +point to buffers of the correct size for family +.

+
+

Parameters

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

family

the IP address family (AF_INET or +AF_INET6)

 

dest

the IP address of the route's destination

 

prefix

the address prefix length

 

next_hop

the IP address of the next hop (or NULL).

[allow-none]

metric

the route metric (or -1 for "default")

 

error

location to store error, or NULL

 
+
+
+

Returns

+

the new NMIPRoute object, or NULL on error.

+

[transfer full]

+
+
+
+
+

nm_ip_route_ref ()

+
void
+nm_ip_route_ref (NMIPRoute *route);
+

Increases the reference count of the object.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+
+
+

nm_ip_route_unref ()

+
void
+nm_ip_route_unref (NMIPRoute *route);
+

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

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+
+
+

nm_ip_route_equal ()

+
gboolean
+nm_ip_route_equal (NMIPRoute *route,
+                   NMIPRoute *other);
+

Determines if two NMIPRoute objects contain the same destination, prefix, +next hop, and metric. (Attributes are not compared.)

+
+

Parameters

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

route

the NMIPRoute

 

other

the NMIPRoute to compare route +to.

 
+
+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+
+
+
+
+

nm_ip_route_equal_full ()

+
gboolean
+nm_ip_route_equal_full (NMIPRoute *route,
+                        NMIPRoute *other,
+                        guint cmp_flags);
+

Determines if two NMIPRoute objects contain the same destination, prefix, +next hop, and metric.

+
+

Parameters

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

route

the NMIPRoute

 

other

the NMIPRoute to compare route +to.

 

cmp_flags

tune how to compare attributes. Currently only +NM_IP_ROUTE_EQUAL_CMP_FLAGS_NONE (0) and NM_IP_ROUTE_EQUAL_CMP_FLAGS_WITH_ATTRS (1) +is supported.

 
+
+
+

Returns

+

TRUE if the objects contain the same values, FALSE if they do not.

+
+

Since: 1.10

+
+
+
+

nm_ip_route_dup ()

+
NMIPRoute *
+nm_ip_route_dup (NMIPRoute *route);
+

Creates a copy of route +

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

a copy of route +.

+

[transfer full]

+
+
+
+
+

nm_ip_route_get_family ()

+
int
+nm_ip_route_get_family (NMIPRoute *route);
+

Gets the IP address family (eg, AF_INET) property of this route +object.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

the IP address family

+
+
+
+
+

nm_ip_route_get_dest ()

+
const char *
+nm_ip_route_get_dest (NMIPRoute *route);
+

Gets the IP destination address property of this route object.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

the IP address of the route's destination

+
+
+
+
+

nm_ip_route_set_dest ()

+
void
+nm_ip_route_set_dest (NMIPRoute *route,
+                      const char *dest);
+

Sets the destination property of this route object.

+

dest + must be a valid address of route +'s family. If you aren't sure you +have a valid address, use nm_utils_ipaddr_valid() to check it.

+
+

Parameters

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

route

the NMIPRoute

 

dest

the route's destination, as a string

 
+
+
+
+
+

nm_ip_route_get_dest_binary ()

+
void
+nm_ip_route_get_dest_binary (NMIPRoute *route,
+                             gpointer dest);
+

Gets the destination property of this route object.

+

dest + must point to a buffer that is the correct size for route +'s family.

+

[skip]

+
+

Parameters

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

route

the NMIPRoute

 

dest

a buffer in which to store the destination in binary format.

 
+
+
+
+
+

nm_ip_route_set_dest_binary ()

+
void
+nm_ip_route_set_dest_binary (NMIPRoute *route,
+                             gconstpointer dest);
+

Sets the destination property of this route object.

+

dest + must point to a buffer that is the correct size for route +'s family.

+

[skip]

+
+

Parameters

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

route

the NMIPRoute

 

dest

the route's destination, in binary format

 
+
+
+
+
+

nm_ip_route_get_prefix ()

+
guint
+nm_ip_route_get_prefix (NMIPRoute *route);
+

Gets the IP prefix (ie "24" or "30" etc) of this route.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

the IP prefix

+
+
+
+
+

nm_ip_route_set_prefix ()

+
void
+nm_ip_route_set_prefix (NMIPRoute *route,
+                        guint prefix);
+

Sets the prefix property of this route object.

+
+

Parameters

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

route

the NMIPRoute

 

prefix

the route prefix

 
+
+
+
+
+

nm_ip_route_get_next_hop ()

+
const char *
+nm_ip_route_get_next_hop (NMIPRoute *route);
+

Gets the IP address of the next hop of this route; this will be NULL if the +route has no next hop.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

the IP address of the next hop, or NULL if this is a device route.

+
+
+
+
+

nm_ip_route_set_next_hop ()

+
void
+nm_ip_route_set_next_hop (NMIPRoute *route,
+                          const char *next_hop);
+

Sets the next-hop property of this route object.

+

next_hop + (if non-NULL) must be a valid address of route +'s family. If you +aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check +it.

+
+

Parameters

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

route

the NMIPRoute

 

next_hop

the route's next hop, as a string.

[allow-none]
+
+
+
+
+

nm_ip_route_get_next_hop_binary ()

+
gboolean
+nm_ip_route_get_next_hop_binary (NMIPRoute *route,
+                                 gpointer next_hop);
+

Gets the next hop property of this route object.

+

next_hop + must point to a buffer that is the correct size for route +'s family.

+

[skip]

+
+

Parameters

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

route

the NMIPRoute

 

next_hop

a buffer in which to store the next hop in binary format.

 
+
+
+

Returns

+

TRUE if route +has a next hop, FALSE if not (in which case +next_hop +will be zeroed out)

+
+
+
+
+

nm_ip_route_set_next_hop_binary ()

+
void
+nm_ip_route_set_next_hop_binary (NMIPRoute *route,
+                                 gconstpointer next_hop);
+

Sets the destination property of this route object.

+

next_hop + (if non-NULL) must point to a buffer that is the correct size for +route +'s family.

+

[skip]

+
+

Parameters

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

route

the NMIPRoute

 

next_hop

the route's next hop, in binary format

 
+
+
+
+
+

nm_ip_route_get_metric ()

+
gint64
+nm_ip_route_get_metric (NMIPRoute *route);
+

Gets the route metric property of this route object; lower values +indicate "better" or more preferred routes; -1 indicates "default" +(meaning NetworkManager will set it appropriately).

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

the route metric

+
+
+
+
+

nm_ip_route_set_metric ()

+
void
+nm_ip_route_set_metric (NMIPRoute *route,
+                        gint64 metric);
+

Sets the metric property of this route object.

+
+

Parameters

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

route

the NMIPRoute

 

metric

the route metric (or -1 for "default")

 
+
+
+
+
+

nm_ip_route_get_attribute_names ()

+
char **
+nm_ip_route_get_attribute_names (NMIPRoute *route);
+

Gets an array of attribute names defined on route +.

+
+

Parameters

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

route

the NMIPRoute

 
+
+
+

Returns

+

a NULL-terminated array of attribute names.

+

[transfer full]

+
+
+
+
+

nm_ip_route_get_attribute ()

+
GVariant *
+nm_ip_route_get_attribute (NMIPRoute *route,
+                           const char *name);
+

Gets the value of the attribute with name name + on route +

+
+

Parameters

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

route

the NMIPRoute

 

name

the name of an route attribute

 
+
+
+

Returns

+

the value of the attribute with name name +on +route +, or NULL if route +has no such attribute.

+

[transfer none]

+
-
-

Functions

+
-

nm_ip_address_new ()

-
NMIPAddress *
-nm_ip_address_new (int family,
-                   const char *addr,
-                   guint prefix,
-                   GError **error);
-

Creates a new NMIPAddress object.

+

nm_ip_route_set_attribute ()

+
void
+nm_ip_route_set_attribute (NMIPRoute *route,
+                           const char *name,
+                           GVariant *value);
+

Sets the named attribute on route + to the given value.

-

Parameters

+

Parameters

@@ -1088,49 +2753,49 @@ nm_ip_address_new (int fam - - - - - - - + + - - + + - - - + + +

family

the IP address family (AF_INET or -AF_INET6)

 

addr

the IP address

route

the NMIPRoute

  

prefix

the address prefix length

name

the name of a route attribute

  

error

location to store error, or NULL

 

value

the value.

[transfer none][allow-none]
+
+
+
+

nm_ip_route_get_variant_attribute_spec ()

+
const NMVariantAttributeSpec *const *
+nm_ip_route_get_variant_attribute_spec
+                               (void);
-

Returns

-

the new NMIPAddress object, or NULL on error.

-

[transfer full]

+

Returns

+

the specifiers for route attributes

+

Since: 1.8

-

nm_ip_address_new_binary ()

-
NMIPAddress *
-nm_ip_address_new_binary (int family,
-                          gconstpointer addr,
-                          guint prefix,
-                          GError **error);
-

Creates a new NMIPAddress object. addr - must point to a buffer of the -correct size for family -.

+

nm_ip_route_attribute_validate ()

+
gboolean
+nm_ip_route_attribute_validate (const char *name,
+                                GVariant *value,
+                                int family,
+                                gboolean *known,
+                                GError **error);
+

Validates a route attribute, i.e. checks that the attribute is a known one +and the value is of the correct type and well-formed.

-

Parameters

+

Parameters

@@ -1139,43 +2804,46 @@ correct size for family - - + + - - + + - - + + + + + + + - - + +

family

the IP address family (AF_INET or -AF_INET6)

name

the attribute name

  

addr

the IP address

value

the attribute value

  

prefix

the address prefix length

family

IP address family of the route

  

known

on return, whether the attribute name is a known one.

[out]

error

location to store error, or NULL

 

return location for a GError, or NULL.

[allow-none]
-

Returns

-

the new NMIPAddress object, or NULL on error.

-

[transfer full]

+

Returns

+

TRUE if the attribute is valid, FALSE otherwise

+

Since: 1.8

-

nm_ip_address_ref ()

-
void
-nm_ip_address_ref (NMIPAddress *address);
-

Increases the reference count of the object.

+

nm_ip_routing_rule_new ()

+
NMIPRoutingRule *
+nm_ip_routing_rule_new (int addr_family);
-

Parameters

+

Parameters

@@ -1183,22 +2851,28 @@ nm_ip_address_ref ( - - + +

address

the NMIPAddress

addr_family

the address family of the routing rule. Must be either +AF_INET (2) or AF_INET6 (10).

  
+
+

Returns

+

a newly created rule instance with the +provided address family. The instance is unsealed.

+

[transfer full]

+
+

Since: 1.18

-

nm_ip_address_unref ()

-
void
-nm_ip_address_unref (NMIPAddress *address);
-

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

+

nm_ip_routing_rule_new_clone ()

+
NMIPRoutingRule *
+nm_ip_routing_rule_new_clone (const NMIPRoutingRule *rule);
-

Parameters

+

Parameters

@@ -1206,58 +2880,63 @@ reaches zero, the object will be destroyed.

- - + +

address

the NMIPAddress

rule

the NMIPRoutingRule to clone.

  
+
+

Returns

+

a newly created rule instance with +the same settings as rule +. Note that the instance will +always be unsealred.

+

[transfer full]

+
+

Since: 1.18

-

nm_ip_address_equal ()

-
gboolean
-nm_ip_address_equal (NMIPAddress *address,
-                     NMIPAddress *other);
-

Determines if two NMIPAddress objects contain the same address and prefix -(attributes are not compared).

+

nm_ip_routing_rule_ref ()

+
NMIPRoutingRule *
+nm_ip_routing_rule_ref (NMIPRoutingRule *self);
+

Increases the reference count of the instance. +This is not thread-safe.

-

Parameters

+

Parameters

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

address

the NMIPAddress

 

other

the NMIPAddress to compare address -to.

 

self

the NMIPRoutingRule instance.

[allow-none]
-

Returns

-

TRUE if the objects contain the same values, FALSE if they do not.

+

Returns

+

the self +argument with incremented +reference count.

+

[transfer full]

+

Since: 1.18

-

nm_ip_address_dup ()

-
NMIPAddress *
-nm_ip_address_dup (NMIPAddress *address);
-

Creates a copy of address -

+

nm_ip_routing_rule_unref ()

+
void
+nm_ip_routing_rule_unref (NMIPRoutingRule *self);
+

Decreases the reference count of the instance and destroys +the instance if the reference count reaches zero. +This is not thread-safe.

-

Parameters

+

Parameters

@@ -1265,28 +2944,21 @@ nm_ip_address_dup ( - - - + + +

address

the NMIPAddress

 

self

the NMIPRoutingRule instance.

[allow-none]
-
-

Returns

-

a copy of address -.

-

[transfer full]

-
+

Since: 1.18

-

nm_ip_address_get_family ()

-
int
-nm_ip_address_get_family (NMIPAddress *address);
-

Gets the IP address family (eg, AF_INET) property of this address -object.

+

nm_ip_routing_rule_is_sealed ()

+
gboolean
+nm_ip_routing_rule_is_sealed (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1294,25 +2966,31 @@ object.

- - + +

address

the NMIPAddress

self

the NMIPRoutingRule instance

  
-

Returns

-

the IP address family

+

Returns

+

whether self +is sealed. Once sealed, an instance +cannot be modified nor unsealed.

+

Since: 1.18

-

nm_ip_address_get_address ()

-
const char *
-nm_ip_address_get_address (NMIPAddress *address);
-

Gets the IP address property of this address object.

+

nm_ip_routing_rule_seal ()

+
void
+nm_ip_routing_rule_seal (NMIPRoutingRule *self);
+

Seals the routing rule. Afterwards, the instance can no longer be +modfied, and it is a bug to call any of the accessors that would +modify the rule. If self + was already sealed, this has no effect.

-

Parameters

+

Parameters

@@ -1320,98 +2998,74 @@ nm_ip_address_get_address ( - - + +

address

the NMIPAddress

self

the NMIPRoutingRule instance

  
-
-

Returns

-

the IP address

-
+

Since: 1.18

-

nm_ip_address_set_address ()

-
void
-nm_ip_address_set_address (NMIPAddress *address,
-                           const char *addr);
-

Sets the IP address property of this address object.

-

addr - must be a valid address of address -'s family. If you aren't sure you -have a valid address, use nm_utils_ipaddr_valid() to check it.

+

nm_ip_routing_rule_get_addr_family ()

+
int
+nm_ip_routing_rule_get_addr_family (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

address

the NMIPAddress

 

addr

the IP address, as a string

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the address family of the rule. Either AF_INET or AF_INET6.

+
+

Since: 1.18

-

nm_ip_address_get_address_binary ()

-
void
-nm_ip_address_get_address_binary (NMIPAddress *address,
-                                  gpointer addr);
-

Gets the IP address property of this address object.

-

addr - must point to a buffer that is the correct size for address -'s family.

-

[skip]

+

nm_ip_routing_rule_get_invert ()

+
gboolean
+nm_ip_routing_rule_get_invert (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

address

the NMIPAddress

 

addr

a buffer in which to store the address in binary format.

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the "invert" setting of the rule.

+
+

Since: 1.18

-

nm_ip_address_set_address_binary ()

+

nm_ip_routing_rule_set_invert ()

void
-nm_ip_address_set_address_binary (NMIPAddress *address,
-                                  gconstpointer addr);
-

Sets the IP address property of this address object.

-

addr - must point to a buffer that is the correct size for address -'s family.

-

[skip]

+nm_ip_routing_rule_set_invert (NMIPRoutingRule *self, + gboolean invert);
-

Parameters

+

Parameters

@@ -1420,28 +3074,27 @@ nm_ip_address_set_address_binary ( - - + + - - + +

address

the NMIPAddress

self

the NMIPRoutingRule instance

  

addr

the address, in binary format

invert

the new value to set

  
+

Since: 1.18

-

nm_ip_address_get_prefix ()

-
guint
-nm_ip_address_get_prefix (NMIPAddress *address);
-

Gets the IP address prefix (ie "24" or "30" etc) property of this address -object.

+

nm_ip_routing_rule_get_priority ()

+
gint64
+nm_ip_routing_rule_get_priority (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1449,26 +3102,30 @@ object.

- - + +

address

the NMIPAddress

self

the NMIPRoutingRule instance

  
-

Returns

-

the IP address prefix

+

Returns

+

the priority. A valid priority is in the range from +0 to G_MAXUINT32. If unset, -1 is returned.

+

Since: 1.18

-

nm_ip_address_set_prefix ()

+

nm_ip_routing_rule_set_priority ()

void
-nm_ip_address_set_prefix (NMIPAddress *address,
-                          guint prefix);
-

Sets the IP address prefix property of this address object.

+nm_ip_routing_rule_set_priority (NMIPRoutingRule *self, + gint64 priority); +

A valid priority ranges from 0 to G_MAXUINT32. "-1" is also allowed +to reset the priority. It is a bug calling this function with any +other value.

-

Parameters

+

Parameters

@@ -1477,28 +3134,27 @@ nm_ip_address_set_prefix (

address

- + + - - + +

the NMIPAddress

self

the NMIPRoutingRule instance

  

prefix

the IP address prefix

priority

the priority to set

  
+

Since: 1.18

-

nm_ip_address_get_attribute_names ()

-
char **
-nm_ip_address_get_attribute_names (NMIPAddress *address);
-

Gets an array of attribute names defined on address -.

+

nm_ip_routing_rule_get_tos ()

+
guint8
+nm_ip_routing_rule_get_tos (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1506,29 +3162,26 @@ nm_ip_address_get_attribute_names ( - - + +

address

the NMIPAddress

self

the NMIPRoutingRule instance

  
-

Returns

-

a NULL-terminated array of attribute names,.

-

[transfer full]

+

Returns

+

the tos of the rule.

+

Since: 1.18

-

nm_ip_address_get_attribute ()

-
GVariant *
-nm_ip_address_get_attribute (NMIPAddress *address,
-                             const char *name);
-

Gets the value of the attribute with name name - on address -

+

nm_ip_routing_rule_set_tos ()

+
void
+nm_ip_routing_rule_set_tos (NMIPRoutingRule *self,
+                            guint8 tos);
-

Parameters

+

Parameters

@@ -1537,39 +3190,54 @@ nm_ip_address_get_attribute (

address

- + + - - + +

the NMIPAddress

self

the NMIPRoutingRule instance

  

name

the name of an address attribute

tos

the tos to set

  
+

Since: 1.18

+
+
+
+

nm_ip_routing_rule_get_ipproto ()

+
guint8
+nm_ip_routing_rule_get_ipproto (const NMIPRoutingRule *self);
-

Returns

-

the value of the attribute with name name -on -address -, or NULL if address -has no such attribute.

-

[transfer none]

+

Parameters

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

self

the NMIPRoutingRule instance

 
+
+

Returns

+

the ipproto of the rule.

+
+

Since: 1.18

-

nm_ip_address_set_attribute ()

+

nm_ip_routing_rule_set_ipproto ()

void
-nm_ip_address_set_attribute (NMIPAddress *address,
-                             const char *name,
-                             GVariant *value);
-

Sets or clears the named attribute on address - to the given value.

+nm_ip_routing_rule_set_ipproto (NMIPRoutingRule *self, + guint8 ipproto);
-

Parameters

+

Parameters

@@ -1578,101 +3246,83 @@ nm_ip_address_set_attribute (

address

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

the NMIPAddress

self

the NMIPRoutingRule instance

  

name

the name of an address attribute

ipproto

the ipproto to set

  

value

the value.

[transfer none][allow-none]
+

Since: 1.18

-

nm_ip_route_new ()

-
NMIPRoute *
-nm_ip_route_new (int family,
-                 const char *dest,
-                 guint prefix,
-                 const char *next_hop,
-                 gint64 metric,
-                 GError **error);
-

Creates a new NMIPRoute object.

+

nm_ip_routing_rule_get_source_port_start ()

+
guint16
+nm_ip_routing_rule_get_source_port_start
+                               (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

family

the IP address family (AF_INET or -AF_INET6)

 

dest

the IP address of the route's destination

 

prefix

the address prefix length

 

next_hop

the IP address of the next hop (or NULL).

[allow-none]

metric

the route metric (or -1 for "default")

self

the NMIPRoutingRule instance

  

error

location to store error, or NULL

+
+
+

Returns

+

the source port start setting.

+
+

Since: 1.18

+
+
+
+

nm_ip_routing_rule_get_source_port_end ()

+
guint16
+nm_ip_routing_rule_get_source_port_end
+                               (const NMIPRoutingRule *self);
+
+

Parameters

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

self

the NMIPRoutingRule instance

  
-

Returns

-

the new NMIPRoute object, or NULL on error.

-

[transfer full]

+

Returns

+

the source port end setting.

+

Since: 1.18

-

nm_ip_route_new_binary ()

-
NMIPRoute *
-nm_ip_route_new_binary (int family,
-                        gconstpointer dest,
-                        guint prefix,
-                        gconstpointer next_hop,
-                        gint64 metric,
-                        GError **error);
-

Creates a new NMIPRoute object. dest - and next_hop - (if non-NULL) must -point to buffers of the correct size for family -.

+

nm_ip_routing_rule_set_source_port ()

+
void
+nm_ip_routing_rule_set_source_port (NMIPRoutingRule *self,
+                                    guint16 start,
+                                    guint16 end);
-

Parameters

+

Parameters

@@ -1681,53 +3331,33 @@ point to buffers of the correct size for family - - - - - - - - - - - - + + - - - - - - - + + - - + +

family

the IP address family (AF_INET or -AF_INET6)

 

dest

the IP address of the route's destination

 

prefix

the address prefix length

self

the NMIPRoutingRule instance

  

next_hop

the IP address of the next hop (or NULL).

[allow-none]

metric

the route metric (or -1 for "default")

start

the start port to set.

  

error

location to store error, or NULL

end

the end port to set.

  
-
-

Returns

-

the new NMIPRoute object, or NULL on error.

-

[transfer full]

-
+

Since: 1.18

-

nm_ip_route_ref ()

-
void
-nm_ip_route_ref (NMIPRoute *route);
-

Increases the reference count of the object.

+

nm_ip_routing_rule_get_destination_port_start ()

+
guint16
+nm_ip_routing_rule_get_destination_port_start
+                               (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1735,22 +3365,26 @@ nm_ip_route_ref ( - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the destination port start setting.

+
+

Since: 1.18

-

nm_ip_route_unref ()

-
void
-nm_ip_route_unref (NMIPRoute *route);
-

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

+

nm_ip_routing_rule_get_destination_port_end ()

+
guint16
+nm_ip_routing_rule_get_destination_port_end
+                               (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1758,23 +3392,28 @@ reaches zero, the object will be destroyed.

- - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the destination port end setting.

+
+

Since: 1.18

-

nm_ip_route_equal ()

-
gboolean
-nm_ip_route_equal (NMIPRoute *route,
-                   NMIPRoute *other);
-

Determines if two NMIPRoute objects contain the same destination, prefix, -next hop, and metric. (Attributes are not compared.)

+

nm_ip_routing_rule_set_destination_port ()

+
void
+nm_ip_routing_rule_set_destination_port
+                               (NMIPRoutingRule *self,
+                                guint16 start,
+                                guint16 end);
-

Parameters

+

Parameters

@@ -1783,35 +3422,86 @@ next hop, and metric. (Attributes are not compared.)

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

route

the NMIPRoute

self

the NMIPRoutingRule instance

  

other

the NMIPRoute to compare route -to.

start

the start port to set.

 

end

the end port to set.

 
+
+

Since: 1.18

+
+
+
+

nm_ip_routing_rule_get_fwmark ()

+
guint32
+nm_ip_routing_rule_get_fwmark (const NMIPRoutingRule *self);
+
+

Parameters

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

self

the NMIPRoutingRule instance

 
+
+
+

Returns

+

the fwmark setting.

+
+

Since: 1.18

+
+
+
+

nm_ip_routing_rule_get_fwmask ()

+
guint32
+nm_ip_routing_rule_get_fwmask (const NMIPRoutingRule *self);
+
+

Parameters

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

self

the NMIPRoutingRule instance

  
-

Returns

-

TRUE if the objects contain the same values, FALSE if they do not.

+

Returns

+

the fwmask setting.

+

Since: 1.18

-

nm_ip_route_equal_full ()

-
gboolean
-nm_ip_route_equal_full (NMIPRoute *route,
-                        NMIPRoute *other,
-                        guint cmp_flags);
-

Determines if two NMIPRoute objects contain the same destination, prefix, -next hop, and metric.

+

nm_ip_routing_rule_set_fwmark ()

+
void
+nm_ip_routing_rule_set_fwmark (NMIPRoutingRule *self,
+                               guint32 fwmark,
+                               guint32 fwmask);
-

Parameters

+

Parameters

@@ -1820,41 +3510,32 @@ next hop, and metric.

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

route

the NMIPRoute

self

the NMIPRoutingRule instance

  

other

the NMIPRoute to compare route -to.

fwmark

the fwmark

  

cmp_flags

tune how to compare attributes. Currently only -NM_IP_ROUTE_EQUAL_CMP_FLAGS_NONE (0) and NM_IP_ROUTE_EQUAL_CMP_FLAGS_WITH_ATTRS (1) -is supported.

fwmask

the fwmask

  
-
-

Returns

-

TRUE if the objects contain the same values, FALSE if they do not.

-
-

Since: 1.10

+

Since: 1.18

-

nm_ip_route_dup ()

-
NMIPRoute *
-nm_ip_route_dup (NMIPRoute *route);
-

Creates a copy of route -

+

nm_ip_routing_rule_get_from_len ()

+
guint8
+nm_ip_routing_rule_get_from_len (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1862,28 +3543,25 @@ nm_ip_route_dup ( - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  
-

Returns

-

a copy of route -.

-

[transfer full]

+

Returns

+

the set prefix length for the from/src parameter.

+

Since: 1.18

-

nm_ip_route_get_family ()

-
int
-nm_ip_route_get_family (NMIPRoute *route);
-

Gets the IP address family (eg, AF_INET) property of this route -object.

+

nm_ip_routing_rule_get_from ()

+
const char *
+nm_ip_routing_rule_get_from (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -1891,124 +3569,124 @@ object.

- - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  
-

Returns

-

the IP address family

+

Returns

+

the set from/src parameter or +NULL, if no value is set.

+

[transfer none]

+

Since: 1.18

-

nm_ip_route_get_dest ()

-
const char *
-nm_ip_route_get_dest (NMIPRoute *route);
-

Gets the IP destination address property of this route object.

+

nm_ip_routing_rule_set_from ()

+
void
+nm_ip_routing_rule_set_from (NMIPRoutingRule *self,
+                             const char *from,
+                             guint8 len);
+

Setting invalid values is accepted, but will later fail +during nm_ip_routing_rule_validate().

-

Parameters

+

Parameters

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

route

the NMIPRoute

self

the NMIPRoutingRule instance

  

from

the from/src address to set. +The address family must match.

[allow-none]

len

the corresponding prefix length of the address.

 
-
-

Returns

-

the IP address of the route's destination

-
+

Since: 1.18

-

nm_ip_route_set_dest ()

-
void
-nm_ip_route_set_dest (NMIPRoute *route,
-                      const char *dest);
-

Sets the destination property of this route object.

-

dest - must be a valid address of route -'s family. If you aren't sure you -have a valid address, use nm_utils_ipaddr_valid() to check it.

+

nm_ip_routing_rule_get_to_len ()

+
guint8
+nm_ip_routing_rule_get_to_len (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

route

the NMIPRoute

 

dest

the route's destination, as a string

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the set prefix length for the to/dst parameter.

+
+

Since: 1.18

-

nm_ip_route_get_dest_binary ()

-
void
-nm_ip_route_get_dest_binary (NMIPRoute *route,
-                             gpointer dest);
-

Gets the destination property of this route object.

-

dest - must point to a buffer that is the correct size for route -'s family.

-

[skip]

+

nm_ip_routing_rule_get_to ()

+
const char *
+nm_ip_routing_rule_get_to (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

route

the NMIPRoute

 

dest

a buffer in which to store the destination in binary format.

self

the NMIPRoutingRule instance

  
+
+

Returns

+

the set to/dst parameter or +NULL, if no value is set.

+

[transfer none]

+
+

Since: 1.18

-

nm_ip_route_set_dest_binary ()

+

nm_ip_routing_rule_set_to ()

void
-nm_ip_route_set_dest_binary (NMIPRoute *route,
-                             gconstpointer dest);
-

Sets the destination property of this route object.

-

dest - must point to a buffer that is the correct size for route -'s family.

-

[skip]

+nm_ip_routing_rule_set_to (NMIPRoutingRule *self, + const char *to, + guint8 len); +

Setting invalid values is accepted, but will later fail +during nm_ip_routing_rule_validate().

-

Parameters

+

Parameters

@@ -2017,27 +3695,35 @@ nm_ip_route_set_dest_binary (

route

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

the NMIPRoute

self

the NMIPRoutingRule instance

  

dest

the route's destination, in binary format

to

the to/dst address to set. +The address family must match.

[allow-none]

len

the corresponding prefix length of the address. +If to +is NULL, this valid is ignored.

  
+

Since: 1.18

-

nm_ip_route_get_prefix ()

-
guint
-nm_ip_route_get_prefix (NMIPRoute *route);
-

Gets the IP prefix (ie "24" or "30" etc) of this route.

+

nm_ip_routing_rule_get_iifname ()

+
const char *
+nm_ip_routing_rule_get_iifname (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -2045,26 +3731,31 @@ nm_ip_route_get_prefix ( - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance.

  
-

Returns

-

the IP prefix

+

Returns

+

the set iifname or NULL if unset.

+

[transfer none]

+

Since: 1.18

-

nm_ip_route_set_prefix ()

+

nm_ip_routing_rule_set_iifname ()

void
-nm_ip_route_set_prefix (NMIPRoute *route,
-                        guint prefix);
-

Sets the prefix property of this route object.

-
-

Parameters

+nm_ip_routing_rule_set_iifname (NMIPRoutingRule *self, + const char *iifname); +

The name supports C backslash escaping for non-UTF-8 characters. +Note that nm_ip_routing_rule_from_string() too uses backslash +escaping when tokenizing the words by whitespace. So, in string +representation you'd get double backslashs.

+
+

Parameters

@@ -2073,28 +3764,27 @@ nm_ip_route_set_prefix (

route

- + + - - - + + +

the NMIPRoute

self

the NMIPRoutingRule instance.

  

prefix

the route prefix

 

iifname

the iifname to set or NULL to unset.

[allow-none]
+

Since: 1.18

-

nm_ip_route_get_next_hop ()

+

nm_ip_routing_rule_get_oifname ()

const char *
-nm_ip_route_get_next_hop (NMIPRoute *route);
-

Gets the IP address of the next hop of this route; this will be NULL if the -route has no next hop.

+nm_ip_routing_rule_get_oifname (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -2102,31 +3792,31 @@ route has no next hop.

- - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance.

  
-

Returns

-

the IP address of the next hop, or NULL if this is a device route.

+

Returns

+

the set oifname or NULL if unset.

+

[transfer none]

+

Since: 1.18

-

nm_ip_route_set_next_hop ()

+

nm_ip_routing_rule_set_oifname ()

void
-nm_ip_route_set_next_hop (NMIPRoute *route,
-                          const char *next_hop);
-

Sets the next-hop property of this route object.

-

next_hop - (if non-NULL) must be a valid address of route -'s family. If you -aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check -it.

-
-

Parameters

+nm_ip_routing_rule_set_oifname (NMIPRoutingRule *self, + const char *oifname); +

The name supports C backslash escaping for non-UTF-8 characters. +Note that nm_ip_routing_rule_from_string() too uses backslash +escaping when tokenizing the words by whitespace. So, in string +representation you'd get double backslashs.

+
+

Parameters

@@ -2135,74 +3825,56 @@ it.

- - + + - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance.

  

next_hop

the route's next hop, as a string.

oifname

the oifname to set or NULL to unset.

[allow-none]
+

Since: 1.18

-

nm_ip_route_get_next_hop_binary ()

-
gboolean
-nm_ip_route_get_next_hop_binary (NMIPRoute *route,
-                                 gpointer next_hop);
-

Gets the next hop property of this route object.

-

next_hop - must point to a buffer that is the correct size for route -'s family.

-

[skip]

+

nm_ip_routing_rule_get_action ()

+
guint8
+nm_ip_routing_rule_get_action (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

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

route

the NMIPRoute

 

next_hop

a buffer in which to store the next hop in binary format.

self

the NMIPRoutingRule instance

  
-

Returns

-

TRUE if route -has a next hop, FALSE if not (in which case -next_hop -will be zeroed out)

+

Returns

+

the set action.

+

Since: 1.18

-

nm_ip_route_set_next_hop_binary ()

+

nm_ip_routing_rule_set_action ()

void
-nm_ip_route_set_next_hop_binary (NMIPRoute *route,
-                                 gconstpointer next_hop);
-

Sets the destination property of this route object.

-

next_hop - (if non-NULL) must point to a buffer that is the correct size for -route -'s family.

-

[skip]

+nm_ip_routing_rule_set_action (NMIPRoutingRule *self, + guint8 action); +

Note that currently only certain actions are allowed. nm_ip_routing_rule_validate() +will reject unsupported actions as invalid.

-

Parameters

+

Parameters

@@ -2211,29 +3883,27 @@ nm_ip_route_set_next_hop_binary ( - - + + - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  

next_hop

the route's next hop, in binary format

action

the action to set

  
+

Since: 1.18

-

nm_ip_route_get_metric ()

-
gint64
-nm_ip_route_get_metric (NMIPRoute *route);
-

Gets the route metric property of this route object; lower values -indicate "better" or more preferred routes; -1 indicates "default" -(meaning NetworkManager will set it appropriately).

+

nm_ip_routing_rule_get_table ()

+
guint32
+nm_ip_routing_rule_get_table (const NMIPRoutingRule *self);
-

Parameters

+

Parameters

@@ -2241,26 +3911,26 @@ indicate "better" or more preferred routes; -1 indicates "default" - - + +

route

the NMIPRoute

self

the NMIPRoutingRule instance

  
-

Returns

-

the route metric

+

Returns

+

the set table.

+

Since: 1.18

-
-

nm_ip_route_set_metric ()

-
void
-nm_ip_route_set_metric (NMIPRoute *route,
-                        gint64 metric);
-

Sets the metric property of this route object.

+
+

nm_ip_routing_rule_set_table ()

+
void
+nm_ip_routing_rule_set_table (NMIPRoutingRule *self,
+                              guint32 table);
-

Parameters

+

Parameters

@@ -2269,58 +3939,63 @@ nm_ip_route_set_metric (

route

- + + - - + +

the NMIPRoute

self

the NMIPRoutingRule instance

  

metric

the route metric (or -1 for "default")

table

the table to set

  
+

Since: 1.18

-

nm_ip_route_get_attribute_names ()

-
char **
-nm_ip_route_get_attribute_names (NMIPRoute *route);
-

Gets an array of attribute names defined on route -.

+

nm_ip_routing_rule_cmp ()

+
int
+nm_ip_routing_rule_cmp (const NMIPRoutingRule *rule,
+                        const NMIPRoutingRule *other);
-

Parameters

+

Parameters

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

route

the NMIPRoute

 

rule

the NMIPRoutingRule instance to compare.

[allow-none]

other

the other NMIPRoutingRule instance to compare.

[allow-none]
-

Returns

-

a NULL-terminated array of attribute names.

-

[transfer full]

+

Returns

+

zero, a positive, or a negative integer to indicate +equality or how the arguments compare.

+

Since: 1.18

-

nm_ip_route_get_attribute ()

-
GVariant *
-nm_ip_route_get_attribute (NMIPRoute *route,
-                           const char *name);
-

Gets the value of the attribute with name name - on route -

+

nm_ip_routing_rule_validate ()

+
gboolean
+nm_ip_routing_rule_validate (const NMIPRoutingRule *self,
+                             GError **error);
-

Parameters

+

Parameters

@@ -2329,39 +4004,34 @@ nm_ip_route_get_attribute (

route

- + + - - - + + +

the NMIPRoute

self

the NMIPRoutingRule instance to validate

  

name

the name of an route attribute

 

error

the error result if validation fails.

[allow-none][out]
-

Returns

-

the value of the attribute with name name -on -route -, or NULL if route -has no such attribute.

-

[transfer none]

+

Returns

+

TRUE if the rule validates.

+

Since: 1.18

-

nm_ip_route_set_attribute ()

-
void
-nm_ip_route_set_attribute (NMIPRoute *route,
-                           const char *name,
-                           GVariant *value);
-

Sets the named attribute on route - to the given value.

+

nm_ip_routing_rule_from_string ()

+
NMIPRoutingRule *
+nm_ip_routing_rule_from_string (const char *str,
+                                NMIPRoutingRuleAsStringFlags to_string_flags,
+                                GHashTable *extra_args,
+                                GError **error);
-

Parameters

+

Parameters

@@ -2370,49 +4040,47 @@ nm_ip_route_set_attribute (

route

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

the NMIPRoute

str

the string representation to convert to an NMIPRoutingRule

  

name

the name of a route attribute

to_string_flags

NMIPRoutingRuleAsStringFlags for controlling the +string conversion.

  

value

the value.

[transfer none][allow-none]

extra_args

extra arguments for controlling the string +conversion. Currently not extra arguments are supported.

[allow-none]

error

the error reason.

[allow-none][out]
-
-
-
-

nm_ip_route_get_variant_attribute_spec ()

-
const NMVariantAttributeSpec *const *
-nm_ip_route_get_variant_attribute_spec
-                               (void);
-

Returns

-

the specifiers for route attributes

+

Returns

+

the new NMIPRoutingRule or NULL on error.

+

[transfer full]

-

Since: 1.8

+

Since: 1.18

-

nm_ip_route_attribute_validate ()

-
gboolean
-nm_ip_route_attribute_validate (const char *name,
-                                GVariant *value,
-                                int family,
-                                gboolean *known,
-                                GError **error);
-

Validates a route attribute, i.e. checks that the attribute is a known one -and the value is of the correct type and well-formed.

+

nm_ip_routing_rule_to_string ()

+
char *
+nm_ip_routing_rule_to_string (const NMIPRoutingRule *self,
+                              NMIPRoutingRuleAsStringFlags to_string_flags,
+                              GHashTable *extra_args,
+                              GError **error);
-

Parameters

+

Parameters

@@ -2421,38 +4089,36 @@ and the value is of the correct type and well-formed.

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

name

the attribute name

 

value

the attribute value

self

the NMIPRoutingRule instance to convert to string.

  

family

IP address family of the route

to_string_flags

NMIPRoutingRuleAsStringFlags for controlling the +string conversion.

  

known

on return, whether the attribute name is a known one.

[out]

extra_args

extra arguments for controlling the string +conversion. Currently not extra arguments are supported.

[allow-none]

error

return location for a GError, or NULL.

[allow-none]

the error reason.

[allow-none][out]
-

Returns

-

TRUE if the attribute is valid, FALSE otherwise

+

Returns

+

the string representation or NULL on error.

+

[transfer full]

-

Since: 1.8

+

Since: 1.18

@@ -3605,6 +5271,161 @@ property.

+

nm_setting_ip_config_get_num_routing_rules ()

+
guint
+nm_setting_ip_config_get_num_routing_rules
+                               (NMSettingIPConfig *setting);
+
+

Parameters

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

setting

the NMSettingIPConfig

 
+
+
+

Returns

+

the number of configured routing rules

+
+

Since: 1.18

+
+
+
+

nm_setting_ip_config_get_routing_rule ()

+
NMIPRoutingRule *
+nm_setting_ip_config_get_routing_rule (NMSettingIPConfig *setting,
+                                       guint idx);
+
+

Parameters

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

setting

the NMSettingIPConfig

 

idx

index number of the routing_rule to return

 
+
+
+

Returns

+

the routing rule at index idx +.

+

[transfer none]

+
+

Since: 1.18

+
+
+
+

nm_setting_ip_config_add_routing_rule ()

+
void
+nm_setting_ip_config_add_routing_rule (NMSettingIPConfig *setting,
+                                       NMIPRoutingRule *routing_rule);
+

Appends a new routing-rule and associated information to the setting. The +given routing rules gets sealed and the reference count is incremented. +The function does not check whether an identical rule already exists +and always appends the rule to the end of the list.

+
+

Parameters

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

setting

the NMSettingIPConfig

 

routing_rule

the NMIPRoutingRule to add. The address family +of the added rule must be compatible with the setting.

 
+
+

Since: 1.18

+
+
+
+

nm_setting_ip_config_remove_routing_rule ()

+
void
+nm_setting_ip_config_remove_routing_rule
+                               (NMSettingIPConfig *setting,
+                                guint idx);
+

Removes the routing_rule at index idx +.

+
+

Parameters

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

setting

the NMSettingIPConfig

 

idx

index number of the routing_rule

 
+
+

Since: 1.18

+
+
+
+

nm_setting_ip_config_clear_routing_rules ()

+
void
+nm_setting_ip_config_clear_routing_rules
+                               (NMSettingIPConfig *setting);
+

Removes all configured routing rules.

+
+

Parameters

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

setting

the NMSettingIPConfig

 
+
+

Since: 1.18

+
+
+

nm_setting_ip_config_get_ignore_auto_routes ()

gboolean
 nm_setting_ip_config_get_ignore_auto_routes
@@ -3931,6 +5752,58 @@ the particular kind of device.
+

enum NMIPRoutingRuleAsStringFlags

+
+

Members

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

NM_IP_ROUTING_RULE_AS_STRING_FLAGS_NONE

 +

no flags selected.

+		 

NM_IP_ROUTING_RULE_AS_STRING_FLAGS_AF_INET

 +

whether to allow parsing + IPv4 addresses.

+		 

NM_IP_ROUTING_RULE_AS_STRING_FLAGS_AF_INET6

 +

whether to allow parsing + IPv6 addresses. If both NM_IP_ROUTING_RULE_AS_STRING_FLAGS_AF_INET + and + NM_IP_ROUTING_RULE_AS_STRING_FLAGS_AF_INET6 + are unset, it's the same + as setting them both.

+		 

NM_IP_ROUTING_RULE_AS_STRING_FLAGS_VALIDATE

 +

if set, ensure that the + rule verfies or fail.

+		 
+
+

Since: 1.18

+
+
+

NM_SETTING_IP_CONFIG_DAD_TIMEOUT_MAX

#define NM_SETTING_IP_CONFIG_DAD_TIMEOUT_MAX     30000
@@ -4045,6 +5918,12 @@ the particular kind of device.

+

NM_SETTING_IP_CONFIG_ROUTING_RULES

+
#define NM_SETTING_IP_CONFIG_ROUTING_RULES      "routing-rules"
+
+
+
+

NM_SETTING_DNS_OPTION_DEBUG

#define NM_SETTING_DNS_OPTION_DEBUG                     "debug"
-- cgit 1.3.0-6-gf8a5