NMConnection

Properties

@@ -183,28 +183,6 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters

Details

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,                  /*< nick=UnknownError >*/
@@ -216,8 +194,11 @@ It should only be accessed through the functions described below.
 
 Describes errors that may result from operations involving a NMConnection.
 
-
+

+++
@@ -258,6 +239,24 @@ Describes errors that may result from operations involving a 
 
 
+nm_connection_error_quark ()
+GQuark              nm_connection_error_quark           (void);
+
+Registers an error quark for NMConnection if necessary.
+
+

 


 
 
 NM_CONNECTION_ERROR_UNKNOWN
++++
+
+
+
+
+


Returns : the error quark used for NMConnection errors.
+

NM_CONNECTION_PATH

#define NM_CONNECTION_PATH "path"

@@ -266,112 +265,100 @@ Describes errors that may result from operations involving a

nm_connection_add_setting ()

void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);

NMConnection

typedef struct _NMConnection NMConnection;

-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. +The NMConnection struct contains only private data. +It should only be accessed through the functions described below.

-- - - - - - - - - - -

`connection` :	a NMConnection -
`setting` :	the NMSetting to add to the connection object. [transfer full] -

nm_connection_clear_secrets ()

void                nm_connection_clear_secrets         (NMConnection *connection);

NMConnectionClass

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

-Clears and frees any secrets that may be stored in the connection, to avoid -keeping secret data in memory when not needed.

+ +

nm_connection_new ()

NMConnection *      nm_connection_new                   (void);

+Creates a new NMConnection object with no NMSetting objects. +

+++ - - + +

connection :

the NMConnection -

Returns :

the new empty NMConnection object

nm_connection_clear_secrets_with_flags ()

void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);

nm_connection_new_from_hash ()

NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
+                                                         GError **error);

-Clears and frees secrets determined by func. +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]
`func` :	function to be called to determine whether a -specific secret should be cleared or not. [scope call] -	`error` :	on unsuccessful return, an error
`user_data` :	caller-supplied data passed to `func` -	Returns :	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_compare ()

gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);

nm_connection_duplicate ()

NMConnection *      nm_connection_duplicate             (NMConnection *connection);

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

`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 to duplicate
Returns :	-`TRUE` if the comparison succeeds, `FALSE` if it does not	a new NMConnection containing the same settings and properties +as the source NMConnection. [transfer full] +

@@ -383,8 +370,11 @@ each flag's behavior.

Create a new NMSetting object of the desired type, given a setting name.

+++ @@ -392,7 +382,7 @@ Create a new - @@ -400,88 +390,89 @@ Create a new

nm_connection_diff ()

gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);

nm_connection_add_setting ()

void                nm_connection_add_setting           (NMConnection *connection,
+                                                         NMSetting *setting);

-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. +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.

`name` :
Returns :	the new setting object, or NULL if the setting name was unknown. [transfer full] +	the new setting object, or `NULL` if the setting name was unknown. [transfer full]

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

`a` :	`connection` :	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] +	`setting` :	the NMSetting to add to the connection object. [transfer full]
Returns :	-`TRUE` if the connections contain the same values, `FALSE` if they do -not

nm_connection_dump ()

void                nm_connection_dump                  (NMConnection *connection);

nm_connection_remove_setting ()

void                nm_connection_remove_setting        (NMConnection *connection,
+                                                         GType setting_type);

-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. +Removes the NMSetting with the given GType from the NMConnection. This +operation dereferences the NMSetting object.

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

`connection` :	the NMConnection +	a NMConnection
`setting_type` :	the GType of the setting object to remove

nm_connection_duplicate ()

NMConnection *      nm_connection_duplicate             (NMConnection *connection);

nm_connection_get_setting ()

NMSetting *         nm_connection_get_setting           (NMConnection *connection,
+                                                         GType setting_type);

-Duplicates a NMConnection. +Gets the NMSetting with the given GType, if one has been previously added +to the NMConnection.

+++ - + + + + + - @@ -489,134 +480,219 @@ as the source

nm_connection_error_quark ()

GQuark              nm_connection_error_quark           (void);

nm_connection_get_setting_by_name ()

NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
+                                                         const char *name);

-Registers an error quark for NMConnection if necessary. +Gets the NMSetting with the given name, if one has been previously added +the the NMConnection.

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

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

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

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. -

nm_connection_replace_settings ()

gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GHashTable *new_settings,
+                                                         GError **error);

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

`connection` :	the NMConnection +	a NMConnection
`func` :	user-supplied function called for each setting's property. [scope call] +	`new_settings` :	a GHashTable of settings. [element-type utf8 GLib.HashTable]
`user_data` :	user data passed to `func` at each invocation	`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_id ()

const char *        nm_connection_get_id                (NMConnection *connection);

nm_connection_compare ()

gboolean            nm_connection_compare               (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags);

-A shortcut to return the ID from the connection's NMSettingConnection. +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 +	`a` :	a NMConnection +
`b` :	a second NMConnection to compare with the first
`flags` :	compare flags, e.g. `NM_SETTING_COMPARE_FLAG_EXACT`
Returns :	the ID from the connection's 'connection' setting	+`TRUE` if the comparison succeeds, `FALSE` if it does not

nm_connection_get_path ()

const char *        nm_connection_get_path              (NMConnection *connection);

nm_connection_diff ()

gboolean            nm_connection_diff                  (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags,
+                                                         GHashTable **out_settings);

-Returns the connection's D-Bus path. +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` :	the NMConnection +	`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]
Returns :	the D-Bus path of the connection, previously set by a call to -`nm_connection_set_path()`.	+`TRUE` if the connections contain the same values, `FALSE` if they do +not

nm_connection_get_setting ()

NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);

nm_connection_verify ()

gboolean            nm_connection_verify                (NMConnection *connection,
+                                                         GError **error);

-Gets the NMSetting with the given GType, if one has been previously added -to the NMConnection. +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` :	a NMConnection -	the NMConnection to verify
`setting_type` :	the GType of the setting object to return	`error` :	location to store error, or `NULL` +
Returns :	the NMSetting, or NULL if no setting of that type was previously -added to the NMConnection. [transfer none] -	+`TRUE` if the connection is valid, `FALSE` if it is not

nm_connection_get_setting_802_1x ()

NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);

nm_connection_need_secrets ()

const char *        nm_connection_need_secrets          (NMConnection *connection,
+                                                         GPtrArray **hints);

-A shortcut to return any NMSetting8021x 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.

+++ @@ -624,22 +700,57 @@ A shortcut to return any Returns :

- + + + + +

`connection` :	an NMSetting8021x 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 array itself with `g_ptr_array_free()`, but not free its +elements. [out][element-type utf8][allow-none][transfer container]
Returns :	the setting name of the NMSetting object which has invalid or +missing secrets

nm_connection_get_setting_adsl ()

NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);

nm_connection_clear_secrets ()

void                nm_connection_clear_secrets         (NMConnection *connection);

+Clears and frees any secrets that may be stored in the connection, to avoid +keeping secret data in memory when not needed. +

++++ + + + + +

connection :

the NMConnection +

nm_connection_clear_secrets_with_flags ()

void                nm_connection_clear_secrets_with_flags
+                                                        (NMConnection *connection,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);

-A shortcut to return any NMSettingAdsl the connection might contain. +Clears and frees secrets determined by func.

+++ @@ -647,8 +758,14 @@ A shortcut to return any Returns :

- + + + + + @@ -656,14 +773,24 @@ A shortcut to return any -

nm_connection_get_setting_bluetooth ()

NMSettingBluetooth * nm_connection_get_setting_bluetooth
-                                                        (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 NMSettingBluetooth 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.

`connection` :	an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] +	`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`

+++ @@ -671,22 +798,44 @@ A shortcut to return any Returns :

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

`connection` :	an NMSettingBluetooth 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_bond ()

NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);

nm_connection_set_path ()

void                nm_connection_set_path              (NMConnection *connection,
+                                                         const char *path);

-A shortcut to return any NMSettingBond 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.

+++ @@ -694,22 +843,25 @@ A shortcut to return any Returns :

- + +

connection :

an NMSettingBond 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_bridge ()

NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);

nm_connection_get_path ()

const char *        nm_connection_get_path              (NMConnection *connection);

-A shortcut to return any NMSettingBridge the connection might contain. +Returns the connection's D-Bus path.

+++ @@ -718,31 +870,37 @@ A shortcut to return any Returns :

- +

connection :

an NMSettingBridge if the connection contains one, otherwise NULL. [transfer none] -

the D-Bus path of the connection, previously set by a call to +nm_connection_set_path().

nm_connection_get_setting_bridge_port ()

NMSettingBridgePort * nm_connection_get_setting_bridge_port
+nm_connection_get_virtual_iface_name ()
+const char *        nm_connection_get_virtual_iface_name
                                                         (NMConnection *connection);
 
-A shortcut to return any NMSettingBridgePort the connection might contain.
+Returns the name of the virtual kernel interface which the connection
+needs to use if specified in the settings. This function abstracts all
+connection types which require this functionality. For all other
+connection types, this function will return NULL.
 
-
+

+++
-
-
@@ -750,43 +908,54 @@ A shortcut to return any 
-nm_connection_get_setting_by_name ()
-NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
+nm_connection_is_type ()
+gboolean            nm_connection_is_type               (NMConnection *connection,
+                                                         const char *type);

-Gets the NMSetting with the given name, if one has been previously added
-the the NMConnection.
+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.
 
-

 


 
 
 connection : the NMConnection
+ The NMConnection
 
 
 
 Returns : an NMSettingBridgePort if the connection contains one, otherwise NULL. [transfer none]
+ Name of the kernel interface or NULL
 
 
 
 
+

+++
-
-
-
+
+
-
+
 


 
 
 connection : a NMConnection
+ the NMConnection
 
 
 name : a setting name type : a setting name to check the connection's type against (like
+NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)
 
 
 Returns : the NMSetting, or NULL if no setting with that name was previously
-added to the NMConnection. [transfer none]
- 
+TRUE if the connection is of the given type, FALSE if not

nm_connection_get_setting_cdma ()

NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);

nm_connection_for_each_setting_value ()

void                nm_connection_for_each_setting_value
+                                                        (NMConnection *connection,
+                                                         NMSettingValueIterFn func,
+                                                         gpointer user_data);

-A shortcut to return any NMSettingCdma the connection might contain. +Iterates over the properties of each NMSetting object in the NMConnection, +calling the supplied user function for each property.

+++ @@ -794,23 +963,35 @@ A shortcut to return any Returns :

- + + + + +

`connection` :	an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none] +	`func` :	user-supplied function called for each setting's property. [scope call]
`user_data` :	user data passed to `func` at each invocation

nm_connection_get_setting_connection ()

NMSettingConnection * nm_connection_get_setting_connection
-                                                        (NMConnection *connection);

nm_connection_to_hash ()

GHashTable *        nm_connection_to_hash               (NMConnection *connection,
+                                                         NMSettingHashFlags flags);

-A shortcut to return any NMSettingConnection 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.

+++ @@ -818,8 +999,16 @@ A shortcut to return any flags :

+ + + - @@ -827,85 +1016,87 @@ A shortcut to return any -

nm_connection_get_setting_gsm ()

NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);

nm_connection_dump ()

void                nm_connection_dump                  (NMConnection *connection);

-A shortcut to return any NMSettingGsm the connection might contain. +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` :	hash flags, e.g. `NM_SETTING_HASH_FLAG_ALL` +
Returns :	an NMSettingConnection 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]

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

`connection` :	the NMConnection
Returns :	an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none] -

nm_connection_get_setting_infiniband ()

NMSettingInfiniband * nm_connection_get_setting_infiniband
-                                                        (NMConnection *connection);

nm_connection_lookup_setting_type ()

GType               nm_connection_lookup_setting_type   (const char *name);

-A shortcut to return any NMSettingInfiniband 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 NMSettingInfiniband 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_get_uuid ()

const char *        nm_connection_get_uuid              (NMConnection *connection);

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

+++ @@ -914,21 +1105,23 @@ A shortcut to return any Returns :

- +

connection :

an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none] -

the UUID from the connection's 'connection' setting

nm_connection_get_setting_olpc_mesh ()

NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);

nm_connection_get_id ()

const char *        nm_connection_get_id                (NMConnection *connection);

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

+++ @@ -937,21 +1130,23 @@ A shortcut to return any Returns :

- +

connection :

an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none] -

the ID from the connection's 'connection' setting

nm_connection_get_setting_ppp ()

NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);

nm_connection_get_setting_802_1x ()

NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);

-A shortcut to return any NMSettingPPP the connection might contain. +A shortcut to return any NMSetting8021x the connection might contain.

+++ @@ -960,7 +1155,7 @@ A shortcut to return any Returns :

- @@ -968,13 +1163,17 @@ A shortcut to return any -

nm_connection_get_setting_pppoe ()

NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);

nm_connection_get_setting_bluetooth ()

NMSettingBluetooth * nm_connection_get_setting_bluetooth
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingPPPOE the connection might contain. +A shortcut to return any NMSettingBluetooth the connection might contain.

connection :

an NMSettingPPP if the connection contains one, otherwise NULL. [transfer none] +

an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -983,7 +1182,7 @@ A shortcut to return any Returns :

- @@ -991,13 +1190,16 @@ A shortcut to return any -

nm_connection_get_setting_serial ()

NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);

nm_connection_get_setting_bond ()

NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);

-A shortcut to return any NMSettingSerial the connection might contain. +A shortcut to return any NMSettingBond the connection might contain.

connection :

an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1006,7 +1208,7 @@ A shortcut to return any Returns :

- @@ -1014,13 +1216,16 @@ A shortcut to return any -

nm_connection_get_setting_vlan ()

NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);

nm_connection_get_setting_bridge ()

NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);

-A shortcut to return any NMSettingVlan the connection might contain. +A shortcut to return any NMSettingBridge the connection might contain.

connection :

an NMSettingSerial if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingBond if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1029,7 +1234,7 @@ A shortcut to return any Returns :

- @@ -1037,13 +1242,17 @@ A shortcut to return any -

nm_connection_get_setting_vpn ()

NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);

nm_connection_get_setting_bridge_port ()

NMSettingBridgePort * nm_connection_get_setting_bridge_port
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingVPN the connection might contain. +A shortcut to return any NMSettingBridgePort the connection might contain.

connection :

an NMSettingVlan if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingBridge if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1052,7 +1261,7 @@ A shortcut to return any Returns :

- @@ -1060,13 +1269,16 @@ A shortcut to return any -

nm_connection_get_setting_wimax ()

NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);

nm_connection_get_setting_cdma ()

NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);

-A shortcut to return any NMSettingWimax the connection might contain. +A shortcut to return any NMSettingCdma the connection might contain.

connection :

an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingBridgePort if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1075,7 +1287,7 @@ A shortcut to return any Returns :

- @@ -1083,13 +1295,17 @@ A shortcut to return any -

nm_connection_get_setting_wired ()

NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);

nm_connection_get_setting_connection ()

NMSettingConnection * nm_connection_get_setting_connection
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingWired the connection might contain. +A shortcut to return any NMSettingConnection the connection might contain.

connection :

an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1098,7 +1314,7 @@ A shortcut to return any Returns :

- @@ -1106,13 +1322,16 @@ A shortcut to return any -

nm_connection_get_setting_wireless ()

NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);

nm_connection_get_setting_gsm ()

NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);

-A shortcut to return any NMSettingWireless the connection might contain. +A shortcut to return any NMSettingGsm the connection might contain.

connection :

an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1121,7 +1340,7 @@ A shortcut to return any Returns :

- @@ -1129,14 +1348,17 @@ A shortcut to return any -

nm_connection_get_setting_wireless_security ()

NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
+nm_connection_get_setting_infiniband ()
+NMSettingInfiniband * nm_connection_get_setting_infiniband
                                                         (NMConnection *connection);
 
-A shortcut to return any NMSettingWirelessSecurity the connection might contain.
+A shortcut to return any NMSettingInfiniband the connection might contain.
 
-

connection :

an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] +

an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none]

+++ @@ -1145,7 +1367,7 @@ A shortcut to return any - @@ -1153,13 +1375,17 @@ A shortcut to return any

nm_connection_get_uuid ()

const char *        nm_connection_get_uuid              (NMConnection *connection);

nm_connection_get_setting_ip4_config ()

NMSettingIP4Config * nm_connection_get_setting_ip4_config
+                                                        (NMConnection *connection);

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

`connection` :
Returns :	an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none] +	an NMSettingInfiniband if the connection contains one, otherwise `NULL`. [transfer none]

+++ @@ -1168,49 +1394,51 @@ A shortcut to return the UUID from the connection's Returns :

- +

connection :

the UUID from the connection's 'connection' setting

an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none] +

nm_connection_get_virtual_iface_name ()

const char *        nm_connection_get_virtual_iface_name
+nm_connection_get_setting_ip6_config ()
+NMSettingIP6Config * nm_connection_get_setting_ip6_config
                                                         (NMConnection *connection);
 
-Returns the name of the virtual kernel interface which the connection
-needs to use if specified in the settings. This function abstracts all
-connection types which require this functionality. For all other
-connection types, this function will return NULL.
+A shortcut to return any NMSettingIP6Config the connection might contain.
 
-
+

+++
-
-
+
 


 
 
 connection : The NMConnection
+ the NMConnection
 
 
 
 Returns : Name of the kernel interface or NULL an NMSettingIP6Config 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_olpc_mesh ()

NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (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 NMSettingOlpcMesh the connection might contain.

+++ @@ -1218,76 +1446,77 @@ property of the connection and matches that against -----+

`connection` :
`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 NMSettingOlpcMesh 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_ppp () +NMSettingPPP * nm_connection_get_setting_ppp (NMConnection *connection); -Returns the GType of the setting's class for a given setting name. +A shortcut to return any NMSettingPPP the connection might contain. - + +++ - - + + - + name : a setting name connection : the NMConnection + Returns : the GType of the setting's class an NMSettingPPP 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_pppoe () +NMSettingPPPOE * nm_connection_get_setting_pppoe (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 NMSettingPPPOE the connection might contain. - + +++ - - + + - + error_quark : a setting error quark connection : the NMConnection + Returns : the GType of the setting's class an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_need_secrets () -const char * nm_connection_need_secrets (NMConnection *connection, - GPtrArray **hints); +nm_connection_get_setting_serial () +NMSettingSerial * nm_connection_get_setting_serial (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 NMSettingSerial the connection might contain. - + +++ @@ -1295,137 +1524,103 @@ secrets are needed. - - - - - + connection : 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 NMSettingSerial if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_new () -NMConnection * nm_connection_new (void); - -Creates a new NMConnection object with no NMSetting objects. - - -- - - - - Returns : the new empty NMConnection object - - - -nm_connection_new_from_hash () -NMConnection * nm_connection_new_from_hash (GHashTable *hash, - GError **error); +nm_connection_get_setting_vpn () +NMSettingVPN * nm_connection_get_setting_vpn (NMConnection *connection); -Creates a new NMConnection from a hash table describing the connection. See -nm_connection_to_hash() for a description of the expected hash table. +A shortcut to return any NMSettingVPN the connection might contain. - + +++ - - + - - - - - + hash : the GHashTable describing -the connection. [element-type utf8 GLib.HashTable] + connection : the NMConnection error : on unsuccessful return, an error Returns : the new NMConnection object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validate an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_remove_setting () -void nm_connection_remove_setting (NMConnection *connection, - GType setting_type); +nm_connection_get_setting_wimax () +NMSettingWimax * nm_connection_get_setting_wimax (NMConnection *connection); -Removes the NMSetting with the given GType from the NMConnection. This -operation dereferences the NMSetting object. +A shortcut to return any NMSettingWimax the connection might contain. - + +++ - - - + + connection : a NMConnection + the NMConnection setting_type : the GType of the setting object to remove Returns : an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_replace_settings () -gboolean nm_connection_replace_settings (NMConnection *connection, - GHashTable *new_settings, - GError **error); - +nm_connection_get_setting_adsl () +NMSettingAdsl * nm_connection_get_setting_adsl (NMConnection *connection); + +A shortcut to return any NMSettingAdsl the connection might contain. + + +++ - - - - - - - - - - + connection : a NMConnection - new_settings : a GHashTable of settings. [element-type utf8 GLib.HashTable] - error : location to store error, or NULL + the NMConnection Returns : -TRUE if the settings were valid and added to the connection, FALSE -if they were not an NMSettingAdsl 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_wired () +NMSettingWired * nm_connection_get_setting_wired (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 NMSettingWired the connection might contain. - + +++ @@ -1433,28 +1628,25 @@ property. - - + + connection : path : the D-Bus path of the connection as given by the settings service -which provides the connection Returns : an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_to_hash () -GHashTable * nm_connection_to_hash (NMConnection *connection, - NMSettingHashFlags flags); +nm_connection_get_setting_wireless () +NMSettingWireless * nm_connection_get_setting_wireless (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 NMSettingWireless the connection might contain. - + +++ @@ -1462,16 +1654,8 @@ properties of the - - - - - @@ -1479,21 +1663,17 @@ with -nm_connection_update_secrets () -gboolean nm_connection_update_secrets (NMConnection *connection, - const char *setting_name, - GHashTable *secrets, - GError **error); +nm_connection_get_setting_wireless_security () +NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security + (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 NMSettingWirelessSecurity the connection might contain. - connection : 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 NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] + +++ @@ -1501,61 +1681,35 @@ will update all secrets from all settings contained in - - - - - - - - - - - - - + connection : 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 NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none] + -nm_connection_verify () -gboolean nm_connection_verify (NMConnection *connection, - GError **error); +nm_connection_get_setting_vlan () +NMSettingVlan * nm_connection_get_setting_vlan (NMConnection *connection); -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. +A shortcut to return any NMSettingVlan the connection might contain. - + +++ - - - - - - + connection : the NMConnection to verify error : location to store error, or NULL + the NMConnection Returns : -TRUE if the connection is valid, FALSE if it is not an NMSettingVlan if the connection contains one, otherwise NULL. [transfer none] + @@ -1583,8 +1737,11 @@ of the D-Bus path of the connection as provided by a settings service. The ::secrets-cleared signal is emitted when the secrets of a connection are cleared. - + +++ @@ -1607,8 +1764,11 @@ are cleared. The ::secrets-updated signal is emitted when the secrets of a setting have been changed. - connection : + +++ @@ -1630,6 +1790,6 @@ updated - Generated by GTK-Doc V1.18 + Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5 connection :

`hash` :	the GHashTable describing -the connection. [element-type utf8 GLib.HashTable] +	`connection` :	the NMConnection
`error` :	on unsuccessful return, an error
Returns :	the new NMConnection object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validate	an NMSettingVPN if the connection contains one, otherwise `NULL`. [transfer none] +

Object Hierarchy

Properties

Details

NMConnection

NMConnectionClass

enum NMConnectionError

nm_connection_error_quark ()

NM_CONNECTION_PATH

nm_connection_add_setting ()

NMConnection

nm_connection_clear_secrets ()

NMConnectionClass

nm_connection_new ()

nm_connection_clear_secrets_with_flags ()

nm_connection_new_from_hash ()

nm_connection_compare ()

nm_connection_duplicate ()

nm_connection_diff ()

nm_connection_add_setting ()

nm_connection_dump ()

nm_connection_remove_setting ()

nm_connection_duplicate ()

nm_connection_get_setting ()

nm_connection_error_quark ()

nm_connection_get_setting_by_name ()

nm_connection_for_each_setting_value ()

nm_connection_replace_settings ()

nm_connection_get_id ()

nm_connection_compare ()

nm_connection_get_path ()

nm_connection_diff ()

nm_connection_get_setting ()

nm_connection_verify ()

nm_connection_get_setting_802_1x ()

nm_connection_need_secrets ()

nm_connection_get_setting_adsl ()

nm_connection_clear_secrets ()

nm_connection_clear_secrets_with_flags ()

nm_connection_get_setting_bluetooth ()

nm_connection_update_secrets ()

nm_connection_get_setting_bond ()

nm_connection_set_path ()

nm_connection_get_setting_bridge ()

nm_connection_get_path ()

nm_connection_get_setting_bridge_port ()

nm_connection_get_virtual_iface_name ()

nm_connection_get_setting_by_name ()

nm_connection_is_type ()

nm_connection_get_setting_cdma ()

nm_connection_for_each_setting_value ()

nm_connection_get_setting_connection ()

nm_connection_to_hash ()

nm_connection_get_setting_gsm ()

nm_connection_dump ()

nm_connection_get_setting_infiniband ()

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_get_uuid ()

nm_connection_get_setting_olpc_mesh ()

nm_connection_get_id ()

nm_connection_get_setting_ppp ()

nm_connection_get_setting_802_1x ()

nm_connection_get_setting_pppoe ()

nm_connection_get_setting_bluetooth ()

nm_connection_get_setting_serial ()

nm_connection_get_setting_bond ()

nm_connection_get_setting_vlan ()

nm_connection_get_setting_bridge ()

nm_connection_get_setting_vpn ()

nm_connection_get_setting_bridge_port ()

nm_connection_get_setting_wimax ()

nm_connection_get_setting_cdma ()

nm_connection_get_setting_wired ()

nm_connection_get_setting_connection ()

nm_connection_get_setting_wireless ()

nm_connection_get_setting_gsm ()

nm_connection_get_setting_wireless_security ()

nm_connection_get_setting_infiniband ()