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/NMRemoteSettings.html | 1016 +++++++++++++++------------- 1 file changed, 556 insertions(+), 460 deletions(-) (limited to 'docs/libnm-glib/html/NMRemoteSettings.html') diff --git a/docs/libnm-glib/html/NMRemoteSettings.html b/docs/libnm-glib/html/NMRemoteSettings.html index aeaf748e..be81004e 100644 --- a/docs/libnm-glib/html/NMRemoteSettings.html +++ b/docs/libnm-glib/html/NMRemoteSettings.html @@ -2,38 +2,29 @@ -NMRemoteSettings +libnm-glib Reference Manual: NMRemoteSettings - + - - - - - - - - - - + + + + + + +
@@ -41,620 +32,725 @@

NMRemoteSettings

NMRemoteSettings

- +
-
-

Synopsis

-
enum                NMRemoteSettingsError;
-#define             NM_REMOTE_SETTINGS_ERROR
-GQuark              nm_remote_settings_error_quark      (void);
-#define             NM_REMOTE_SETTINGS_BUS
-#define             NM_REMOTE_SETTINGS_SERVICE_RUNNING
-#define             NM_REMOTE_SETTINGS_HOSTNAME
-#define             NM_REMOTE_SETTINGS_CAN_MODIFY
-#define             NM_REMOTE_SETTINGS_NEW_CONNECTION
-#define             NM_REMOTE_SETTINGS_CONNECTIONS_READ
-void                (*NMRemoteSettingsAddConnectionFunc)
-                                                        (NMRemoteSettings *settings,
-                                                         NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
-                                                         GError *error,
-                                                         gpointer user_data);
-struct              NMRemoteSettings;
-struct              NMRemoteSettingsClass;
-NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);
-void                nm_remote_settings_new_async        (DBusGConnection *bus,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMRemoteSettings *  nm_remote_settings_new_finish       (GAsyncResult *result,
-                                                         GError **error);
-GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);
-NMRemoteConnection * nm_remote_settings_get_connection_by_path
-                                                        (NMRemoteSettings *settings,
-                                                         const char *path);
-NMRemoteConnection * nm_remote_settings_get_connection_by_uuid
-                                                        (NMRemoteSettings *settings,
-                                                         const char *uuid);
-gboolean            nm_remote_settings_add_connection   (NMRemoteSettings *settings,
-                                                         NMConnection *connection,
-                                                         NMRemoteSettingsAddConnectionFunc callback,
-                                                         gpointer user_data);
-gboolean            nm_remote_settings_save_hostname    (NMRemoteSettings *settings,
-                                                         const char *hostname,
-                                                         NMRemoteSettingsSaveHostnameFunc callback,
-                                                         gpointer user_data);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMRemoteSettings
-
-
-
-

Implemented Interfaces

-

-NMRemoteSettings implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "bus"                      DBusGConnection*      : Read / Write / Construct Only
-  "can-modify"               gboolean              : Read
-  "hostname"                 gchar*                : Read
-  "service-running"          gboolean              : Read
-
-
-

Signals

-
-  "connections-read"                               : Run First
-  "new-connection"                                 : Run First
-
-
-
-

Description

-

-

-
-
-

Details

-
-

enum NMRemoteSettingsError

-
typedef enum {
-	NM_REMOTE_SETTINGS_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED,     /*< nick=ConnectionRemoved >*/
-	NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE, /*< nick=ConnectionUnavailable >*/
-} NMRemoteSettingsError;
-
-

-Describes errors that may result from operations involving a NMRemoteSettings. -

-
+

Functions

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

NM_REMOTE_SETTINGS_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_remote_settings_error_quark ()

NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED

the NMRemoteConnection object - was removed before it was completely initialized + +void + +(*NMRemoteSettingsAddConnectionFunc) ()

NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE

the NMRemoteConnection object - is not visible or otherwise unreadable + +void + +(*NMRemoteSettingsSaveHostnameFunc) () +
+NMRemoteSettings * + +nm_remote_settings_new () +
+void + +nm_remote_settings_new_async () +
+NMRemoteSettings * + +nm_remote_settings_new_finish () +
+GSList * + +nm_remote_settings_list_connections () +
+NMRemoteConnection * + +nm_remote_settings_get_connection_by_path () +
+NMRemoteConnection * + +nm_remote_settings_get_connection_by_uuid () +
+gboolean + +nm_remote_settings_add_connection () +
+gboolean + +nm_remote_settings_save_hostname ()
-
-
-

NM_REMOTE_SETTINGS_ERROR

-
#define NM_REMOTE_SETTINGS_ERROR nm_remote_settings_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
+DBusGConnection *busRead / Write / Construct Only
gbooleancan-modifyRead
+gchar *hostnameRead
gbooleanservice-runningRead
-
-
-

nm_remote_settings_error_quark ()

-
GQuark              nm_remote_settings_error_quark      (void);
-

-Registers an error quark for NMRemoteSettings if necessary. -

-
+
+

Signals

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

Returns :

the error quark used for NMRemoteSettings errors.
voidconnections-readRun First
voidnew-connectionRun First
-
-
-

NM_REMOTE_SETTINGS_BUS

-
#define NM_REMOTE_SETTINGS_BUS             "bus"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
enumNMRemoteSettingsError
#defineNM_REMOTE_SETTINGS_ERROR
#defineNM_REMOTE_SETTINGS_BUS
#defineNM_REMOTE_SETTINGS_SERVICE_RUNNING
#defineNM_REMOTE_SETTINGS_HOSTNAME
#defineNM_REMOTE_SETTINGS_CAN_MODIFY
#defineNM_REMOTE_SETTINGS_NEW_CONNECTION
#defineNM_REMOTE_SETTINGS_CONNECTIONS_READ
-
-
-

NM_REMOTE_SETTINGS_SERVICE_RUNNING

-
#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
+

+
Object Hierarchy

+
    GObject
+    ╰── NMRemoteSettings
 

-

-

 

-

-

-
NM_REMOTE_SETTINGS_HOSTNAME

-
#define NM_REMOTE_SETTINGS_HOSTNAME        "hostname"
-

+

+
Description

 

 

 

-

+

+
Functions

 

-
NM_REMOTE_SETTINGS_CAN_MODIFY

-
#define NM_REMOTE_SETTINGS_CAN_MODIFY      "can-modify"
-

-

-

+
nm_remote_settings_error_quark ()

+
GQuark
+nm_remote_settings_error_quark (void);

+
Registers an error quark for NMRemoteSettings if necessary.

+

+
Returns

+
 the error quark used for NMRemoteSettings errors.

+

 

-

-

-
NM_REMOTE_SETTINGS_NEW_CONNECTION

-
#define NM_REMOTE_SETTINGS_NEW_CONNECTION    "new-connection"
-

-

-

 

 

 

-
NM_REMOTE_SETTINGS_CONNECTIONS_READ

-
#define NM_REMOTE_SETTINGS_CONNECTIONS_READ  "connections-read"
-

+
NMRemoteSettingsAddConnectionFunc ()

+
void
+(*NMRemoteSettingsAddConnectionFunc) (NMRemoteSettings *settings,
+                                      NMRemoteConnection *connection,
+                                      GError *error,
+                                      gpointer user_data);

 

 

 

 

 

-
NMRemoteSettingsAddConnectionFunc ()

-
void                (*NMRemoteSettingsAddConnectionFunc)
-                                                        (NMRemoteSettings *settings,
-                                                         NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);

+
NMRemoteSettingsSaveHostnameFunc ()

+
void
+(*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
+                                     GError *error,
+                                     gpointer user_data);

 

 

 

 

 

-
NMRemoteSettingsSaveHostnameFunc ()

-
void                (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
-                                                         GError *error,
-                                                         gpointer user_data);

-

-

+
nm_remote_settings_new ()

+
NMRemoteSettings *
+nm_remote_settings_new (DBusGConnection *bus);

+
Creates a new object representing the remote settings service.

+
Note that this will do blocking D-Bus calls to initialize the
+settings object. You can use nm_remote_settings_new_async() if you
+want to avoid that.

+

+
Parameters

+

+++++
+
+
+
+
+
+





bus
 a valid and connected D-Bus connection. 
[allow-none]

 

-

-

-
struct NMRemoteSettings

-
struct NMRemoteSettings;

-

-

+

+
Returns

+
 the new remote settings object on success, or NULL on failure

+

 

-

-

-
struct NMRemoteSettingsClass

-
struct NMRemoteSettingsClass {
-	GObjectClass parent;
-
-	/* Signals */
-	void (*new_connection) (NMRemoteSettings *settings,
-	                        NMRemoteConnection *connection);
-
-	void (*connections_read) (NMRemoteSettings *settings);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-};
-

-

-

 

 

 

-
nm_remote_settings_new ()

-
NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);

-

-Creates a new object representing the remote settings service.
-

-

-Note that this will do blocking D-Bus calls to initialize the
-settings object. You can use nm_remote_settings_new_async() if you
-want to avoid that.
-

-

+
nm_remote_settings_new_async ()

+
void
+nm_remote_settings_new_async (DBusGConnection *bus,
+                              GCancellable *cancellable,
+                              GAsyncReadyCallback callback,
+                              gpointer user_data);

+
Creates a new object representing the remote settings service and
+begins asynchronously initializing it. callback
+ will be called
+when it is done; use nm_remote_settings_new_finish() to get the
+result.

+

+
Parameters

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

 





 
 
 
bus :
a valid and connected D-Bus connection. [allow-none]
-
bus
 a valid and connected D-Bus connection. 
[allow-none]
 

 
Returns :
the new remote settings object on success, or NULL on failure
cancellable
a GCancellable, or NULL
 
callback
callback to call when the settings object is created
 
user_data
data for callback
+
 
 

 
 

 

+

 

 

-
nm_remote_settings_new_async ()

-
void                nm_remote_settings_new_async        (DBusGConnection *bus,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

-

-Creates a new object representing the remote settings service and
-begins asynchronously initializing it. callback will be called
-when it is done; use nm_remote_settings_new_finish() to get the
-result.
-

-

+
nm_remote_settings_new_finish ()

+
NMRemoteSettings *
+nm_remote_settings_new_finish (GAsyncResult *result,
+                               GError **error);

+
Gets the result of an nm_remote_settings_new_async() call.

+

+
Parameters

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

 





 
 
 
bus :
a valid and connected D-Bus connection. [allow-none]
-
cancellable :
a GCancellable, or NULL
-
result
a GAsyncResult
 
 

 
callback :
callback to call when the settings object is created
user_data :
data for callback
-
error
location for a GError, or NULL
 
 

 
 

 

+

+
Returns

+
 a new NMRemoteSettings object, or NULL on error

+

+

+

 

 

-
nm_remote_settings_new_finish ()

-
NMRemoteSettings *  nm_remote_settings_new_finish       (GAsyncResult *result,
-                                                         GError **error);

-

-Gets the result of an nm_remote_settings_new_async() call.
-

-

+
nm_remote_settings_list_connections ()

+
GSList *
+nm_remote_settings_list_connections (NMRemoteSettings *settings);

+

+
Parameters

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

 





 
result :
a GAsyncResult
-
error :
location for a GError, or NULL
-
Returns :
a new NMRemoteSettings object, or NULL on error
settings
the NMRemoteSettings
 

 

 

+

+
Returns

+
 a
+list containing all connections provided by the remote settings service.
+Each element of the returned list is a NMRemoteConnection instance, which is
+owned by the NMRemoteSettings object and should not be freed by the caller.
+The returned list is, however, owned by the caller and should be freed
+using g_slist_free() when no longer required. 

+
[transfer container][element-type NMClient.RemoteConnection]

+

+

 

 

-
nm_remote_settings_list_connections ()

-
GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);

-

+
nm_remote_settings_get_connection_by_path ()

+
NMRemoteConnection *
+nm_remote_settings_get_connection_by_path
+                               (NMRemoteSettings *settings,
+                                const char *path);

+
Returns the NMRemoteConnection representing the connection at path
+.

+

+
Parameters

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

 





 
 
 
settings :
the NMRemoteSettings
-
settings
the NMRemoteSettings
 
 

 
Returns :
a
-list containing all connections provided by the remote settings service.
-Each element of the returned list is a NMRemoteConnection instance, which is
-owned by the NMRemoteSettings object and should not be freed by the caller.
-The returned list is, however, owned by the caller and should be freed
-using g_slist_free() when no longer required. [transfer container][element-type NMClient.RemoteConnection]
-
path
the D-Bus object path of the remote connection
 
 

 
 

 

+

+
Returns

+
 the remote connection object on success, or NULL if the object was
+not known. 

+
[transfer none]

+

+

 

 

-
nm_remote_settings_get_connection_by_path ()

-
NMRemoteConnection * nm_remote_settings_get_connection_by_path
-                                                        (NMRemoteSettings *settings,
-                                                         const char *path);

-

-Returns the NMRemoteConnection representing the connection at path.
-

-

+
nm_remote_settings_get_connection_by_uuid ()

+
NMRemoteConnection *
+nm_remote_settings_get_connection_by_uuid
+                               (NMRemoteSettings *settings,
+                                const char *uuid);

+
Returns the NMRemoteConnection identified by uuid
+.

+

+
Parameters

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

 





 
 
 
settings :
the NMRemoteSettings
-
path :
the D-Bus object path of the remote connection
settings
the NMRemoteSettings
 
 

 
Returns :
the remote connection object on success, or NULL if the object was
-not known. [transfer none]
-
uuid
the UUID of the remote connection
 
 

 
 

 

+

+
Returns

+
 the remote connection object on success, or NULL if the object was
+not known. 

+
[transfer none]

+

+

 

 

-
nm_remote_settings_get_connection_by_uuid ()

-
NMRemoteConnection * nm_remote_settings_get_connection_by_uuid
-                                                        (NMRemoteSettings *settings,
-                                                         const char *uuid);

-

-Returns the NMRemoteConnection identified by uuid.
-

-

+
nm_remote_settings_add_connection ()

+
gboolean
+nm_remote_settings_add_connection (NMRemoteSettings *settings,
+                                   NMConnection *connection,
+                                   NMRemoteSettingsAddConnectionFunc callback,
+                                   gpointer user_data);

+
Requests that the remote settings service add the given settings to a new
+connection.

+

+
Parameters

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

 





 
 
 
settings :
the NMRemoteSettings
-
settings
the NMRemoteSettings
 
 

 
uuid :
the UUID of the remote connection
connection
the connection to add. Note that this object's settings will be
+added, not the object itself
 
 

 
Returns :
the remote connection object on success, or NULL if the object was
-not known. [transfer none]
-
callback
 callback to be called when the add operation completes. 
[scope async]
user_data
 caller-specific data passed to callback
+. 
[closure]
 

 
 

 

+

+
Returns

+
 TRUE if the request was successful, FALSE if it failed

+

+

+
-

nm_remote_settings_add_connection ()

-
gboolean            nm_remote_settings_add_connection   (NMRemoteSettings *settings,
-                                                         NMConnection *connection,
-                                                         NMRemoteSettingsAddConnectionFunc callback,
-                                                         gpointer user_data);
-

-Requests that the remote settings service add the given settings to a new -connection. -

-
+

nm_remote_settings_save_hostname ()

+
gboolean
+nm_remote_settings_save_hostname (NMRemoteSettings *settings,
+                                  const char *hostname,
+                                  NMRemoteSettingsSaveHostnameFunc callback,
+                                  gpointer user_data);
+

Requests that the machine's persistent hostname be set to the specified value +or cleared.

+
+

Parameters

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

settings :

the NMRemoteSettings -

settings

the NMRemoteSettings

 

connection :

the connection to add. Note that this object's settings will be -added, not the object itself

hostname

the new persistent hostname to set, or NULL to clear any existing +persistent hostname

 

callback :

callback to be called when the add operation completes. [scope async] -

callback

callback to be called when the +hostname operation completes.

[scope async][allow-none]

user_data :

caller-specific data passed to callback. [closure] -

Returns :

TRUE if the request was successful, FALSE if it failed

user_data

caller-specific data passed to callback +.

[closure]
-
+
+

Returns

+

TRUE if the request was successful, FALSE if it failed

+

+
+
+
+
+

Types and Values

-

nm_remote_settings_save_hostname ()

-
gboolean            nm_remote_settings_save_hostname    (NMRemoteSettings *settings,
-                                                         const char *hostname,
-                                                         NMRemoteSettingsSaveHostnameFunc callback,
-                                                         gpointer user_data);
-

-Requests that the machine's persistent hostname be set to the specified value -or cleared. -

-
+

enum NMRemoteSettingsError

+

Describes errors that may result from operations involving a NMRemoteSettings.

+
+

Members

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

settings :

the NMRemoteSettings +

NM_REMOTE_SETTINGS_ERROR_UNKNOWN

 +

unknown or unclassified error

 

hostname :

the new persistent hostname to set, or NULL to clear any existing -persistent hostname

callback :

callback to be called when the -hostname operation completes. [scope async][allow-none] +

NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED

 +

the NMRemoteConnection object + was removed before it was completely initialized

 

user_data :

caller-specific data passed to callback. [closure] +

NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE

 +

the NMRemoteConnection object + is not visible or otherwise unreadable

Returns :

TRUE if the request was successful, FALSE if it failed 
+
+
+

NM_REMOTE_SETTINGS_ERROR

+
#define NM_REMOTE_SETTINGS_ERROR nm_remote_settings_error_quark ()
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_BUS

+
#define NM_REMOTE_SETTINGS_BUS             "bus"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_SERVICE_RUNNING

+
#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_HOSTNAME

+
#define NM_REMOTE_SETTINGS_HOSTNAME        "hostname"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_CAN_MODIFY

+
#define NM_REMOTE_SETTINGS_CAN_MODIFY      "can-modify"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_NEW_CONNECTION

+
#define NM_REMOTE_SETTINGS_NEW_CONNECTION    "new-connection"
+
+

+

+
+
+
+

NM_REMOTE_SETTINGS_CONNECTIONS_READ

+
#define NM_REMOTE_SETTINGS_CONNECTIONS_READ  "connections-read"
+
+

+

+
+

Property Details

-

The "bus" property

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

The “bus” property

+
  “bus”                      DBusGConnection *

DBusGConnection.

+

Flags: Read / Write / Construct Only

-

The "can-modify" property

-
  "can-modify"               gboolean              : Read
+

The “can-modify” property

+
  “can-modify”               gboolean

Can modify anything (hostname, connections, etc).

+

Flags: Read

Default value: FALSE

-

The "hostname" property

-
  "hostname"                 gchar*                : Read
+

The “hostname” property

+
  “hostname”                 gchar *

Persistent hostname.

+

Flags: Read

Default value: NULL

-

The "service-running" property

-
  "service-running"          gboolean              : Read
+

The “service-running” property

+
  “service-running”          gboolean

Is service running.

+

Flags: Read

Default value: FALSE

Signal Details

-

The "connections-read" signal

-
void                user_function                      (NMRemoteSettings *nmremotesettings,
-                                                        gpointer          user_data)             : Run First
-

-

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

nmremotesettings :

the object which received the signal.

user_data :

user data set when the signal handler was connected.
+

The “connections-read” signal

+
void
+user_function (NMRemoteSettings *nmremotesettings,
+               gpointer          user_data)
+

Flags: Run First

-

The "new-connection" signal

-
void                user_function                      (NMRemoteSettings *nmremotesettings,
-                                                        GObject          *arg1,
-                                                        gpointer          user_data)             : Run First
-

-

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

nmremotesettings :

the object which received the signal.

user_data :

user data set when the signal handler was connected.
+

The “new-connection” signal

+
void
+user_function (NMRemoteSettings *nmremotesettings,
+               GObject          *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