From 8baa1aca8dfd35e3190d7d5655eb83b5b901e263 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 21 Apr 2011 10:42:53 +0200 Subject: Imported Upstream version 0.8.4.0 --- docs/libnm-glib/html/NMDevice.html | 349 +++++++++++++++---------------------- 1 file changed, 145 insertions(+), 204 deletions(-) (limited to 'docs/libnm-glib/html/NMDevice.html') diff --git a/docs/libnm-glib/html/NMDevice.html b/docs/libnm-glib/html/NMDevice.html index b19fba63..da61cfdc 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -5,17 +5,17 @@ NMDevice - + - + - + @@ -32,7 +32,7 @@ Signals -
+
@@ -41,10 +41,9 @@
-
+

Synopsis

-
#define             NM_DEVICE_DEVICE_TYPE
-#define             NM_DEVICE_UDI
+
#define             NM_DEVICE_UDI
 #define             NM_DEVICE_INTERFACE
 #define             NM_DEVICE_IP_INTERFACE
 #define             NM_DEVICE_DRIVER
@@ -62,32 +61,29 @@
                     NMDeviceClass;
 GObject *           nm_device_new                       (DBusGConnection *connection,
                                                          const char *path);
-const char *          nm_device_get_iface               (NMDevice *device);
-const char *          nm_device_get_ip_iface            (NMDevice *device);
-NMDeviceType        nm_device_get_device_type           (NMDevice *device);
-const char *          nm_device_get_udi                 (NMDevice *device);
-const char *          nm_device_get_driver              (NMDevice *device);
-NMDeviceCapabilities  nm_device_get_capabilities        (NMDevice *device);
+const char *        nm_device_get_iface                 (NMDevice *device);
+const char *        nm_device_get_ip_iface              (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
+const char *        nm_device_get_driver                (NMDevice *device);
+guint32             nm_device_get_capabilities          (NMDevice *device);
 gboolean            nm_device_get_managed               (NMDevice *device);
 gboolean            nm_device_get_firmware_missing      (NMDevice *device);
-NMIP4Config *         nm_device_get_ip4_config          (NMDevice *device);
-NMDHCP4Config *       nm_device_get_dhcp4_config        (NMDevice *device);
-NMIP6Config *         nm_device_get_ip6_config          (NMDevice *device);
-NMDHCP6Config *       nm_device_get_dhcp6_config        (NMDevice *device);
+NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
+NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
+NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
+NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
 NMDeviceState       nm_device_get_state                 (NMDevice *device);
-const char *          nm_device_get_product             (NMDevice *device);
-const char *          nm_device_get_vendor              (NMDevice *device);
+const char *        nm_device_get_product               (NMDevice *device);
+const char *        nm_device_get_vendor                (NMDevice *device);
 void                (*NMDeviceDeactivateFn)             (NMDevice *device,
                                                          GError *error,
                                                          gpointer user_data);
 void                nm_device_disconnect                (NMDevice *device,
                                                          NMDeviceDeactivateFn callback,
                                                          gpointer user_data);
-GSList *              nm_device_filter_connections      (NMDevice *device,
-                                                         const GSList *connections);
-
+

Object Hierarchy

   GObject
@@ -95,16 +91,14 @@ const char *          NMDeviceEthernet
                +----NMDeviceWifi
-               +----NMDeviceModem
+               +----NMSerialDevice
                +----NMDeviceBt
-               +----NMDeviceWimax
-
+

Properties

   "capabilities"             guint                 : Read
-  "device-type"              guint                 : Read / Write / Construct Only
   "dhcp4-config"             NMDHCP4Config*        : Read
   "dhcp6-config"             NMDHCP6Config*        : Read
   "driver"                   gchar*                : Read
@@ -120,28 +114,20 @@ const char *          vendor"                   gchar*                : Read
-
+

Signals

-  "state-changed"                                  : Run First
+  "state-changed"                                  : Run First
-
+

Description

-
+

Details

-
-

NM_DEVICE_DEVICE_TYPE

-
#define NM_DEVICE_DEVICE_TYPE "device-type"
-
-

-

-
-
-
+

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
@@ -149,7 +135,7 @@ const char * +

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
@@ -157,7 +143,7 @@ const char * +

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
@@ -165,7 +151,7 @@ const char * +

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
@@ -173,7 +159,7 @@ const char * +

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
@@ -181,7 +167,7 @@ const char * +

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
@@ -189,7 +175,7 @@ const char * +

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
@@ -197,7 +183,7 @@ const char * +

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
@@ -205,7 +191,7 @@ const char * +

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
@@ -213,7 +199,7 @@ const char * +

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
@@ -221,7 +207,7 @@ const char * +

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
@@ -229,7 +215,7 @@ const char * +

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
@@ -237,7 +223,7 @@ const char * +

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
@@ -245,7 +231,7 @@ const char * +

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
@@ -253,14 +239,14 @@ const char * +

NMDevice

typedef struct _NMDevice NMDevice;

-
+

NMDeviceClass

typedef struct {
 	NMObjectClass parent;
@@ -271,9 +257,6 @@ const char *          char *          
+

 
nm_device_new ()

 
GObject *           nm_device_new                       (DBusGConnection *connection,
                                                          const char *path);

@@ -304,20 +287,21 @@ Creates a new 
 
 
path :

-the DBus object path of the device
+the DBus object path of the device
+
 
 
 
Returns :

-a new device. [transfer full]
+ a new device
-
+

nm_device_get_iface ()

-
const char *          nm_device_get_iface               (NMDevice *device);
+
const char *        nm_device_get_iface                 (NMDevice *device);

Gets the interface name of the NMDevice.

@@ -331,16 +315,17 @@ Gets the interface name of the Returns :

-the interface of the device. This is the internal string used by the -device, and must not be modified. + the interface of the device. This is the internal string used by the +device, and must not be modified. +
-
+

nm_device_get_ip_iface ()

-
const char *          nm_device_get_ip_iface            (NMDevice *device);
+
const char *        nm_device_get_ip_iface              (NMDevice *device);

Gets the IP interface name of the NMDevice over which IP traffic flows when the device is in the ACTIVATED state. @@ -355,38 +340,17 @@ when the device is in the ACTIVATED state.

Returns :

-the IP traffic interface of the device. This is the internal string -used by the device, and must not be modified. - - -
-
-
-
-

nm_device_get_device_type ()

-
NMDeviceType        nm_device_get_device_type           (NMDevice *device);
-

-Returns the numeric type of the NMDevice, ie ethernet, wifi, etc. -

-
-- - - - - - - -

device :

a NMDevice + the IP traffic interface of the device. This is the internal string +used by the device, and must not be modified.

Returns :

the device type
-
+

nm_device_get_udi ()

-
const char *          nm_device_get_udi                 (NMDevice *device);
+
const char *        nm_device_get_udi                   (NMDevice *device);

Gets the Unique Device Identifier of the NMDevice.

@@ -400,17 +364,18 @@ Gets the Unique Device Identifier of the

Returns :

-the Unique Device Identifier of the device. This identifier may be + the Unique Device Identifier of the device. This identifier may be used to gather more information about the device from various operating -system services like udev or sysfs. +system services like udev or sysfs. +
-
+

nm_device_get_driver ()

-
const char *          nm_device_get_driver              (NMDevice *device);
+
const char *        nm_device_get_driver                (NMDevice *device);

Gets the driver of the NMDevice.

@@ -424,16 +389,17 @@ Gets the driver of the

Returns :

-the driver of the device. This is the internal string used by the -device, and must not be modified. + the driver of the device. This is the internal string used by the +device, and must not be modified. +
-
+

nm_device_get_capabilities ()

-
NMDeviceCapabilities  nm_device_get_capabilities        (NMDevice *device);
+
guint32             nm_device_get_capabilities          (NMDevice *device);

Gets the device' capabilities.

@@ -447,13 +413,14 @@ Gets the device' capabilities.

Returns :

-the capabilities + the capabilities +
-
+

nm_device_get_managed ()

gboolean            nm_device_get_managed               (NMDevice *device);

@@ -469,14 +436,14 @@ Whether the Returns :

- -TRUE if the device is managed by NetworkManager + TRUE if the device is managed by NetworkManager +
-
+

nm_device_get_firmware_missing ()

gboolean            nm_device_get_firmware_missing      (NMDevice *device);

@@ -493,17 +460,17 @@ to be missing.

Returns :

- -TRUE if firmware required for the device's operation is likely -to be missing. + TRUE if firmware required for the device's operation is likely +to be missing. +
-
+

nm_device_get_ip4_config ()

-
NMIP4Config *         nm_device_get_ip4_config          (NMDevice *device);
+
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);

Gets the current NMIP4Config associated with the NMDevice.

@@ -517,16 +484,16 @@ Gets the current

Returns :

-the NMIP4Config or NULL if the device is not activated. [transfer none] + the NMIP4Config or NULL if the device is not activated.
-
+

nm_device_get_dhcp4_config ()

-
NMDHCP4Config *       nm_device_get_dhcp4_config        (NMDevice *device);
+
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);

Gets the current NMDHCP4Config associated with the NMDevice.

@@ -540,17 +507,17 @@ Gets the current

Returns :

-the NMDHCPConfig or NULL if the device is not activated or not -using DHCP. [transfer none] + the NMDHCPConfig or NULL if the device is not activated or not +using DHCP.
-
+

nm_device_get_ip6_config ()

-
NMIP6Config *         nm_device_get_ip6_config          (NMDevice *device);
+
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);

Gets the current NMIP6Config associated with the NMDevice.

@@ -564,16 +531,16 @@ Gets the current

Returns :

-the NMIP6Config or NULL if the device is not activated. [transfer none] + the NMIP6Config or NULL if the device is not activated.
-
+

nm_device_get_dhcp6_config ()

-
NMDHCP6Config *       nm_device_get_dhcp6_config        (NMDevice *device);
+
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);

Gets the current NMDHCP6Config associated with the NMDevice.

@@ -587,15 +554,15 @@ Gets the current

Returns :

-the NMDHCPConfig or NULL if the device is not activated or not -using DHCP. [transfer none] + the NMDHCPConfig or NULL if the device is not activated or not +using DHCP.
-
+

nm_device_get_state ()

NMDeviceState       nm_device_get_state                 (NMDevice *device);

@@ -611,15 +578,16 @@ Gets the current

Returns :

-the current device state + the current device state +
-
+

nm_device_get_product ()

-
const char *          nm_device_get_product             (NMDevice *device);
+
const char *        nm_device_get_product               (NMDevice *device);

Gets the product string of the NMDevice.

@@ -633,16 +601,17 @@ Gets the product string of the Returns :

-the product name of the device. This is the internal string used by the -device, and must not be modified. + the product name of the device. This is the internal string used by the +device, and must not be modified. +
-
+

nm_device_get_vendor ()

-
const char *          nm_device_get_vendor              (NMDevice *device);
+
const char *        nm_device_get_vendor                (NMDevice *device);

Gets the vendor string of the NMDevice.

@@ -656,94 +625,78 @@ Gets the vendor string of the Returns :

-the vendor name of the device. This is the internal string used by the -device, and must not be modified. + the vendor name of the device. This is the internal string used by the +device, and must not be modified. +
-
+

NMDeviceDeactivateFn ()

void                (*NMDeviceDeactivateFn)             (NMDevice *device,
                                                          GError *error,
                                                          gpointer user_data);

-
-
-
-

nm_device_disconnect ()

-
void                nm_device_disconnect                (NMDevice *device,
-                                                         NMDeviceDeactivateFn callback,
-                                                         gpointer user_data);
-

-Disconnects the device if currently connected, and prevents the device from -automatically connecting to networks until the next manual network connection -request. -

- - - + -

device :

a NMDevice +

callback :

callback to be called when disconnect operation completes. [scope async] +

error :

user_data :

caller-specific data passed to callback +
-
-

nm_device_filter_connections ()

-
GSList *              nm_device_filter_connections      (NMDevice *device,
-                                                         const GSList *connections);
+
+

nm_device_disconnect ()

+
void                nm_device_disconnect                (NMDevice *device,
+                                                         NMDeviceDeactivateFn callback,
+                                                         gpointer user_data);

-Filters a given list of connections for a given NMDevice object and return -connections which may be activated with the device. For example if device -is a WiFi device that supports only WEP encryption, the returned list will -contain any WiFi connections in connections that allow connection to -unencrypted or WEP-enabled SSIDs. The returned list will not contain -Ethernet, Bluetooth, WiFi WPA connections, or any other connection that is -incompatible with the device. +Disconnects the device if currently connected, and prevents the device from +automatically connecting to networks until the next manual network connection +request.

- + - - + + - - +

device :

an NMDevice to filter connections fora NMDevice +

connections :

a list of NMConnection objects to filter

callback :

callback to be called when disconnect operation completes +

Returns :

a -list of NMConnection objects that could be activated with the given device. -The elements of the list are owned by their creator and should not be freed -by the caller, but the returned list itself is owned by the caller and should -be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection] +

user_data :

caller-specific data passed to callback
-
+

Property Details

-
+

The "capabilities" property

  "capabilities"             guint                 : Read

@@ -752,16 +705,7 @@ The capabilities of the device.

Default value: 0

-
-

The "device-type" property

-
  "device-type"              guint                 : Read / Write / Construct Only
-

-The numeric type of the device. -

-

Default value: 0

-
-
-
+

The "dhcp4-config" property

  "dhcp4-config"             NMDHCP4Config*        : Read

@@ -769,7 +713,7 @@ The

-
+

The "dhcp6-config" property

  "dhcp6-config"             NMDHCP6Config*        : Read

@@ -777,7 +721,7 @@ The

-
+

The "driver" property

  "driver"                   gchar*                : Read

@@ -786,7 +730,7 @@ The driver of the device.

Default value: NULL

-
+

The "firmware-missing" property

  "firmware-missing"         gboolean              : Read

@@ -796,7 +740,7 @@ for its operation.

Default value: FALSE

-
+

The "interface" property

  "interface"                gchar*                : Read

@@ -805,7 +749,7 @@ The interface of the device.

Default value: NULL

-
+

The "ip-interface" property

  "ip-interface"             gchar*                : Read

@@ -815,7 +759,7 @@ operations like addressing and routing.

Default value: NULL

-
+

The "ip4-config" property

  "ip4-config"               NMIP4Config*          : Read

@@ -823,7 +767,7 @@ The +

The "ip6-config" property

  "ip6-config"               NMIP6Config*          : Read

@@ -831,7 +775,7 @@ The +

The "managed" property

  "managed"                  gboolean              : Read

@@ -840,7 +784,7 @@ Whether the device is managed by NetworkManager.

Default value: FALSE

-
+

The "product" property

  "product"                  gchar*                : Read

@@ -849,7 +793,7 @@ The product string of the device.

Default value: NULL

-
+

The "state" property

  "state"                    guint                 : Read

@@ -858,21 +802,16 @@ The state of the device.

Default value: 0

-
+

The "udi" property

  "udi"                      gchar*                : Read

-An operating-system specific device hardware identifier; this is not -unique to a specific hardware device across reboots or hotplugs. It -is an opaque string which for some device types (Bluetooth, Modem) -contains an identifier provided by the underlying hardware service daemon -such as Bluez or ModemManager, and clients can use this property to -request more information about the device from those services. +The Unique Device Identifier of the device.

Default value: NULL

-
+

The "vendor" property

  "vendor"                   gchar*                : Read

@@ -881,15 +820,15 @@ The vendor string of the device.

Default value: NULL

-
+

Signal Details

-
+

The "state-changed" signal

void                user_function                      (NMDevice *device,
                                                         guint     state,
                                                         guint     arg2,
                                                         guint     arg3,
-                                                        gpointer  user_data)      : Run First
+ gpointer user_data) : Run First

Notifies the state change of a NMDevice.

@@ -898,11 +837,13 @@ Notifies the state change of a device :

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

state :

-the new state of the device +the new state of the device +

user_data :

@@ -915,6 +856,6 @@ Notifies the state change of a
- Generated by GTK-Doc V1.17
+ Generated by GTK-Doc V1.15
\ No newline at end of file -- cgit 1.3.0-6-gf8a5