From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-glib/html/NMClient.html | 3320 ++++++++++++++++++++---------------- 1 file changed, 1825 insertions(+), 1495 deletions(-) (limited to 'docs/libnm-glib/html/NMClient.html') diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html index b28d9ed5..23eca511 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -2,38 +2,29 @@ -NMClient +libnm-glib Reference Manual: NMClient - + - - - - - - - - - - + + + + + + +
@@ -41,160 +32,540 @@

NMClient

NMClient

- +
-
-

Synopsis

-
#define             NM_CLIENT_VERSION
-#define             NM_CLIENT_STATE
-#define             NM_CLIENT_STARTUP
-#define             NM_CLIENT_MANAGER_RUNNING
-#define             NM_CLIENT_NETWORKING_ENABLED
-#define             NM_CLIENT_WIRELESS_ENABLED
-#define             NM_CLIENT_WIRELESS_HARDWARE_ENABLED
-#define             NM_CLIENT_WWAN_ENABLED
-#define             NM_CLIENT_WWAN_HARDWARE_ENABLED
-#define             NM_CLIENT_WIMAX_ENABLED
-#define             NM_CLIENT_WIMAX_HARDWARE_ENABLED
-#define             NM_CLIENT_ACTIVE_CONNECTIONS
-#define             NM_CLIENT_CONNECTIVITY
-#define             NM_CLIENT_PRIMARY_CONNECTION
-#define             NM_CLIENT_ACTIVATING_CONNECTION
-#define             NM_CLIENT_DEVICES
-enum                NMClientPermission;
-enum                NMClientPermissionResult;
-enum                NMClientError;
-#define             NM_CLIENT_ERROR
-GQuark              nm_client_error_quark               (void);
-                    NMClient;
-                    NMClientClass;
-NMClient *          nm_client_new                       (void);
-void                nm_client_new_async                 (GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMClient *          nm_client_new_finish                (GAsyncResult *result,
-                                                         GError **error);
-const GPtrArray *   nm_client_get_devices               (NMClient *client);
-NMDevice *          nm_client_get_device_by_path        (NMClient *client,
-                                                         const char *object_path);
-NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
-                                                         const char *iface);
-void                (*NMClientActivateFn)               (NMClient *client,
-                                                         NMActiveConnection *active_connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_client_activate_connection       (NMClient *client,
-                                                         NMConnection *connection,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientActivateFn callback,
-                                                         gpointer user_data);
-void                (*NMClientAddActivateFn)            (NMClient *client,
-                                                         NMActiveConnection *connection,
-                                                         const char *new_connection_path,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_client_add_and_activate_connection
-                                                        (NMClient *client,
-                                                         NMConnection *partial,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientAddActivateFn callback,
-                                                         gpointer user_data);
-void                nm_client_deactivate_connection     (NMClient *client,
-                                                         NMActiveConnection *active);
-gboolean            nm_client_networking_get_enabled    (NMClient *client);
-void                nm_client_networking_set_enabled    (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wireless_get_enabled      (NMClient *client);
-void                nm_client_wireless_set_enabled      (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wireless_hardware_get_enabled
-                                                        (NMClient *client);
-gboolean            nm_client_wwan_get_enabled          (NMClient *client);
-void                nm_client_wwan_set_enabled          (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
-gboolean            nm_client_wimax_get_enabled         (NMClient *client);
-void                nm_client_wimax_set_enabled         (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);
-const char *        nm_client_get_version               (NMClient *client);
-NMState             nm_client_get_state                 (NMClient *client);
-gboolean            nm_client_get_startup               (NMClient *client);
-gboolean            nm_client_get_manager_running       (NMClient *client);
-const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
-void                nm_client_sleep                     (NMClient *client,
-                                                         gboolean sleep_);
-NMClientPermissionResult nm_client_get_permission_result
-                                                        (NMClient *client,
-                                                         NMClientPermission permission);
-gboolean            nm_client_get_logging               (NMClient *client,
-                                                         char **level,
-                                                         char **domains,
-                                                         GError **error);
-gboolean            nm_client_set_logging               (NMClient *client,
-                                                         const char *level,
-                                                         const char *domains,
-                                                         GError **error);
-NMConnectivityState nm_client_get_connectivity          (NMClient *client);
-NMConnectivityState nm_client_check_connectivity        (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GError **error);
-void                nm_client_check_connectivity_async  (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);
-NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);
-NMActiveConnection * nm_client_get_activating_connection
-                                                        (NMClient *client);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_client_error_quark () +
+NMClient * + +nm_client_new () +
+void + +nm_client_new_async () +
+NMClient * + +nm_client_new_finish () +
const GPtrArray * + +nm_client_get_devices () +
+NMDevice * + +nm_client_get_device_by_path () +
+NMDevice * + +nm_client_get_device_by_iface () +
+void + +(*NMClientActivateFn) () +
+void + +nm_client_activate_connection () +
+void + +(*NMClientAddActivateFn) () +
+void + +nm_client_add_and_activate_connection () +
+void + +nm_client_deactivate_connection () +
+gboolean + +nm_client_networking_get_enabled () +
+void + +nm_client_networking_set_enabled () +
+gboolean + +nm_client_wireless_get_enabled () +
+void + +nm_client_wireless_set_enabled () +
+gboolean + +nm_client_wireless_hardware_get_enabled () +
+gboolean + +nm_client_wwan_get_enabled () +
+void + +nm_client_wwan_set_enabled () +
+gboolean + +nm_client_wwan_hardware_get_enabled () +
+gboolean + +nm_client_wimax_get_enabled () +
+void + +nm_client_wimax_set_enabled () +
+gboolean + +nm_client_wimax_hardware_get_enabled () +
const char * + +nm_client_get_version () +
+NMState + +nm_client_get_state () +
+gboolean + +nm_client_get_startup () +
+gboolean + +nm_client_get_manager_running () +
const GPtrArray * + +nm_client_get_active_connections () +
+void + +nm_client_sleep () +
+NMClientPermissionResult + +nm_client_get_permission_result () +
+gboolean + +nm_client_get_logging () +
+gboolean + +nm_client_set_logging () +
+NMConnectivityState + +nm_client_get_connectivity () +
+NMConnectivityState + +nm_client_check_connectivity () +
+void + +nm_client_check_connectivity_async () +
+NMConnectivityState + +nm_client_check_connectivity_finish () +
+NMActiveConnection * + +nm_client_get_primary_connection () +
+NMActiveConnection * + +nm_client_get_activating_connection () +
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMClient
-
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMActiveConnection *activating-connectionRead
+NMObjectArray *active-connectionsRead
guintconnectivityRead
+NMObjectArray *devicesRead
gbooleanmanager-runningRead
gbooleannetworking-enabledRead / Write
+NMActiveConnection *primary-connectionRead
gbooleanstartupRead
guintstateRead
+gchar *versionRead
gbooleanwimax-enabledRead / Write
gbooleanwimax-hardware-enabledRead
gbooleanwireless-enabledRead / Write
gbooleanwireless-hardware-enabledRead
gbooleanwwan-enabledRead / Write
gbooleanwwan-hardware-enabledRead
-

Implemented Interfaces

-

-NMClient implements - GInitable and GAsyncInitable.

+

Signals

+
+++++ + + + + + + + + + + + + + + + + + +
voiddevice-addedRun First
voiddevice-removedRun First
voidpermission-changedRun First
-

Properties

-
-  "activating-connection"    NMActiveConnection*   : Read
-  "active-connections"       NMObjectArray*        : Read
-  "connectivity"             guint                 : Read
-  "devices"                  NMObjectArray*        : Read
-  "manager-running"          gboolean              : Read
-  "networking-enabled"       gboolean              : Read / Write
-  "primary-connection"       NMActiveConnection*   : Read
-  "startup"                  gboolean              : Read
-  "state"                    guint                 : Read
-  "version"                  gchar*                : Read
-  "wimax-enabled"            gboolean              : Read / Write
-  "wimax-hardware-enabled"   gboolean              : Read
-  "wireless-enabled"         gboolean              : Read / Write
-  "wireless-hardware-enabled" gboolean              : Read
-  "wwan-enabled"             gboolean              : Read / Write
-  "wwan-hardware-enabled"    gboolean              : Read
-
+

Types and Values

+
-

Signals

-
-  "device-added"                                   : Run First
-  "device-removed"                                 : Run First
-  "permission-changed"                             : Run First
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMClient
 
@@ -203,1819 +574,1778 @@ NMClient implements

-

Details

+

Functions

-

NM_CLIENT_VERSION

-
#define NM_CLIENT_VERSION "version"
-
-

-

+

nm_client_error_quark ()

+
GQuark
+nm_client_error_quark (void);
+

Registers an error quark for NMClient if necessary.

+
+

Returns

+

the error quark used for NMClient errors.

+

-
-
-

NM_CLIENT_STATE

-
#define NM_CLIENT_STATE "state"
-
-

-

+

Since 0.9.10


-

NM_CLIENT_STARTUP

-
#define NM_CLIENT_STARTUP "startup"
-
-

-

+

nm_client_new ()

+
NMClient *
+nm_client_new (void);
+

Creates a new NMClient.

+

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

+

NOTE: NMClient provides information about devices and a mechanism to +control them. To access and modify network configuration data, use the +NMRemoteSettings object.

+
+

Returns

+

a new NMClient or NULL on an error

+

+
+
+
+
+

nm_client_new_async ()

+
void
+nm_client_new_async (GCancellable *cancellable,
+                     GAsyncReadyCallback callback,
+                     gpointer user_data);
+

Creates a new NMClient and begins asynchronously initializing it. +callback + will be called when it is done; use +nm_client_new_finish() to get the result. Note that on an error, +the callback can be invoked with two first parameters as NULL.

+

NOTE: NMClient provides information about devices and a mechanism to +control them. To access and modify network configuration data, use the +NMRemoteSettings object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

cancellable

a GCancellable, or NULL

 

callback

callback to call when the client is created

 

user_data

data for callback +

 
-
-
-

NM_CLIENT_MANAGER_RUNNING

-
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
-
-

-


-

NM_CLIENT_NETWORKING_ENABLED

-
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
-
-

-

+

nm_client_new_finish ()

+
NMClient *
+nm_client_new_finish (GAsyncResult *result,
+                      GError **error);
+

Gets the result of an nm_client_new_async() call.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

result

a GAsyncResult

 

error

location for a GError, or NULL

 
-
-
-

NM_CLIENT_WIRELESS_ENABLED

-
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
-
-

-

+
+

Returns

+

a new NMClient, or NULL on error

+

-
-
-

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

+
const GPtrArray *
+nm_client_get_devices (NMClient *client);
+

Gets all the known network devices. Use nm_device_get_type() or the +NM_IS_DEVICE_XXXX functions to determine what kind of +device member of the returned array is, and then you may use device-specific +methods such as nm_device_ethernet_get_hw_address().

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
-
-
-

NM_CLIENT_WWAN_HARDWARE_ENABLED

-
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
-
-

-

+
+

Returns

+

a GPtrArray +containing all the NMDevices. The returned array is owned by the +NMClient object and should not be modified.

+

[transfer none][element-type NMDevice]

-
-
-

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

+
NMDevice *
+nm_client_get_device_by_path (NMClient *client,
+                              const char *object_path);
+

Gets a NMDevice from a NMClient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

client

a NMClient

 

object_path

the object path to search for

 
-
-
-

NM_CLIENT_ACTIVE_CONNECTIONS

-
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
-
-

-

+
+

Returns

+

the NMDevice for the given object_path +or NULL if none is found.

+

[transfer none]

-
-
-

NM_CLIENT_CONNECTIVITY

-
#define NM_CLIENT_CONNECTIVITY "connectivity"
-
-

-


-

NM_CLIENT_PRIMARY_CONNECTION

-
#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
-
-

-

+

nm_client_get_device_by_iface ()

+
NMDevice *
+nm_client_get_device_by_iface (NMClient *client,
+                               const char *iface);
+

Gets a NMDevice from a NMClient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

client

a NMClient

 

iface

the interface name to search for

 
+
+
+

Returns

+

the NMDevice for the given iface +or NULL if none is found.

+

[transfer none]

-
-
-

NM_CLIENT_ACTIVATING_CONNECTION

-
#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
-
-

-


-

NM_CLIENT_DEVICES

-
#define NM_CLIENT_DEVICES "devices"
-
+

NMClientActivateFn ()

+
void
+(*NMClientActivateFn) (NMClient *client,
+                       NMActiveConnection *active_connection,
+                       GError *error,
+                       gpointer user_data);


-

enum NMClientPermission

-
typedef enum {
-	NM_CLIENT_PERMISSION_NONE = 0,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK = 1,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI = 2,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN = 3,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX = 4,
-	NM_CLIENT_PERMISSION_SLEEP_WAKE = 5,
-	NM_CLIENT_PERMISSION_NETWORK_CONTROL = 6,
-	NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED = 7,
-	NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN = 8,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM = 9,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN = 10,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME = 11,
-
-	NM_CLIENT_PERMISSION_LAST = NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME
-} NMClientPermission;
-
-

-NMClientPermission values indicate various permissions that NetworkManager -clients can obtain to perform certain tasks on behalf of the current user. -

-
+

nm_client_activate_connection ()

+
void
+nm_client_activate_connection (NMClient *client,
+                               NMConnection *connection,
+                               NMDevice *device,
+                               const char *specific_object,
+                               NMClientActivateFn callback,
+                               gpointer user_data);
+

Starts a connection to a particular network using the configuration settings +from connection + and the network device device +. Certain connection types +also take a "specific object" which is the object path of a connection- +specific object, like an NMAccessPoint for Wi-Fi connections, or an +NMWimaxNsp for WiMAX connections, to which you wish to connect. If the +specific object is not given, NetworkManager can, in some cases, automatically +determine which network to connect to given the settings in connection +.

+

If connection + is not given for a device-based activation, NetworkManager +picks the best available connection for the device and activates it.

+

Note that the callback is invoked when NetworkManager has started activating +the new connection, not when it finishes. You can used the returned +NMActiveConnection object (in particular, “state”) to +track the activation to its completion.

+
+

Parameters

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

NM_CLIENT_PERMISSION_NONE

unknown or no permission -

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

controls whether networking - can be globally enabled or disabled -

client

a NMClient

 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

controls whether Wi-Fi can be - globally enabled or disabled -

connection

an NMConnection.

[allow-none]

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

controls whether WWAN (3G) can be - globally enabled or disabled -

device

the NMDevice.

[allow-none]

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

controls whether WiMAX can be - globally enabled or disabled -

specific_object

the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of NULL should be used +(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by device +, which you can +get using nm_object_get_path(), and which will be used to complete the +details of the newly added connection.

[allow-none]

NM_CLIENT_PERMISSION_SLEEP_WAKE

controls whether the client can ask - NetworkManager to sleep and wake -

callback

the function to call when the call is done.

[scope async][allow-none]

NM_CLIENT_PERMISSION_NETWORK_CONTROL

controls whether networking connections - can be started, stopped, and changed -

user_data

user data to pass to the callback function.

[closure]
+
+
+
+
+

NMClientAddActivateFn ()

+
void
+(*NMClientAddActivateFn) (NMClient *client,
+                          NMActiveConnection *connection,
+                          const char *new_connection_path,
+                          GError *error,
+                          gpointer user_data);
+

+

+
+
+
+

nm_client_add_and_activate_connection ()

+
void
+nm_client_add_and_activate_connection (NMClient *client,
+                                       NMConnection *partial,
+                                       NMDevice *device,
+                                       const char *specific_object,
+                                       NMClientAddActivateFn callback,
+                                       gpointer user_data);
+

Adds a new connection using the given details (if any) as a template, +automatically filling in missing settings with the capabilities of the +given device and specific object. The new connection is then activated. +Cannot be used for VPN connections at this time.

+

Note that the callback is invoked when NetworkManager has started activating +the new connection, not when it finishes. You can used the returned +NMActiveConnection object (in particular, “state”) to +track the activation to its completion.

+
+

Parameters

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

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

controls whether a password - protected Wi-Fi hotspot can be created -

client

a NMClient

 

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

controls whether an open Wi-Fi hotspot - can be created -

partial

an NMConnection to add; the connection may be +partially filled (or even NULL) and will be completed by NetworkManager +using the given device +and specific_object +before being added.

[allow-none]

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

controls whether connections - that are available to all users can be modified -

device

the NMDevice

 

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN

controls whether connections - owned by the current user can be modified -

specific_object

the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of NULL should be used +(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by device +, which you can +get using nm_object_get_path(), and which will be used to complete the +details of the newly added connection.

[allow-none]

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

controls whether the - persistent hostname can be changed -

callback

the function to call when the call is done.

[scope async][allow-none]

NM_CLIENT_PERMISSION_LAST

a reserved boundary value -

user_data

user data to pass to the callback function.

[closure]
+

-

enum NMClientPermissionResult

-
typedef enum {
-	NM_CLIENT_PERMISSION_RESULT_UNKNOWN = 0,
-	NM_CLIENT_PERMISSION_RESULT_YES,
-	NM_CLIENT_PERMISSION_RESULT_AUTH,
-	NM_CLIENT_PERMISSION_RESULT_NO
-} NMClientPermissionResult;
-
-

-NMClientPermissionResult values indicate what authorizations and permissions -the user requires to obtain a given NMClientPermission -

-
+

nm_client_deactivate_connection ()

+
void
+nm_client_deactivate_connection (NMClient *client,
+                                 NMActiveConnection *active);
+

Deactivates an active NMActiveConnection.

+
+

Parameters

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

NM_CLIENT_PERMISSION_RESULT_UNKNOWN

unknown or no authorization -

NM_CLIENT_PERMISSION_RESULT_YES

the permission is available -

NM_CLIENT_PERMISSION_RESULT_AUTH

authorization is necessary before the - permission is available -

client

a NMClient

 

NM_CLIENT_PERMISSION_RESULT_NO

permission to perform the operation is - denied by system policy -

active

the NMActiveConnection to deactivate

 
+

-

enum NMClientError

-
typedef enum {
-	NM_CLIENT_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_CLIENT_ERROR_MANAGER_NOT_RUNNING,    /*< nick=ManagerNotRunning >*/
-} NMClientError;
-
-

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

-
+

nm_client_networking_get_enabled ()

+
gboolean
+nm_client_networking_get_enabled (NMClient *client);
+

Whether networking is enabled or disabled.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

TRUE if networking is enabled, FALSE if networking is disabled

+

+
+
+
+
+

nm_client_networking_set_enabled ()

+
void
+nm_client_networking_set_enabled (NMClient *client,
+                                  gboolean enabled);
+

Enables or disables networking. When networking is disabled, all controlled +interfaces are disconnected and deactivated. When networking is enabled, +all controlled interfaces are available for activation.

+
+

Parameters

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

NM_CLIENT_ERROR_UNKNOWN

unknown or unclassified error -

client

a NMClient

 

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

an operation that requires NetworkManager - failed because NetworkManager is not running -

enabled

TRUE to set networking enabled, FALSE to set networking disabled

 
-
-
-

NM_CLIENT_ERROR

-
#define NM_CLIENT_ERROR nm_client_error_quark ()
-
-

-


-

nm_client_error_quark ()

-
GQuark              nm_client_error_quark               (void);
-

-Registers an error quark for NMClient if necessary. -

-
+

nm_client_wireless_get_enabled ()

+
gboolean
+nm_client_wireless_get_enabled (NMClient *client);
+

Determines whether the wireless is enabled.

+
+

Parameters

+
--+++ - - + + +

Returns :

the error quark used for NMClient errors.

client

a NMClient

 
-

Since 0.9.10

+
+
+

Returns

+

TRUE if wireless is enabled

+

+

-

NMClient

-
typedef struct _NMClient NMClient;
-

-

+

nm_client_wireless_set_enabled ()

+
void
+nm_client_wireless_set_enabled (NMClient *client,
+                                gboolean enabled);
+

Enables or disables wireless devices.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

client

a NMClient

 

enabled

TRUE to enable wireless

 
+

-

NMClientClass

-
typedef struct {
-	NMObjectClass parent;
-
-	/* Signals */
-	void (*device_added) (NMClient *client, NMDevice *device);
-	void (*device_removed) (NMClient *client, NMDevice *device);
-	void (*permission_changed) (NMClient *client,
-	                            NMClientPermission permission,
-	                            NMClientPermissionResult result);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMClientClass;
-
-

-

+

nm_client_wireless_hardware_get_enabled ()

+
gboolean
+nm_client_wireless_hardware_get_enabled
+                               (NMClient *client);
+

Determines whether the wireless hardware is enabled.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

TRUE if the wireless hardware is enabled

+

+

-

nm_client_new ()

-
NMClient *          nm_client_new                       (void);
-

-Creates a new NMClient. -

-

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

-

-NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object. -

-
+

nm_client_wwan_get_enabled ()

+
gboolean
+nm_client_wwan_get_enabled (NMClient *client);
+

Determines whether WWAN is enabled.

+
+

Parameters

+
--+++ - - + + +

Returns :

a new NMClient or NULL on an error

client

a NMClient

 
+
+

Returns

+

TRUE if WWAN is enabled

+

+
+

-

nm_client_new_async ()

-
void                nm_client_new_async                 (GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-

-Creates a new NMClient and begins asynchronously initializing it. -callback will be called when it is done; use -nm_client_new_finish() to get the result. Note that on an error, -the callback can be invoked with two first parameters as NULL. -

-

-NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object. -

-
+

nm_client_wwan_set_enabled ()

+
void
+nm_client_wwan_set_enabled (NMClient *client,
+                            gboolean enabled);
+

Enables or disables WWAN devices.

+
+

Parameters

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

cancellable :

a GCancellable, or NULL -

callback :

callback to call when the client is created

client

a NMClient

 

user_data :

data for callback -

enabled

TRUE to enable WWAN

 
+

-

nm_client_new_finish ()

-
NMClient *          nm_client_new_finish                (GAsyncResult *result,
-                                                         GError **error);
-

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

-
+

nm_client_wwan_hardware_get_enabled ()

+
gboolean
+nm_client_wwan_hardware_get_enabled (NMClient *client);
+

Determines whether the WWAN hardware is enabled.

+
+

Parameters

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

result :

a GAsyncResult -

error :

location for a GError, or NULL -

Returns :

a new NMClient, or NULL on error

client

a NMClient

 
+
+

Returns

+

TRUE if the WWAN hardware is enabled

+

+
+

-

nm_client_get_devices ()

-
const GPtrArray *   nm_client_get_devices               (NMClient *client);
-

-Gets all the known network devices. Use nm_device_get_type() or the -NM_IS_DEVICE_XXXX functions to determine what kind of -device member of the returned array is, and then you may use device-specific -methods such as nm_device_ethernet_get_hw_address(). -

-
+

nm_client_wimax_get_enabled ()

+
gboolean
+nm_client_wimax_get_enabled (NMClient *client);
+

Determines whether WiMAX is enabled.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

TRUE if WiMAX is enabled

+

+
+
+
+
+

nm_client_wimax_set_enabled ()

+
void
+nm_client_wimax_set_enabled (NMClient *client,
+                             gboolean enabled);
+

Enables or disables WiMAX devices.

+
+

Parameters

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

client :

a NMClient -

client

a NMClient

 

Returns :

a GPtrArray -containing all the NMDevices. The returned array is owned by the -NMClient object and should not be modified. [transfer none][element-type NMDevice] -

enabled

TRUE to enable WiMAX

 
+

-

nm_client_get_device_by_path ()

-
NMDevice *          nm_client_get_device_by_path        (NMClient *client,
-                                                         const char *object_path);
-

-Gets a NMDevice from a NMClient. -

-
+

nm_client_wimax_hardware_get_enabled ()

+
gboolean
+nm_client_wimax_hardware_get_enabled (NMClient *client);
+

Determines whether the WiMAX hardware is enabled.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

TRUE if the WiMAX hardware is enabled

+

+
+
+
+
+

nm_client_get_version ()

+
const char *
+nm_client_get_version (NMClient *client);
+

Gets NetworkManager version.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

string with the version

+

+
+
+
+
+

nm_client_get_state ()

+
NMState
+nm_client_get_state (NMClient *client);
+

Gets the current daemon state.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

the current NMState

+

+
+
+
+
+

nm_client_get_startup ()

+
gboolean
+nm_client_get_startup (NMClient *client);
+

Tests whether the daemon is still in the process of activating +connections at startup.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

whether the daemon is still starting up

+

+
+

Since 0.9.10

+
+
+
+

nm_client_get_manager_running ()

+
gboolean
+nm_client_get_manager_running (NMClient *client);
+

Determines whether the daemon is running.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

TRUE if the daemon is running

+

+
+
+
+
+

nm_client_get_active_connections ()

+
const GPtrArray *
+nm_client_get_active_connections (NMClient *client);
+

Gets the active connections.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

a GPtrArray +containing all the active NMActiveConnections. +The returned array is owned by the client and should not be modified.

+

[transfer none][element-type NMActiveConnection]

+
+
+
+
+

nm_client_sleep ()

+
void
+nm_client_sleep (NMClient *client,
+                 gboolean sleep_);
+

Deprecated; use nm_client_networking_set_enabled() instead.

+
+

Parameters

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

client :

a NMClient -

object_path :

the object path to search for

client

a NMClient

 

Returns :

the NMDevice for the given object_path or NULL if none is found. [transfer none] -

sleep_

TRUE to put the daemon to sleep

 
+

-

nm_client_get_device_by_iface ()

-
NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
-                                                         const char *iface);
-

-Gets a NMDevice from a NMClient. -

-
+

nm_client_get_permission_result ()

+
NMClientPermissionResult
+nm_client_get_permission_result (NMClient *client,
+                                 NMClientPermission permission);
+

Requests the result of a specific permission, which indicates whether the +client can or cannot perform the action the permission represents

+
+

Parameters

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

client :

a NMClient -

iface :

the interface name to search for

client

a NMClient

 

Returns :

the NMDevice for the given iface or NULL if none is found. [transfer none] -

permission

the permission for which to return the result, one of NMClientPermission

 
-
-
-

NMClientActivateFn ()

-
void                (*NMClientActivateFn)               (NMClient *client,
-                                                         NMActiveConnection *active_connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-

-

+
+

Returns

+

the permission's result, one of NMClientPermissionResult

+

+

-

nm_client_activate_connection ()

-
void                nm_client_activate_connection       (NMClient *client,
-                                                         NMConnection *connection,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientActivateFn callback,
-                                                         gpointer user_data);
-

-Starts a connection to a particular network using the configuration settings -from connection and the network device device. Certain connection types -also take a "specific object" which is the object path of a connection- -specific object, like an NMAccessPoint for Wi-Fi connections, or an -NMWimaxNsp for WiMAX connections, to which you wish to connect. If the -specific object is not given, NetworkManager can, in some cases, automatically -determine which network to connect to given the settings in connection. -

-

-If connection is not given for a device-based activation, NetworkManager -picks the best available connection for the device and activates it. -

-

-Note that the callback is invoked when NetworkManager has started activating -the new connection, not when it finishes. You can used the returned -NMActiveConnection object (in particular, "state") to -track the activation to its completion. -

-
+

nm_client_get_logging ()

+
gboolean
+nm_client_get_logging (NMClient *client,
+                       char **level,
+                       char **domains,
+                       GError **error);
+

Gets NetworkManager current logging level and domains.

+
+

Parameters

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

client :

a NMClient -

connection :

an NMConnection. [allow-none] -

device :

the NMDevice. [allow-none] -

client

a NMClient

 

specific_object :

the object path of a connection-type-specific -object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of NULL should be used -(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object -path of a NMAccessPoint or NMWimaxNsp owned by device, which you can -get using nm_object_get_path(), and which will be used to complete the -details of the newly added connection. [allow-none] -

level

return location for logging level string.

[allow-none]

callback :

the function to call when the call is done. [scope async][allow-none] -

domains

return location for log domains string. The string is +a list of domains separated by ",".

[allow-none]

user_data :

user data to pass to the callback function. [closure] -

error

return location for a GError, or NULL.

[allow-none]
-
-
-

NMClientAddActivateFn ()

-
void                (*NMClientAddActivateFn)            (NMClient *client,
-                                                         NMActiveConnection *connection,
-                                                         const char *new_connection_path,
-                                                         GError *error,
-                                                         gpointer user_data);
-

-

+
+

Returns

+

TRUE on success, FALSE otherwise

+

+
+

Since 0.9.8


-

nm_client_add_and_activate_connection ()

-
void                nm_client_add_and_activate_connection
-                                                        (NMClient *client,
-                                                         NMConnection *partial,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientAddActivateFn callback,
-                                                         gpointer user_data);
-

-Adds a new connection using the given details (if any) as a template, -automatically filling in missing settings with the capabilities of the -given device and specific object. The new connection is then activated. -Cannot be used for VPN connections at this time. -

-

-Note that the callback is invoked when NetworkManager has started activating -the new connection, not when it finishes. You can used the returned -NMActiveConnection object (in particular, "state") to -track the activation to its completion. -

-
+

nm_client_set_logging ()

+
gboolean
+nm_client_set_logging (NMClient *client,
+                       const char *level,
+                       const char *domains,
+                       GError **error);
+

Sets NetworkManager logging level and/or domains.

+
+

Parameters

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

client :

a NMClient -

partial :

an NMConnection to add; the connection may be -partially filled (or even NULL) and will be completed by NetworkManager -using the given device and specific_object before being added. [allow-none] -

client

a NMClient

 

device :

the NMDevice -

specific_object :

the object path of a connection-type-specific -object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of NULL should be used -(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object -path of a NMAccessPoint or NMWimaxNsp owned by device, which you can -get using nm_object_get_path(), and which will be used to complete the -details of the newly added connection. [allow-none] -

level

logging level to set (NULL or an empty string for no change).

[allow-none]

callback :

the function to call when the call is done. [scope async][allow-none] -

domains

logging domains to set. The string should be a list of log +domains separated by ",". (NULL or an empty string for no change).

[allow-none]

user_data :

user data to pass to the callback function. [closure] -

error

return location for a GError, or NULL.

[allow-none]
+
+

Returns

+

TRUE on success, FALSE otherwise

+

+
+

Since 0.9.8

+

-

nm_client_deactivate_connection ()

-
void                nm_client_deactivate_connection     (NMClient *client,
-                                                         NMActiveConnection *active);
-

-Deactivates an active NMActiveConnection. -

-
+

nm_client_get_connectivity ()

+
NMConnectivityState
+nm_client_get_connectivity (NMClient *client);
+

Gets the current network connectivity state. Contrast +nm_client_check_connectivity() and +nm_client_check_connectivity_async(), which re-check the +connectivity state first before returning any information.

+
+

Parameters

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

client :

a NMClient -

active :

the NMActiveConnection to deactivate

client

an NMClient

 
+
+

Returns

+

the current connectivity state

+

+
+

Since 0.9.8.6

+

-

nm_client_networking_get_enabled ()

-
gboolean            nm_client_networking_get_enabled    (NMClient *client);
-

-Whether networking is enabled or disabled. -

-
+

nm_client_check_connectivity ()

+
NMConnectivityState
+nm_client_check_connectivity (NMClient *client,
+                              GCancellable *cancellable,
+                              GError **error);
+

Updates the network connectivity state and returns the (new) +current state. Contrast nm_client_get_connectivity(), which returns +the most recent known state without re-checking.

+

This is a blocking call; use nm_client_check_connectivity_async() +if you do not want to block.

+
+

Parameters

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

client :

a NMClient -

client

an NMClient

 

Returns :

-TRUE if networking is enabled, FALSE if networking is disabled

cancellable

a GCancellable

 

error

return location for a GError

 
+
+

Returns

+

the (new) current connectivity state

+

+
+

Since 0.9.8.6

+

-

nm_client_networking_set_enabled ()

-
void                nm_client_networking_set_enabled    (NMClient *client,
-                                                         gboolean enabled);
-

-Enables or disables networking. When networking is disabled, all controlled -interfaces are disconnected and deactivated. When networking is enabled, -all controlled interfaces are available for activation. -

-
+

nm_client_check_connectivity_async ()

+
void
+nm_client_check_connectivity_async (NMClient *client,
+                                    GCancellable *cancellable,
+                                    GAsyncReadyCallback callback,
+                                    gpointer user_data);
+

Asynchronously updates the network connectivity state and invokes +callback + when complete. Contrast nm_client_get_connectivity(), +which (immediately) returns the most recent known state without +re-checking, and nm_client_check_connectivity(), which blocks.

+
+

Parameters

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

client :

a NMClient -

client

an NMClient

 

cancellable

a GCancellable

 

enabled :

-TRUE to set networking enabled, FALSE to set networking disabled

callback

callback to call with the result

 

user_data

data for callback +.

 
+

Since 0.9.8.6

+

-

nm_client_wireless_get_enabled ()

-
gboolean            nm_client_wireless_get_enabled      (NMClient *client);
-

-Determines whether the wireless is enabled. -

-
+

nm_client_check_connectivity_finish ()

+
NMConnectivityState
+nm_client_check_connectivity_finish (NMClient *client,
+                                     GAsyncResult *result,
+                                     GError **error);
+

Retrieves the result of an nm_client_check_connectivity_async() +call.

+
+

Parameters

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

client :

a NMClient -

client

an NMClient

 

result

the GAsyncResult

 

Returns :

-TRUE if wireless is enabled

error

return location for a GError

 
+
+

Returns

+

the (new) current connectivity state

+

+
+

Since 0.9.8.6

+
-

nm_client_wireless_set_enabled ()

-
void                nm_client_wireless_set_enabled      (NMClient *client,
-                                                         gboolean enabled);
-

-Enables or disables wireless devices. -

-
+

nm_client_get_primary_connection ()

+
NMActiveConnection *
+nm_client_get_primary_connection (NMClient *client);
+

Gets the NMActiveConnection corresponding to the primary active +network device.

+

In particular, when there is no VPN active, or the VPN does not +have the default route, this returns the active connection that has +the default route. If there is a VPN active with the default route, +then this function returns the active connection that contains the +route to the VPN endpoint.

+

If there is no default route, or the default route is over a +non-NetworkManager-recognized device, this will return NULL.

+
+

Parameters

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

client :

a NMClient -

enabled :

-TRUE to enable wireless

client

an NMClient

 
+
+

Returns

+

the appropriate NMActiveConnection, if +any.

+

[transfer none]

+
+

Since 0.9.8.6

+
-

nm_client_wireless_hardware_get_enabled ()

-
gboolean            nm_client_wireless_hardware_get_enabled
-                                                        (NMClient *client);
-

-Determines whether the wireless hardware is enabled. -

-
+

nm_client_get_activating_connection ()

+
NMActiveConnection *
+nm_client_get_activating_connection (NMClient *client);
+

Gets the NMActiveConnection corresponding to a +currently-activating connection that is expected to become the new +“primary-connection” upon successful activation.

+
+

Parameters

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

client :

a NMClient -

Returns :

-TRUE if the wireless hardware is enabled

client

an NMClient

 
+
+

Returns

+

the appropriate NMActiveConnection, if +any.

+

[transfer none]

+
+

Since 0.9.8.6

+ + +
+

Types and Values

+
+

NM_CLIENT_VERSION

+
#define NM_CLIENT_VERSION "version"
+
+

+

+

-

nm_client_wwan_get_enabled ()

-
gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+

NM_CLIENT_STATE

+
#define NM_CLIENT_STATE "state"
+

-Determines whether WWAN is enabled.

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

client :

a NMClient -

Returns :

-TRUE if WWAN is enabled

-

nm_client_wwan_set_enabled ()

-
void                nm_client_wwan_set_enabled          (NMClient *client,
-                                                         gboolean enabled);
+

NM_CLIENT_STARTUP

+
#define NM_CLIENT_STARTUP "startup"
+

-Enables or disables WWAN devices.

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

client :

a NMClient -

enabled :

-TRUE to enable WWAN

-

nm_client_wwan_hardware_get_enabled ()

-
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+

NM_CLIENT_MANAGER_RUNNING

+
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
+

-Determines whether the WWAN hardware is enabled.

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

client :

a NMClient -

Returns :

-TRUE if the WWAN hardware is enabled

-

nm_client_wimax_get_enabled ()

-
gboolean            nm_client_wimax_get_enabled         (NMClient *client);
+

NM_CLIENT_NETWORKING_ENABLED

+
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
+

-Determines whether WiMAX is enabled.

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

client :

a NMClient -

Returns :

-TRUE if WiMAX is enabled

-

nm_client_wimax_set_enabled ()

-
void                nm_client_wimax_set_enabled         (NMClient *client,
-                                                         gboolean enabled);
+

NM_CLIENT_WIRELESS_ENABLED

+
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
+

-Enables or disables WiMAX devices.

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

client :

a NMClient -

enabled :

-TRUE to enable WiMAX

-

nm_client_wimax_hardware_get_enabled ()

-
gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);
+

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

+
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
+

-Determines whether the WiMAX hardware is enabled.

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

client :

a NMClient -

Returns :

-TRUE if the WiMAX hardware is enabled

-

nm_client_get_version ()

-
const char *        nm_client_get_version               (NMClient *client);
+

NM_CLIENT_WWAN_ENABLED

+
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
+

-Gets NetworkManager version.

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

client :

a NMClient -

Returns :

string with the version

-

nm_client_get_state ()

-
NMState             nm_client_get_state                 (NMClient *client);
+

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

-Gets the current daemon state.

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

client :

a NMClient -

Returns :

the current NMState -

-

nm_client_get_startup ()

-
gboolean            nm_client_get_startup               (NMClient *client);
+

NM_CLIENT_WIMAX_HARDWARE_ENABLED

+
#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
+

-Tests whether the daemon is still in the process of activating -connections at startup.

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

client :

a NMClient -

Returns :

whether the daemon is still starting up
-

Since 0.9.10


-

nm_client_get_manager_running ()

-
gboolean            nm_client_get_manager_running       (NMClient *client);
+

NM_CLIENT_ACTIVE_CONNECTIONS

+
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
+

-Determines whether the daemon is running.

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

client :

a NMClient -

Returns :

-TRUE if the daemon is running

-

nm_client_get_active_connections ()

-
const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
+

NM_CLIENT_CONNECTIVITY

+
#define NM_CLIENT_CONNECTIVITY "connectivity"
+

-Gets the active connections.

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

client :

a NMClient -

Returns :

a GPtrArray -containing all the active NMActiveConnections. -The returned array is owned by the client and should not be modified. [transfer none][element-type NMActiveConnection] -

-

nm_client_sleep ()

-
void                nm_client_sleep                     (NMClient *client,
-                                                         gboolean sleep_);
+

NM_CLIENT_PRIMARY_CONNECTION

+
#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
+

-Deprecated; use nm_client_networking_set_enabled() instead.

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

client :

a NMClient -

sleep_ :

-TRUE to put the daemon to sleep

-

nm_client_get_permission_result ()

-
NMClientPermissionResult nm_client_get_permission_result
-                                                        (NMClient *client,
-                                                         NMClientPermission permission);
+

NM_CLIENT_ACTIVATING_CONNECTION

+
#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
+

-Requests the result of a specific permission, which indicates whether the -client can or cannot perform the action the permission represents

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

client :

a NMClient -

permission :

the permission for which to return the result, one of NMClientPermission -

Returns :

the permission's result, one of NMClientPermissionResult -

-

nm_client_get_logging ()

-
gboolean            nm_client_get_logging               (NMClient *client,
-                                                         char **level,
-                                                         char **domains,
-                                                         GError **error);
+

NM_CLIENT_DEVICES

+
#define NM_CLIENT_DEVICES "devices"
+

-Gets NetworkManager current logging level and domains.

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

client :

a NMClient -

level :

return location for logging level string. [allow-none] -

domains :

return location for log domains string. The string is -a list of domains separated by ",". [allow-none] -

error :

return location for a GError, or NULL. [allow-none] -

Returns :

-TRUE on success, FALSE otherwise
-

Since 0.9.8


-

nm_client_set_logging ()

-
gboolean            nm_client_set_logging               (NMClient *client,
-                                                         const char *level,
-                                                         const char *domains,
-                                                         GError **error);
-

-Sets NetworkManager logging level and/or domains. -

-
+

enum NMClientPermission

+

NMClientPermission values indicate various permissions that NetworkManager +clients can obtain to perform certain tasks on behalf of the current user.

+
+

Members

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

client :

a NMClient +

NM_CLIENT_PERMISSION_NONE

+

unknown or no permission

 

level :

logging level to set (NULL or an empty string for no change). [allow-none] +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

+

controls whether networking + can be globally enabled or disabled

 

domains :

logging domains to set. The string should be a list of log -domains separated by ",". (NULL or an empty string for no change). [allow-none] +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

+

controls whether Wi-Fi can be + globally enabled or disabled

 

error :

return location for a GError, or NULL. [allow-none] +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

+

controls whether WWAN (3G) can be + globally enabled or disabled

 

Returns :

-TRUE on success, FALSE otherwise
-

Since 0.9.8

-
-
-
-

nm_client_get_connectivity ()

-
NMConnectivityState nm_client_get_connectivity          (NMClient *client);
-

-Gets the current network connectivity state. Contrast -nm_client_check_connectivity() and -nm_client_check_connectivity_async(), which re-check the -connectivity state first before returning any information. -

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

client :

an NMClient +

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

+

controls whether WiMAX can be + globally enabled or disabled

 

Returns :

the current connectivity state
-

Since 0.9.8.6

-
-
-
-

nm_client_check_connectivity ()

-
NMConnectivityState nm_client_check_connectivity        (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GError **error);
-

-Updates the network connectivity state and returns the (new) -current state. Contrast nm_client_get_connectivity(), which returns -the most recent known state without re-checking. -

-

-This is a blocking call; use nm_client_check_connectivity_async() -if you do not want to block. -

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

client :

an NMClient +

NM_CLIENT_PERMISSION_SLEEP_WAKE

+

controls whether the client can ask + NetworkManager to sleep and wake

 

cancellable :

a GCancellable +

NM_CLIENT_PERMISSION_NETWORK_CONTROL

+

controls whether networking connections + can be started, stopped, and changed

 

error :

return location for a GError +

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

+

controls whether a password + protected Wi-Fi hotspot can be created

 

Returns :

the (new) current connectivity state

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

+

controls whether an open Wi-Fi hotspot + can be created

+
 
-

Since 0.9.8.6

-
-
-
-

nm_client_check_connectivity_async ()

-
void                nm_client_check_connectivity_async  (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-

-Asynchronously updates the network connectivity state and invokes -callback when complete. Contrast nm_client_get_connectivity(), -which (immediately) returns the most recent known state without -re-checking, and nm_client_check_connectivity(), which blocks. -

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

client :

an NMClient +

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

+

controls whether connections + that are available to all users can be modified

 

cancellable :

a GCancellable +

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN

+

controls whether connections + owned by the current user can be modified

 

callback :

callback to call with the result

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

+

controls whether the + persistent hostname can be changed

+
 

user_data :

data for callback.

NM_CLIENT_PERMISSION_LAST

+

a reserved boundary value

+
 
-

Since 0.9.8.6

+

-

nm_client_check_connectivity_finish ()

-
NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);
-

-Retrieves the result of an nm_client_check_connectivity_async() -call. -

-
+

enum NMClientPermissionResult

+

NMClientPermissionResult values indicate what authorizations and permissions +the user requires to obtain a given NMClientPermission

+
+

Members

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

client :

an NMClient +

NM_CLIENT_PERMISSION_RESULT_UNKNOWN

+

unknown or no authorization

 

result :

the GAsyncResult +

NM_CLIENT_PERMISSION_RESULT_YES

+

the permission is available

 

error :

return location for a GError +

NM_CLIENT_PERMISSION_RESULT_AUTH

+

authorization is necessary before the + permission is available

 

Returns :

the (new) current connectivity state

NM_CLIENT_PERMISSION_RESULT_NO

+

permission to perform the operation is + denied by system policy

+
 
-

Since 0.9.8.6

+

-

nm_client_get_primary_connection ()

-
NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);
-

-Gets the NMActiveConnection corresponding to the primary active -network device. -

-

-In particular, when there is no VPN active, or the VPN does not -have the default route, this returns the active connection that has -the default route. If there is a VPN active with the default route, -then this function returns the active connection that contains the -route to the VPN endpoint. -

-

-If there is no default route, or the default route is over a -non-NetworkManager-recognized device, this will return NULL. -

-
+

enum NMClientError

+

Describes errors that may result from operations involving a NMClient.

+
+

Members

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

client :

an NMClient +

NM_CLIENT_ERROR_UNKNOWN

+

unknown or unclassified error

 

Returns :

the appropriate NMActiveConnection, if -any. [transfer none] +

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

+

an operation that requires NetworkManager + failed because NetworkManager is not running

 
-

Since 0.9.8.6

+

-

nm_client_get_activating_connection ()

-
NMActiveConnection * nm_client_get_activating_connection
-                                                        (NMClient *client);
+

NM_CLIENT_ERROR

+
#define NM_CLIENT_ERROR nm_client_error_quark ()
+

-Gets the NMActiveConnection corresponding to a -currently-activating connection that is expected to become the new -"primary-connection" upon successful activation.

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

client :

an NMClient -

Returns :

the appropriate NMActiveConnection, if -any. [transfer none] -
-

Since 0.9.8.6

Property Details

-

The "activating-connection" property

-
  "activating-connection"    NMActiveConnection*   : Read
-

-The NMActiveConnection of the activating connection that is -likely to become the new "primary-connection". -

+

The “activating-connection” property

+
  “activating-connection”    NMActiveConnection *
+

+

Flags: Read

Since 0.9.8.6


-

The "active-connections" property

-
  "active-connections"       NMObjectArray*        : Read
-

-The active connections. -Type: GLib.PtrArray -

+

The “active-connections” property

+
  “active-connections”       NMObjectArray *
+

+

Flags: Read


-

The "connectivity" property

-
  "connectivity"             guint                 : Read
-

-The network connectivity state. -

+

The “connectivity” property

+
  “connectivity”             guint
+

+

Flags: Read

Allowed values: <= 4

Default value: 0

Since 0.9.8.6


-

The "devices" property

-
  "devices"                  NMObjectArray*        : Read
-

-List of known network devices. -

+

The “devices” property

+
  “devices”                  NMObjectArray *
+

+

Flags: Read

Since 0.9.10


-

The "manager-running" property

-
  "manager-running"          gboolean              : Read
-

-Whether the daemon is running. -

+

The “manager-running” property

+
  “manager-running”          gboolean
+

+

Flags: Read

Default value: FALSE


-

The "networking-enabled" property

-
  "networking-enabled"       gboolean              : Read / Write
-

-Whether networking is enabled. -

+

The “networking-enabled” property

+
  “networking-enabled”       gboolean
+

+

Flags: Read / Write

Default value: TRUE


-

The "primary-connection" property

-
  "primary-connection"       NMActiveConnection*   : Read
-

-The NMActiveConnection of the device with the default route; -see nm_client_get_primary_connection() for more details. -

+

The “primary-connection” property

+
  “primary-connection”       NMActiveConnection *
+

+

Flags: Read

Since 0.9.8.6


-

The "startup" property

-
  "startup"                  gboolean              : Read
-

-Whether the daemon is still starting up. -

+

The “startup” property

+
  “startup”                  gboolean
+

+

Flags: Read

Default value: FALSE

Since 0.9.10


-

The "state" property

-
  "state"                    guint                 : Read
-

-The current daemon state. -

+

The “state” property

+
  “state”                    guint
+

+

Flags: Read

Allowed values: <= 70

Default value: 0


-

The "version" property

-
  "version"                  gchar*                : Read
-

-The NetworkManager version. -

+

The “version” property

+
  “version”                  gchar *
+

+

Flags: Read

Default value: NULL


-

The "wimax-enabled" property

-
  "wimax-enabled"            gboolean              : Read / Write
-

-Whether WiMAX functionality is enabled. -

+

The “wimax-enabled” property

+
  “wimax-enabled”            gboolean
+

+

Flags: Read / Write

Default value: FALSE


-

The "wimax-hardware-enabled" property

-
  "wimax-hardware-enabled"   gboolean              : Read
-

-Whether the WiMAX hardware is enabled. -

+

The “wimax-hardware-enabled” property

+
  “wimax-hardware-enabled”   gboolean
+

+

Flags: Read

Default value: FALSE


-

The "wireless-enabled" property

-
  "wireless-enabled"         gboolean              : Read / Write
-

-Whether wireless is enabled. -

+

The “wireless-enabled” property

+
  “wireless-enabled”         gboolean
+

+

Flags: Read / Write

Default value: FALSE


-

The "wireless-hardware-enabled" property

-
  "wireless-hardware-enabled" gboolean              : Read
-

-Whether the wireless hardware is enabled. -

+

The “wireless-hardware-enabled” property

+
  “wireless-hardware-enabled” gboolean
+

+

Flags: Read

Default value: TRUE


-

The "wwan-enabled" property

-
  "wwan-enabled"             gboolean              : Read / Write
-

-Whether WWAN functionality is enabled. -

+

The “wwan-enabled” property

+
  “wwan-enabled”             gboolean
+

+

Flags: Read / Write

Default value: FALSE


-

The "wwan-hardware-enabled" property

-
  "wwan-hardware-enabled"    gboolean              : Read
-

-Whether the WWAN hardware is enabled. -

+

The “wwan-hardware-enabled” property

+
  “wwan-hardware-enabled”    gboolean
+

+

Flags: Read

Default value: FALSE

Signal Details

-

The "device-added" signal

-
void                user_function                      (NMClient *client,
-                                                        GObject  *device,
-                                                        gpointer  user_data)      : Run First
-

-Notifies that a NMDevice is added. -

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

client :

the client that received the signal

device :

the new device. [type NMDevice] -

user_data :

user data set when the signal handler was connected.
+

The “device-added” signal

+
void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)
+

Flags: Run First


-

The "device-removed" signal

-
void                user_function                      (NMClient *client,
-                                                        GObject  *device,
-                                                        gpointer  user_data)      : Run First
-

-Notifies that a NMDevice is removed. -

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

client :

the client that received the signal

device :

the removed device. [type NMDevice] -

user_data :

user data set when the signal handler was connected.
+

The “device-removed” signal

+
void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)
+

Flags: Run First


-

The "permission-changed" signal

-
void                user_function                      (NMClient *client,
-                                                        guint     permission,
-                                                        guint     result,
-                                                        gpointer  user_data)       : Run First
-

-Notifies that a permission has changed -

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

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

The “permission-changed” signal

+
void
+user_function (NMClient *client,
+               guint     permission,
+               guint     result,
+               gpointer  user_data)
+

Flags: Run First

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