NMRemoteSettings

@@ -41,62 +41,149 @@

Synopsis

#define             NM_REMOTE_SETTINGS_BUS
-#define             NM_REMOTE_SETTINGS_SCOPE
+enum                NMRemoteSettingsError;
+#define             NM_TYPE_REMOTE_SETTINGS_ERROR
+#define             NM_REMOTE_SETTINGS_ERROR
+GQuark              nm_remote_settings_error_quark      (void);
+#define             NM_REMOTE_SETTINGS_BUS
 #define             NM_REMOTE_SETTINGS_SERVICE_RUNNING
-                    NMRemoteSettings;
-                    NMRemoteSettingsClass;
-NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus,
-                                                         NMConnectionScope scope);
+#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;
+GType               nm_remote_settings_get_type         (void);
+NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);
+GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);
+NMRemoteConnection *  nm_remote_settings_get_connection_by_path
+                                                        (NMRemoteSettings *settings,
+                                                         const char *path);
+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 - NMSettingsInterface.

Properties

   "bus"                      DBusGConnection*      : Read / Write / Construct Only
-  "scope"                    guint                 : 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

NM_REMOTE_SETTINGS_BUS

#define NM_REMOTE_SETTINGS_BUS "bus"
+
+enum NMRemoteSettingsError
+typedef enum {
+	NM_REMOTE_SETTINGS_ERROR_UNKNOWN = 0,
+	NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED,
+	NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE,
+} NMRemoteSettingsError;
 
 
+Describes errors that may result from operations involving a NMRemoteSettings.
 
+
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NM_REMOTE_SETTINGS_ERROR_UNKNOWN unknown or unclassified error
+
NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED the NMRemoteConnection object
+  was removed before it was completely initialized
+
NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE the NMRemoteConnection object
+  is not visible or otherwise unreadable
+
 
 
-
-NM_REMOTE_SETTINGS_SCOPE
-#define NM_REMOTE_SETTINGS_SCOPE "scope"
+
+NM_TYPE_REMOTE_SETTINGS_ERROR
+#define NM_TYPE_REMOTE_SETTINGS_ERROR (nm_remote_settings_error_get_type ()) 
 
 
 
 
 
-
+
+NM_REMOTE_SETTINGS_ERROR
+#define NM_REMOTE_SETTINGS_ERROR nm_remote_settings_error_quark ()
+
+
+
+
+
+
+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_BUS
+#define NM_REMOTE_SETTINGS_BUS             "bus"
+
+
+
+
+
+
 NM_REMOTE_SETTINGS_SERVICE_RUNNING
 #define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
 
@@ -104,18 +191,76 @@ NMRemoteSettings implements
 
 
 
-
-NMRemoteSettings
-typedef struct _NMRemoteSettings NMRemoteSettings;
+
+NM_REMOTE_SETTINGS_HOSTNAME
+#define NM_REMOTE_SETTINGS_HOSTNAME        "hostname"
+
 
 
 
 
-
-NMRemoteSettingsClass
-typedef struct {
+
+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"
+
+
+
+
+
+
+NMRemoteSettingsAddConnectionFunc ()
+void                (*NMRemoteSettingsAddConnectionFunc)
+                                                        (NMRemoteSettings *settings,
+                                                         NMRemoteConnection *connection,
+                                                         GError *error,
+                                                         gpointer user_data);
+
+
+
+
+
+NMRemoteSettingsSaveHostnameFunc ()
+void                (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
+                                                         GError *error,
+                                                         gpointer user_data);
+
+
+
+
+
+struct NMRemoteSettings
+struct NMRemoteSettings;
+
+
+
+
+
+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);
@@ -123,16 +268,22 @@ NMRemoteSettings implements
 	void (*_reserved4) (void);
 	void (*_reserved5) (void);
 	void (*_reserved6) (void);
-} NMRemoteSettingsClass;
+};
 
 
 
 
 
-
+
+nm_remote_settings_get_type ()
+GType               nm_remote_settings_get_type         (void);
+
+
+
+
+
 nm_remote_settings_new ()
-NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus,
-                                                         NMConnectionScope scope);
+NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);
 
 Creates a new object representing the remote settings service.
 
@@ -141,49 +292,231 @@ Creates a new object representing the remote settings service.
 
 
 bus :
-a valid and connected D-Bus connection
+a valid and connected D-Bus connection. [allow-none]
+
+
+
+Returns :
+the new remote settings object on success, or NULL on failure
+
+
+
+
+
+
+nm_remote_settings_list_connections ()
+GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);
+
++
+
+
+
+
+
+
+
+
+
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_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.
+
+
++
-
-
+
+
+
+
+
-

 scope : the settings service scope (either user or system)
+ settings : the NMRemoteSettings
 
 
 path : the D-Bus object path of the remote connection

 Returns :  the new remote settings object on success, or NULL on failure
+ the remote connection object on success, or NULL if the object was
+not known. [transfer none]
 
 
 
 
 
+
+
+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.
+
+
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
settings : the NMRemoteSettings
+
connection : the connection to add. Note that this object's settings will be
+added, not the object itself
callback : callback to be called when the add operation completes. [scope async]
+
user_data : caller-specific data passed to callback
+
Returns : TRUE if the request was successful, FALSE if it failed
 
-
+
+
+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.
+
+
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
settings : the NMRemoteSettings
+
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]
+
user_data : caller-specific data passed to callback
+
Returns : TRUE if the request was successful, FALSE if it failed
+
+
+
 Property Details
-
+
 The "bus" property
   "bus"                      DBusGConnection*      : Read / Write / Construct Only
 DBusGConnection.
 
 
-
-The "scope" property
-  "scope"                    guint                 : Read / Write / Construct Only
-NMConnection scope.
-Allowed values: <= 2
-Default value: 2
+
+The "can-modify" property
+  "can-modify"               gboolean              : Read
+Can modify anything (hostname, connections, etc).
+Default value: FALSE
 
 
-
+
+The "hostname" property
+  "hostname"                 gchar*                : Read
+Persistent hostname.
+Default value: NULL
+
+
+
 The "service-running" property
   "service-running"          gboolean              : Read
 Is service running.
 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 "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.
+
+
 
 
 
-          Generated by GTK-Doc V1.15
+          Generated by GTK-Doc V1.17
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5

`scope` :	the settings service scope (either user or system) +	`settings` :	the `NMRemoteSettings`
`path` :	the D-Bus object path of the remote connection
Returns :	the new remote settings object on success, or `NULL` on failure +	the remote connection object on success, or NULL if the object was +not known. [transfer none]

`settings` :	the `NMRemoteSettings` +
`connection` :	the connection to add. Note that this object's settings will be +added, not the object itself
`callback` :	callback to be called when the add operation completes. [scope async] +
`user_data` :	caller-specific data passed to `callback` +
Returns :	TRUE if the request was successful, FALSE if it failed

`settings` :	the `NMRemoteSettings` +
`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] +
`user_data` :	caller-specific data passed to `callback` +
Returns :	TRUE if the request was successful, FALSE if it failed

Synopsis

Object Hierarchy

Implemented Interfaces

Properties

Signals

Description

Details

NM_REMOTE_SETTINGS_BUS

enum NMRemoteSettingsError

NM_REMOTE_SETTINGS_SCOPE

NM_TYPE_REMOTE_SETTINGS_ERROR

NM_REMOTE_SETTINGS_ERROR

nm_remote_settings_error_quark ()

NM_REMOTE_SETTINGS_BUS

NM_REMOTE_SETTINGS_SERVICE_RUNNING

NMRemoteSettings

NM_REMOTE_SETTINGS_HOSTNAME

NMRemoteSettingsClass

NM_REMOTE_SETTINGS_CAN_MODIFY

NM_REMOTE_SETTINGS_NEW_CONNECTION

NM_REMOTE_SETTINGS_CONNECTIONS_READ

NMRemoteSettingsAddConnectionFunc ()

NMRemoteSettingsSaveHostnameFunc ()

struct NMRemoteSettings

struct NMRemoteSettingsClass

nm_remote_settings_get_type ()

nm_remote_settings_new ()

nm_remote_settings_list_connections ()

nm_remote_settings_get_connection_by_path ()

nm_remote_settings_add_connection ()

nm_remote_settings_save_hostname ()

Property Details

The `"bus"` property

The `"scope"` property

The `"can-modify"` property

The `"hostname"` property

The `"service-running"` property

Signal Details

The `"connections-read"` signal

The `"new-connection"` signal

				libnm-glib Reference Manual
Top @@ -27,12 +27,12 @@ \| Object Hierarchy \| - Implemented Interfaces - \| Properties + \| + Signals

`NM_REMOTE_SETTINGS_ERROR_UNKNOWN`	unknown or unclassified error +
`NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED`	the NMRemoteConnection object + was removed before it was completely initialized +
`NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE`	the NMRemoteConnection object + is not visible or otherwise unreadable +

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