libnm-glib Reference Manual: NMRemoteConnection

@@ -32,511 +41,635 @@

NMRemoteConnection

- +

Synopsis

enum                NMRemoteConnectionError;
+#define             NM_REMOTE_CONNECTION_ERROR
+GQuark              nm_remote_connection_error_quark    (void);
+#define             NM_REMOTE_CONNECTION_UNSAVED
+#define             NM_REMOTE_CONNECTION_UPDATED
+#define             NM_REMOTE_CONNECTION_REMOVED
+                    NMRemoteConnection;
+                    NMRemoteConnectionClass;
+void                (*NMRemoteConnectionResultFunc)     (NMRemoteConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+typedef             NMRemoteConnectionCommitFunc;
+typedef             NMRemoteConnectionDeleteFunc;
+void                (*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
+                                                         GHashTable *secrets,
+                                                         GError *error,
+                                                         gpointer user_data);
+NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
+                                                         const char *path);
+void                nm_remote_connection_commit_changes (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+void                nm_remote_connection_commit_changes_unsaved
+                                                        (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+void                nm_remote_connection_save           (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+void                nm_remote_connection_delete         (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+void                nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         NMRemoteConnectionGetSecretsFunc callback,
+                                                         gpointer user_data);
+gboolean            nm_remote_connection_get_unsaved    (NMRemoteConnection *connection);
+

Object Hierarchy

+  GObject
+   +----NMConnection
+         +----NMRemoteConnection
+

Implemented Interfaces

+NMRemoteConnection implements + GInitable and GAsyncInitable.

Properties

+  "bus"                      DBusGConnection*      : Write / Construct Only
+  "dbus-connection"          DBusGConnection*      : Write / Construct Only
+  "dbus-path"                gchar*                : Write / Construct Only
+  "unsaved"                  gboolean              : Read
+

Functions

Signals

+  "removed"                                        : Run First
+  "updated"                                        : Run First
+  "visible"                                        : Run First
+

+ +

Description

Details

enum NMRemoteConnectionError

typedef enum {
+	NM_REMOTE_CONNECTION_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
+	NM_REMOTE_CONNECTION_ERROR_DISCONNECTED,            /*< nick=Disconnected >*/
+} NMRemoteConnectionError;
+

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

-void -	-(*NMRemoteConnectionCommitFunc) () +	`NM_REMOTE_CONNECTION_ERROR_UNKNOWN`	unknown or unclassified error
-void -	-(*NMRemoteConnectionDeleteFunc) () -
-void -	-(*NMRemoteConnectionGetSecretsFunc) () -
-NMRemoteConnection * -	-nm_remote_connection_new () -
-void -	-nm_remote_connection_commit_changes () -
-void -	-nm_remote_connection_delete () -
-void -	-nm_remote_connection_get_secrets () +	`NM_REMOTE_CONNECTION_ERROR_DISCONNECTED`	dbus disconnected

Properties

NM_REMOTE_CONNECTION_ERROR

#define NM_REMOTE_CONNECTION_ERROR (nm_remote_connection_error_quark ())
+

nm_remote_connection_error_quark ()

GQuark              nm_remote_connection_error_quark    (void);

+Registers an error quark for NMRemoteConnection if necessary. +

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

-DBusGConnection *	bus	Write / Construct Only
-DBusGConnection *	dbus-connection	Write / Construct Only
-gchar *	dbus-path	Write / Construct Only
Returns :	the error quark used for NMRemoteConnection errors.

Signals

NM_REMOTE_CONNECTION_UNSAVED

#define NM_REMOTE_CONNECTION_UNSAVED         "unsaved"
+

NM_REMOTE_CONNECTION_UPDATED

#define NM_REMOTE_CONNECTION_UPDATED         "updated"
+

NM_REMOTE_CONNECTION_REMOVED

#define NM_REMOTE_CONNECTION_REMOVED         "removed"
+

NMRemoteConnection

typedef struct _NMRemoteConnection NMRemoteConnection;

NMRemoteConnectionClass

typedef struct {
+	NMConnectionClass parent_class;
+
+	/* Signals */
+	void (*updated) (NMRemoteConnection *connection,
+	                 GHashTable *new_settings);
+
+	void (*removed) (NMRemoteConnection *connection);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMRemoteConnectionClass;
+

NMRemoteConnectionResultFunc ()

void                (*NMRemoteConnectionResultFunc)     (NMRemoteConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);

+Called when NetworkManager has finished an asynchronous operation on a +connection, like commit changes, deleting, saving, etc. +

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

void	removed	Run First	`connection` :	the connection for which an operation was performed
void	updated	Run First	`error` :	on failure, a descriptive error
void	visible	Run First	`user_data` :	user data passed to function which began the operation

Types and Values

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

#define	NM_REMOTE_CONNECTION_UPDATED
#define	NM_REMOTE_CONNECTION_REMOVED

Object Hierarchy

    GObject
-    ╰── NMConnection
-        ╰── NMRemoteConnection
+
+
+NMRemoteConnectionCommitFunc
+typedef NMRemoteConnectionResultFunc NMRemoteConnectionCommitFunc;
 
+
+
 
-
-Description
+
+
+NMRemoteConnectionDeleteFunc
+typedef NMRemoteConnectionResultFunc NMRemoteConnectionDeleteFunc;
+
 
 
 
-
-Functions
+
 
-NMRemoteConnectionCommitFunc ()
-void
-(*NMRemoteConnectionCommitFunc) (NMRemoteConnection *connection,
-                                 GError *error,
-                                 gpointer user_data);
-Called when NetworkManager has committed outstanding changes to a connection
-to backing storage as a result of nm_remote_connection_commit_changes().
-
-Parameters
-
+NMRemoteConnectionGetSecretsFunc ()
+void                (*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
+                                                         GHashTable *secrets,
+                                                         GError *error,
+                                                         gpointer user_data);
+
+Called when NetworkManager returns secrets in response to a request for
+secrets via nm_remote_connection_get_secrets().
+
+
---++
-
-
-
+
+
+
+
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the connection for which updates are to be committed   connection : the connection for which secrets were requested
secrets : on success, a hash table of
+hash tables, with each inner hash mapping a setting property to a GValue
+containing that property's value. [element-type utf8 GLib.HashTable]
+
 
 error on failure, a descriptive error   error : on failure, a descriptive error
 
 user_data user data passed to nm_remote_connection_commit_changes()   user_data : user data passed to nm_remote_connection_get_secrets()
+
 
 
 
 
-
 
 
-NMRemoteConnectionDeleteFunc ()
-void
-(*NMRemoteConnectionDeleteFunc) (NMRemoteConnection *connection,
-                                 GError *error,
-                                 gpointer user_data);
-Called when NetworkManager has deleted a connection as a result of
-nm_remote_connection_delete().
-
-Parameters
-
+nm_remote_connection_new ()
+NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
+                                                         const char *path);
+
+Creates a new object representing the remote connection.
+
+
---++
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the connection to be deleted   bus : a valid and connected D-Bus connection
 
 error on failure, a descriptive error   path : the D-Bus path of the connection as exported by the settings service
 
 user_data user data passed to nm_remote_connection_delete()   Returns : the new remote connection object on success, or NULL on failure
 
 
 
 
-
 
 
-NMRemoteConnectionGetSecretsFunc ()
-void
-(*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
-                                     GHashTable *secrets,
-                                     GError *error,
-                                     gpointer user_data);
-Called when NetworkManager returns secrets in response to a request for
-secrets via nm_remote_connection_get_secrets().
-
-Parameters
-
+nm_remote_connection_commit_changes ()
+void                nm_remote_connection_commit_changes (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+
+Send any local changes to the settings and properties of this connection to
+NetworkManager, which will immediately save them to disk.
+
+
---++
-
-
-
-
-
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the connection for which secrets were requested  
secrets  on success, a hash table of
-hash tables, with each inner hash mapping a setting property to a GValue
-containing that property's value. [element-type utf8 GLib.HashTable] connection : the NMRemoteConnection
+
 
 error on failure, a descriptive error   callback : a function to be called when the
+commit completes. [scope async][allow-none]
+
 
 user_data user data passed to nm_remote_connection_get_secrets()   user_data : caller-specific data to be passed to callback. [closure]
+
 
 
 
 
-
 
 
-nm_remote_connection_new ()
-NMRemoteConnection *
-nm_remote_connection_new (DBusGConnection *bus,
-                          const char *path);
-Creates a new object representing the remote connection.
-
-Parameters
-
+nm_remote_connection_commit_changes_unsaved ()
+void                nm_remote_connection_commit_changes_unsaved
+                                                        (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+
+Send any local changes to the settings and properties of this connection to
+NetworkManager.  The changes are not saved to disk until either
+nm_remote_connection_save() or nm_remote_connection_commit_changes() is
+called.
+
+
---++
-
-
-
+
+
+
+
+
+
-
-
-
+
+
 





 
 
 bus a valid and connected D-Bus connection   connection : the NMRemoteConnection
+
callback : a function to be called when the
+commit completes. [scope async][allow-none]
+
 
 path the D-Bus path of the connection as exported by the settings service   user_data : caller-specific data to be passed to callback. [closure]
+
 
 
 
-
-
-Returns
- the new remote connection object on success, or NULL on failure
-
-
+Since 0.9.10
 
 
 
-nm_remote_connection_commit_changes ()
-void
-nm_remote_connection_commit_changes (NMRemoteConnection *connection,
-                                     NMRemoteConnectionCommitFunc callback,
-                                     gpointer user_data);
-Save any local changes to the settings and properties of this connection and
-save them in the settings service.
-
-Parameters
-
+nm_remote_connection_save ()
+void                nm_remote_connection_save           (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+
+Saves the connection to disk if the connection has changes that have not yet
+been written to disk, or if the connection has never been saved.
+
+
---++
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the NMRemoteConnection   connection : the NMRemoteConnection
+
 
 callback  a function to be called when the
-commit completes. [scope async][allow-none] callback : a function to be called when the
+save completes. [scope async][allow-none]
+
 
 user_data  caller-specific data to be passed to callback
-. [closure] user_data : caller-specific data to be passed to callback. [closure]
+
 
 
 
-
+Since 0.9.10
 
 
 
-nm_remote_connection_delete ()
-void
-nm_remote_connection_delete (NMRemoteConnection *connection,
-                             NMRemoteConnectionDeleteFunc callback,
-                             gpointer user_data);
-Delete the connection.
-
-Parameters
-
+nm_remote_connection_delete ()
+void                nm_remote_connection_delete         (NMRemoteConnection *connection,
+                                                         NMRemoteConnectionResultFunc callback,
+                                                         gpointer user_data);
+
+Delete the connection.
+
+
---++
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the NMRemoteConnection   connection : the NMRemoteConnection
+
 
 callback  a function to be called when the delete completes. [scope async][allow-none] callback : a function to be called when the delete completes. [scope async][allow-none]
+
 
 user_data  caller-specific data to be passed to callback
-. [closure] user_data : caller-specific data to be passed to callback. [closure]
+
 
 
 
 
-
 
 
-nm_remote_connection_get_secrets ()
-void
-nm_remote_connection_get_secrets (NMRemoteConnection *connection,
-                                  const char *setting_name,
-                                  NMRemoteConnectionGetSecretsFunc callback,
-                                  gpointer user_data);
-Request the connection's secrets.
-
-Parameters
-
+nm_remote_connection_get_secrets ()
+void                nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
+                                                         const char *setting_name,
+                                                         NMRemoteConnectionGetSecretsFunc callback,
+                                                         gpointer user_data);
+
+Request the connection's secrets.
+
+
---++
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
-
-
-
+
+
 





 
 
 connection the NMRemoteConnection   connection : the NMRemoteConnection
+
 
 setting_name the NMSetting object name to get secrets for   setting_name : the NMSetting object name to get secrets for
 
 callback  a function to be called when the update completes;
-must not be NULL. [scope async] callback : a function to be called when the update completes;
+must not be NULL. [scope async]
+
 
 user_data  caller-specific data to be passed to callback
-. [closure] user_data : caller-specific data to be passed to callback. [closure]
+
 
 
 
 
-
-
-
-Types and Values
-
-NM_REMOTE_CONNECTION_UPDATED
-#define NM_REMOTE_CONNECTION_UPDATED         "updated"
-
-
-
-
 
 
-NM_REMOTE_CONNECTION_REMOVED
-#define NM_REMOTE_CONNECTION_REMOVED         "removed"
-
-
-
+nm_remote_connection_get_unsaved ()
+gboolean            nm_remote_connection_get_unsaved    (NMRemoteConnection *connection);
+
++++
+
+
+
+
+
+
+
+
+
+
+


connection : the NMRemoteConnection
+
Returns : 
+TRUE if the remote connection contains changes that have not
+been saved to disk, FALSE if the connection is the same as its on-disk
+representation.
+Since 0.9.10
 
 
 
 Property Details
 
-The “bus” property
-  “bus”                      DBusGConnection *
+The "bus" property
+  "bus"                      DBusGConnection*      : Write / Construct Only
 DBusGConnection.
-Flags: Write / Construct Only
 
 
 
-The “dbus-connection” property
-  “dbus-connection”          DBusGConnection *
+The "dbus-connection" property
+  "dbus-connection"          DBusGConnection*      : Write / Construct Only
 DBusGConnection.
-Flags: Write / Construct Only
 
 
 
-The “dbus-path” property
-  “dbus-path”                gchar *
+The "dbus-path" property
+  "dbus-path"                gchar*                : Write / Construct Only
 DBus Object Path.
-Flags: Write / Construct Only
 Default value: NULL
 
+
+
+The "unsaved" property
+  "unsaved"                  gboolean              : Read
+
+TRUE if the remote connection contains changes that have not been saved
+to disk, FALSE if the connection is the same as its on-disk representation.
+
+Default value: FALSE
+Since 0.9.10
+
 
 
 Signal Details
 
-The “removed” signal
-void
-user_function (NMRemoteConnection *connection,
-               gpointer            user_data)
-Flags: Run First
+The "removed" signal
+void                user_function                      (NMRemoteConnection *connection,
+                                                        gpointer            user_data)       : Run First
+
+This signal is emitted when a connection is either deleted or becomes
+invisible to the current user.
+
+
++++
+
+
+
+
+
+
+
+
+
+
+


connection : a NMConnection
+
user_data : user data set when the signal handler was connected.
 
 
 
-The “updated” signal
-void
-user_function (NMRemoteConnection *connection,
-               gpointer            user_data)
-Flags: Run First
+The "updated" signal
+void                user_function                      (NMRemoteConnection *connection,
+                                                        gpointer            user_data)       : Run First
+
+This signal is emitted when a connection changes, and it is
+still visible to the user.
+
+
++++
+
+
+
+
+
+
+
+
+
+
+


connection : a NMConnection
+
user_data : user data set when the signal handler was connected.
 
 
 
-The “visible” signal
-void
-user_function (NMRemoteConnection *nmremoteconnection,
-               gboolean            arg1,
-               gpointer            user_data)
-Flags: Run First
+The "visible" signal
+void                user_function                      (NMRemoteConnection *nmremoteconnection,
+                                                        gboolean            arg1,
+                                                        gpointer            user_data)               : Run First
+
+
+
++++
+
+
+
+
+
+
+
+
+
+
+


nmremoteconnection : the object which received the signal.
user_data : user data set when the signal handler was connected.
 
 
 
 
 
-          Generated by GTK-Doc V1.20
+          Generated by GTK-Doc V1.19

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

			libnm-glib Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Implemented Interfaces + \| + Properties + \| + Signals +

connection	the connection for which updates are to be committed	`connection` :	the connection for which secrets were requested
`secrets` :	on success, a hash table of +hash tables, with each inner hash mapping a setting property to a GValue +containing that property's value. [element-type utf8 GLib.HashTable] +
error	on failure, a descriptive error	`error` :	on failure, a descriptive error
user_data	user data passed to `nm_remote_connection_commit_changes()`	`user_data` :	user data passed to `nm_remote_connection_get_secrets()` +

connection	the connection to be deleted	`bus` :	a valid and connected D-Bus connection
error	on failure, a descriptive error	`path` :	the D-Bus path of the connection as exported by the settings service
user_data	user data passed to `nm_remote_connection_delete()`	Returns :	the new remote connection object on success, or `NULL` on failure

connection	the connection for which secrets were requested
secrets	on success, a hash table of -hash tables, with each inner hash mapping a setting property to a GValue -containing that property's value.	[element-type utf8 GLib.HashTable]	`connection` :	the NMRemoteConnection +
error	on failure, a descriptive error		`callback` :	a function to be called when the +commit completes. [scope async][allow-none] +
user_data	user data passed to `nm_remote_connection_get_secrets()`		`user_data` :	caller-specific data to be passed to `callback`. [closure] +

connection	the NMRemoteConnection		`connection` :	the NMRemoteConnection +
callback	a function to be called when the -commit completes.	[scope async][allow-none]	`callback` :	a function to be called when the +save completes. [scope async][allow-none] +
user_data	caller-specific data to be passed to `callback` -.	[closure]	`user_data` :	caller-specific data to be passed to `callback`. [closure] +

`connection` :	a NMConnection +
`user_data` :	user data set when the signal handler was connected.

`nmremoteconnection` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.