From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-glib/html/NMClient.html | 1198 ++++++++++++++++++++++++------------ 1 file changed, 798 insertions(+), 400 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 83d7fdef..18eddaf5 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -3,12 +3,12 @@ NMClient - + - + @@ -45,36 +45,50 @@

Synopsis

-
                    NMClient;
-void                (*NMClientActivateFn)               (NMClient *client,
-                                                         NMActiveConnection *active_connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMClientAddActivateFn)            (NMClient *client,
-                                                         NMActiveConnection *connection,
-                                                         const char *new_connection_path,
-                                                         GError *error,
-                                                         gpointer user_data);
-                    NMClientClass;
-enum                NMClientPermission;
-enum                NMClientPermissionResult;
-#define             NM_CLIENT_ACTIVE_CONNECTIONS
+
#define             NM_CLIENT_VERSION
+#define             NM_CLIENT_STATE
 #define             NM_CLIENT_MANAGER_RUNNING
 #define             NM_CLIENT_NETWORKING_ENABLED
-#define             NM_CLIENT_STATE
-#define             NM_CLIENT_VERSION
-#define             NM_CLIENT_WIMAX_ENABLED
-#define             NM_CLIENT_WIMAX_HARDWARE_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
+enum                NMClientPermission;
+enum                NMClientPermissionResult;
+                    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,
@@ -84,51 +98,54 @@ enum                gpointer user_data);
 void                nm_client_deactivate_connection     (NMClient *client,
                                                          NMActiveConnection *active);
-const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
-NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
-                                                         const char *iface);
-NMDevice *          nm_client_get_device_by_path        (NMClient *client,
-                                                         const char *object_path);
-const GPtrArray *   nm_client_get_devices               (NMClient *client);
-gboolean            nm_client_get_logging               (NMClient *client,
-                                                         char **level,
-                                                         char **domains,
-                                                         GError **error);
+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_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);
-NMState             nm_client_get_state                 (NMClient *client);
-const char *        nm_client_get_version               (NMClient *client);
-gboolean            nm_client_networking_get_enabled    (NMClient *client);
-void                nm_client_networking_set_enabled    (NMClient *client,
-                                                         gboolean enabled);
-NMClient *          nm_client_new                       (void);
-void                nm_client_new_async                 (GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMClient *          nm_client_new_finish                (GAsyncResult *result,
+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);
-void                nm_client_sleep                     (NMClient *client,
-                                                         gboolean sleep_);
-gboolean            nm_client_wimax_get_enabled         (NMClient *client);
-gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);
-void                nm_client_wimax_set_enabled         (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wireless_get_enabled      (NMClient *client);
-gboolean            nm_client_wireless_hardware_get_enabled
+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);
-void                nm_client_wireless_set_enabled      (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wwan_get_enabled          (NMClient *client);
-gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
-void                nm_client_wwan_set_enabled          (NMClient *client,
-                                                         gboolean enabled);
 
@@ -148,9 +165,12 @@ NMClient implements

Properties

+  "activating-connection"    NMActiveConnection*   : Read
   "active-connections"       NMObjectArray*        : Read
+  "connectivity"             guint                 : Read
   "manager-running"          gboolean              : Read
   "networking-enabled"       gboolean              : Read / Write
+  "primary-connection"       NMActiveConnection*   : Read
   "state"                    guint                 : Read
   "version"                  gchar*                : Read
   "wimax-enabled"            gboolean              : Read / Write
@@ -177,53 +197,112 @@ NMClient implements
 

Details

-

NMClient

-
typedef struct _NMClient NMClient;
+

NM_CLIENT_VERSION

+
#define NM_CLIENT_VERSION "version"
+


-

NMClientActivateFn ()

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

NM_CLIENT_STATE

+
#define NM_CLIENT_STATE "state"
+


-

NMClientAddActivateFn ()

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

NM_CLIENT_MANAGER_RUNNING

+
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
+


-

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

@@ -252,8 +331,11 @@ NMClient implements NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

-
+
+++ @@ -348,8 +430,11 @@ clients can obtain to perform certain tasks on behalf of the current user. NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission

-

NM_CLIENT_PERMISSION_NONE

+
+++ @@ -378,89 +463,235 @@ the user requires to obtain a given -

NM_CLIENT_ACTIVE_CONNECTIONS

-
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
-
+

NMClient

+
typedef struct _NMClient NMClient;


-

NM_CLIENT_MANAGER_RUNNING

-
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
+

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_NETWORKING_ENABLED

-
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
-
+

nm_client_new ()

+
NMClient *          nm_client_new                       (void);

+Creates a new NMClient.

-
-
-
-

NM_CLIENT_STATE

-
#define NM_CLIENT_STATE "state"
-

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

-
-
-
-

NM_CLIENT_VERSION

-
#define NM_CLIENT_VERSION "version"
-

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

++++ + + + + +

Returns :

a new NMClient +

-

NM_CLIENT_WIMAX_ENABLED

-
#define NM_CLIENT_WIMAX_ENABLED "wimax-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: NMClient provides information about devices and a mechanism to +control them. To access and modify network configuration data, use the +NMRemoteSettings object.

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

cancellable :

a GCancellable, or NULL +

callback :

callback to call when the client is created

user_data :

data for callback +

-

NM_CLIENT_WIMAX_HARDWARE_ENABLED

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

nm_client_new_finish ()

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

+Gets the result of an nm_client_new_async() call.

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

result :

a GAsyncResult +

error :

location for a GError, or NULL +

Returns :

a new NMClient, or NULL on error

-

NM_CLIENT_WIRELESS_ENABLED

-
#define NM_CLIENT_WIRELESS_ENABLED "wireless-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().

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

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 NMClient.Device] +

-

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

-
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-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.

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

client :

a NMClient +

object_path :

the object path to search for

Returns :

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

-

NM_CLIENT_WWAN_ENABLED

-
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
-
+

nm_client_get_device_by_iface ()

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

+Gets a NMDevice from a NMClient.

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

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_WWAN_HARDWARE_ENABLED

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

NMClientActivateFn ()

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

@@ -482,8 +713,11 @@ specific object, like an connection.

-
+
+++ @@ -504,7 +738,7 @@ determine which network to connect to given the settings in specific_object :

client :

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 +wired and mobile broadband connections, and the value of NULL should be used (ie, no specific object). For WiFi 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 @@ -526,6 +760,17 @@ details of the newly added connection. [
+

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,
@@ -540,8 +785,11 @@ 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.
 

-
+
+++ @@ -551,7 +799,7 @@ Cannot be used for VPN connections at this time. @@ -564,7 +812,7 @@ using the given device and specific_object :

client :

partial :

an NMConnection to add; the connection may be -partially filled (or even NULL) and will be completed by NetworkManager +partially filled (or even NULL) and will be completed by NetworkManager using the given device and specific_object before being added. [allow-none]
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 +wired and mobile broadband connections, and the value of NULL should be used (ie, no specific object). For WiFi 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 @@ -592,8 +840,11 @@ details of the newly added connection. [ Deactivates an active NMActiveConnection.

-
+
+++ @@ -609,13 +860,16 @@ Deactivates an active -

nm_client_get_active_connections ()

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

nm_client_networking_get_enabled ()

+
gboolean            nm_client_networking_get_enabled    (NMClient *client);

-Gets the active connections. +Whether networking is enabled or disabled.

-

client :

+
+++ @@ -624,24 +878,27 @@ Gets the active connections. - +

client :

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 NMClient.ActiveConnection] - +TRUE if networking is enabled, FALSE if networking is disabled

-

nm_client_get_device_by_iface ()

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

nm_client_networking_set_enabled ()

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

-Gets a NMDevice from a NMClient. +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.

-
+
+++ @@ -649,27 +906,25 @@ Gets a - - - - - - + +

client :

iface :

the interface name to search for

Returns :

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

enabled :

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

-

nm_client_get_device_by_path ()

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

nm_client_wireless_get_enabled ()

+
gboolean            nm_client_wireless_get_enabled      (NMClient *client);

-Gets a NMDevice from a NMClient. +Determines whether the wireless is enabled.

-
+
+++ @@ -677,29 +932,26 @@ Gets a - - - - - +

client :

object_path :

the object path to search for

Returns :

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

-

nm_client_get_devices ()

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

nm_client_wireless_set_enabled ()

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

-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(). +Enables or disables wireless devices.

-
+
+++ @@ -707,27 +959,26 @@ returned array is, and then you may use device-specific methods such as - - + +

client :

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 NMClient.Device] -

enabled :

+TRUE to enable wireless

-

nm_client_get_logging ()

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

nm_client_wireless_hardware_get_enabled ()

+
gboolean            nm_client_wireless_hardware_get_enabled
+                                                        (NMClient *client);

-Gets NetworkManager current logging level and domains. +Determines whether the wireless hardware is enabled.

-
+
+++ @@ -735,39 +986,25 @@ Gets NetworkManager current logging level and domains. - - - - - - - - - - - - - - + +

client :

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

Returns :

+TRUE if the wireless hardware is enabled
-

Since 0.9.8


-

nm_client_get_manager_running ()

-
gboolean            nm_client_get_manager_running       (NMClient *client);
+

nm_client_wwan_get_enabled ()

+
gboolean            nm_client_wwan_get_enabled          (NMClient *client);

-Determines whether the daemon is running. +Determines whether WWAN is enabled.

-
+
+++ @@ -777,23 +1014,24 @@ Determines whether the daemon is running. +TRUE if WWAN is enabled

client :

Returns :

-TRUE if the daemon is running

-

nm_client_get_permission_result ()

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

nm_client_wwan_set_enabled ()

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

-Requests the result of a specific permission, which indicates whether the -client can or cannot perform the action the permission represents +Enables or disables WWAN devices.

-
+
+++ @@ -801,27 +1039,25 @@ client can or cannot perform the action the permission represents - - - - - - + +

client :

permission :

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

Returns :

the permission's result, one of NMClientPermissionResult -

enabled :

+TRUE to enable WWAN

-

nm_client_get_state ()

-
NMState             nm_client_get_state                 (NMClient *client);
+

nm_client_wwan_hardware_get_enabled ()

+
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);

-Gets the current daemon state. +Determines whether the WWAN hardware is enabled.

-
+
+++ @@ -830,21 +1066,24 @@ Gets the current daemon state. - +

client :

Returns :

the current NMState - +TRUE if the WWAN hardware is enabled

-

nm_client_get_version ()

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

nm_client_wimax_get_enabled ()

+
gboolean            nm_client_wimax_get_enabled         (NMClient *client);

-Gets NetworkManager version. +Determines whether WiMAX is enabled.

-
+
+++ @@ -853,20 +1092,25 @@ Gets NetworkManager version. - +

client :

Returns :

string with the version +TRUE if WiMAX is enabled

-

nm_client_networking_get_enabled ()

-
gboolean            nm_client_networking_get_enabled    (NMClient *client);
+

nm_client_wimax_set_enabled ()

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

-Whether networking is enabled or disabled. +Enables or disables WiMAX devices.

-
+
+++ @@ -874,25 +1118,26 @@ Whether networking is enabled or disabled. - + +TRUE to enable WiMAX

client :

Returns :

enabled :

-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);
+

nm_client_wimax_hardware_get_enabled ()

+
gboolean            nm_client_wimax_hardware_get_enabled
+                                                        (NMClient *client);

-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. +Determines whether the WiMAX hardware is enabled.

-
+
+++ @@ -900,70 +1145,59 @@ all controlled interfaces are available for activation. - + +TRUE if the WiMAX hardware is enabled

client :

enabled :

Returns :

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

-

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

+

nm_client_get_version ()

+
const char *        nm_client_get_version               (NMClient *client);

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

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

Returns :

a new NMClient +

client :

a NMClient

Returns :

string with the version

-

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

+

nm_client_get_state ()

+
NMState             nm_client_get_state                 (NMClient *client);

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

-
+
+++ - - + - - - - - - + @@ -971,44 +1205,42 @@ control them. To access and modify network configuration data, use the
-

nm_client_new_finish ()

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

nm_client_get_manager_running ()

+
gboolean            nm_client_get_manager_running       (NMClient *client);

-Gets the result of an nm_client_new_async() call. +Determines whether the daemon is running.

-

cancellable :

a GCancellable, or NULL +

client :

a NMClient

callback :

callback to call when the client is created

user_data :

data for callback +

Returns :

the current NMState
+
+++ - - - - - - + - +

result :

a GAsyncResult -

error :

location for a GError, or NULL +

client :

a NMClient

Returns :

a new NMClient, or NULL on error +TRUE if the daemon is running

-

nm_client_set_logging ()

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

nm_client_get_active_connections ()

+
const GPtrArray *   nm_client_get_active_connections    (NMClient *client);

-Sets NetworkManager logging level and/or domains. +Gets the active connections.

-
+
+++ @@ -1016,29 +1248,14 @@ Sets NetworkManager logging level and/or domains. - - - - - - - - - - - - - +

client :

level :

logging level to set (NULL or an empty string for no change). [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] -

error :

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

Returns :

-TRUE on success, FALSE otherwisea GPtrArray +containing all the active NMActiveConnections. +The returned array is owned by the client and should not be modified. [transfer none][element-type NMClient.ActiveConnection] +
-

Since 0.9.8


@@ -1048,8 +1265,11 @@ domains separated by ",". (nm_client_networking_set_enabled() instead.

-
+
+++ @@ -1066,13 +1286,19 @@ Deprecated; use -

nm_client_wimax_get_enabled ()

-
gboolean            nm_client_wimax_get_enabled         (NMClient *client);
+

nm_client_get_permission_result ()

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

-Determines whether WiMAX is enabled. +Requests the result of a specific permission, which indicates whether the +client can or cannot perform the action the permission represents

-

client :

+
+++ @@ -1080,23 +1306,33 @@ Determines whether WiMAX is enabled. + + + + - +

client :

permission :

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

Returns :

-TRUE if WiMAX is enabledthe permission's result, one of NMClientPermissionResult +

-

nm_client_wimax_hardware_get_enabled ()

-
gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);
+

nm_client_get_logging ()

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

-Determines whether the WiMAX hardware is enabled. +Gets NetworkManager current logging level and domains.

-
+
+++ @@ -1104,23 +1340,45 @@ Determines whether the WiMAX hardware is enabled. + + + + + + + + + + + + +TRUE on success, FALSE otherwise

client :

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 if the WiMAX hardware is enabled
+

Since 0.9.8


-

nm_client_wimax_set_enabled ()

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

nm_client_set_logging ()

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

-Enables or disables WiMAX devices. +Sets NetworkManager logging level and/or domains.

-
+
+++ @@ -1128,164 +1386,285 @@ Enables or disables WiMAX devices. - + + + + + + + + + + + + + +TRUE on success, FALSE otherwise

client :

enabled :

level :

logging level to set (NULL or an empty string for no change). [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] +

error :

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

Returns :

-TRUE to enable WiMAX
+

Since 0.9.8


-

nm_client_wireless_get_enabled ()

-
gboolean            nm_client_wireless_get_enabled      (NMClient *client);
+

nm_client_get_connectivity ()

+
NMConnectivityState nm_client_get_connectivity          (NMClient *client);

-Determines whether the wireless is enabled. +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 :

a NMClient +an NMClient

Returns :

-TRUE if wireless is enabledthe current connectivity state
+

Since 0.9.8.4


-

nm_client_wireless_hardware_get_enabled ()

-
gboolean            nm_client_wireless_hardware_get_enabled
-                                                        (NMClient *client);
+

nm_client_check_connectivity ()

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

-Determines whether the wireless hardware is enabled. +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 :

a NMClient +an NMClient +

cancellable :

a GCancellable +

error :

return location for a GError

Returns :

-TRUE if the wireless hardware is enabledthe (new) current connectivity state
+

Since 0.9.8.4


-

nm_client_wireless_set_enabled ()

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

nm_client_check_connectivity_async ()

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

-Enables or disables wireless devices. +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 :

a NMClient +an NMClient

enabled :

-TRUE to enable wireless

cancellable :

a GCancellable +

callback :

callback to call with the result

user_data :

data for callback.
+

Since 0.9.8.4


-

nm_client_wwan_get_enabled ()

-
gboolean            nm_client_wwan_get_enabled          (NMClient *client);
+

nm_client_check_connectivity_finish ()

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

-Determines whether WWAN is enabled. +Retrieves the result of an nm_client_check_connectivity_async() +call.

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

client :

a NMClient +an NMClient +

result :

the GAsyncResult +

error :

return location for a GError

Returns :

-TRUE if WWAN is enabledthe (new) current connectivity state
+

Since 0.9.8.4


-

nm_client_wwan_hardware_get_enabled ()

-
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
+

nm_client_get_primary_connection ()

+
NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);

-Determines whether the WWAN hardware is enabled. +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. +

+
+++ - - +

client :

a NMClient +an NMClient

Returns :

-TRUE if the WWAN hardware is enabledthe appropriate NMActiveConnection, if +any. [transfer none] +
+

Since 0.9.8.4


-

nm_client_wwan_set_enabled ()

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

nm_client_get_activating_connection ()

+
NMActiveConnection * nm_client_get_activating_connection
+                                                        (NMClient *client);

-Enables or disables WWAN devices. +Gets the NMActiveConnection corresponding to a +currently-activating connection that is expected to become the new +"primary-connection" upon successful activation.

-
+
+++ - - - + +

client :

a NMClient +an NMClient

enabled :

-TRUE to enable WWAN

Returns :

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

Since 0.9.8.4

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

+

Since 0.9.8.4

+
+
+

The "active-connections" property

  "active-connections"       NMObjectArray*        : Read

Active connections.


+

The "connectivity" property

+
  "connectivity"             guint                 : Read
+

+The network connectivity state. +

+

Allowed values: <= 4

+

Default value: 0

+

Since 0.9.8.4

+
+
+

The "manager-running" property

  "manager-running"          gboolean              : Read

Whether NetworkManager is running.

@@ -1300,6 +1679,16 @@ Enables or disables WWAN devices.

+

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

+

Since 0.9.8.4

+
+
+

The "state" property

  "state"                    guint                 : Read

@@ -1370,8 +1759,11 @@ The NetworkManager version.

Notifies that a NMDevice is added.

-
+
+++ @@ -1379,7 +1771,7 @@ Notifies that a - @@ -1398,8 +1790,11 @@ Notifies that a Notifies that a NMDevice is removed.

-

client :

device :

the new device. [type NMClient.Device] +the new device. [type NMClient.Device]
+
+++ @@ -1407,7 +1802,7 @@ Notifies that a - @@ -1427,8 +1822,11 @@ Notifies that a Notifies that a permission has changed

-

client :

device :

the removed device. [type NMClient.Device] +the removed device. [type NMClient.Device]
+
+++ @@ -1455,6 +1853,6 @@ Notifies that a permission has changed + Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

client :