NMSetting

@@ -176,95 +176,165 @@ of properties and allowed values.

Details

NMSetting

typedef struct _NMSetting NMSetting;

enum NMSettingError

typedef enum {
+	NM_SETTING_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,    /*< nick=PropertyNotFound >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,   /*< nick=PropertyNotSecret >*/
+	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/
+} NMSettingError;
+

-The NMSetting struct contains only private data. -It should only be accessed through the functions described below. +Describes errors that may result from operations involving a NMSetting.

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

`NM_SETTING_ERROR_UNKNOWN`	unknown or unclassified error +
`NM_SETTING_ERROR_PROPERTY_NOT_FOUND`	a property required by the operation + was not found; for example, an attempt to update an invalid secret +
`NM_SETTING_ERROR_PROPERTY_NOT_SECRET`	an operation which requires a secret + was attempted on a non-secret property +
`NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH`	the operation requires a property + of a specific type, or the value couldn't be transformed to the same type + as the property being acted upon +

NMSettingClass

typedef struct {
-	GObjectClass parent;
-
-	/* Virtual functions */
-	gboolean    (*verify)            (NMSetting  *setting,
-	                                  GSList     *all_settings,
-	                                  GError     **error);
-
-	GPtrArray  *(*need_secrets)      (NMSetting  *setting);
-
-	gboolean    (*update_one_secret) (NMSetting  *setting,
-	                                  const char *key,
-	                                  GValue     *value,
-	                                  GError    **error);
-
-	gboolean    (*get_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags *out_flags,
-	                                  GError **error);
-
-	gboolean    (*set_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags flags,
-	                                  GError **error);
-
-	/* Returns TRUE if the given property contains the same value in both settings */
-	gboolean    (*compare_property)  (NMSetting *setting,
-	                                  NMSetting *other,
-	                                  const GParamSpec *prop_spec,
-	                                  NMSettingCompareFlags flags);
-
-	void        (*clear_secrets_with_flags) (NMSetting *setting,
-	                                         GParamSpec *pspec,
-	                                         NMSettingClearSecretsWithFlagsFn func,
-	                                         gpointer user_data);
-
-	const char *(*get_virtual_iface_name) (NMSetting *setting);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-} NMSettingClass;
+NM_SETTING_ERROR
+#define NM_SETTING_ERROR nm_setting_error_quark ()

NMSettingClearSecretsWithFlagsFn ()

gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
-                                                         const char *secret,
-                                                         NMSettingSecretFlags flags,
-                                                         gpointer user_data);

nm_setting_error_quark ()

GQuark              nm_setting_error_quark              (void);

+Registers an error quark for NMSetting if necessary. +

++++ + + + + +

Returns :

the error quark used for NMSetting errors.

NM_SETTING_PARAM_SERIALIZE

#define NM_SETTING_PARAM_SERIALIZE    (1 << (0 + G_PARAM_USER_SHIFT))
+

NM_SETTING_PARAM_REQUIRED

#define NM_SETTING_PARAM_REQUIRED     (1 << (1 + G_PARAM_USER_SHIFT))
+

NM_SETTING_PARAM_SECRET

#define NM_SETTING_PARAM_SECRET       (1 << (2 + G_PARAM_USER_SHIFT))
+

NM_SETTING_PARAM_FUZZY_IGNORE

#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))
+

NM_SETTING_NAME

#define NM_SETTING_NAME "name"
+

enum NMSettingSecretFlags

typedef enum {
+	NM_SETTING_SECRET_FLAG_NONE         = 0x00000000,
+	NM_SETTING_SECRET_FLAG_AGENT_OWNED  = 0x00000001,
+	NM_SETTING_SECRET_FLAG_NOT_SAVED    = 0x00000002,
+	NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004
+
+	/* NOTE: if adding flags, update nm-setting-private.h as well */
+} NMSettingSecretFlags;
+

+These flags indicate specific behavior related to handling of a secret. Each +secret has a corresponding set of these flags which indicate how the secret +is to be stored and/or requested when it is needed. +

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

`setting` :	The setting for which secrets are being iterated
`secret` :	The secret's name	`NM_SETTING_SECRET_FLAG_NONE`	the system is responsible for providing and +storing this secret (default) +
`flags` :	The secret's flags, eg `NM_SETTING_SECRET_FLAG_AGENT_OWNED` +	`NM_SETTING_SECRET_FLAG_AGENT_OWNED`	a user secret agent is responsible +for providing and storing this secret; when it is required agents will be +asked to retrieve it
`user_data` :	User data passed to `nm_connection_clear_secrets_with_flags()` +	`NM_SETTING_SECRET_FLAG_NOT_SAVED`	this secret should not be saved, but +should be requested from the user each time it is needed
Returns :	-`TRUE` to clear the secret, `FALSE` to not clear the secret	`NM_SETTING_SECRET_FLAG_NOT_REQUIRED`	in situations where it cannot be +automatically determined that the secret is required (some VPNs and PPP +providers dont require all secrets) this flag indicates that the specific +secret is not required +

@@ -285,8 +355,11 @@ It should only be accessed through the functions described below. These flags modify the comparison behavior when comparing two settings or two connections.

+++ @@ -329,75 +402,138 @@ storage (ie, the secret's flag includes NM_SETTING_S -enum NMSettingDiffResult -typedef enum { - NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000, - NM_SETTING_DIFF_RESULT_IN_A = 0x00000001, - NM_SETTING_DIFF_RESULT_IN_B = 0x00000002, -} NMSettingDiffResult; - +NMSetting +typedef struct _NMSetting NMSetting; -These values indicate the result of a setting difference operation. +The NMSetting struct contains only private data. +It should only be accessed through the functions described below. -

NM_SETTING_COMPARE_FLAG_EXACT

+ + + +NMSettingClearSecretsWithFlagsFn () +gboolean (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting, + const char *secret, + NMSettingSecretFlags flags, + gpointer user_data); +

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

`NM_SETTING_DIFF_RESULT_UNKNOWN`	unknown result -	`setting` :	The setting for which secrets are being iterated
`NM_SETTING_DIFF_RESULT_IN_A`	the property is present in setting A +	`secret` :	The secret's name
`flags` :	The secret's flags, eg `NM_SETTING_SECRET_FLAG_AGENT_OWNED`
`NM_SETTING_DIFF_RESULT_IN_B`	the property is present in setting B +	`user_data` :	User data passed to `nm_connection_clear_secrets_with_flags()`
Returns :	+`TRUE` to clear the secret, `FALSE` to not clear the secret

-enum NMSettingError -typedef enum { - NM_SETTING_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ - NM_SETTING_ERROR_PROPERTY_NOT_FOUND, /*< nick=PropertyNotFound >*/ - NM_SETTING_ERROR_PROPERTY_NOT_SECRET, /*< nick=PropertyNotSecret >*/ - NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/ -} NMSettingError; +NMSettingClass +typedef struct { + GObjectClass parent; + + /* Virtual functions */ + gboolean (*verify) (NMSetting *setting, + GSList *all_settings, + GError **error); + + GPtrArray *(*need_secrets) (NMSetting *setting); + + gboolean (*update_one_secret) (NMSetting *setting, + const char *key, + GValue *value, + GError **error); + + gboolean (*get_secret_flags) (NMSetting *setting, + const char *secret_name, + gboolean verify_secret, + NMSettingSecretFlags *out_flags, + GError **error); + + gboolean (*set_secret_flags) (NMSetting *setting, + const char *secret_name, + gboolean verify_secret, + NMSettingSecretFlags flags, + GError **error); + + /* Returns TRUE if the given property contains the same value in both settings */ + gboolean (*compare_property) (NMSetting *setting, + NMSetting *other, + const GParamSpec *prop_spec, + NMSettingCompareFlags flags); + + void (*clear_secrets_with_flags) (NMSetting *setting, + GParamSpec *pspec, + NMSettingClearSecretsWithFlagsFn func, + gpointer user_data); + + const char *(*get_virtual_iface_name) (NMSetting *setting); + + /* Padding for future expansion */ + void (*_reserved1) (void); +} NMSettingClass; -Describes errors that may result from operations involving a NMSetting. - + + + +NMSettingValueIterFn () +void (*NMSettingValueIterFn) (NMSetting *setting, + const char *key, + const GValue *value, + GParamFlags flags, + gpointer user_data); + +++ - - + - - + + - - + + + + + - - + @@ -416,8 +552,11 @@ Describes errors that may result from operations involving a nm_setting_to_hash(). - NM_SETTING_ERROR_UNKNOWN unknown or unclassified error + setting : The setting for which properties are being iterated, given to +nm_setting_enumerate_values() NM_SETTING_ERROR_PROPERTY_NOT_FOUND a property required by the operation - was not found; for example, an attempt to update an invalid secret - key : The value/property name NM_SETTING_ERROR_PROPERTY_NOT_SECRET an operation which requires a secret - was attempted on a non-secret property + value : The property's value flags : The property's flags, like NM_SETTING_PARAM_SECRET NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH the operation requires a property - of a specific type, or the value couldn't be transformed to the same type - as the property being acted upon + user_data : User data passed to nm_setting_enumerate_values() + +++ @@ -439,49 +578,34 @@ when calling -enum NMSettingSecretFlags -typedef enum { - NM_SETTING_SECRET_FLAG_NONE = 0x00000000, - NM_SETTING_SECRET_FLAG_AGENT_OWNED = 0x00000001, - NM_SETTING_SECRET_FLAG_NOT_SAVED = 0x00000002, - NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004 - - /* NOTE: if adding flags, update nm-setting-private.h as well */ -} NMSettingSecretFlags; - +nm_setting_to_hash () +GHashTable * nm_setting_to_hash (NMSetting *setting, + NMSettingHashFlags flags); -These flags indicate specific behavior related to handling of a secret. Each -secret has a corresponding set of these flags which indicate how the secret -is to be stored and/or requested when it is needed. +Converts the NMSetting into a GHashTable mapping each setting property +name to a GValue describing that property, suitable for marshalling over +D-Bus or serializing. The mapping is string to GValue. - NM_SETTING_HASH_FLAG_ALL + +++ - - - - - - + - - + - - + @@ -489,136 +613,131 @@ secret is not required -NMSettingValueIterFn () -void (*NMSettingValueIterFn) (NMSetting *setting, - const char *key, - const GValue *value, - GParamFlags flags, - gpointer user_data); - NM_SETTING_SECRET_FLAG_NONE the system is responsible for providing and -storing this secret (default) - NM_SETTING_SECRET_FLAG_AGENT_OWNED a user secret agent is responsible -for providing and storing this secret; when it is required agents will be -asked to retrieve it + setting : the NMSetting NM_SETTING_SECRET_FLAG_NOT_SAVED this secret should not be saved, but -should be requested from the user each time it is needed + flags : hash flags, e.g. NM_SETTING_HASH_FLAG_ALL NM_SETTING_SECRET_FLAG_NOT_REQUIRED in situations where it cannot be -automatically determined that the secret is required (some VPNs and PPP -providers dont require all secrets) this flag indicates that the specific -secret is not required + Returns : a new GHashTable +describing the setting's properties. [transfer full][element-type utf8 GObject.Value] +nm_setting_new_from_hash () +NMSetting * nm_setting_new_from_hash (GType setting_type, + GHashTable *hash); + +Creates a new NMSetting object and populates that object with the properties +contained in the hash table, using each hash key as the property to set, +and each hash value as the value to set that property to. Setting properties +are strongly typed, thus the GValue type of the hash value must be correct. +See the documentation on each NMSetting object subclass for the correct +property names and value types. + + +++ - - - - - - - - - - + + - - + - - + + setting : The setting for which properties are being iterated, given to -nm_setting_enumerate_values() - key : The value/property name value : The property's value setting_type : the NMSetting type which the hash contains properties for flags : The property's flags, like NM_SETTING_PARAM_SECRET + hash : the GHashTable containing a +string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value] user_data : User data passed to nm_setting_enumerate_values() - Returns : a new NMSetting object populated with the properties from the +hash table, or NULL on failure -NM_SETTING_ERROR -#define NM_SETTING_ERROR nm_setting_error_quark () - - - - - - -NM_SETTING_NAME -#define NM_SETTING_NAME "name" - - - - - - -NM_SETTING_PARAM_FUZZY_IGNORE -#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT)) - - - - - - -NM_SETTING_PARAM_REQUIRED -#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT)) - - - - - - -NM_SETTING_PARAM_SECRET -#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT)) - - - - - - -NM_SETTING_PARAM_SERIALIZE -#define NM_SETTING_PARAM_SERIALIZE (1 << (0 + G_PARAM_USER_SHIFT)) - +nm_setting_duplicate () +NMSetting * nm_setting_duplicate (NMSetting *setting); +Duplicates a NMSetting. + ++++ + + + + + + + + + + + setting : the NMSetting to duplicate Returns : a new NMSetting containing the same properties and values as the +source NMSetting. [transfer full] + -nm_setting_clear_secrets () -void nm_setting_clear_secrets (NMSetting *setting); +nm_setting_get_name () +const char * nm_setting_get_name (NMSetting *setting); -Resets and clears any secrets in the setting. Secrets should be added to the -setting only when needed, and cleared immediately after use to prevent -leakage of information. +Returns the type name of the NMSetting object - + +- ++ + + - + + + + + + setting : the NMSetting Returns : a string containing the type name of the NMSetting object, +like 'ppp' or 'wireless' or 'wired'. -nm_setting_clear_secrets_with_flags () -void nm_setting_clear_secrets_with_flags (NMSetting *setting, - NMSettingClearSecretsWithFlagsFn func, - gpointer user_data); +nm_setting_verify () +gboolean nm_setting_verify (NMSetting *setting, + GSList *all_settings, + GError **error); -Clears and frees secrets determined by func. +Validates the setting. Each setting's properties have allowed values, and +some are dependent on other values (hence the need for all_settings). The +returned GError contains information about which property of the setting +failed validation, and in what way that property failed validation. - + +++ - + - - + - - + + + + + setting : the NMSetting - the NMSetting to verify func : function to be called to determine whether a -specific secret should be cleared or not. [scope call] + all_settings : a GSList of all settings +in the connection from which setting came. [element-type NMSetting] user_data : caller-supplied data passed to func + error : location to store error, or NULL Returns : +TRUE if the setting is valid, FALSE if it is not @@ -633,8 +752,11 @@ Compares two NMSettingCompareFlags for a description of each flag's behavior. - + +++ @@ -660,6 +782,42 @@ for a description of each flag's behavior. +enum NMSettingDiffResult +typedef enum { + NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000, + NM_SETTING_DIFF_RESULT_IN_A = 0x00000001, + NM_SETTING_DIFF_RESULT_IN_B = 0x00000002, +} NMSettingDiffResult; + + +These values indicate the result of a setting difference operation. + + a : ++++ + + + + + + + + + + + + + + + NM_SETTING_DIFF_RESULT_UNKNOWN unknown result + NM_SETTING_DIFF_RESULT_IN_A the property is present in setting A + NM_SETTING_DIFF_RESULT_IN_B the property is present in setting B + +

+ + nm_setting_diff () gboolean nm_setting_diff (NMSetting *a, NMSetting *b, @@ -673,8 +831,11 @@ for a description of each flag's behavior. If the settings differ, the keys of each setting that differ from the other are added to results, mapped to one or more NMSettingDiffResult values. - + +++ @@ -714,29 +875,6 @@ in and the settings differ, a new one is created and returned. -nm_setting_duplicate () -NMSetting * nm_setting_duplicate (NMSetting *setting); - -Duplicates a NMSetting. - - a : -- - - - - - - - - - - setting : the NMSetting to duplicate Returns : a new NMSetting containing the same properties and values as the -source NMSetting. [transfer full] - - - - nm_setting_enumerate_values () void nm_setting_enumerate_values (NMSetting *setting, NMSettingValueIterFn func, @@ -745,8 +883,11 @@ source NMSetting object, calling the supplied user function for each property. - + +++ @@ -767,28 +908,18 @@ user function for each property. -nm_setting_error_quark () -GQuark nm_setting_error_quark (void); - -Registers an error quark for NMSetting if necessary. - - setting : -- - - - - Returns : the error quark used for NMSetting errors. - - - -nm_setting_get_name () -const char * nm_setting_get_name (NMSetting *setting); +nm_setting_to_string () +char * nm_setting_to_string (NMSetting *setting); -Returns the type name of the NMSetting object +Convert the setting into a string. For debugging purposes ONLY, should NOT +be used for serialization of the setting, or machine-parsed in any way. The +output format is not guaranteed to be stable and may change at any time. - + +++ @@ -797,62 +928,49 @@ Returns the type name of the Returns : - + setting : a string containing the type name of the NMSetting object, -like 'ppp' or 'wireless' or 'wired'. an allocated string containing a textual representation of the +setting's properties and values (including secrets!), which the caller should +free with g_free() + -nm_setting_get_secret_flags () -gboolean nm_setting_get_secret_flags (NMSetting *setting, - const char *secret_name, - NMSettingSecretFlags *out_flags, - GError **error); +nm_setting_clear_secrets () +void nm_setting_clear_secrets (NMSetting *setting); -For a given secret, retrieves the NMSettingSecretFlags describing how to -handle that secret. +Resets and clears any secrets in the setting. Secrets should be added to the +setting only when needed, and cleared immediately after use to prevent +leakage of information. - + +- - ++ + - - - - - - - - - - - - - - - - - - + setting : the NMSetting secret_name : the secret key name to get flags for out_flags : on success, the NMSettingSecretFlags for the secret error : location to store error, or NULL - Returns : TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not -nm_setting_get_virtual_iface_name () -const char * nm_setting_get_virtual_iface_name (NMSetting *setting); +nm_setting_clear_secrets_with_flags () +void nm_setting_clear_secrets_with_flags (NMSetting *setting, + NMSettingClearSecretsWithFlagsFn func, + gpointer user_data); -Returns the name of the virtual kernel interface which the connection -needs to use if specified in the settings. +Clears and frees secrets determined by func. - + +++ @@ -860,9 +978,15 @@ needs to use if specified in the settings. - - + + + + + + setting : Returns : Name of the virtual interface or NULL if the setting does not -support this feature func : function to be called to determine whether a +specific secret should be cleared or not. [scope call] + user_data : caller-supplied data passed to func + @@ -877,8 +1001,11 @@ to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed. - + +++ @@ -887,10 +1014,10 @@ is no way to conclusively determine exactly which secrets are needed. - @@ -898,51 +1025,61 @@ itself with -nm_setting_new_from_hash () -NMSetting * nm_setting_new_from_hash (GType setting_type, - GHashTable *hash); +nm_setting_update_secrets () +gboolean nm_setting_update_secrets (NMSetting *setting, + GHashTable *secrets, + GError **error); -Creates a new NMSetting object and populates that object with the properties -contained in the hash table, using each hash key as the property to set, -and each hash value as the value to set that property to. Setting properties -are strongly typed, thus the GValue type of the hash value must be correct. -See the documentation on each NMSetting object subclass for the correct -property names and value types. +Update the setting's secrets, given a hash table of secrets intended for that +setting (deserialized from D-Bus for example). - setting : Returns : a GPtrArray containing the property names of secrets of the -NMSetting which may be required; the caller owns the array -and must free the each array element with g_free(), as well as the array -itself with g_ptr_array_free(). [transfer full][element-type utf8] + a GPtrArray containing +the property names of secrets of the NMSetting which may be required; the +caller owns the array and must free it with g_ptr_array_free(), but must not +free the elements. [transfer container][element-type utf8] + +++ - - + + - - + + + + + - + setting_type : the NMSetting type which the hash contains properties for setting : the NMSetting + hash : the GHashTable containing a -string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value] + secrets : a GHashTable mapping +string to GValue of setting property names and secrets. [element-type utf8 GObject.Value] + error : location to store error, or NULL Returns : a new NMSetting object populated with the properties from the -hash table, or NULL on failure +TRUE if the secrets were successfully updated, FALSE on failure to +update one or more of the secrets. -nm_setting_set_secret_flags () -gboolean nm_setting_set_secret_flags (NMSetting *setting, +nm_setting_get_secret_flags () +gboolean nm_setting_get_secret_flags (NMSetting *setting, const char *secret_name, - NMSettingSecretFlags flags, + NMSettingSecretFlags *out_flags, GError **error); For a given secret, retrieves the NMSettingSecretFlags describing how to handle that secret. - + +++ @@ -951,15 +1088,15 @@ handle that secret. - + - - + + - @@ -972,47 +1109,20 @@ this setting, and if that property is secret), FALSE if not -nm_setting_to_hash () -GHashTable * nm_setting_to_hash (NMSetting *setting, - NMSettingHashFlags flags); - -Converts the NMSetting into a GHashTable mapping each setting property -name to a GValue describing that property, suitable for marshalling over -D-Bus or serializing. The mapping is string to GValue. - - setting : secret_name : the secret key name to set flags for the secret key name to get flags for flags : the NMSettingSecretFlags for the secret out_flags : on success, the NMSettingSecretFlags for the secret error : location to store error, or NULL + location to store error, or NULL -- - - - - - - - - - - - - - - setting : the NMSetting - flags : hash flags, e.g. NM_SETTING_HASH_FLAG_ALL - Returns : a new GHashTable -describing the setting's properties. [transfer full][element-type utf8 GObject.Value] - - - - -nm_setting_to_string () -char * nm_setting_to_string (NMSetting *setting); +nm_setting_set_secret_flags () +gboolean nm_setting_set_secret_flags (NMSetting *setting, + const char *secret_name, + NMSettingSecretFlags flags, + GError **error); -Convert the setting into a string. For debugging purposes ONLY, should NOT -be used for serialization of the setting, or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. +For a given secret, retrieves the NMSettingSecretFlags describing how to +handle that secret. - + +++ @@ -1020,87 +1130,49 @@ output format is not guaranteed to be stable and may change at any time. - - - - - setting : Returns : an allocated string containing a textual representation of the -setting's properties and values (including secrets!), which the caller should -free with g_free() - - - - -nm_setting_update_secrets () -gboolean nm_setting_update_secrets (NMSetting *setting, - GHashTable *secrets, - GError **error); - -Update the setting's secrets, given a hash table of secrets intended for that -setting (deserialized from D-Bus for example). - - -- - - - + + - - + + - - + setting : the NMSetting - secret_name : the secret key name to set flags for secrets : a GHashTable mapping -string to GValue of setting property names and secrets. [element-type utf8 GObject.Value] - flags : the NMSettingSecretFlags for the secret error : location to store error, or NULL + location to store error, or NULL Returns : -TRUE if the secrets were successfully updated and the connection -is valid, FALSE on failure or if the setting was never added to the connection TRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not -nm_setting_verify () -gboolean nm_setting_verify (NMSetting *setting, - GSList *all_settings, - GError **error); +nm_setting_get_virtual_iface_name () +const char * nm_setting_get_virtual_iface_name (NMSetting *setting); -Validates the setting. Each setting's properties have allowed values, and -some are dependent on other values (hence the need for all_settings). The -returned GError contains information about which property of the setting -failed validation, and in what way that property failed validation. +Returns the name of the virtual kernel interface which the connection +needs to use if specified in the settings. - + +++ - - - - - - - - - - + setting : the NMSetting to verify all_settings : a GSList of all settings -in the connection from which setting came. [element-type NMSetting] - error : location to store error, or NULL + the NMSetting Returns : -TRUE if the setting is valid, FALSE if it is not Name of the virtual interface or NULL if the setting does not +support this feature @@ -1122,6 +1194,6 @@ example 'ppp' or 'wireless' or 'wired'. - Generated by GTK-Doc V1.18 + Generated by GTK-Doc V1.19

`setting` :	the NMSetting -	the NMSetting to verify
`func` :	function to be called to determine whether a -specific secret should be cleared or not. [scope call] +	`all_settings` :	a GSList of all settings +in the connection from which `setting` came. [element-type NMSetting]
`user_data` :	caller-supplied data passed to `func` +	`error` :	location to store error, or `NULL`
Returns :	+`TRUE` if the setting is valid, `FALSE` if it is not

`setting` :	the NMSetting to verify
`all_settings` :	a GSList of all settings -in the connection from which `setting` came. [element-type NMSetting] -
`error` :	location to store error, or `NULL` +	the NMSetting
Returns :	-`TRUE` if the setting is valid, `FALSE` if it is not	Name of the virtual interface or `NULL` if the setting does not +support this feature

`setting` :	The setting for which properties are being iterated, given to -`nm_setting_enumerate_values()` -
`key` :	The value/property name
`value` :	The property's value	`setting_type` :	the NMSetting type which the hash contains properties for
`flags` :	The property's flags, like `NM_SETTING_PARAM_SECRET` +	`hash` :	the GHashTable containing a +string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value]
`user_data` :	User data passed to `nm_setting_enumerate_values()` -	Returns :	a new NMSetting object populated with the properties from the +hash table, or `NULL` on failure

`setting` :	the NMSetting to duplicate
Returns :	a new NMSetting containing the same properties and values as the +source NMSetting. [transfer full] +

`NM_SETTING_DIFF_RESULT_UNKNOWN`	unknown result +
`NM_SETTING_DIFF_RESULT_IN_A`	the property is present in setting A +
`NM_SETTING_DIFF_RESULT_IN_B`	the property is present in setting B +

`setting` :	the NMSetting
`secret_name` :	the secret key name to get flags for
`out_flags` :	on success, the NMSettingSecretFlags for the secret
`error` :	location to store error, or `NULL` -
Returns :	TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

`setting` :
Returns :	a GPtrArray containing the property names of secrets of the -NMSetting which may be required; the caller owns the array -and must free the each array element with `g_free()`, as well as the array -itself with `g_ptr_array_free()`. [transfer full][element-type utf8] +	a GPtrArray containing +the property names of secrets of the NMSetting which may be required; the +caller owns the array and must free it with `g_ptr_array_free()`, but must not +free the elements. [transfer container][element-type utf8]

`setting` :
`secret_name` :	the secret key name to set flags for	the secret key name to get flags for
`flags` :	the NMSettingSecretFlags for the secret	`out_flags` :	on success, the NMSettingSecretFlags for the secret
`error` :	location to store error, or `NULL` +	location to store error, or `NULL`

`setting` :
Returns :	an allocated string containing a textual representation of the -setting's properties and values (including secrets!), which the caller should -free with `g_free()` -

Synopsis

Object Hierarchy

Details

NMSetting

enum NMSettingError

NMSettingClass

NM_SETTING_ERROR

NMSettingClearSecretsWithFlagsFn ()

nm_setting_error_quark ()

NM_SETTING_PARAM_SERIALIZE

NM_SETTING_PARAM_REQUIRED

NM_SETTING_PARAM_SECRET

NM_SETTING_PARAM_FUZZY_IGNORE

NM_SETTING_NAME

enum NMSettingSecretFlags

enum NMSettingDiffResult

NMSetting

NMSettingClearSecretsWithFlagsFn ()

enum NMSettingError

NMSettingClass

NMSettingValueIterFn ()

enum NMSettingSecretFlags

nm_setting_to_hash ()

NMSettingValueIterFn ()

nm_setting_new_from_hash ()

NM_SETTING_ERROR

NM_SETTING_NAME

NM_SETTING_PARAM_FUZZY_IGNORE

NM_SETTING_PARAM_REQUIRED

NM_SETTING_PARAM_SECRET

NM_SETTING_PARAM_SERIALIZE

nm_setting_duplicate ()

nm_setting_clear_secrets ()

nm_setting_get_name ()

nm_setting_clear_secrets_with_flags ()

nm_setting_verify ()

enum NMSettingDiffResult

nm_setting_diff ()

nm_setting_duplicate ()

nm_setting_enumerate_values ()

nm_setting_error_quark ()

nm_setting_get_name ()

nm_setting_to_string ()

nm_setting_get_secret_flags ()

nm_setting_clear_secrets ()

nm_setting_get_virtual_iface_name ()

nm_setting_clear_secrets_with_flags ()

nm_setting_new_from_hash ()

nm_setting_update_secrets ()

nm_setting_set_secret_flags ()

nm_setting_get_secret_flags ()

nm_setting_to_hash ()

nm_setting_to_string ()

nm_setting_set_secret_flags ()

nm_setting_update_secrets ()

nm_setting_verify ()

nm_setting_get_virtual_iface_name ()