From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMRemoteConnection.html | 713 ++++++++++++++------------- 1 file changed, 374 insertions(+), 339 deletions(-) (limited to 'docs/libnm-glib/html/NMRemoteConnection.html') diff --git a/docs/libnm-glib/html/NMRemoteConnection.html b/docs/libnm-glib/html/NMRemoteConnection.html index 127b665b..36b650d5 100644 --- a/docs/libnm-glib/html/NMRemoteConnection.html +++ b/docs/libnm-glib/html/NMRemoteConnection.html @@ -2,38 +2,29 @@ -NMRemoteConnection +libnm-glib Reference Manual: NMRemoteConnection - + - - - - - - - - - - + + + + + + +
@@ -41,467 +32,511 @@

NMRemoteConnection

NMRemoteConnection

- +
-
-

Synopsis

-
#define             NM_REMOTE_CONNECTION_UPDATED
-#define             NM_REMOTE_CONNECTION_REMOVED
-                    NMRemoteConnection;
-                    NMRemoteConnectionClass;
-void                (*NMRemoteConnectionCommitFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMRemoteConnectionDeleteFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-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,
-                                                         NMRemoteConnectionCommitFunc callback,
-                                                         gpointer user_data);
-void                nm_remote_connection_delete         (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionDeleteFunc callback,
-                                                         gpointer user_data);
-void                nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
-                                                         const char *setting_name,
-                                                         NMRemoteConnectionGetSecretsFunc callback,
-                                                         gpointer user_data);
-
-
-
-

Object Hierarchy

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

Implemented Interfaces

-

-NMRemoteConnection implements - GInitable and GAsyncInitable.

+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*NMRemoteConnectionCommitFunc) () +
+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 () +

Properties

-
-  "bus"                      DBusGConnection*      : Write / Construct Only
-  "dbus-connection"          DBusGConnection*      : Write / Construct Only
-  "dbus-path"                gchar*                : Write / Construct Only
-
+
+++++ + + + + + + + + + + + + + + + + + +
+DBusGConnection *busWrite / Construct Only
+DBusGConnection *dbus-connectionWrite / Construct Only
+gchar *dbus-pathWrite / Construct Only

Signals

-
-  "removed"                                        : Run First
-  "updated"                                        : Run First
-  "visible"                                        : Run First
-
+
+++++ + + + + + + + + + + + + + + + + + +
voidremovedRun First
voidupdatedRun First
voidvisibleRun First
-

Description

-

-

+

Types and Values

+
++++ + + + + + + + + + + +
#defineNM_REMOTE_CONNECTION_UPDATED
#defineNM_REMOTE_CONNECTION_REMOVED
-

Details

-
-

NM_REMOTE_CONNECTION_UPDATED

-
#define NM_REMOTE_CONNECTION_UPDATED         "updated"
-
-

-

-
-
-
-

NM_REMOTE_CONNECTION_REMOVED

-
#define NM_REMOTE_CONNECTION_REMOVED         "removed"
+
Object Hierarchy

+
    GObject
+    ╰── NMConnection
+        ╰── NMRemoteConnection
 

-

-

-
-
-
-

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

Description

-
+
+

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

-
+

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

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

connection :

the connection for which updates are to be committed

connection

the connection for which updates are to be committed

 

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

 
+
-

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

-
+

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

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

connection :

the connection to be deleted

connection

the connection to be deleted

 

error :

on failure, a descriptive error

error

on failure, a descriptive error

 

user_data :

user data passed to nm_remote_connection_delete() -

user_data

user data passed to nm_remote_connection_delete()

 
+
-

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

-
+

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

+
--+++ - - + + + - - + +containing that property's value.

+ - - + + + - - + + +

connection :

the connection for which secrets were requested

connection

the connection for which secrets were requested

 

secrets :

on success, a hash table of +

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

[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_get_secrets() -

user_data

user data passed to nm_remote_connection_get_secrets()

 
+
-

nm_remote_connection_new ()

-
NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
-                                                         const char *path);
-

-Creates a new object representing the remote connection. -

-
+

nm_remote_connection_new ()

+
NMRemoteConnection *
+nm_remote_connection_new (DBusGConnection *bus,
+                          const char *path);
+

Creates a new object representing the remote connection.

+
+

Parameters

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

bus :

a valid and connected D-Bus connection

path :

the D-Bus path of the connection as exported by the settings service

bus

a valid and connected D-Bus connection

 

Returns :

the new remote connection object on success, or NULL on failure

path

the D-Bus path of the connection as exported by the settings service

 
+
+

Returns

+

the new remote connection object on success, or NULL on failure

+

+
+
-

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

-
+

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

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

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 +commit 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_delete ()

-
void                nm_remote_connection_delete         (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionDeleteFunc callback,
-                                                         gpointer user_data);
-

-Delete the connection. -

-
+

nm_remote_connection_delete ()

+
void
+nm_remote_connection_delete (NMRemoteConnection *connection,
+                             NMRemoteConnectionDeleteFunc callback,
+                             gpointer user_data);
+

Delete the connection.

+
+

Parameters

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

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

-
+

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

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

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

+

+
+

Property Details

-

The "bus" property

-
  "bus"                      DBusGConnection*      : Write / Construct Only
+

The “bus” property

+
  “bus”                      DBusGConnection *

DBusGConnection.

+

Flags: Write / Construct Only

-

The "dbus-connection" property

-
  "dbus-connection"          DBusGConnection*      : Write / Construct Only
+

The “dbus-connection” property

+
  “dbus-connection”          DBusGConnection *

DBusGConnection.

+

Flags: Write / Construct Only

-

The "dbus-path" property

-
  "dbus-path"                gchar*                : Write / Construct Only
+

The “dbus-path” property

+
  “dbus-path”                gchar *

DBus Object Path.

+

Flags: Write / Construct Only

Default value: NULL

Signal Details

-

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 “removed” 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 “updated” signal

+
void
+user_function (NMRemoteConnection *connection,
+               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.
+

The “visible” signal

+
void
+user_function (NMRemoteConnection *nmremoteconnection,
+               gboolean            arg1,
+               gpointer            user_data)
+

Flags: Run First

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file -- cgit 1.3.0-6-gf8a5