From f75dd6fd1975146623052b843b182dc32c3fbe46 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 8 Apr 2011 07:30:59 +0200 Subject: Imported Upstream version 0.8.998 --- docs/libnm-glib/html/NMClient.html | 525 ++++++++++++++++++++++++++----------- 1 file changed, 374 insertions(+), 151 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 f2e61adb..b8834f84 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -3,19 +3,19 @@ NMClient - + - - + + - + - - + + @@ -32,7 +32,7 @@ Signals -
+
@@ -41,15 +41,18 @@
-
+

Synopsis

-
#define             NM_CLIENT_STATE
+
#define             NM_CLIENT_VERSION
+#define             NM_CLIENT_STATE
 #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
 enum                NMClientPermission;
 enum                NMClientPermissionResult;
@@ -59,15 +62,27 @@ enum                GPtrArray *   nm_client_get_devices               (NMClient *client);
 NMDevice *          nm_client_get_device_by_path        (NMClient *client,
                                                          const char *object_path);
-void                (*NMClientActivateDeviceFn)         (gpointer user_data,
-                                                         const char *object_path,
-                                                         GError *error);
+void                (*NMClientActivateFn)               (NMClient *client,
+                                                         NMActiveConnection *active_connection,
+                                                         GError *error,
+                                                         gpointer user_data);
 void                nm_client_activate_connection       (NMClient *client,
-                                                         const char *service_name,
-                                                         const char *connection_path,
+                                                         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,
-                                                         NMClientActivateDeviceFn callback,
+                                                         NMClientAddActivateFn callback,
                                                          gpointer user_data);
 void                nm_client_deactivate_connection     (NMClient *client,
                                                          NMActiveConnection *active);
@@ -83,6 +98,12 @@ const 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);
@@ -93,7 +114,7 @@ const NMClientPermission permission);
-
+

Object Hierarchy

   GObject
@@ -101,35 +122,46 @@ const 
+

 
Properties

 
-  "active-connections"       nm-object-array*      : Read
+  "active-connections"       NMObjectArray*        : Read
   "manager-running"          gboolean              : Read
-  "networking-enabled"       gboolean              : Read
+  "networking-enabled"       gboolean              : Read / Write
   "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 / Construct
-  "wwan-hardware-enabled"    gboolean              : Read / Write / Construct Only
+  "wwan-enabled"             gboolean              : Read / Write
+  "wwan-hardware-enabled"    gboolean              : Read
 

 

-

+

 
Signals

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

 

-

+

 
Description

 

 

 

-

+

 
Details

-

+

+
NM_CLIENT_VERSION

+
#define NM_CLIENT_VERSION "version"
+

+

+

+

+

+

 
NM_CLIENT_STATE

 
#define NM_CLIENT_STATE "state"
 

@@ -137,7 +169,7 @@ const 
+

 
NM_CLIENT_MANAGER_RUNNING

 
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
 

@@ -145,7 +177,7 @@ const 
+

 
NM_CLIENT_NETWORKING_ENABLED

 
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
 

@@ -153,7 +185,7 @@ const 
+

 
NM_CLIENT_WIRELESS_ENABLED

 
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
 

@@ -161,7 +193,7 @@ const 
+

 
NM_CLIENT_WIRELESS_HARDWARE_ENABLED

 
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
 

@@ -169,7 +201,7 @@ const 
+

 
NM_CLIENT_WWAN_ENABLED

 
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
 

@@ -177,7 +209,7 @@ const 
+

 
NM_CLIENT_WWAN_HARDWARE_ENABLED

 
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
 

@@ -185,7 +217,23 @@ const 
+

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

@@ -193,23 +241,30 @@ const 
+

 
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_USE_USER_CONNECTIONS = 4,
+	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_USE_USER_CONNECTIONS
+	NM_CLIENT_PERMISSION_LAST = NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME
 } NMClientPermission;
 

 

 

 

 

-

+

 
enum NMClientPermissionResult

 
typedef enum {
 	NM_CLIENT_PERMISSION_RESULT_UNKNOWN = 0,
@@ -222,14 +277,14 @@ const 
+

 
NMClient

 
typedef struct _NMClient NMClient;

 

 

 

 

-

+

 
NMClientClass

 
typedef struct {
 	NMObjectClass parent;
@@ -237,6 +292,9 @@ const 
 

 

-

+

 
nm_client_new ()

 
NMClient *          nm_client_new                       (void);

 

@@ -261,13 +319,13 @@ Creates a new 
 
 
Returns :

- a new NMClient
+a new NMClient
 
 
 

 

 

-

+

 
nm_client_get_devices ()

 
const GPtrArray *   nm_client_get_devices               (NMClient *client);

 

@@ -283,15 +341,15 @@ Gets all the detected devices.
 
 
 
Returns :

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

 

 

-

+

 
nm_client_get_device_by_path ()

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

@@ -308,58 +366,112 @@ Gets a 
 
 
 
object_path :

-the object path to search for
-
+the object path to search for
 
 
 
Returns :

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

 

 

-

-
NMClientActivateDeviceFn ()

-
void                (*NMClientActivateDeviceFn)         (gpointer user_data,
-                                                         const char *object_path,
-                                                         GError *error);

+

+
NMClientActivateFn ()

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

+

+

+

+

+

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

 

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

 
 
 
user_data :

+
client :
a NMClient
 
 

 
object_path :

+
connection :
an NMConnection
 
 

 
error :

+
device :
the NMDevice. [allow-none]
+
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 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
+details of the newly added connection. [allow-none]
+
callback :
the function to call when the call is done. [scope async][allow-none]
+
user_data :
user data to pass to the callback function. [closure]
 
 

 
 

 

 

-

-
nm_client_activate_connection ()

-
void                nm_client_activate_connection       (NMClient *client,
-                                                         const char *service_name,
-                                                         const char *connection_path,
+

+
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,
-                                                         NMClientActivateDeviceFn callback,
+                                                         NMClientAddActivateFn callback,
                                                          gpointer user_data);

 

-Activates a connection with the given NMDevice.
+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.
 

 
@@ -370,13 +482,10 @@ Activates a connection with the given 
 
 
-
-
-
-
-
-
+
@@ -386,25 +495,30 @@ Activates a connection with the given 
 
-
-
-

 

service_name :
the connection's service name
-
connection_path :
the connection's DBus path
+
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]
 
 

 

 
specific_object :
the device specific object (currently used only for
-activating wireless devices and should be the NMAccessPoint's path.
+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 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
+details of the newly added connection. [allow-none]
 
 

 

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

 

 
user_data :
user data to pass to the callback function
+user data to pass to the callback function. [closure]
 
 

 
 

 

 

-

+

 
nm_client_deactivate_connection ()

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

@@ -421,14 +535,13 @@ Deactivates an active active :

-the NMActiveConnection to deactivate
-
+the NMActiveConnection to deactivate
 
 
 

 

 

-

+

 
nm_client_networking_get_enabled ()

 
gboolean            nm_client_networking_get_enabled    (NMClient *client);

 

@@ -444,14 +557,14 @@ Whether networking is enabled or disabled.
 
 
 
Returns :

- TRUE if networking is enabled, FALSE if networking is disabled
-
+
+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);

@@ -471,14 +584,13 @@ all controlled interfaces are available for activation.
 
 
enabled :

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

 

 

-

+

 
nm_client_wireless_get_enabled ()

 
gboolean            nm_client_wireless_get_enabled      (NMClient *client);

 

@@ -494,14 +606,14 @@ Determines whether the wireless is enabled.
 
 
 
Returns :

- TRUE if wireless is enabled
-
+
+TRUE if wireless is enabled
 
 
 

 

 

-

+

 
nm_client_wireless_set_enabled ()

 
void                nm_client_wireless_set_enabled      (NMClient *client,
                                                          gboolean enabled);

@@ -519,14 +631,13 @@ Enables or disables wireless devices.
 
 
enabled :

 
-TRUE to enable wireless
-
+TRUE to enable wireless
 
 
 

 

 

-

+

 
nm_client_wireless_hardware_get_enabled ()

 
gboolean            nm_client_wireless_hardware_get_enabled
                                                         (NMClient *client);

@@ -543,14 +654,14 @@ Determines whether the wireless hardware is enabled.
 
 
 
Returns :

- TRUE if the wireless hardware is enabled
-
+
+TRUE if the wireless hardware is enabled
 
 
 

 

 

-

+

 
nm_client_wwan_get_enabled ()

 
gboolean            nm_client_wwan_get_enabled          (NMClient *client);

 

@@ -566,14 +677,14 @@ Determines whether WWAN is enabled.
 
 
 
Returns :

- TRUE if WWAN is enabled
-
+
+TRUE if WWAN is enabled
 
 
 

 

 

-

+

 
nm_client_wwan_set_enabled ()

 
void                nm_client_wwan_set_enabled          (NMClient *client,
                                                          gboolean enabled);

@@ -591,14 +702,13 @@ Enables or disables WWAN devices.
 
 
enabled :

 
-TRUE to enable WWAN
-
+TRUE to enable WWAN
 
 
 

 

 

-

+

 
nm_client_wwan_hardware_get_enabled ()

 
gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);

 

@@ -614,14 +724,107 @@ Determines whether the WWAN hardware is enabled.
 
 
 
Returns :

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

+

+

+

+
nm_client_wimax_get_enabled ()

+
gboolean            nm_client_wimax_get_enabled         (NMClient *client);

+

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

+

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

+

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

+

+Gets NetworkManager version.
+

+

++
+
+
+
+
+
+
+


client :
a NMClient
 
 
Returns :
string with the version

 
 

 

 

-

+

 
nm_client_get_state ()

 
NMState             nm_client_get_state                 (NMClient *client);

 

@@ -637,14 +840,14 @@ Gets the current daemon state.
 
 
 
Returns :

- the current NMState
+the current NMState
 
 
 
 

 

 

-

+

 
nm_client_get_manager_running ()

 
gboolean            nm_client_get_manager_running       (NMClient *client);

 

@@ -660,14 +863,14 @@ Determines whether the daemon is running.
 
 
 
Returns :

- TRUE if the daemon is running
-
+
+TRUE if the daemon is running
 
 
 

 

 

-

+

 
nm_client_get_active_connections ()

 
const GPtrArray *   nm_client_get_active_connections    (NMClient *client);

 

@@ -683,15 +886,16 @@ Gets the active connections.
 
 
 
Returns :

- a GPtrArray containing all the active NMActiveConnections.
-The returned array is owned by the client and should not be modified.
+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]
 
 
 
 

 

 

-

+

 
nm_client_sleep ()

 
void                nm_client_sleep                     (NMClient *client,
                                                          gboolean sleep);

@@ -709,14 +913,13 @@ Deprecated; use sleep :

 
-TRUE to put the daemon to sleep
-
+TRUE to put the daemon to sleep
 
 
 

 

 

-

+

 
nm_client_get_permission_result ()

 
NMClientPermissionResult  nm_client_get_permission_result
                                                         (NMClient *client,
@@ -740,80 +943,103 @@ client can or cannot perform the action the permission represents
 
 
 
Returns :

- the permission's result, one of NMClientPermissionResult
+the permission's result, one of NMClientPermissionResult
 
 
 
 

 

 

-

+

 
Property Details

-

+

 
The "active-connections" property

-
  "active-connections"       nm-object-array*      : Read

+
  "active-connections"       NMObjectArray*        : Read

 
Active connections.

 

 

-

+

 
The "manager-running" property

 
  "manager-running"          gboolean              : Read

 
Whether NetworkManager is running.

 
Default value: FALSE

 

 

-

+

 
The "networking-enabled" property

-
  "networking-enabled"       gboolean              : Read

+
  "networking-enabled"       gboolean              : Read / Write

 
Is networking enabled.

 
Default value: TRUE

 

 

-

+

 
The "state" property

 
  "state"                    guint                 : Read

 

 The current daemon state.
 

-
Allowed values: <= 4

+
Allowed values: <= 70

 
Default value: 0

 

 

-

+

+
The "version" property

+
  "version"                  gchar*                : Read

+

+The NetworkManager version.
+

+
Default value: NULL

+

+

+

+
The "wimax-enabled" property

+
  "wimax-enabled"            gboolean              : Read / Write

+
Is WiMAX enabled.

+
Default value: FALSE

+

+

+

+
The "wimax-hardware-enabled" property

+
  "wimax-hardware-enabled"   gboolean              : Read

+
Is WiMAX hardware enabled.

+
Default value: FALSE

+

+

+

 
The "wireless-enabled" property

 
  "wireless-enabled"         gboolean              : Read / Write

 
Is wireless enabled.

-
Default value: TRUE

+
Default value: FALSE

 

 

-

+

 
The "wireless-hardware-enabled" property

 
  "wireless-hardware-enabled" gboolean              : Read

 
Is wireless hardware enabled.

 
Default value: TRUE

 

 

-

+

 
The "wwan-enabled" property

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

+
  "wwan-enabled"             gboolean              : Read / Write

 
Is WWAN enabled.

-
Default value: TRUE

+
Default value: FALSE

 

 

-

+

 
The "wwan-hardware-enabled" property

-
  "wwan-hardware-enabled"    gboolean              : Read / Write / Construct Only

+
  "wwan-hardware-enabled"    gboolean              : Read

 
Is WWAN hardware enabled.

-
Default value: TRUE

+
Default value: FALSE

 

 

-

+

 
Signal Details

-

+

 
The "device-added" signal

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

+                                                        gpointer  user_data)      : Run First

 

 Notifies that a NMDevice is added.
 

@@ -822,12 +1048,11 @@ Notifies that a 
 
 
client :

-the client that received the signal
-
+the client that received the signal
 
 
 
device :

-the new device
+the new device. [type NMClient.Device]
 
 
 
@@ -838,11 +1063,11 @@ Notifies that a 

 

 

-

+

 
The "device-removed" signal

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

+                                                        gpointer  user_data)      : Run First

Notifies that a NMDevice is removed.

@@ -851,12 +1076,11 @@ Notifies that a

widget :

-the client that received the signal - +the client that received the signal

device :

-the removed device +the removed device. [type NMClient.Device] @@ -867,12 +1091,12 @@ Notifies that a
-
+

The "permission-changed" signal

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

Notifies that a permission has changed

@@ -881,8 +1105,7 @@ Notifies that a permission has changed

widget :

-the client that received the signal - +the client that received the signal

permission :

@@ -905,6 +1128,6 @@ Notifies that a permission has changed
- Generated by GTK-Doc V1.15
+ Generated by GTK-Doc V1.17
\ No newline at end of file -- cgit 1.3.0-6-gf8a5