Properties

@@ -184,9 +171,30 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters

Details

enum NMConnectionError

typedef enum
-{
+NMConnection
+typedef struct _NMConnection NMConnection;
+
+The NMConnection struct contains only private data.
+It should only be accessed through the functions described below.
+
+

NMConnectionClass

typedef struct {
+	GObjectClass parent;
+
+	/* Signals */
+	void (*secrets_updated) (NMConnection *connection, const char * setting);
+} NMConnectionClass;
+

enum NMConnectionError

typedef enum {
 	NM_CONNECTION_ERROR_UNKNOWN = 0,
 	NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND,
 	NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID,
@@ -230,138 +238,121 @@ Describes errors that may result from operations involving a 
 
 
-NM_TYPE_CONNECTION_ERROR
-#define NM_TYPE_CONNECTION_ERROR (nm_connection_error_get_type ()) 
-
-
-
-
-
-
-NM_CONNECTION_ERROR
-#define NM_CONNECTION_ERROR nm_connection_error_quark ()
+NM_CONNECTION_PATH
+#define NM_CONNECTION_PATH "path"
 
 
 
 
 
 
-nm_connection_error_quark ()
-GQuark              nm_connection_error_quark           (void);
+nm_connection_add_setting ()
+void                nm_connection_add_setting           (NMConnection *connection,
+                                                         NMSetting *setting);
 
-Registers an error quark for NMConnection if necessary.
+Adds a NMSetting to the connection, replacing any previous NMSetting of the
+same name which has previously been added to the NMConnection.  The
+connection takes ownership of the NMSetting object and does not increase
+the setting object's reference count.
 
 -
-
-
-
+
+
+
+
+
+
+
+
+
+
 
Returns : the error quark used for NMConnection errors.
connection : a NMConnection
+
setting : the NMSetting to add to the connection object. [transfer full]
+
 
 
 
 
-NM_CONNECTION_PATH
-#define NM_CONNECTION_PATH "path"
-
-
-
-
-
-
-NMConnection
-typedef struct _NMConnection NMConnection;
-
-The NMConnection struct contains only private data.
-It should only be accessed through the functions described below.
-
-
-
-
-NMConnectionClass
-typedef struct {
-	GObjectClass parent;
-
-	/* Signals */
-	void (*secrets_updated) (NMConnection *connection, const char * setting);
-} NMConnectionClass;
-
-
-
-
-
-
-nm_connection_get_type ()
-GType               nm_connection_get_type              (void);
-
-
-
-
-
-nm_connection_new ()
-NMConnection *      nm_connection_new                   (void);
+nm_connection_clear_secrets ()
+void                nm_connection_clear_secrets         (NMConnection *connection);
 
-Creates a new NMConnection object with no NMSetting objects.
+Clears and frees any secrets that may be stored in the connection, to avoid
+keeping secret data in memory when not needed.
 
 
-
-
+
+
 
 Returns : the new empty NMConnection object connection : the NMConnection
+
 
 
 
 
 
-nm_connection_new_from_hash ()
-NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
-                                                         GError **error);
+nm_connection_clear_secrets_with_flags ()
+void                nm_connection_clear_secrets_with_flags
+                                                        (NMConnection *connection,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);
 
-Creates a new NMConnection from a hash table describing the connection.  See
-nm_connection_to_hash() for a description of the expected hash table.
+Clears and frees secrets determined by func.
 
 
-
-
+
-
-
+
+
-
-
+
+
 
 
 hash : the GHashTable describing
-the connection. [element-type utf8 GLib.HashTable]
+ connection : the NMConnection
 
 
 error : on unsuccessful return, an error func : function to be called to determine whether a
+specific secret should be cleared or not. [scope call]
+
 
 Returns : the new NMConnection object, populated with settings created
-from the values in the hash table, or NULL if the connection failed to
-validate user_data : caller-supplied data passed to func
+
 
 
 
 
 
 
-nm_connection_duplicate ()
-NMConnection *      nm_connection_duplicate             (NMConnection *connection);
+nm_connection_compare ()
+gboolean            nm_connection_compare               (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags);
 
-Duplicates a NMConnection.
+Compares two NMConnection objects for similarity, with comparison behavior
+modified by a set of flags.  See nm_setting_compare() for a description of
+each flag's behavior.
 
 
-
-
+
+
-
-
+
+
+
+
+
+
+
+
+
 
 
 connection : the NMConnection to duplicate a : a NMConnection
+
 
 Returns : a new NMConnection containing the same settings and properties
-as the source NMConnection. [transfer full]
+ b : a second NMConnection to compare with the first
flags : compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
 
 
Returns : 
+TRUE if the comparison succeeds, FALSE if it does not
 
 
 
@@ -389,80 +380,88 @@ Create a new 
 
 
-nm_connection_add_setting ()
-void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);
+nm_connection_diff ()
+gboolean            nm_connection_diff                  (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags,
+                                                         GHashTable **out_settings);
 
-Adds a NMSetting to the connection, replacing any previous NMSetting of the
-same name which has previously been added to the NMConnection.  The
-connection takes ownership of the NMSetting object and does not increase
-the setting object's reference count.
+Compares two NMConnection objects for similarity, with comparison behavior
+modified by a set of flags.  See nm_setting_compare() for a description of
+each flag's behavior.  If the connections differ, settings and keys within
+each setting that differ are added to the returned out_settings hash table.
+No values are returned, only key names.
 
 
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 connection : a :
 a NMConnection
 
 
 setting : the NMSetting to add to the connection object. [transfer full]
+ b : a second NMConnection to compare with the first
flags : compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
+
out_settings : if the
+connections differ, on return a hash table mapping setting names to
+second-level GHashTable (utf8 to guint32), which contains the key names that
+differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable]
 
 
Returns : 
+TRUE if the connections contain the same values, FALSE if they do
+not
 
 
 
 
 
-nm_connection_remove_setting ()
-void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
+nm_connection_dump ()
+void                nm_connection_dump                  (NMConnection *connection);
 
-Removes the NMSetting with the given GType from the NMConnection.  This
-operation dereferences the NMSetting object.
+Print the connection to stdout.  For debugging purposes ONLY, should NOT
+be used for serialization of the connection or machine-parsed in any way. The
+output format is not guaranteed to be stable and may change at any time.
 
 -
-
+
-
-
-
-
-
-
-
+
 

 connection : a NMConnection
+ the NMConnection
 
setting_type : the GType of the setting object to remove
 
 
 
 
-nm_connection_get_setting ()
-NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
+nm_connection_duplicate ()
+NMConnection *      nm_connection_duplicate             (NMConnection *connection);
 
-Gets the NMSetting with the given GType, if one has been previously added
-to the NMConnection.
+Duplicates a NMConnection.
 
 
-
-
-
-
-
+
-
@@ -470,198 +469,131 @@ added to the 
 
 
-nm_connection_get_setting_by_name ()
-NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
+nm_connection_error_quark ()
+GQuark              nm_connection_error_quark           (void);
 
-Gets the NMSetting with the given name, if one has been previously added
-the the NMConnection.
+Registers an error quark for NMConnection if necessary.
 
 

 
 
 
 connection : a NMConnection
-
setting_type : the GType of the setting object to return the NMConnection to duplicate
 
 
 Returns : the NMSetting, or NULL if no setting of that type was previously
-added to the NMConnection. [transfer none]
+ a new NMConnection containing the same settings and properties
+as the source NMConnection. [transfer full]
 
 
 -
-
-
-
-
-
-
-
-
-
+
-
-
-
+
+
 
connection : a NMConnection
-
name : a setting name

 Returns : the NMSetting, or NULL if no setting with that name was previously
-added to the NMConnection. [transfer none]
-
the error quark used for NMConnection errors.
 
 
 
 
-nm_connection_replace_settings ()
-gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GHashTable *new_settings,
-                                                         GError **error);
+nm_connection_for_each_setting_value ()
+void                nm_connection_for_each_setting_value
+                                                        (NMConnection *connection,
+                                                         NMSettingValueIterFn func,
+                                                         gpointer user_data);
+
+Iterates over the properties of each NMSetting object in the NMConnection,
+calling the supplied user function for each property.
+
 
-
-
-
-
-
-
-
+
-
-
+
+
 
 
 
 connection : a NMConnection
-
new_settings : a GHashTable of settings. [element-type utf8 GLib.HashTable]
+ the NMConnection
 
 
 error : location to store error, or NULL
+ func : user-supplied function called for each setting's property. [scope call]
 
 
 Returns : 
-TRUE if the settings were valid and added to the connection, FALSE
-if they were not user_data : user data passed to func at each invocation
 
 
 
 
 
 
-nm_connection_compare ()
-gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);
+nm_connection_get_id ()
+const char *        nm_connection_get_id                (NMConnection *connection);
 
-Compares two NMConnection objects for similarity, with comparison behavior
-modified by a set of flags.  See nm_setting_compare() for a description of
-each flag's behavior.
+A shortcut to return the ID from the connection's NMSettingConnection.
 
 
-
-
-
-
-
-
-
-
-
-
+
-
+
 
 
 a : a NMConnection
-
b : a second NMConnection to compare with the first
flags : compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
+ connection : the NMConnection
 
 
 
 Returns : 
-TRUE if the comparison succeeds, FALSE if it does not the ID from the connection's 'connection' setting
 
 
 
 
 
 
-nm_connection_diff ()
-gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);
+nm_connection_get_path ()
+const char *        nm_connection_get_path              (NMConnection *connection);
 
-Compares two NMConnection objects for similarity, with comparison behavior
-modified by a set of flags.  See nm_setting_compare() for a description of
-each flag's behavior.  If the connections differ, settings and keys within
-each setting that differ are added to the returned out_settings hash table.
-No values are returned, only key names.
+Returns the connection's D-Bus path.
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
 
 
 a : a NMConnection
-
b : a second NMConnection to compare with the first
flags : compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
-
out_settings : if the
-connections differ, on return a hash table mapping setting names to
-second-level GHashTable (utf8 to guint32), which contains the key names that
-differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable]
+ connection : the NMConnection
 
 
 
 Returns : 
-TRUE if the connections contain the same values, FALSE if they do
-not the D-Bus path of the connection, previously set by a call to
+nm_connection_set_path().
 
 
 
 
 
 
-nm_connection_verify ()
-gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
+nm_connection_get_setting ()
+NMSetting *         nm_connection_get_setting           (NMConnection *connection,
+                                                         GType setting_type);
 
-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 WiFi 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 
-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
-setting and which property failed validation, and how it failed validation.
+Gets the NMSetting with the given GType, if one has been previously added
+to the NMConnection.
 
 
-
+
-
-
+
+
-
+
 
 
 
 connection : the NMConnection to verify a NMConnection
+
 
 error : location to store error, or NULL
- setting_type : the GType of the setting object to return
 
 
 Returns : 
-TRUE if the connection is valid, FALSE if it is not the NMSetting, or NULL if no setting of that type was previously
+added to the NMConnection. [transfer none]
+
 
 
 
 
 
 
-nm_connection_need_secrets ()
-const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
+nm_connection_get_setting_802_1x ()
+NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
 
-Returns the name of the first setting object in the connection which would
-need secrets 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.
+A shortcut to return any NMSetting8021x the connection might contain.
 
 @@ -672,66 +604,62 @@ secrets are needed.
 
-
-
-
-
-
+
 

 
 hints : the address of a pointer to a GPtrArray, initialized to NULL, which on
-return points to an allocated 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(). [out callee-allocates][element-type utf8][allow-none][transfer full]
-

 Returns : the setting name of the NMSetting object which has invalid or
-missing secrets an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
 
 
-nm_connection_clear_secrets ()
-void                nm_connection_clear_secrets         (NMConnection *connection);
+nm_connection_get_setting_bluetooth ()
+NMSettingBluetooth * nm_connection_get_setting_bluetooth
+                                                        (NMConnection *connection);
 
-Clears and frees any secrets that may be stored in the connection, to avoid
-keeping secret data in memory when not needed.
+A shortcut to return any NMSettingBluetooth the connection might contain.
 
 -
+
+
-
+
+
+
+
+
+
 

 connection :
 the NMConnection
 
Returns : an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
-nm_connection_clear_secrets_with_flags ()
-void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
+nm_connection_get_setting_by_name ()
+NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
+                                                         const char *name);
 
-Clears and frees secrets determined by func.
+Gets the NMSetting with the given name, if one has been previously added
+the the NMConnection.
 
 
-
-
-
+
+
-
-
+
@@ -739,18 +667,10 @@ specific secret should be cleared or not. [
 
 
-nm_connection_update_secrets ()
-gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
+nm_connection_get_setting_cdma ()
+NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
 
-Update the specified setting's secrets, given a hash table of secrets
-intended for that setting (deserialized from D-Bus for example).  Will also
-extract the given setting's secrets hash if given a hash of hashes, as would
-be returned from nm_connection_to_hash().  If setting_name is NULL, expects
-a fully serialized NMConnection as returned by nm_connection_to_hash() and
-will update all secrets from all settings contained in secrets.
+A shortcut to return any NMSettingCdma the connection might contain.
 
 
 
 
 
 connection : the NMConnection
+ a NMConnection
 
 
 func : function to be called to determine whether a
-specific secret should be cleared or not. [scope call]
- name : a setting name
 
 user_data : caller-supplied data passed to func
+ Returns : the NMSetting, or NULL if no setting with that name was previously
+added to the NMConnection. [transfer none]
 
 
 
@@ -761,38 +681,20 @@ will update all secrets from all settings contained in 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
+
 
setting_name : the setting object name to which the secrets apply
secrets : a GHashTable mapping
-string:GValue of setting property names and secrets of the given setting_name. [element-type utf8 GObject.Value]
-
error : location to store error, or NULL
-

 Returns : 
-TRUE if the secrets were successfully updated, FALSE if the update
-failed (tried to update secrets for a setting that doesn't exist, etc) an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 

 

 
 
-nm_connection_set_path ()
-void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
+nm_connection_get_setting_connection ()
+NMSettingConnection * nm_connection_get_setting_connection
+                                                        (NMConnection *connection);
 
-Sets the D-Bus path of the connection.  This property is not serialized, and
-is only for the reference of the caller.  Sets the "path"
-property.
+A shortcut to return any NMSettingConnection the connection might contain.
 
 @@ -803,19 +705,19 @@ property.
 
-
-
+
+
 

 
 path : the D-Bus path of the connection as given by the settings service
-which provides the connection Returns : an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
 
 
-nm_connection_get_path ()
-const char *        nm_connection_get_path              (NMConnection *connection);
+nm_connection_get_setting_gsm ()
+NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
 
-Returns the connection's D-Bus path.
+A shortcut to return any NMSettingGsm the connection might contain.
 
 @@ -827,21 +729,19 @@ Returns the connection's D-Bus path.
 
-
+
 

 
 Returns : the D-Bus path of the connection, previously set by a call to
-nm_connection_set_path(). an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
 
 
-nm_connection_is_type ()
-gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
+nm_connection_get_setting_ip4_config ()
+NMSettingIP4Config * nm_connection_get_setting_ip4_config
+                                                        (NMConnection *connection);
 
-A convenience function to check if the given connection is a particular
-type (ie wired, wifi, ppp, etc). Checks the "type"
-property of the connection and matches that against type.
+A shortcut to return any NMSettingIP4Config the connection might contain.
 
 @@ -852,28 +752,20 @@ property of the connection and matches that against 
 
 
 
-
-
-
-
-
+
 
type : a setting name to check the connection's type against (like
-NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

 Returns : 
-TRUE if the connection is of the given type, FALSE if not an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 

 

 
 
-nm_connection_for_each_setting_value ()
-void                nm_connection_for_each_setting_value
-                                                        (NMConnection *connection,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
+nm_connection_get_setting_ip6_config ()
+NMSettingIP6Config * nm_connection_get_setting_ip6_config
+                                                        (NMConnection *connection);
 
-Iterates over the properties of each NMSetting object in the NMConnection,
-calling the supplied user function for each property.
+A shortcut to return any NMSettingIP6Config the connection might contain.
 
 @@ -884,29 +776,19 @@ calling the supplied user function for each property.
 
-
-
+
-
-
-
-
 

 
 func : user-supplied function called for each setting's property. [scope call]
+ Returns : an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none]
 
 
user_data : user data passed to func at each invocation
 
 
 
 
 
-nm_connection_to_hash ()
-GHashTable *        nm_connection_to_hash               (NMConnection *connection,
-                                                         NMSettingHashFlags flags);
+nm_connection_get_setting_olpc_mesh ()
+NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
 
-Converts the NMConnection into a GHashTable describing the connection,
-suitable for marshalling over D-Bus or serializing.  The hash table mapping
-is string:GHashTable with each element in the returned hash representing
-a NMSetting object.  The keys are setting object names, and the values
-are GHashTables mapping string:GValue, each of which represents the
-properties of the NMSetting object.
+A shortcut to return any NMSettingOlpcMesh the connection might contain.
 
 @@ -917,16 +799,8 @@ properties of the 
 
 
-
-
-
-
-
@@ -934,72 +808,79 @@ with 
-nm_connection_dump ()
-void                nm_connection_dump                  (NMConnection *connection);
+nm_connection_get_setting_ppp ()
+NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);

-Print the connection to stdout.  For debugging purposes ONLY, should NOT
-be used for serialization of the connection or machine-parsed in any way. The
-output format is not guaranteed to be stable and may change at any time.
+A shortcut to return any NMSettingPPP the connection might contain.
 

 
flags : hash flags, e.g. NM_SETTING_HASH_FLAG_ALL
-

 Returns : a new
-GHashTable describing the connection, its settings, and each setting's
-properties.  The caller owns the hash table and must unref the hash table
-with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable]
+ an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none]
 
 
 
 
 -
+
+
-
+
+
+
+
+
+
 

 connection :
 the NMConnection
 
Returns : an NMSettingPPP if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
-nm_connection_lookup_setting_type ()
-GType               nm_connection_lookup_setting_type   (const char *name);
+nm_connection_get_setting_pppoe ()
+NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);
 
-Returns the GType of the setting's class for a given setting name.
+A shortcut to return any NMSettingPPOE the connection might contain.
 
 
-
-
+
+
-
+
 
 
 name : a setting name connection : the NMConnection
+
 
 
 Returns : the GType of the setting's class an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
 
 
-nm_connection_lookup_setting_type_by_quark ()
-GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);
+nm_connection_get_setting_vpn ()
+NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);
 
-Returns the GType of the setting's class for a given setting error quark.
-Useful for figuring out which setting a returned error is for.
+A shortcut to return any NMSettingVPN the connection might contain.
 
 
-
-
+
+
-
+
 
 
 error_quark : a setting error quark connection : the NMConnection
+
 
 
 Returns : the GType of the setting's class an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 
 
 
 
-nm_connection_get_uuid ()
-const char *        nm_connection_get_uuid              (NMConnection *connection);
+nm_connection_get_setting_wimax ()
+NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
 
-A shortcut to return the UUID from the connection's NMSettingConnection.
+A shortcut to return any NMSettingWimax the connection might contain.
 
 @@ -1011,17 +892,18 @@ A shortcut to return the UUID from the connection's Returns :
-
+
 
the UUID from the connection's 'connection' setting an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 

 

 
 
-nm_connection_get_id ()
-const char *        nm_connection_get_id                (NMConnection *connection);
+nm_connection_get_setting_wired ()
+NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
 
-A shortcut to return the ID from the connection's NMSettingConnection.
+A shortcut to return any NMSettingWired the connection might contain.
 
 @@ -1033,18 +915,18 @@ A shortcut to return the ID from the connection's Returns :
-
+
 
the ID from the connection's 'connection' setting an NMSettingWired if the connection contains one, otherwise NULL. [transfer none]
+
 
 
 

 

 
 
-nm_connection_get_setting_802_1x ()
-NMSetting8021x *            nm_connection_get_setting_802_1x
-                                                        (NMConnection *connection);
+nm_connection_get_setting_wireless ()
+NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
 
-A shortcut to return any NMSetting8021x the connection might contain.
+A shortcut to return any NMSettingWireless the connection might contain.
 
 @@ -1056,7 +938,7 @@ A shortcut to return any Returns :
-
@@ -1064,11 +946,11 @@ A shortcut to return any 
-nm_connection_get_setting_bluetooth ()
-NMSettingBluetooth *        nm_connection_get_setting_bluetooth
+nm_connection_get_setting_wireless_security ()
+NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
                                                         (NMConnection *connection);
 
-A shortcut to return any NMSettingBluetooth the connection might contain.
+A shortcut to return any NMSettingWirelessSecurity the connection might contain.
 
 

 
an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none]
+ an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none]
 
 
 
@@ -1080,7 +962,7 @@ A shortcut to return any Returns :
-
@@ -1088,11 +970,10 @@ A shortcut to return any 
-nm_connection_get_setting_cdma ()
-NMSettingCdma *             nm_connection_get_setting_cdma
-                                                        (NMConnection *connection);
+nm_connection_get_uuid ()
+const char *        nm_connection_get_uuid              (NMConnection *connection);

-A shortcut to return any NMSettingCdma the connection might contain.
+A shortcut to return the UUID from the connection's NMSettingConnection.
 

 
an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none]
+ an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none]
 
 
 
 
 
@@ -1104,19 +985,20 @@ A shortcut to return any Returns :
-
+
 
an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none]
- the UUID from the connection's 'connection' setting
 
 
 

 

 
 
-nm_connection_get_setting_connection ()
-NMSettingConnection *       nm_connection_get_setting_connection
-                                                        (NMConnection *connection);
+nm_connection_is_type ()
+gboolean            nm_connection_is_type               (NMConnection *connection,
+                                                         const char *type);
 
-A shortcut to return any NMSettingConnection the connection might contain.
+A convenience function to check if the given connection is a particular
+type (ie wired, wifi, ppp, etc). Checks the "type"
+property of the connection and matches that against type.
 
 @@ -1127,68 +1009,73 @@ A shortcut to return any type :
+
+
+
-
+
 
a setting name to check the connection's type against (like
+NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

 Returns : an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none]
- 
+TRUE if the connection is of the given type, FALSE if not
 
 
 

 

 
 
-nm_connection_get_setting_gsm ()
-NMSettingGsm *              nm_connection_get_setting_gsm
-                                                        (NMConnection *connection);
+nm_connection_lookup_setting_type ()
+GType               nm_connection_lookup_setting_type   (const char *name);
 
-A shortcut to return any NMSettingGsm the connection might contain.
+Returns the GType of the setting's class for a given setting name.
 
 
-
-
+
+
-
+
 
 
 connection : the NMConnection
- name : a setting name
 
 
 Returns : an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none]
- the GType of the setting's class
 
 
 
 
 
 
-nm_connection_get_setting_ip4_config ()
-NMSettingIP4Config *        nm_connection_get_setting_ip4_config
-                                                        (NMConnection *connection);
+nm_connection_lookup_setting_type_by_quark ()
+GType               nm_connection_lookup_setting_type_by_quark
+                                                        (GQuark error_quark);
 
-A shortcut to return any NMSettingIP4Config the connection might contain.
+Returns the GType of the setting's class for a given setting error quark.
+Useful for figuring out which setting a returned error is for.
 
 
-
-
+
+
-
+
 
 
 connection : the NMConnection
- error_quark : a setting error quark
 
 
 Returns : an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none]
- the GType of the setting's class
 
 
 
 
 
 
-nm_connection_get_setting_ip6_config ()
-NMSettingIP6Config *        nm_connection_get_setting_ip6_config
-                                                        (NMConnection *connection);
+nm_connection_need_secrets ()
+const char *        nm_connection_need_secrets          (NMConnection *connection,
+                                                         GPtrArray **hints);
 
-A shortcut to return any NMSettingIP6Config the connection might contain.
+Returns the name of the first setting object in the connection which would
+need secrets 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.
 
 @@ -1199,116 +1086,134 @@ A shortcut to return any Returns :
-
+
+
+
+
+
 
an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none]
+ hints : the address of a pointer to a GPtrArray, initialized to NULL, which on
+return points to an allocated 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(). [out callee-allocates][element-type utf8][allow-none][transfer full]
 
 
Returns : the setting name of the NMSetting object which has invalid or
+missing secrets
 
 

 

 
 
-nm_connection_get_setting_olpc_mesh ()
-NMSettingOlpcMesh *         nm_connection_get_setting_olpc_mesh
-                                                        (NMConnection *connection);
+nm_connection_new ()
+NMConnection *      nm_connection_new                   (void);
 
-A shortcut to return any NMSettingOlpcMesh the connection might contain.
+Creates a new NMConnection object with no NMSetting objects.
 
 -
-
-
-
-
-
+
-
-
-
+
+
 
connection : the NMConnection
-

 Returns : an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none]
-
the new empty NMConnection object
 
 
 
 
-nm_connection_get_setting_ppp ()
-NMSettingPPP *              nm_connection_get_setting_ppp
-                                                        (NMConnection *connection);
+nm_connection_new_from_hash ()
+NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
+                                                         GError **error);
 
-A shortcut to return any NMSettingPPP the connection might contain.
+Creates a new NMConnection from a hash table describing the connection.  See
+nm_connection_to_hash() for a description of the expected hash table.
 
 
-
-
+
+
+
+
+
-
+
 
 
 connection : the NMConnection
+ hash : the GHashTable describing
+the connection. [element-type utf8 GLib.HashTable]
 
 
 error : on unsuccessful return, an error

 Returns : an NMSettingPPP if the connection contains one, otherwise NULL. [transfer none]
- the new NMConnection object, populated with settings created
+from the values in the hash table, or NULL if the connection failed to
+validate
 
 
 
 
 
 
-nm_connection_get_setting_pppoe ()
-NMSettingPPPOE *            nm_connection_get_setting_pppoe
-                                                        (NMConnection *connection);
+nm_connection_remove_setting ()
+void                nm_connection_remove_setting        (NMConnection *connection,
+                                                         GType setting_type);
 
-A shortcut to return any NMSettingPPOE the connection might contain.
+Removes the NMSetting with the given GType from the NMConnection.  This
+operation dereferences the NMSetting object.
 
 
-
-
-
+
+
 
 
 
 connection : the NMConnection
+ a NMConnection
 
 
 Returns : an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none]
- setting_type : the GType of the setting object to remove
 
 
 
 
 
 
-nm_connection_get_setting_vpn ()
-NMSettingVPN *              nm_connection_get_setting_vpn
-                                                        (NMConnection *connection);
-
-A shortcut to return any NMSettingVPN the connection might contain.
-
+nm_connection_replace_settings ()
+gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GHashTable *new_settings,
+                                                         GError **error);
 
-
-
-
+
+
+
+
+
+
+
+
+
 
 
 
 connection : the NMConnection
+ a NMConnection
 
 
 Returns : an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none]
+ new_settings : a GHashTable of settings. [element-type utf8 GLib.HashTable]
+
error : location to store error, or NULL
 
 
Returns : 
+TRUE if the settings were valid and added to the connection, FALSE
+if they were not
 
 
 
 
 
-nm_connection_get_setting_wimax ()
-NMSettingWimax *            nm_connection_get_setting_wimax
-                                                        (NMConnection *connection);
+nm_connection_set_path ()
+void                nm_connection_set_path              (NMConnection *connection,
+                                                         const char *path);
 
-A shortcut to return any NMSettingWimax the connection might contain.
+Sets the D-Bus path of the connection.  This property is not serialized, and
+is only for the reference of the caller.  Sets the "path"
+property.
 
 @@ -1319,20 +1224,25 @@ A shortcut to return any Returns :
-
+
+
 
an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none]
- path : the D-Bus path of the connection as given by the settings service
+which provides the connection
 
 
 

 

 
 
-nm_connection_get_setting_wired ()
-NMSettingWired *            nm_connection_get_setting_wired
-                                                        (NMConnection *connection);
+nm_connection_to_hash ()
+GHashTable *        nm_connection_to_hash               (NMConnection *connection,
+                                                         NMSettingHashFlags flags);
 
-A shortcut to return any NMSettingWired the connection might contain.
+Converts the NMConnection into a GHashTable describing the connection,
+suitable for marshalling over D-Bus or serializing.  The hash table mapping
+is string:GHashTable with each element in the returned hash representing
+a NMSetting object.  The keys are setting object names, and the values
+are GHashTables mapping string:GValue, each of which represents the
+properties of the NMSetting object.
 
 @@ -1343,8 +1253,16 @@ A shortcut to return any flags :
+
+
+
-
@@ -1352,11 +1270,18 @@ A shortcut to return any 
-nm_connection_get_setting_wireless ()
-NMSettingWireless *         nm_connection_get_setting_wireless
-                                                        (NMConnection *connection);
+nm_connection_update_secrets ()
+gboolean            nm_connection_update_secrets        (NMConnection *connection,
+                                                         const char *setting_name,
+                                                         GHashTable *secrets,
+                                                         GError **error);

-A shortcut to return any NMSettingWireless the connection might contain.
+Update the specified setting's secrets, given a hash table of secrets
+intended for that setting (deserialized from D-Bus for example).  Will also
+extract the given setting's secrets hash if given a hash of hashes, as would
+be returned from nm_connection_to_hash().  If setting_name is NULL, expects
+a fully serialized NMConnection as returned by nm_connection_to_hash() and
+will update all secrets from all settings contained in secrets.
 

 
hash flags, e.g. NM_SETTING_HASH_FLAG_ALL
+

 Returns : an NMSettingWired if the connection contains one, otherwise NULL. [transfer none]
+ a new
+GHashTable describing the connection, its settings, and each setting's
+properties.  The caller owns the hash table and must unref the hash table
+with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable]
 
 
 
 
 
@@ -1367,33 +1292,61 @@ A shortcut to return any Returns :
-
+
+
+
+
+
+
+
+
+
+
+
+
+
 
an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none]
+ setting_name : the setting object name to which the secrets apply
secrets : a GHashTable mapping
+string:GValue of setting property names and secrets of the given setting_name. [element-type utf8 GObject.Value]
+
error : location to store error, or NULL
 
 
Returns : 
+TRUE if the secrets were successfully updated, FALSE if the update
+failed (tried to update secrets for a setting that doesn't exist, etc)
 
 

 

 
 
-nm_connection_get_setting_wireless_security ()
-NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
-                                                        (NMConnection *connection);
+nm_connection_verify ()
+gboolean            nm_connection_verify                (NMConnection *connection,
+                                                         GError **error);
 
-A shortcut to return any NMSettingWirelessSecurity the connection might contain.
+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 WiFi 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 
+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
+setting and which property failed validation, and how it failed validation.
 
 
-
+
+
+
+
-
+
 
 
 
 connection : the NMConnection
+ the NMConnection to verify
error : location to store error, or NULL
 
 
 
 Returns : an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none]
- 
+TRUE if the connection is valid, FALSE if it is not
 
 
 
@@ -1468,6 +1421,6 @@ updated
 
 
 
-          Generated by GTK-Doc V1.17
+          Generated by GTK-Doc V1.18

\ No newline at end of file -- cgit 1.3.0-6-gf8a5

`hash` :	the GHashTable describing -the connection. [element-type utf8 GLib.HashTable] +	`connection` :	the NMConnection
`error` :	on unsuccessful return, an error	`func` :	function to be called to determine whether a +specific secret should be cleared or not. [scope call] +
Returns :	the new NMConnection object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validate	`user_data` :	caller-supplied data passed to `func` +

`connection` :	the NMConnection to duplicate	`a` :	a NMConnection +
Returns :	a new NMConnection containing the same settings and properties -as the source NMConnection. [transfer full] +	`b` :	a second NMConnection to compare with the first
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT`
Returns :	+`TRUE` if the comparison succeeds, `FALSE` if it does not

`connection` :	`a` :	a NMConnection
`setting` :	the NMSetting to add to the connection object. [transfer full] +	`b` :	a second NMConnection to compare with the first
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT` +
`out_settings` :	if the +connections differ, on return a hash table mapping setting names to +second-level GHashTable (utf8 to guint32), which contains the key names that +differ mapped to one or more of `NMSettingDiffResult` as a bitfield. [element-type utf8 GLib.HashTable]
Returns :	+`TRUE` if the connections contain the same values, `FALSE` if they do +not

`connection` :	a NMConnection -
`new_settings` :	a GHashTable of settings. [element-type utf8 GLib.HashTable] +	the NMConnection
`error` :	location to store error, or `NULL` +	`func` :	user-supplied function called for each setting's property. [scope call]
Returns :	-`TRUE` if the settings were valid and added to the connection, `FALSE` -if they were not	`user_data` :	user data passed to `func` at each invocation

`a` :	a NMConnection -
`b` :	a second NMConnection to compare with the first
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT` +	`connection` :	the NMConnection
Returns :	-`TRUE` if the comparison succeeds, `FALSE` if it does not	the ID from the connection's 'connection' setting

Returns :	the error quark used for NMConnection errors.
`connection` :	a NMConnection +
`setting` :	the NMSetting to add to the connection object. [transfer full] +

`connection` :	a NMConnection -
`setting_type` :	the GType of the setting object to return	the NMConnection to duplicate
Returns :	the NMSetting, or NULL if no setting of that type was previously -added to the NMConnection. [transfer none] +	a new NMConnection containing the same settings and properties +as the source NMConnection. [transfer full]

`connection` :	a NMConnection -
`name` :	a setting name
Returns :	the NMSetting, or NULL if no setting with that name was previously -added to the NMConnection. [transfer none] -
the error quark used for NMConnection errors.

`connection` :	the NMConnection to verify	a NMConnection +
`error` :	location to store error, or `NULL` -	`setting_type` :	the GType of the setting object to return
Returns :	-`TRUE` if the connection is valid, `FALSE` if it is not	the NMSetting, or NULL if no setting of that type was previously +added to the NMConnection. [transfer none] +

`hints` :	the address of a pointer to a GPtrArray, initialized to NULL, which on -return points to an allocated 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()`. [out callee-allocates][element-type utf8][allow-none][transfer full] -
Returns :	the setting name of the NMSetting object which has invalid or -missing secrets	an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none] +

`connection` :	the NMConnection +	a NMConnection
`func` :	function to be called to determine whether a -specific secret should be cleared or not. [scope call] -	`name` :	a setting name
`user_data` :	caller-supplied data passed to `func` +	Returns :	the NMSetting, or NULL if no setting with that name was previously +added to the NMConnection. [transfer none]

`setting_name` :	the setting object name to which the secrets apply
`secrets` :	a GHashTable mapping -string:GValue of setting property names and secrets of the given `setting_name`. [element-type utf8 GObject.Value] -
`error` :	location to store error, or `NULL` -
Returns :	-`TRUE` if the secrets were successfully updated, `FALSE` if the update -failed (tried to update secrets for a setting that doesn't exist, etc)	an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none] +

`type` :	a setting name to check the connection's type against (like -`NM_SETTING_WIRELESS_SETTING_NAME` or `NM_SETTING_WIRED_SETTING_NAME`)
Returns :	-`TRUE` if the connection is of the given `type`, `FALSE` if not	an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none] +

`flags` :	hash flags, e.g. `NM_SETTING_HASH_FLAG_ALL` -
Returns :	a new -GHashTable describing the connection, its settings, and each setting's -properties. The caller owns the hash table and must unref the hash table -with `g_hash_table_unref()` when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable] +	an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none]

`error_quark` :	a setting error quark	`connection` :	the NMConnection +
Returns :	the GType of the setting's class	an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] +

a setting name to check the connection's type against (like +`NM_SETTING_WIRELESS_SETTING_NAME` or `NM_SETTING_WIRED_SETTING_NAME`)
Returns :	an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none] -	+`TRUE` if the connection is of the given `type`, `FALSE` if not

`connection` :	the NMConnection -	`name` :	a setting name
Returns :	an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none] -	the GType of the setting's class

an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none] +	`hints` :	the address of a pointer to a GPtrArray, initialized to NULL, which on +return points to an allocated 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()`. [out callee-allocates][element-type utf8][allow-none][transfer full]
Returns :	the setting name of the NMSetting object which has invalid or +missing secrets

hash flags, e.g. `NM_SETTING_HASH_FLAG_ALL` +
Returns :	an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +	a new +GHashTable describing the connection, its settings, and each setting's +properties. The caller owns the hash table and must unref the hash table +with `g_hash_table_unref()` when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable]

an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] +	`setting_name` :	the setting object name to which the secrets apply
`secrets` :	a GHashTable mapping +string:GValue of setting property names and secrets of the given `setting_name`. [element-type utf8 GObject.Value] +
`error` :	location to store error, or `NULL`
Returns :	+`TRUE` if the secrets were successfully updated, `FALSE` if the update +failed (tried to update secrets for a setting that doesn't exist, etc)

Object Hierarchy

Properties

Details

enum NMConnectionError

NMConnection

NMConnectionClass

enum NMConnectionError

NM_TYPE_CONNECTION_ERROR

NM_CONNECTION_ERROR

NM_CONNECTION_PATH

nm_connection_error_quark ()

nm_connection_add_setting ()

NM_CONNECTION_PATH

NMConnection

NMConnectionClass

nm_connection_get_type ()

nm_connection_new ()

nm_connection_clear_secrets ()

nm_connection_new_from_hash ()

nm_connection_clear_secrets_with_flags ()

nm_connection_duplicate ()

nm_connection_compare ()

nm_connection_add_setting ()

nm_connection_diff ()

nm_connection_remove_setting ()

nm_connection_dump ()

nm_connection_get_setting ()

nm_connection_duplicate ()

nm_connection_get_setting_by_name ()

nm_connection_error_quark ()

nm_connection_replace_settings ()

nm_connection_for_each_setting_value ()

nm_connection_compare ()

nm_connection_get_id ()

nm_connection_diff ()

nm_connection_get_path ()

nm_connection_verify ()

nm_connection_get_setting ()

nm_connection_need_secrets ()

nm_connection_get_setting_802_1x ()

nm_connection_clear_secrets ()

nm_connection_get_setting_bluetooth ()

nm_connection_clear_secrets_with_flags ()

nm_connection_get_setting_by_name ()

nm_connection_update_secrets ()

nm_connection_get_setting_cdma ()

nm_connection_set_path ()

nm_connection_get_setting_connection ()

nm_connection_get_path ()

nm_connection_get_setting_gsm ()

nm_connection_is_type ()

nm_connection_get_setting_ip4_config ()

nm_connection_for_each_setting_value ()

nm_connection_get_setting_ip6_config ()

nm_connection_to_hash ()

nm_connection_get_setting_olpc_mesh ()

nm_connection_dump ()

nm_connection_get_setting_ppp ()

nm_connection_lookup_setting_type ()

nm_connection_get_setting_pppoe ()

nm_connection_lookup_setting_type_by_quark ()

nm_connection_get_setting_vpn ()

nm_connection_get_uuid ()

nm_connection_get_setting_wimax ()

nm_connection_get_id ()

nm_connection_get_setting_wired ()

nm_connection_get_setting_802_1x ()

nm_connection_get_setting_wireless ()

nm_connection_get_setting_bluetooth ()

nm_connection_get_setting_wireless_security ()

nm_connection_get_setting_cdma ()

nm_connection_get_uuid ()

nm_connection_get_setting_connection ()

nm_connection_is_type ()

nm_connection_get_setting_gsm ()

nm_connection_lookup_setting_type ()

nm_connection_get_setting_ip4_config ()

nm_connection_lookup_setting_type_by_quark ()

nm_connection_get_setting_ip6_config ()

nm_connection_need_secrets ()