From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm-util/html/NMConnection.html | 116 ++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 3 deletions(-) (limited to 'docs/libnm-util/html/NMConnection.html') diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index ef0d76b9..5b41012d 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -51,6 +51,7 @@ #define NM_CONNECTION_CHANGED #define NM_CONNECTION_PATH enum NMConnectionError; +#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD #define NM_CONNECTION_ERROR GQuark nm_connection_error_quark (void); NMConnection; @@ -84,6 +85,10 @@ enum GHashTable **out_settings); gboolean nm_connection_verify (NMConnection *connection, GError **error); +gboolean nm_connection_normalize (NMConnection *connection, + GHashTable *parameters, + gboolean *modified, + GError **error); const char * nm_connection_need_secrets (NMConnection *connection, GPtrArray **hints); void nm_connection_clear_secrets (NMConnection *connection); @@ -100,6 +105,7 @@ const char * char * nm_connection_get_path (NMConnection *connection); const char * nm_connection_get_virtual_iface_name (NMConnection *connection); +const char * nm_connection_get_interface_name (NMConnection *connection); gboolean nm_connection_is_type (NMConnection *connection, const char *type); void nm_connection_for_each_setting_value @@ -235,7 +241,8 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters NM_CONNECTION_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND, /*< nick=ConnectionSettingNotFound >*/ NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID, /*< nick=ConnectionTypeInvalid >*/ - NM_CONNECTION_ERROR_SETTING_NOT_FOUND /*< nick=SettingNotFound >*/ + NM_CONNECTION_ERROR_SETTING_NOT_FOUND, /*< nick=SettingNotFound >*/ + NM_CONNECTION_ERROR_INVALID_SETTING, /*< nick=InvalidSetting >*/ } NMConnectionError;

@@ -273,11 +280,25 @@ Describes errors that may result from operations involving a NMSetting object + +

NM_CONNECTION_ERROR_INVALID_SETTING

+the NMConnection object contains + a conflicting setting object + +
+

NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD

+
#define NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD "ip6-config-method"
+
+

+

+
+
+

NM_CONNECTION_ERROR

#define NM_CONNECTION_ERROR nm_connection_error_quark ()
@@ -727,7 +748,7 @@ Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For example, if a Wi-Fi connection is security enabled, the NMSettingWireless setting object's 'security' property must contain the setting name of the -NMSettingWirelessSecurity object, which must also be present in the +NMSettingWirelessSecurity object, which must also be present in the connection for the connection to be valid. As another example, the NMSettingWired object's 'mac-address' property must be a validly formatted MAC address. The returned GError contains information about which @@ -758,6 +779,62 @@ setting and which property failed validation, and how it failed validation.
+

nm_connection_normalize ()

+
gboolean            nm_connection_normalize             (NMConnection *connection,
+                                                         GHashTable *parameters,
+                                                         gboolean *modified,
+                                                         GError **error);
+

+Does some basic normalization and fixup of well known inconsistencies +and deprecated fields. If the connection was modified in any way, +the output parameter modified is set TRUE. +

+

+Finally the connection will be verified and TRUE returns if the connection +is valid. As this function only performs some specific normalization steps +it cannot repair all connections. If the connection has errors that +cannot be normalized, the connection will not be modified. +

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

connection :

the NMConnection to normalize

parameters :

a GHashTable with +normalization parameters to allow customization of the normalization by providing +specific arguments. Unknown arguments will be ignored and the default will be +used. The keys must be strings, hashed by g_str_hash() and g_str_equal() functions. +The values are opaque and depend on the parameter name. [allow-none][element-type utf8 gpointer] +

modified :

outputs whether any settings were modified. [out][allow-none] +

error :

location to store error, or NULL. Contains the reason, +why the connection is invalid, if the function returns an error.

Returns :

 +TRUE if the connection is valid, FALSE if it is not
+

Since 1.0

+
+
+

nm_connection_need_secrets ()

const char *        nm_connection_need_secrets          (NMConnection *connection,
                                                          GPtrArray **hints);
@@ -988,6 +1065,39 @@ connection types, this function will return +

nm_connection_get_interface_name ()

+
const char *        nm_connection_get_interface_name    (NMConnection *connection);
+

+Returns the interface name as stored in NMSettingConnection:interface_name. +If the connection contains no NMSettingConnection, it will return NULL. +

+

+For hardware devices and software devices created outside of NetworkManager, +this name is used to match the device. for software devices created by +NetworkManager, this is the name of the created interface. +

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

connection :

The NMConnection +

Returns :

Name of the kernel interface or NULL +
+

Since 1.0

+
+
+

nm_connection_is_type ()

gboolean            nm_connection_is_type               (NMConnection *connection,
                                                          const char *type);
@@ -1247,7 +1357,7 @@ A shortcut to return the type from the connection's char * nm_connection_get_virtual_device_description (NMConnection *connection);

-Returns the name that nm_device_disambiguate_names() would +Returns the name that nm_device_disambiguate_names() would return for the virtual device that would be created for connection. Eg, "VLAN (eth1.1)".

-- cgit 1.3.0-6-gf8a5