From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm/html/NMSettingIPConfig.html | 282 ++++++++++++++++----------------- 1 file changed, 141 insertions(+), 141 deletions(-) (limited to 'docs/libnm/html/NMSettingIPConfig.html') diff --git a/docs/libnm/html/NMSettingIPConfig.html b/docs/libnm/html/NMSettingIPConfig.html index 98cd3a82..fde14a76 100644 --- a/docs/libnm/html/NMSettingIPConfig.html +++ b/docs/libnm/html/NMSettingIPConfig.html @@ -8,7 +8,7 @@ - + @@ -975,7 +975,7 @@ nm_ip_address_new (int fam GError **error);

Creates a new NMIPAddress object.

-

Parameters

+

Parameters

@@ -1008,7 +1008,7 @@ nm_ip_address_new (int fam
-

Returns

+

Returns

the new NMIPAddress object, or NULL on error.

[transfer full]

@@ -1026,7 +1026,7 @@ nm_ip_address_new_binary (intfamily .

-

Parameters

+

Parameters

@@ -1059,7 +1059,7 @@ correct size for family
-

Returns

+

Returns

the new NMIPAddress object, or NULL on error.

[transfer full]

@@ -1071,7 +1071,7 @@ correct size for family nm_ip_address_ref (NMIPAddress *address);

Increases the reference count of the object.

-

Parameters

+

Parameters

@@ -1094,7 +1094,7 @@ nm_ip_address_unref ( -

Parameters

+

Parameters

@@ -1118,7 +1118,7 @@ nm_ip_address_equal (NMIPAddress objects contain the same address and prefix (attributes are not compared).

-

Parameters

+

Parameters

@@ -1141,7 +1141,7 @@ to.

-

Returns

+

Returns

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

@@ -1153,7 +1153,7 @@ nm_ip_address_dup (address

-

Parameters

+

Parameters

@@ -1168,7 +1168,7 @@ nm_ip_address_dup ( -

Returns

+

Returns

a copy of address .

[transfer full]

@@ -1182,7 +1182,7 @@ nm_ip_address_get_family ( -

Parameters

+

Parameters

@@ -1197,7 +1197,7 @@ object.

-

Returns

+

Returns

the IP address family

@@ -1208,7 +1208,7 @@ object.

nm_ip_address_get_address (NMIPAddress *address);

Gets the IP address property of this address object.

-

Parameters

+

Parameters

@@ -1223,7 +1223,7 @@ nm_ip_address_get_address ( -

Returns

+

Returns

the IP address

@@ -1239,7 +1239,7 @@ nm_ip_address_set_address (nm_utils_ipaddr_valid() to check it.

-

Parameters

+

Parameters

@@ -1273,7 +1273,7 @@ nm_ip_address_get_address_binary (

[skip]

-

Parameters

+

Parameters

@@ -1307,7 +1307,7 @@ nm_ip_address_set_address_binary (

[skip]

-

Parameters

+

Parameters

@@ -1337,7 +1337,7 @@ nm_ip_address_get_prefix (
-

Parameters

+

Parameters

@@ -1352,7 +1352,7 @@ object.

-

Returns

+

Returns

the IP address prefix

@@ -1364,7 +1364,7 @@ nm_ip_address_set_prefix (guint prefix);

Sets the IP address prefix property of this address object.

-

Parameters

+

Parameters

@@ -1394,7 +1394,7 @@ nm_ip_address_get_attribute_names (Gets an array of attribute names defined on address .

-

Parameters

+

Parameters

@@ -1409,7 +1409,7 @@ nm_ip_address_get_attribute_names (
-

Returns

+

Returns

a NULL-terminated array of attribute names,.

[transfer full]

@@ -1424,7 +1424,7 @@ nm_ip_address_get_attribute (address

-

Parameters

+

Parameters

@@ -1446,7 +1446,7 @@ nm_ip_address_get_attribute ( -

Returns

+

Returns

the value of the attribute with name name on address @@ -1465,7 +1465,7 @@ nm_ip_address_set_attribute (address to the given value.

-

Parameters

+

Parameters

@@ -1504,7 +1504,7 @@ nm_ip_route_new (int famil GError **error);

Creates a new NMIPRoute object.

-

Parameters

+

Parameters

@@ -1547,7 +1547,7 @@ nm_ip_route_new (int famil
-

Returns

+

Returns

the new NMIPRoute object, or NULL on error.

[transfer full]

@@ -1568,7 +1568,7 @@ nm_ip_route_new_binary (intfamily .

-

Parameters

+

Parameters

@@ -1611,7 +1611,7 @@ point to buffers of the correct size for family
-

Returns

+

Returns

the new NMIPRoute object, or NULL on error.

[transfer full]

@@ -1623,7 +1623,7 @@ point to buffers of the correct size for familyNMIPRoute *route);

Increases the reference count of the object.

-

Parameters

+

Parameters

@@ -1646,7 +1646,7 @@ nm_ip_route_unref ( -

Parameters

+

Parameters

@@ -1670,7 +1670,7 @@ nm_ip_route_equal (NMIPRoute objects contain the same destination, prefix, next hop, and metric. (Attributes are not compared.)

-

Parameters

+

Parameters

@@ -1693,7 +1693,7 @@ to.

-

Returns

+

Returns

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

@@ -1705,7 +1705,7 @@ nm_ip_route_dup (route

-

Parameters

+

Parameters

@@ -1720,7 +1720,7 @@ nm_ip_route_dup ( -

Returns

+

Returns

a copy of route .

[transfer full]

@@ -1734,7 +1734,7 @@ nm_ip_route_get_family ( -

Parameters

+

Parameters

@@ -1749,7 +1749,7 @@ object.

-

Returns

+

Returns

the IP address family

@@ -1760,7 +1760,7 @@ object.

nm_ip_route_get_dest (NMIPRoute *route);

Gets the IP destination address property of this route object.

-

Parameters

+

Parameters

@@ -1775,7 +1775,7 @@ nm_ip_route_get_dest ( -

Returns

+

Returns

the IP address of the route's destination

@@ -1791,7 +1791,7 @@ nm_ip_route_set_dest (nm_utils_ipaddr_valid() to check it.

-

Parameters

+

Parameters

@@ -1825,7 +1825,7 @@ nm_ip_route_get_dest_binary ([skip]

-

Parameters

+

Parameters

@@ -1859,7 +1859,7 @@ nm_ip_route_set_dest_binary ([skip]

-

Parameters

+

Parameters

@@ -1888,7 +1888,7 @@ nm_ip_route_set_dest_binary (NMIPRoute *route);

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

-

Parameters

+

Parameters

@@ -1903,7 +1903,7 @@ nm_ip_route_get_prefix ( -

Returns

+

Returns

the IP prefix

@@ -1915,7 +1915,7 @@ nm_ip_route_set_prefix (guint prefix);

Sets the prefix property of this route object.

-

Parameters

+

Parameters

@@ -1945,7 +1945,7 @@ nm_ip_route_get_next_hop (NULL if the route has no next hop.

-

Parameters

+

Parameters

@@ -1960,7 +1960,7 @@ route has no next hop.

-

Returns

+

Returns

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

@@ -1977,7 +1977,7 @@ nm_ip_route_set_next_hop (nm_utils_ipaddr_valid() to check it.

-

Parameters

+

Parameters

@@ -2011,7 +2011,7 @@ nm_ip_route_get_next_hop_binary (

[skip]

-

Parameters

+

Parameters

@@ -2033,7 +2033,7 @@ nm_ip_route_get_next_hop_binary (
-

Returns

+

Returns

TRUE if route has a next hop, FALSE if not (in which case next_hop @@ -2053,7 +2053,7 @@ nm_ip_route_set_next_hop_binary (

[skip]

-

Parameters

+

Parameters

@@ -2084,7 +2084,7 @@ nm_ip_route_get_metric (
-

Parameters

+

Parameters

@@ -2099,7 +2099,7 @@ indicate "better" or more preferred routes; -1 indicates "default"
-

Returns

+

Returns

the route metric

@@ -2111,7 +2111,7 @@ nm_ip_route_set_metric (gint64 metric);

Sets the metric property of this route object.

-

Parameters

+

Parameters

@@ -2141,7 +2141,7 @@ nm_ip_route_get_attribute_names (Gets an array of attribute names defined on route .

-

Parameters

+

Parameters

@@ -2156,7 +2156,7 @@ nm_ip_route_get_attribute_names (
-

Returns

+

Returns

a NULL-terminated array of attribute names.

[transfer full]

@@ -2171,7 +2171,7 @@ nm_ip_route_get_attribute (route

-

Parameters

+

Parameters

@@ -2193,7 +2193,7 @@ nm_ip_route_get_attribute ( -

Returns

+

Returns

the value of the attribute with name name on route @@ -2212,7 +2212,7 @@ nm_ip_route_set_attribute (route to the given value.

-

Parameters

+

Parameters

@@ -2245,7 +2245,7 @@ nm_ip_route_set_attribute (const char * nm_setting_ip_config_get_method (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2260,7 +2260,7 @@ nm_setting_ip_config_get_method (
-

Returns

+

Returns

the “method” property of the setting; see NMSettingIP4Config and NMSettingIP6Config for details of the methods available with each type.

@@ -2272,7 +2272,7 @@ methods available with each type.

guint
 nm_setting_ip_config_get_num_dns (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2287,7 +2287,7 @@ nm_setting_ip_config_get_num_dns (
-

Returns

+

Returns

the number of configured DNS servers

@@ -2298,7 +2298,7 @@ nm_setting_ip_config_get_num_dns (NMSettingIPConfig *setting, int idx);
-

Parameters

+

Parameters

@@ -2320,7 +2320,7 @@ nm_setting_ip_config_get_dns ( -

Returns

+

Returns

the IP address of the DNS server at index idx

@@ -2333,7 +2333,7 @@ nm_setting_ip_config_add_dns (const char *dns);

Adds a new DNS server to the setting.

-

Parameters

+

Parameters

@@ -2355,7 +2355,7 @@ nm_setting_ip_config_add_dns ( -

Returns

+

Returns

TRUE if the DNS server was added; FALSE if the server was already known

@@ -2369,7 +2369,7 @@ nm_setting_ip_config_remove_dns (Removes the DNS server at index idx .

-

Parameters

+

Parameters

@@ -2401,7 +2401,7 @@ nm_setting_ip_config_remove_dns_by_value

Removes the DNS server dns .

-

Parameters

+

Parameters

@@ -2423,7 +2423,7 @@ nm_setting_ip_config_remove_dns_by_value
-

Returns

+

Returns

TRUE if the DNS server was found and removed; FALSE if it was not.

@@ -2434,7 +2434,7 @@ nm_setting_ip_config_remove_dns_by_value nm_setting_ip_config_clear_dns (NMSettingIPConfig *setting);

Removes all configured DNS servers.

-

Parameters

+

Parameters

@@ -2456,7 +2456,7 @@ nm_setting_ip_config_clear_dns (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2471,7 +2471,7 @@ nm_setting_ip_config_get_num_dns_searches
-

Returns

+

Returns

the number of configured DNS search domains

@@ -2482,7 +2482,7 @@ nm_setting_ip_config_get_num_dns_searches nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting, int idx);
-

Parameters

+

Parameters

@@ -2504,7 +2504,7 @@ nm_setting_ip_config_get_dns_search (
-

Returns

+

Returns

the DNS search domain at index idx

@@ -2517,7 +2517,7 @@ nm_setting_ip_config_add_dns_search (const char *dns_search);

Adds a new DNS search domain to the setting.

-

Parameters

+

Parameters

@@ -2539,7 +2539,7 @@ nm_setting_ip_config_add_dns_search (
-

Returns

+

Returns

TRUE if the DNS search domain was added; FALSE if the search domain was already known

@@ -2554,7 +2554,7 @@ nm_setting_ip_config_remove_dns_search

Removes the DNS search domain at index idx .

-

Parameters

+

Parameters

@@ -2586,7 +2586,7 @@ nm_setting_ip_config_remove_dns_search_by_value

Removes the DNS search domain dns_search .

-

Parameters

+

Parameters

@@ -2608,7 +2608,7 @@ nm_setting_ip_config_remove_dns_search_by_value
-

Returns

+

Returns

TRUE if the DNS search domain was found and removed; FALSE if it was not.

Since 0.9.10

@@ -2621,7 +2621,7 @@ nm_setting_ip_config_clear_dns_searches (NMSettingIPConfig *setting);

Removes all configured DNS search domains.

-

Parameters

+

Parameters

@@ -2643,7 +2643,7 @@ nm_setting_ip_config_clear_dns_searches nm_setting_ip_config_get_num_dns_options (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2658,7 +2658,7 @@ nm_setting_ip_config_get_num_dns_options
-

Returns

+

Returns

the number of configured DNS options

Since: 1.2

@@ -2674,7 +2674,7 @@ Either the options are explicitly set to have no values, or the options are left undefined. The latter means to use a default configuration, while the former explicitly means "no-options".

-

Parameters

+

Parameters

@@ -2689,7 +2689,7 @@ a default configuration, while the former explicitly means "no-options".

-

Returns

+

Returns

whether DNS options are initalized or left unset (the default).

@@ -2700,7 +2700,7 @@ a default configuration, while the former explicitly means "no-options".

nm_setting_ip_config_get_dns_option (NMSettingIPConfig *setting, guint idx);
-

Parameters

+

Parameters

@@ -2722,7 +2722,7 @@ nm_setting_ip_config_get_dns_option (
-

Returns

+

Returns

the DNS option at index idx

@@ -2736,7 +2736,7 @@ nm_setting_ip_config_next_valid_dns_option (NMSettingIPConfig *setting, guint idx);
-

Parameters

+

Parameters

@@ -2758,7 +2758,7 @@ nm_setting_ip_config_next_valid_dns_option
-

Returns

+

Returns

the index, greater or equal than idx , of the first valid DNS option, or -1 if no valid option is found

@@ -2773,7 +2773,7 @@ nm_setting_ip_config_add_dns_option (const char *dns_option);

Adds a new DNS option to the setting.

-

Parameters

+

Parameters

@@ -2795,7 +2795,7 @@ nm_setting_ip_config_add_dns_option (
-

Returns

+

Returns

TRUE if the DNS option was added; FALSE otherwise

Since: 1.2

@@ -2810,7 +2810,7 @@ nm_setting_ip_config_remove_dns_option

Removes the DNS option at index idx .

-

Parameters

+

Parameters

@@ -2843,7 +2843,7 @@ nm_setting_ip_config_remove_dns_option_by_value

Removes the DNS option dns_option .

-

Parameters

+

Parameters

@@ -2865,7 +2865,7 @@ nm_setting_ip_config_remove_dns_option_by_value
-

Returns

+

Returns

TRUE if the DNS option was found and removed; FALSE if it was not.

Since: 1.2

@@ -2879,7 +2879,7 @@ nm_setting_ip_config_clear_dns_options gboolean is_set);

Removes all configured DNS options.

-

Parameters

+

Parameters

@@ -2909,7 +2909,7 @@ Specify how to clear the options.

gint
 nm_setting_ip_config_get_dns_priority (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2924,10 +2924,10 @@ nm_setting_ip_config_get_dns_priority ( -

Returns

+

Returns

the priority of DNS servers

-

Since: 1.2.4

+

Since: 1.4


@@ -2936,7 +2936,7 @@ nm_setting_ip_config_get_dns_priority (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -2951,7 +2951,7 @@ nm_setting_ip_config_get_num_addresses
-

Returns

+

Returns

the number of configured addresses

@@ -2962,7 +2962,7 @@ nm_setting_ip_config_get_num_addresses nm_setting_ip_config_get_address (NMSettingIPConfig *setting, int idx);
-

Parameters

+

Parameters

@@ -2984,7 +2984,7 @@ nm_setting_ip_config_get_address (
-

Returns

+

Returns

the address at index idx .

[transfer none]

@@ -2999,7 +2999,7 @@ nm_setting_ip_config_add_address (Adds a new IP address and associated information to the setting. The given address is duplicated internally and is not changed by this function.

-

Parameters

+

Parameters

@@ -3021,7 +3021,7 @@ given address is duplicated internally and is not changed by this function.

-

Returns

+

Returns

TRUE if the address was added; FALSE if the address was already known.

@@ -3035,7 +3035,7 @@ nm_setting_ip_config_remove_address (Removes the address at index idx .

-

Parameters

+

Parameters

@@ -3067,7 +3067,7 @@ nm_setting_ip_config_remove_address_by_value

Removes the address address .

-

Parameters

+

Parameters

@@ -3089,7 +3089,7 @@ nm_setting_ip_config_remove_address_by_value
-

Returns

+

Returns

TRUE if the address was found and removed; FALSE if it was not.

@@ -3100,7 +3100,7 @@ nm_setting_ip_config_remove_address_by_value nm_setting_ip_config_clear_addresses (NMSettingIPConfig *setting);

Removes all configured addresses.

-

Parameters

+

Parameters

@@ -3121,7 +3121,7 @@ nm_setting_ip_config_clear_addresses (const char * nm_setting_ip_config_get_gateway (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -3136,7 +3136,7 @@ nm_setting_ip_config_get_gateway (
-

Returns

+

Returns

the IP address of the gateway associated with this configuration, or NULL.

@@ -3147,7 +3147,7 @@ nm_setting_ip_config_get_gateway (guint nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -3162,7 +3162,7 @@ nm_setting_ip_config_get_num_routes (
-

Returns

+

Returns

the number of configured routes

@@ -3173,7 +3173,7 @@ nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting, int idx);
-

Parameters

+

Parameters

@@ -3195,7 +3195,7 @@ nm_setting_ip_config_get_route (
-

Returns

+

Returns

the route at index idx .

[transfer none]

@@ -3210,7 +3210,7 @@ nm_setting_ip_config_add_route (Adds a new route and associated information to the setting. The given route is duplicated internally and is not changed by this function.

-

Parameters

+

Parameters

@@ -3232,7 +3232,7 @@ given route is duplicated internally and is not changed by this function.

-

Returns

+

Returns

TRUE if the route was added; FALSE if the route was already known.

@@ -3245,7 +3245,7 @@ nm_setting_ip_config_remove_route (Removes the route at index idx .

-

Parameters

+

Parameters

@@ -3277,7 +3277,7 @@ nm_setting_ip_config_remove_route_by_value

Removes the route route .

-

Parameters

+

Parameters

@@ -3299,7 +3299,7 @@ nm_setting_ip_config_remove_route_by_value
-

Returns

+

Returns

TRUE if the route was found and removed; FALSE if it was not.

@@ -3310,7 +3310,7 @@ nm_setting_ip_config_remove_route_by_value nm_setting_ip_config_clear_routes (NMSettingIPConfig *setting);

Removes all configured routes.

-

Parameters

+

Parameters

@@ -3333,7 +3333,7 @@ nm_setting_ip_config_get_route_metric (“route-metric” property.

-

Parameters

+

Parameters

@@ -3348,7 +3348,7 @@ property.

-

Returns

+

Returns

the route metric that is used for routes that don't explicitly specify a metric. See “route-metric” for more details.

@@ -3362,7 +3362,7 @@ nm_setting_ip_config_get_ignore_auto_routes

Returns the value contained in the “ignore-auto-routes” property.

-

Parameters

+

Parameters

@@ -3377,7 +3377,7 @@ property.

-

Returns

+

Returns

TRUE if automatically configured (ie via DHCP) routes should be ignored.

@@ -3391,7 +3391,7 @@ nm_setting_ip_config_get_ignore_auto_dns

Returns the value contained in the “ignore-auto-dns” property.

-

Parameters

+

Parameters

@@ -3406,7 +3406,7 @@ property.

-

Returns

+

Returns

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

@@ -3420,7 +3420,7 @@ nm_setting_ip_config_get_dhcp_hostname

Returns the value contained in the “dhcp-hostname” property.

-

Parameters

+

Parameters

@@ -3435,7 +3435,7 @@ property.

-

Returns

+

Returns

the configured hostname to send to the DHCP server

@@ -3448,7 +3448,7 @@ nm_setting_ip_config_get_dhcp_send_hostname

Returns the value contained in the “dhcp-send-hostname” property.

-

Parameters

+

Parameters

@@ -3463,7 +3463,7 @@ property.

-

Returns

+

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.

@@ -3478,7 +3478,7 @@ nm_setting_ip_config_get_never_default

Returns the value contained in the “never-default” property.

-

Parameters

+

Parameters

@@ -3493,7 +3493,7 @@ property.

-

Returns

+

Returns

TRUE if this connection should never be the default connection

@@ -3506,7 +3506,7 @@ nm_setting_ip_config_get_may_fail (Returns the value contained in the “may-fail” property.

-

Parameters

+

Parameters

@@ -3521,7 +3521,7 @@ property.

-

Returns

+

Returns

TRUE if this connection doesn't require this type of IP addressing to complete for the connection to succeed.

@@ -3532,7 +3532,7 @@ addressing to complete for the connection to succeed.

gint
 nm_setting_ip_config_get_dad_timeout (NMSettingIPConfig *setting);
-

Parameters

+

Parameters

@@ -3547,7 +3547,7 @@ nm_setting_ip_config_get_dad_timeout ( -

Returns

+

Returns

the “dad-timeout” property.

Since: 1.2

@@ -3560,7 +3560,7 @@ nm_setting_ip_config_get_dhcp_timeout (“dhcp-timeout” property.

-

Parameters

+

Parameters

@@ -3575,7 +3575,7 @@ property.

-

Returns

+

Returns

the configured DHCP timeout in seconds. 0 = default for the particular kind of device.

@@ -3879,7 +3879,7 @@ priority, only DNS servers from configurations with the lowest priority value will be used.

Flags: Read / Write / Construct

Default value: 0

-

Since: 1.2.4

+

Since: 1.4


@@ -3996,6 +3996,6 @@ For IPv4, zero is a regular value for the metric.

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