NMConnection

@@ -232,7 +232,7 @@ Describes errors that may result from operations involving a

nm_connection_error_quark ()

GQuark              nm_connection_error_quark           (void);

GQuark              nm_connection_error_quark           (void);

Registers an error quark for NMConnection if necessary.

@@ -286,7 +286,7 @@ It should only be accessed through the functions described below.

nm_connection_get_type ()

GType               nm_connection_get_type              (void);

GType               nm_connection_get_type              (void);

@@ -317,8 +317,8 @@ Creates a new

nm_connection_new_from_hash ()

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

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

Creates a new NMConnection from a hash table describing the connection. See nm_connection_to_hash() for a description of the expected hash table. @@ -328,7 +328,7 @@ Creates a new

- @@ -401,9 +401,9 @@ the setting object's reference count.

nm_connection_remove_setting ()

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

+ GType setting_type);

-Removes the NMSetting with the given GType from the NMConnection. This +Removes the NMSetting with the given GType from the NMConnection. This operation dereferences the NMSetting object.

hash :

the GHashTable describing the connection +

the GHashTable describing the connection

@@ -416,7 +416,7 @@ operation dereferences the setting_type :

- @@ -426,9 +426,9 @@ operation dereferences the

nm_connection_get_setting ()

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

+ GType setting_type);

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

the GType of the setting object to remove +

the GType of the setting object to remove

@@ -441,7 +441,7 @@ to the - @@ -487,9 +487,9 @@ added to the

nm_connection_replace_settings ()

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

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

setting_type :

the GType of the setting object to return +

the GType of the setting object to return

@@ -500,17 +500,17 @@ added to the - - - @@ -520,7 +520,7 @@ if they were not

nm_connection_compare ()

gboolean            nm_connection_compare               (NMConnection *a,
+gboolean            nm_connection_compare               (NMConnection *a,
                                                          NMConnection *b,
                                                          NMSettingCompareFlags flags);
 
@@ -548,7 +548,7 @@ each flag's behavior.

- @@ -557,8 +557,8 @@ each flag's behavior.

nm_connection_verify ()

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

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

Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For @@ -567,7 +567,7 @@ 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 +MAC address. The returned GError contains information about which setting and which property failed validation, and how it failed validation.

`new_settings` :	a GHashTable of settings +	a GHashTable of settings
`error` :	location to store error, or `NULL` +	location to store error, or `NULL`
Returns :	`TRUE` if the settings were valid and added to the connection, `FALSE` +	`TRUE` if the settings were valid and added to the connection, `FALSE` if they were not
Returns :	`TRUE` if the comparison succeeds, `FALSE` if it does not +	`TRUE` if the comparison succeeds, `FALSE` if it does not

@@ -580,12 +580,12 @@ setting and which property failed validation, and how it failed validation. - - @@ -595,7 +595,7 @@ setting and which property failed validation, and how it failed validation.

nm_connection_need_secrets ()

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

+ GPtrArray **hints);

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 @@ -613,11 +613,11 @@ secrets are needed.

- @@ -649,10 +649,10 @@ keeping secret data in memory when not needed.

nm_connection_update_secrets ()

gboolean            nm_connection_update_secrets        (NMConnection *connection,
+gboolean            nm_connection_update_secrets        (NMConnection *connection,
                                                          const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
+                                                         GHashTable *secrets,
+                                                         GError **error);

Update the specified setting's secrets, given a hash table of secrets intended for that setting (deserialized from D-Bus for example). @@ -672,19 +672,19 @@ intended for that setting (deserialized from D-Bus for example).

- - - @@ -800,7 +800,7 @@ Returns the connection's D-Bus path.

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

+ gpointer user_data);

Iterates over the properties of each NMSetting object in the NMConnection, calling the supplied user function for each property. @@ -829,13 +829,13 @@ calling the supplied user function for each property.

nm_connection_to_hash ()

GHashTable *        nm_connection_to_hash               (NMConnection *connection);

GHashTable *        nm_connection_to_hash               (NMConnection *connection);

-Converts the NMConnection into a GHashTable describing the 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 +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 +are GHashTables mapping string:GValue, each of which represents the properties of the NMSetting object.

`error` :	location to store error, or `NULL` +	location to store error, or `NULL`
Returns :	`TRUE` if the connection is valid, `FALSE` if it is not +	`TRUE` if the connection is valid, `FALSE` if it is not
`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 +	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()` +and must free the each array element with `g_free()`, as well as the array +itself with `g_ptr_array_free()`
`secrets` :	a GHashTable mapping string:GValue of setting property names and +	a GHashTable mapping string:GValue of setting property names and secrets
`error` :	location to store error, or `NULL` +	location to store error, or `NULL`
Returns :	`TRUE` if the secrets were successfully updated and the connection -is valid, `FALSE` on failure or if the setting was never added to the connection +	`TRUE` if the secrets were successfully updated and the connection +is valid, `FALSE` on failure or if the setting was never added to the connection

@@ -848,9 +848,9 @@ properties of the - @@ -900,9 +900,9 @@ Create a new

nm_connection_lookup_setting_type ()

GType               nm_connection_lookup_setting_type   (const char *name);

GType               nm_connection_lookup_setting_type   (const char *name);

-Returns the GType of the setting's class for a given setting name. +Returns the GType of the setting's class for a given setting name.

Returns :

a new GHashTable describing the connection, its settings, and +

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. +the hash table with g_hash_table_unref() when it is no longer needed.

@@ -914,7 +914,7 @@ Returns the Returns :

- @@ -923,10 +923,10 @@ Returns the

nm_connection_lookup_setting_type_by_quark ()

GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);

GType               nm_connection_lookup_setting_type_by_quark
+                                                        (GQuark error_quark);

-Returns the GType of the setting's class for a given setting error quark. +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.

the GType of the setting's class +

the GType of the setting's class

@@ -939,7 +939,7 @@ Useful for figuring out which setting a returned error is for. - @@ -950,7 +950,7 @@ Useful for figuring out which setting a returned error is for.

Property Details

The `"path"` property

  "path"                     gchar*                : Read / Write / Construct

  "path"                     gchar*                : Read / Write / Construct

The connection's D-Bus path, used only by the calling process as a record of the D-Bus path of the connection as provided by a settings service. @@ -960,7 +960,7 @@ of the D-Bus path of the connection as provided by a settings service.

The `"scope"` property

  "scope"                    guint                 : Read / Write / Construct

  "scope"                    guint                 : Read / Write / Construct

The connection's scope, used only by the calling process as a record of which settings service the connection is provided by. One of the @@ -975,8 +975,8 @@ NM_CONNECTION_SCOPE_* defines.

The `"secrets-updated"` signal

void                user_function                      (NMConnection *connection,
-                                                        gchar        *setting_name,
-                                                        gpointer      user_data)         : Run First

+ gchar *setting_name, + gpointer user_data) : Run First

The ::secrets-updated signal is emitted when the secrets of a setting have been changed. @@ -1006,6 +1006,6 @@ updated

+ Generated by GTK-Doc V1.15

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

Returns :

the GType of the setting's class +

the GType of the setting's class

Object Hierarchy

Properties

nm_connection_error_quark ()

nm_connection_get_type ()

nm_connection_new_from_hash ()

nm_connection_remove_setting ()

nm_connection_get_setting ()

nm_connection_replace_settings ()

nm_connection_compare ()

nm_connection_verify ()

nm_connection_need_secrets ()

nm_connection_update_secrets ()

nm_connection_to_hash ()

nm_connection_lookup_setting_type ()

nm_connection_lookup_setting_type_by_quark ()

Property Details

The `"path"` property

The `"scope"` property

The `"secrets-updated"` signal

Object Hierarchy

Properties

nm_connection_error_quark ()

nm_connection_get_type ()

nm_connection_new_from_hash ()

nm_connection_remove_setting ()

nm_connection_get_setting ()

nm_connection_replace_settings ()

nm_connection_compare ()

nm_connection_verify ()

nm_connection_need_secrets ()

nm_connection_update_secrets ()

nm_connection_to_hash ()

nm_connection_lookup_setting_type ()

nm_connection_lookup_setting_type_by_quark ()

Property Details

The "path" property

The "scope" property

The "secrets-updated" signal

The `"path"` property

The `"scope"` property

The `"secrets-updated"` signal