Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm-glib/html/NMRemoteSettings.html | 198 ++++++++++++++--------------- 1 file changed, 99 insertions(+), 99 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 6b571ac3..b423de58 100644 --- a/docs/libnm-glib/html/NMRemoteSettings.html +++ b/docs/libnm-glib/html/NMRemoteSettings.html @@ -8,7 +8,7 @@ - + @@ -44,7 +44,7 @@ -GQuark +GQuark nm_remote_settings_error_quark () @@ -100,7 +100,7 @@ -GSList * +GSList * nm_remote_settings_list_connections () @@ -132,7 +132,7 @@ -gboolean +gboolean nm_remote_settings_add_connection () @@ -140,7 +140,7 @@ -gboolean +gboolean nm_remote_settings_add_connection_unsaved () @@ -148,7 +148,7 @@ -gboolean +gboolean nm_remote_settings_load_connections () @@ -156,7 +156,7 @@ -gboolean +gboolean nm_remote_settings_reload_connections () @@ -164,7 +164,7 @@ -gboolean +gboolean nm_remote_settings_save_hostname () @@ -184,23 +184,23 @@ -DBusGConnection * +DBusGConnection * bus Read / Write / Construct Only -gboolean +gboolean can-modify Read -gchar * +gchar * hostname Read -gboolean +gboolean service-running Read @@ -219,12 +219,12 @@ void connections-read -Run First +Run First void new-connection -Run First +Run First @@ -274,7 +274,7 @@

Object Hierarchy

    GObject
+    GObject
     ╰── NMRemoteSettings

@@ -284,13 +284,13 @@ which stores network configuration and allows authenticated clients to add, delete, and modify that configuration. The data required to connect to a specific network is called a "connection" and encapsulated by the -NMConnection object. Once a connection is known to NetworkManager, having +NMConnection object. Once a connection is known to NetworkManager, having either been added by a user or read from on-disk storage, the NMRemoteSettings object creates a NMRemoteConnection object which represents this stored connection. Use the NMRemoteConnection object to perform any operations like modification or deletion.

To add a new network connection to the NetworkManager settings service, first -build up a template NMConnection object. Since this connection is not yet +build up a template NMConnection object. Since this connection is not yet added to NetworkManager, it is known only to your program and is not yet an NMRemoteConnection. Then ask NMRemoteSettings to add your connection. When the connection is added successfully, the supplied callback is called @@ -366,15 +366,15 @@ the stored object known to NetworkManager.

gpointer user_data) { if (error) - g_print ("Error adding connection: %s", error->message); + g_print ("Error adding connection: %s", error->message); else { - g_print ("Added: %s\n", nm_connection_get_path (NM_CONNECTION (remote))); + g_print ("Added: %s\n", nm_connection_get_path (NM_CONNECTION (remote))); /* Use 'remote' with nm_remote_connection_commit_changes() to save * changes and nm_remote_connection_delete() to delete the connection */ } } -static gboolean +static gboolean add_wired_connection (const char *human_name) { NMConnection *connection; @@ -383,35 +383,35 @@ the stored object known to NetworkManager.

char *uuid; gboolean success; - connection = nm_connection_new (); + connection = nm_connection_new (); /* Build up the 'connection' setting */ - s_con = (NMSettingConnection *) nm_setting_connection_new (); - uuid = nm_utils_uuid_generate (); - g_object_set (G_OBJECT (s_con), - NM_SETTING_CONNECTION_UUID, uuid, - NM_SETTING_CONNECTION_ID, human_name, - NM_SETTING_CONNECTION_TYPE, NM_SETTING_WIRED_SETTING_NAME, - NULL); - g_free (uuid); - nm_connection_add_setting (connection, NM_SETTING (s_con)); + s_con = (NMSettingConnection *) nm_setting_connection_new (); + uuid = nm_utils_uuid_generate (); + g_object_set (G_OBJECT (s_con), + NM_SETTING_CONNECTION_UUID, uuid, + NM_SETTING_CONNECTION_ID, human_name, + NM_SETTING_CONNECTION_TYPE, NM_SETTING_WIRED_SETTING_NAME, + NULL); + g_free (uuid); + nm_connection_add_setting (connection, NM_SETTING (s_con)); /* Add the required 'wired' setting as this is a wired connection */ - nm_connection_add_setting (connection, nm_setting_wired_new ()); + nm_connection_add_setting (connection, nm_setting_wired_new ()); /* Add an 'ipv4' setting using AUTO configuration (eg DHCP) */ - s_ip4 = (NMSettingIP4Config *) nm_setting_ip4_config_new (); - g_object_set (G_OBJECT (s_ip4), - NM_SETTING_IP4_CONFIG_METHOD, NM_SETTING_IP4_CONFIG_METHOD_AUTO, - NULL); - nm_connection_add_setting (connection, NM_SETTING (s_ip4)); + s_ip4 = (NMSettingIP4Config *) nm_setting_ip4_config_new (); + g_object_set (G_OBJECT (s_ip4), + NM_SETTING_IP4_CONFIG_METHOD, NM_SETTING_IP4_CONFIG_METHOD_AUTO, + NULL); + nm_connection_add_setting (connection, NM_SETTING (s_ip4)); /* Ask NetworkManager to store the connection */ success = nm_remote_settings_add_connection (settings, connection, added_cb, loop); /* Release the template connection; the actual stored connection will * be returned in added_cb() */ - g_object_unref (connection); + g_object_unref (connection); /* Let glib event loop run and added_cb() will be called when NetworkManager * is done adding the new connection. */ @@ -429,7 +429,7 @@ the stored object known to NetworkManager.

Functions

nm_remote_settings_error_quark ()

GQuark
+GQuark
 nm_remote_settings_error_quark (void);
 Registers an error quark for NMRemoteSettings if necessary.
 
@@ -443,8 +443,8 @@ nm_remote_settings_error_quark (v
 void
 (*NMRemoteSettingsAddConnectionFunc) (NMRemoteSettings *settings,
                                       NMRemoteConnection *connection,
-                                      GError *error,
-                                      gpointer user_data);
+                                      GError *error,
+                                      gpointer user_data);

@@ -453,22 +453,22 @@ nm_remote_settings_error_quark (v (*NMRemoteSettingsLoadConnectionsFunc) (NMRemoteSettings *settings, char **failures, - GError *error, - gpointer user_data); + GError *error, + gpointer user_data); NMRemoteSettingsSaveHostnameFunc () void (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings, - GError *error, - gpointer user_data); + GError *error, + gpointer user_data); nm_remote_settings_new () NMRemoteSettings * -nm_remote_settings_new (DBusGConnection *bus); +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 @@ -490,17 +490,17 @@ want to avoid that. Returns - the new remote settings object on success, or NULL on failure + the new remote settings object on success, or NULL on failure nm_remote_settings_new_async () void -nm_remote_settings_new_async (DBusGConnection *bus, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); +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 @@ -522,7 +522,7 @@ result. cancellable -a GCancellable, or NULL +a GCancellable, or NULL @@ -544,8 +544,8 @@ result. nm_remote_settings_new_finish () NMRemoteSettings * -nm_remote_settings_new_finish (GAsyncResult *result, - GError **error); +nm_remote_settings_new_finish (GAsyncResult *result, + GError **error); Gets the result of an nm_remote_settings_new_async() call. Parameters @@ -558,12 +558,12 @@ nm_remote_settings_new_finish (result -a GAsyncResult +a GAsyncResult error -location for a GError, or NULL +location for a GError, or NULL @@ -571,13 +571,13 @@ nm_remote_settings_new_finish ( Returns - a new NMRemoteSettings object, or NULL on error + a new NMRemoteSettings object, or NULL on error nm_remote_settings_list_connections () -GSList * +GSList * nm_remote_settings_list_connections (NMRemoteSettings *settings); Parameters @@ -601,7 +601,7 @@ 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. +using g_slist_free() when no longer required. [transfer container][element-type NMRemoteConnection] @@ -638,7 +638,7 @@ nm_remote_settings_get_connection_by_id Returns -the remote connection object on success, or NULL if no + the remote connection object on success, or NULL if no matching object was found. [transfer none] @@ -677,7 +677,7 @@ nm_remote_settings_get_connection_by_path Returns -the remote connection object on success, or NULL if the object was + the remote connection object on success, or NULL if the object was not known. [transfer none] @@ -715,7 +715,7 @@ nm_remote_settings_get_connection_by_uuid Returns -the remote connection object on success, or NULL if the object was + the remote connection object on success, or NULL if the object was not known. [transfer none] @@ -723,11 +723,11 @@ not known. nm_remote_settings_add_connection () -gboolean +gboolean nm_remote_settings_add_connection (NMRemoteSettings *settings, - NMConnection *connection, + NMConnection *connection, NMRemoteSettingsAddConnectionFunc callback, - gpointer user_data); + gpointer user_data); Requests that the remote settings service add the given settings to a new connection. The connection is immediately written to disk. connection is @@ -776,18 +776,18 @@ added, not the object itself Returns - TRUE if the request was successful, FALSE if it failed + TRUE if the request was successful, FALSE if it failed nm_remote_settings_add_connection_unsaved () -gboolean +gboolean nm_remote_settings_add_connection_unsaved (NMRemoteSettings *settings, - NMConnection *connection, + NMConnection *connection, NMRemoteSettingsAddConnectionFunc callback, - gpointer user_data); + gpointer user_data); Requests that the remote settings service add the given settings to a new connection. The connection is not written to disk, which may be done at a later time by calling the connection's nm_remote_connection_commit_changes() @@ -828,29 +828,29 @@ added, not the object itself Returns - TRUE if the request was successful, FALSE if it failed + TRUE if the request was successful, FALSE if it failed Since: 0.9.10 nm_remote_settings_load_connections () -gboolean +gboolean nm_remote_settings_load_connections (NMRemoteSettings *settings, char **filenames, char ***failures, - GError **error); + GError **error); Requests that the remote settings service load or reload the given files, adding or updating the connections described within. The changes to the indicated files will not yet be reflected in settings 's connections array when the function returns. If all of the indicated files were successfully loaded, the -function will return TRUE, and failures - will be set to NULL. If +function will return TRUE, and failures + will be set to NULL. If NetworkManager tried to load the files, but some (or all) failed, then failures - will be set to a NULL-terminated array of the + will be set to a NULL-terminated array of the filenames that failed to load. Parameters @@ -868,18 +868,18 @@ filenames that failed to load. filenames -NULL-terminated array of filenames to load +NULL-terminated array of filenames to load failures -on return, a NULL-terminated array of + on return, a NULL-terminated array of filenames that failed to load. [out][transfer full] error -return location for GError +return location for GError @@ -887,18 +887,18 @@ filenames that failed to load. Returns - TRUE if NetworkManager at least tried to load filenames + TRUE if NetworkManager at least tried to load filenames , -FALSE if an error occurred (eg, permission denied). +FALSE if an error occurred (eg, permission denied). Since: 0.9.10 nm_remote_settings_reload_connections () -gboolean +gboolean nm_remote_settings_reload_connections (NMRemoteSettings *settings, - GError **error); + GError **error); Requests that the remote settings service reload all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state. @@ -918,7 +918,7 @@ the in-memory state matches the on-disk state. error -return location for GError +return location for GError @@ -926,18 +926,18 @@ the in-memory state matches the on-disk state. Returns - TRUE on success, FALSE on failure + TRUE on success, FALSE on failure Since: 0.9.10 nm_remote_settings_save_hostname () -gboolean +gboolean nm_remote_settings_save_hostname (NMRemoteSettings *settings, const char *hostname, NMRemoteSettingsSaveHostnameFunc callback, - gpointer user_data); + gpointer user_data); Requests that the machine's persistent hostname be set to the specified value or cleared. @@ -956,7 +956,7 @@ or cleared. hostname -the new persistent hostname to set, or NULL to clear any existing + the new persistent hostname to set, or NULL to clear any existing persistent hostname @@ -977,7 +977,7 @@ hostname operation completes. Returns - TRUE if the request was successful, FALSE if it failed + TRUE if the request was successful, FALSE if it failed @@ -1077,23 +1077,23 @@ hostname operation completes. Property Details The “bus” property - “bus” DBusGConnection * -The DBusGConnection that the NMRemoteSettings is connected to. Defaults + “bus” DBusGConnection * +The DBusGConnection that the NMRemoteSettings is connected to. Defaults to the system bus if not specified. Flags: Read / Write / Construct Only The “can-modify” property - “can-modify” gboolean -If TRUE, adding and modifying connections is supported. + “can-modify” gboolean +If TRUE, adding and modifying connections is supported. Flags: Read Default value: FALSE The “hostname” property - “hostname” gchar * + “hostname” gchar * The machine hostname stored in persistent configuration. This can be modified by calling nm_remote_settings_save_hostname(). Flags: Read @@ -1102,7 +1102,7 @@ modified by calling The “service-running” property - “service-running” gboolean + “service-running” gboolean Whether the settings service is running. Flags: Read Default value: FALSE @@ -1114,17 +1114,17 @@ modified by calling The “connections-read” signal void user_function (NMRemoteSettings *nmremotesettings, - gpointer user_data) -Flags: Run First + gpointer user_data) +Flags: Run First The “new-connection” signal void user_function (NMRemoteSettings *nmremotesettings, - GObject *arg1, - gpointer user_data) -Flags: Run First + GObject *arg1, + gpointer user_data) +Flags: Run First @@ -1133,6 +1133,6 @@ user_function ( - Generated by GTK-Doc V1.27 +Generated by GTK-Doc V1.28 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

Object Hierarchy

Functions

nm_remote_settings_error_quark ()

NMRemoteSettingsSaveHostnameFunc ()

nm_remote_settings_new ()

Returns

nm_remote_settings_new_async ()

nm_remote_settings_new_finish ()

Parameters

Returns

nm_remote_settings_list_connections ()

Parameters

Returns

Returns

Returns

nm_remote_settings_add_connection ()

Returns

nm_remote_settings_add_connection_unsaved ()

Returns

nm_remote_settings_load_connections ()

Parameters

Returns

nm_remote_settings_reload_connections ()

Returns

nm_remote_settings_save_hostname ()

Returns

Property Details

The `“bus”` property

The `“can-modify”` property

The `“hostname”` property

The `“service-running”` property

The `“connections-read”` signal

The `“new-connection”` signal