libnm Reference Manual: NMClient

From 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 14 Jul 2015 19:38:58 +0200 Subject: Imported Upstream version 1.0.4 --- docs/libnm/html/NMClient.html | 280 ++++++++++++++++++++++++++---------------- 1 file changed, 176 insertions(+), 104 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index b038c231..950d7251 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -2,13 +2,13 @@ -libnm Reference Manual: NMClient +NMClient: libnm Reference Manual - + @@ -759,8 +759,6 @@

Description

Functions

@@ -772,7 +770,6 @@ nm_client_error_quark (void Returns the error quark used for NMClient errors. -

@@ -810,7 +807,6 @@ that. Returns a new NMClient or NULL on an error - @@ -886,7 +882,6 @@ nm_client_new_finish (GAsyncResul Returns a new NMClient, or NULL on error - @@ -913,7 +908,6 @@ nm_client_get_version ( Returns string with the version (or NULL if NetworkManager is not running) - @@ -940,7 +934,6 @@ nm_client_get_state ( Returns the current NMState - @@ -968,7 +961,6 @@ connections at startup. Returns whether the daemon is still starting up - @@ -995,7 +987,6 @@ nm_client_get_nm_running ( Returns TRUE if the daemon is running - @@ -1022,7 +1013,6 @@ nm_client_networking_get_enabled ( Returns TRUE if networking is enabled, FALSE if networking is disabled - @@ -1065,7 +1055,6 @@ all controlled interfaces are available for activation. Returns TRUE on success, FALSE otherwise - @@ -1092,7 +1081,6 @@ nm_client_wireless_get_enabled ( Returns TRUE if wireless is enabled - @@ -1150,7 +1138,6 @@ nm_client_wireless_hardware_get_enabled Returns TRUE if the wireless hardware is enabled - @@ -1177,7 +1164,6 @@ nm_client_wwan_get_enabled ( Returns TRUE if WWAN is enabled - @@ -1234,7 +1220,6 @@ nm_client_wwan_hardware_get_enabled ( Returns TRUE if the WWAN hardware is enabled - @@ -1261,7 +1246,6 @@ nm_client_wimax_get_enabled ( Returns TRUE if WiMAX is enabled - @@ -1318,7 +1302,6 @@ nm_client_wimax_hardware_get_enabled ( Returns TRUE if the WiMAX hardware is enabled - @@ -1366,7 +1349,6 @@ a list of domains separated by ",". Returns TRUE on success, FALSE otherwise - @@ -1414,7 +1396,6 @@ domains separated by ",". (NULL or an empty string Returns TRUE on success, FALSE otherwise - @@ -1450,7 +1431,6 @@ client can or cannot perform the action the permission represents Returns the permission's result, one of NMClientPermissionResult - @@ -1480,7 +1460,6 @@ connectivity state first before returning any information. Returns the current connectivity state - @@ -1525,7 +1504,6 @@ if you do not want to block. Returns the (new) current connectivity state - @@ -1614,7 +1592,6 @@ call. Returns the (new) current connectivity state - @@ -1663,7 +1640,6 @@ clear any existing persistent hostname. Returns TRUE if the request was successful, FALSE if it failed - @@ -1755,7 +1731,6 @@ nm_client_save_hostname_finish ( Returns TRUE if the request was successful, FALSE if it failed - @@ -2256,7 +2231,6 @@ nm_client_deactivate_connection ( Returns success or failure - @@ -2347,7 +2321,6 @@ nm_client_deactivate_connection_finish Returns success or failure - @@ -2668,7 +2641,6 @@ filenames that failed to load. TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied). - @@ -2770,7 +2742,6 @@ filenames that failed to load. TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied). - @@ -2813,7 +2784,6 @@ the in-memory state matches the on-disk state. Returns TRUE on success, FALSE on failure - @@ -2899,7 +2869,6 @@ nm_client_reload_connections_finish ( Returns TRUE on success, FALSE on failure - @@ -2909,192 +2878,144 @@ nm_client_reload_connections_finish (NM_CLIENT_VERSION #define NM_CLIENT_VERSION "version" - - NM_CLIENT_STATE #define NM_CLIENT_STATE "state" - - NM_CLIENT_STARTUP #define NM_CLIENT_STARTUP "startup" - - NM_CLIENT_NM_RUNNING #define NM_CLIENT_NM_RUNNING "nm-running" - - NM_CLIENT_NETWORKING_ENABLED #define NM_CLIENT_NETWORKING_ENABLED "networking-enabled" - - NM_CLIENT_WIRELESS_ENABLED #define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled" - - NM_CLIENT_WIRELESS_HARDWARE_ENABLED #define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled" - - NM_CLIENT_WWAN_ENABLED #define NM_CLIENT_WWAN_ENABLED "wwan-enabled" - - NM_CLIENT_WWAN_HARDWARE_ENABLED #define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled" - - NM_CLIENT_WIMAX_ENABLED #define NM_CLIENT_WIMAX_ENABLED "wimax-enabled" - - NM_CLIENT_WIMAX_HARDWARE_ENABLED #define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled" - - NM_CLIENT_ACTIVE_CONNECTIONS #define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections" - - NM_CLIENT_CONNECTIVITY #define NM_CLIENT_CONNECTIVITY "connectivity" - - NM_CLIENT_PRIMARY_CONNECTION #define NM_CLIENT_PRIMARY_CONNECTION "primary-connection" - - NM_CLIENT_ACTIVATING_CONNECTION #define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection" - - NM_CLIENT_DEVICES #define NM_CLIENT_DEVICES "devices" - - NM_CLIENT_CONNECTIONS #define NM_CLIENT_CONNECTIONS "connections" - - NM_CLIENT_HOSTNAME #define NM_CLIENT_HOSTNAME "hostname" - - NM_CLIENT_CAN_MODIFY #define NM_CLIENT_CAN_MODIFY "can-modify" - - NM_CLIENT_DEVICE_ADDED #define NM_CLIENT_DEVICE_ADDED "device-added" - - NM_CLIENT_DEVICE_REMOVED #define NM_CLIENT_DEVICE_REMOVED "device-removed" - - NM_CLIENT_PERMISSION_CHANGED #define NM_CLIENT_PERMISSION_CHANGED "permission-changed" - - NM_CLIENT_CONNECTION_ADDED #define NM_CLIENT_CONNECTION_ADDED "connection-added" - - NM_CLIENT_CONNECTION_REMOVED #define NM_CLIENT_CONNECTION_REMOVED "connection-removed" - - @@ -3313,8 +3234,6 @@ the user requires to obtain a given NM_CLIENT_ERROR #define NM_CLIENT_ERROR nm_client_error_quark () - - @@ -3322,21 +3241,23 @@ the user requires to obtain a given The “activating-connection” property “activating-connection” NMActiveConnection * - +The NMActiveConnection of the activating connection that is +likely to become the new “primary-connection”. Flags: Read The “active-connections” property “active-connections” GPtrArray * - +The active connections. +Element-type: NMActiveConnection Flags: Read The “can-modify” property “can-modify” gboolean - +If TRUE, adding and modifying connections is supported. Flags: Read Default value: FALSE @@ -3344,14 +3265,18 @@ the user requires to obtain a given The “connections” property “connections” GPtrArray * - +The list of configured connections that are available to the user. (Note +that this differs from the underlying D-Bus property, which may also +contain the object paths of connections that the user does not have +permission to read the details of.) +Element-type: NMRemoteConnection Flags: Read The “connectivity” property “connectivity” NMConnectivityState - +The network connectivity state. Flags: Read Default value: NM_CONNECTIVITY_UNKNOWN @@ -3359,14 +3284,16 @@ the user requires to obtain a given The “devices” property “devices” GPtrArray * - +List of known network devices. +Element-type: NMDevice Flags: Read The “hostname” property “hostname” gchar * - +The machine hostname stored in persistent configuration. This can be +modified by calling nm_client_save_hostname(). Flags: Read Default value: NULL @@ -3374,7 +3301,7 @@ the user requires to obtain a given The “networking-enabled” property “networking-enabled” gboolean - +Whether networking is enabled. Flags: Read / Write Default value: TRUE @@ -3382,7 +3309,7 @@ the user requires to obtain a given The “nm-running” property “nm-running” gboolean - +Whether the daemon is running. Flags: Read Default value: FALSE @@ -3390,14 +3317,15 @@ the user requires to obtain a given The “primary-connection” property “primary-connection” NMActiveConnection * - +The NMActiveConnection of the device with the default route; +see nm_client_get_primary_connection() for more details. Flags: Read The “startup” property “startup” gboolean - +Whether the daemon is still starting up. Flags: Read Default value: FALSE @@ -3405,7 +3333,7 @@ the user requires to obtain a given The “state” property “state” NMState - +The current daemon state. Flags: Read Default value: NM_STATE_UNKNOWN @@ -3413,7 +3341,7 @@ the user requires to obtain a given The “version” property “version” gchar * - +The NetworkManager version. Flags: Read Default value: NULL @@ -3421,7 +3349,7 @@ the user requires to obtain a given The “wimax-enabled” property “wimax-enabled” gboolean - +Whether WiMAX functionality is enabled. Flags: Read / Write Default value: FALSE @@ -3429,7 +3357,7 @@ the user requires to obtain a given The “wimax-hardware-enabled” property “wimax-hardware-enabled” gboolean - +Whether the WiMAX hardware is enabled. Flags: Read Default value: FALSE @@ -3437,7 +3365,7 @@ the user requires to obtain a given The “wireless-enabled” property “wireless-enabled” gboolean - +Whether wireless is enabled. Flags: Read / Write Default value: FALSE @@ -3445,7 +3373,7 @@ the user requires to obtain a given The “wireless-hardware-enabled” property “wireless-hardware-enabled” gboolean - +Whether the wireless hardware is enabled. Flags: Read Default value: TRUE @@ -3453,7 +3381,7 @@ the user requires to obtain a given The “wwan-enabled” property “wwan-enabled” gboolean - +Whether WWAN functionality is enabled. Flags: Read / Write Default value: FALSE @@ -3461,7 +3389,7 @@ the user requires to obtain a given The “wwan-hardware-enabled” property “wwan-hardware-enabled” gboolean - +Whether the WWAN hardware is enabled. Flags: Read Default value: FALSE @@ -3474,6 +3402,34 @@ the user requires to obtain a given NMClient *client, NMRemoteConnection *connection, gpointer user_data) +Notifies that a NMConnection has been added. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the settings object that received the signal connection the new connection user_data user data set when the signal handler was connected. + Flags: Run First @@ -3483,6 +3439,34 @@ user_function (NMClient *client, NMRemoteConnection *connection, gpointer user_data) +Notifies that a NMConnection has been removed. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the settings object that received the signal connection the removed connection user_data user data set when the signal handler was connected. + Flags: Run First @@ -3492,6 +3476,34 @@ user_function (NMClient *client, GObject *device, gpointer user_data) +Notifies that a NMDevice is added. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the client that received the signal device the new device. [type NMDevice] user_data user data set when the signal handler was connected. + Flags: Run First @@ -3501,6 +3513,34 @@ user_function (NMClient *client, GObject *device, gpointer user_data) +Notifies that a NMDevice is removed. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the client that received the signal device the removed device. [type NMDevice] user_data user data set when the signal handler was connected. + Flags: Run First @@ -3511,12 +3551,44 @@ user_function (guint permission, guint result, gpointer user_data) +Notifies that a permission has changed + +Parameters + +++++ + + + + + + + + + + + + + + + + + + + + + + + client the client that received the signal permission a permission from NMClientPermission result the permission's result, one of NMClientPermissionResult user_data user data set when the signal handler was connected. + Flags: Run First - - Generated by GTK-Doc V1.21 +Generated by GTK-Doc V1.24 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

client	the settings object that received the signal
connection	the new connection
user_data	user data set when the signal handler was connected.

client	the client that received the signal
device	the new device.	[type NMDevice]
user_data	user data set when the signal handler was connected.

client	the client that received the signal
permission	a permission from NMClientPermission
result	the permission's result, one of NMClientPermissionResult
user_data	user data set when the signal handler was connected.