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/NMDevice.html | 838 ++++++++++++++++++++----------------- 1 file changed, 461 insertions(+), 377 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 e0f5f25a..621a183b 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -3,12 +3,12 @@ NMDevice - + - + @@ -45,68 +45,68 @@

Synopsis

-
                    NMDevice;
-                    NMDeviceClass;
-void                (*NMDeviceDeactivateFn)             (NMDevice *device,
-                                                         GError *error,
-                                                         gpointer user_data);
-#define             NM_DEVICE_ACTIVE_CONNECTION
-#define             NM_DEVICE_AUTOCONNECT
-#define             NM_DEVICE_AVAILABLE_CONNECTIONS
-#define             NM_DEVICE_CAPABILITIES
-#define             NM_DEVICE_DEVICE_TYPE
-#define             NM_DEVICE_DHCP4_CONFIG
-#define             NM_DEVICE_DHCP6_CONFIG
+
#define             NM_DEVICE_DEVICE_TYPE
+#define             NM_DEVICE_UDI
+#define             NM_DEVICE_INTERFACE
+#define             NM_DEVICE_IP_INTERFACE
 #define             NM_DEVICE_DRIVER
 #define             NM_DEVICE_DRIVER_VERSION
-#define             NM_DEVICE_FIRMWARE_MISSING
 #define             NM_DEVICE_FIRMWARE_VERSION
-#define             NM_DEVICE_INTERFACE
+#define             NM_DEVICE_CAPABILITIES
+#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_AUTOCONNECT
+#define             NM_DEVICE_FIRMWARE_MISSING
 #define             NM_DEVICE_IP4_CONFIG
+#define             NM_DEVICE_DHCP4_CONFIG
 #define             NM_DEVICE_IP6_CONFIG
-#define             NM_DEVICE_IP_INTERFACE
-#define             NM_DEVICE_MANAGED
-#define             NM_DEVICE_PRODUCT
+#define             NM_DEVICE_DHCP6_CONFIG
 #define             NM_DEVICE_STATE
 #define             NM_DEVICE_STATE_REASON
-#define             NM_DEVICE_UDI
+#define             NM_DEVICE_ACTIVE_CONNECTION
+#define             NM_DEVICE_AVAILABLE_CONNECTIONS
 #define             NM_DEVICE_VENDOR
-gboolean            nm_device_connection_compatible     (NMDevice *device,
-                                                         NMConnection *connection,
-                                                         GError **error);
-gboolean            nm_device_connection_valid          (NMDevice *device,
-                                                         NMConnection *connection);
-void                nm_device_disconnect                (NMDevice *device,
-                                                         NMDeviceDeactivateFn callback,
-                                                         gpointer user_data);
-GSList *            nm_device_filter_connections        (NMDevice *device,
-                                                         const GSList *connections);
-NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
-gboolean            nm_device_get_autoconnect           (NMDevice *device);
-const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
-NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+#define             NM_DEVICE_PRODUCT
+                    NMDevice;
+                    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);
-NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
-NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
 const char *        nm_device_get_driver                (NMDevice *device);
 const char *        nm_device_get_driver_version        (NMDevice *device);
-gboolean            nm_device_get_firmware_missing      (NMDevice *device);
 const char *        nm_device_get_firmware_version      (NMDevice *device);
-const char *        nm_device_get_iface                 (NMDevice *device);
+NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+gboolean            nm_device_get_managed               (NMDevice *device);
+gboolean            nm_device_get_autoconnect           (NMDevice *device);
+void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);
+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);
-const char *        nm_device_get_ip_iface              (NMDevice *device);
-gboolean            nm_device_get_managed               (NMDevice *device);
-const char *        nm_device_get_product               (NMDevice *device);
+NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
 NMDeviceState       nm_device_get_state                 (NMDevice *device);
 NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
                                                          NMDeviceStateReason *reason);
-const char *        nm_device_get_udi                   (NMDevice *device);
+NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
+const char *        nm_device_get_product               (NMDevice *device);
 const char *        nm_device_get_vendor                (NMDevice *device);
-GObject *           nm_device_new                       (DBusGConnection *connection,
-                                                         const char *path);
-void                nm_device_set_autoconnect           (NMDevice *device,
-                                                         gboolean autoconnect);
+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);
+gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);
+gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);
@@ -174,310 +174,250 @@ NMDevice implements

Details

-

NMDevice

-
typedef struct _NMDevice NMDevice;
-

-

-
-
-
-

NMDeviceClass

-
typedef struct {
-	NMObjectClass parent;
-
-	/* Signals */
-	void (*state_changed) (NMDevice *device,
-	                       NMDeviceState new_state,
-	                       NMDeviceState old_state,
-	                       NMDeviceStateReason reason);
-
-	gboolean (*connection_compatible) (NMDevice *device,
-	                                   NMConnection *connection,
-	                                   GError **error);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceClass;
+
NM_DEVICE_DEVICE_TYPE

+
#define NM_DEVICE_DEVICE_TYPE "device-type"
-

NMDeviceDeactivateFn ()

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

NM_DEVICE_UDI

+
#define NM_DEVICE_UDI "udi"
+

-

NM_DEVICE_ACTIVE_CONNECTION

-
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+
NM_DEVICE_INTERFACE

+
#define NM_DEVICE_INTERFACE "interface"
-

NM_DEVICE_AUTOCONNECT

-
#define NM_DEVICE_AUTOCONNECT "autoconnect"
+
NM_DEVICE_IP_INTERFACE

+
#define NM_DEVICE_IP_INTERFACE "ip-interface"
-

NM_DEVICE_AVAILABLE_CONNECTIONS

-
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
+
NM_DEVICE_DRIVER

+
#define NM_DEVICE_DRIVER "driver"
-

NM_DEVICE_CAPABILITIES

-
#define NM_DEVICE_CAPABILITIES "capabilities"
+
NM_DEVICE_DRIVER_VERSION

+
#define NM_DEVICE_DRIVER_VERSION "driver-version"
-

NM_DEVICE_DEVICE_TYPE

-
#define NM_DEVICE_DEVICE_TYPE "device-type"
+
NM_DEVICE_FIRMWARE_VERSION

+
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
-

NM_DEVICE_DHCP4_CONFIG

-
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+
NM_DEVICE_CAPABILITIES

+
#define NM_DEVICE_CAPABILITIES "capabilities"
-

NM_DEVICE_DHCP6_CONFIG

-
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+
NM_DEVICE_MANAGED

+
#define NM_DEVICE_MANAGED "managed"
-

NM_DEVICE_DRIVER

-
#define NM_DEVICE_DRIVER "driver"
+
NM_DEVICE_AUTOCONNECT

+
#define NM_DEVICE_AUTOCONNECT "autoconnect"
-

NM_DEVICE_DRIVER_VERSION

-
#define NM_DEVICE_DRIVER_VERSION "driver-version"
+
NM_DEVICE_FIRMWARE_MISSING

+
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
-

NM_DEVICE_FIRMWARE_MISSING

-
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+
NM_DEVICE_IP4_CONFIG

+
#define NM_DEVICE_IP4_CONFIG "ip4-config"
-

NM_DEVICE_FIRMWARE_VERSION

-
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
+
NM_DEVICE_DHCP4_CONFIG

+
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
-

NM_DEVICE_INTERFACE

-
#define NM_DEVICE_INTERFACE "interface"
+
NM_DEVICE_IP6_CONFIG

+
#define NM_DEVICE_IP6_CONFIG "ip6-config"
-

NM_DEVICE_IP4_CONFIG

-
#define NM_DEVICE_IP4_CONFIG "ip4-config"
+
NM_DEVICE_DHCP6_CONFIG

+
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
-

NM_DEVICE_IP6_CONFIG

-
#define NM_DEVICE_IP6_CONFIG "ip6-config"
+
NM_DEVICE_STATE

+
#define NM_DEVICE_STATE "state"
-

NM_DEVICE_IP_INTERFACE

-
#define NM_DEVICE_IP_INTERFACE "ip-interface"
+
NM_DEVICE_STATE_REASON

+
#define NM_DEVICE_STATE_REASON "state-reason"
-

NM_DEVICE_MANAGED

-
#define NM_DEVICE_MANAGED "managed"
+
NM_DEVICE_ACTIVE_CONNECTION

+
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
-

NM_DEVICE_PRODUCT

-
#define NM_DEVICE_PRODUCT "product"
+
NM_DEVICE_AVAILABLE_CONNECTIONS

+
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
-

NM_DEVICE_STATE

-
#define NM_DEVICE_STATE "state"
+
NM_DEVICE_VENDOR

+
#define NM_DEVICE_VENDOR "vendor"
-

NM_DEVICE_STATE_REASON

-
#define NM_DEVICE_STATE_REASON "state-reason"
+
NM_DEVICE_PRODUCT

+
#define NM_DEVICE_PRODUCT "product"
-

NM_DEVICE_UDI

-
#define NM_DEVICE_UDI "udi"
-
+

NMDevice

+
typedef struct _NMDevice NMDevice;

-

NM_DEVICE_VENDOR

-
#define NM_DEVICE_VENDOR "vendor"
+
NMDeviceClass

+
typedef struct {
+	NMObjectClass parent;
+
+	/* Signals */
+	void (*state_changed) (NMDevice *device,
+	                       NMDeviceState new_state,
+	                       NMDeviceState old_state,
+	                       NMDeviceStateReason reason);
+
+	gboolean (*connection_compatible) (NMDevice *device,
+	                                   NMConnection *connection,
+	                                   GError **error);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMDeviceClass;
-

nm_device_connection_compatible ()

-
gboolean            nm_device_connection_compatible     (NMDevice *device,
-                                                         NMConnection *connection,
-                                                         GError **error);
-

-Validates a given connection for a given NMDevice object and returns -whether the connection may be activated with the device. For example if -device is a WiFi device that supports only WEP encryption, the connection -will only be valid if it is a WiFi connection which describes a WEP or open -network, and will not be valid if it describes a WPA network, or if it is -an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the -device. -

+

nm_device_new ()

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

-This function does the same as nm_device_connection_valid(), i.e. checking -compatibility of the given device and connection. But, in addition, it sets -GError when FALSE is returned. +Creates a new NMDevice.

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

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device +the DBusGConnection

error :

return location for a GError, or NULL -

path :

the DBus object path of the device

Returns :

 -TRUE if the connection may be activated with this device, FALSE -if is incompatible with the device's capabilities and characteristics.
-
-
-
-

nm_device_connection_valid ()

-
gboolean            nm_device_connection_valid          (NMDevice *device,
-                                                         NMConnection *connection);
-

-Validates a given connection for a given NMDevice object and returns -whether the connection may be activated with the device. For example if -device is a WiFi device that supports only WEP encryption, the connection -will only be valid if it is a WiFi connection which describes a WEP or open -network, and will not be valid if it describes a WPA network, or if it is -an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the -device. -

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

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device +a new device. [transfer full]

Returns :

 -TRUE if the connection may be activated with this device, FALSE -if is incompatible with the device's capabilities and characteristics.
-

nm_device_disconnect ()

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

nm_device_get_iface ()

+
const char *        nm_device_get_iface                 (NMDevice *device);

-Disconnects the device if currently connected, and prevents the device from -automatically connecting to networks until the next manual network connection -request. +Gets the interface name of the NMDevice.

-
+
+++ @@ -485,67 +425,52 @@ request. - - - - - - + +

device :

callback :

callback to be called when disconnect -operation completes. [scope async][allow-none] -

user_data :

caller-specific data passed to callback. [closure] -

Returns :

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

nm_device_filter_connections ()

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

nm_device_get_ip_iface ()

+
const char *        nm_device_get_ip_iface              (NMDevice *device);

-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. To get the full list of connections see -nm_remote_settings_list_connections(). +Gets the IP interface name of the NMDevice over which IP traffic flows +when the device is in the ACTIVATED state.

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

device :

an NMDevice to filter connections for

connections :

a list of NMConnection objects to filter. [element-type NetworkManager.Connection] +a NMDevice

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] -the IP traffic interface of the device. This is the internal string +used by the device, and must not be modified.
-

nm_device_get_active_connection ()

-
NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+

nm_device_get_device_type ()

+
NMDeviceType        nm_device_get_device_type           (NMDevice *device);

-Gets the NMActiveConnection object which owns this device during activation. +Returns the numeric type of the NMDevice, ie ethernet, wifi, etc.

-
+
+++ @@ -554,22 +479,23 @@ Gets the Returns :

- +

device :

the NMActiveConnection or NULL if the device is -not part of an active connection. [transfer none] -the device type
-

nm_device_get_autoconnect ()

-
gboolean            nm_device_get_autoconnect           (NMDevice *device);
+

nm_device_get_udi ()

+
const char *        nm_device_get_udi                   (NMDevice *device);

-Whether the NMDevice can be autoconnected. +Gets the Unique Device Identifier of the NMDevice.

-
+
+++ @@ -578,22 +504,25 @@ Whether the Returns :

- +

device :

 -TRUE if the device is allowed to be autoconnectedthe 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.
-

nm_device_get_available_connections ()

-
const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
+

nm_device_get_driver ()

+
const char *        nm_device_get_driver                (NMDevice *device);

-Gets the NMRemoteConnections currently known to the daemon that could -be activated on device. +Gets the driver of the NMDevice.

-
+
+++ @@ -602,24 +531,24 @@ be activated on device. - +

device :

Returns :

the GPtrArray -containing NMRemoteConnections. This is the internal copy used by -the connection, and must not be modified. [element-type NMClient.RemoteConnection] -the driver of the device. This is the internal string used by the +device, and must not be modified.
-

Since 0.9.8

-

nm_device_get_capabilities ()

-
NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+

nm_device_get_driver_version ()

+
const char *        nm_device_get_driver_version        (NMDevice *device);

-Gets the device' capabilities. +Gets the driver version of the NMDevice.

-
+
+++ @@ -628,20 +557,24 @@ Gets the device' capabilities. - +

device :

Returns :

the capabilitiesthe version of the device driver. 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);
+

nm_device_get_firmware_version ()

+
const char *        nm_device_get_firmware_version      (NMDevice *device);

-Returns the numeric type of the NMDevice, ie ethernet, wifi, etc. +Gets the firmware version of the NMDevice.

-
+
+++ @@ -650,20 +583,24 @@ Returns the numeric type of the Returns :

- +

device :

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

nm_device_get_dhcp4_config ()

-
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
+

nm_device_get_capabilities ()

+
NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);

-Gets the current NMDHCP4Config associated with the NMDevice. +Gets the device' capabilities.

-
+
+++ @@ -672,22 +609,23 @@ Gets the current - +

device :

Returns :

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

nm_device_get_dhcp6_config ()

-
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
+

nm_device_get_managed ()

+
gboolean            nm_device_get_managed               (NMDevice *device);

-Gets the current NMDHCP6Config associated with the NMDevice. +Whether the NMDevice is managed by NetworkManager.

-
+
+++ @@ -696,22 +634,24 @@ Gets the current - +

device :

Returns :

the NMDHCP6Config or NULL if the device is not activated or not -using DHCP. [transfer none] - +TRUE if the device is managed by NetworkManager
-

nm_device_get_driver ()

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

nm_device_get_autoconnect ()

+
gboolean            nm_device_get_autoconnect           (NMDevice *device);

-Gets the driver of the NMDevice. +Whether the NMDevice can be autoconnected.

-
+
+++ @@ -720,21 +660,25 @@ Gets the driver of the - +

device :

Returns :

the driver of the device. This is the internal string used by the -device, and must not be modified. +TRUE if the device is allowed to be autoconnected
-

nm_device_get_driver_version ()

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

nm_device_set_autoconnect ()

+
void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);

-Gets the driver version of the NMDevice. +Enables or disables automatic activation of the NMDevice.

-
+
+++ @@ -742,9 +686,9 @@ Gets the driver version of the Returns :

- + +

device :

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

autoconnect :

 +TRUE to enable autoconnecting
@@ -757,8 +701,11 @@ device, and must not be modified. Indicates that firmware required for the device's operation is likely to be missing.

-
+
+++ @@ -776,13 +723,16 @@ to be missing.
-

nm_device_get_firmware_version ()

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

nm_device_get_ip4_config ()

+
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);

-Gets the firmware version of the NMDevice. +Gets the current NMIP4Config associated with the NMDevice.

-

device :
+
+++ @@ -791,21 +741,24 @@ Gets the firmware version of the Returns :

- +

device :

the firmware version of the device. This is the internal string used by the -device, and must not be modified.the NMIP4Config or NULL if the device is not activated. [transfer none] +
-

nm_device_get_iface ()

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

nm_device_get_dhcp4_config ()

+
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);

-Gets the interface name of the NMDevice. +Gets the current NMDHCP4Config associated with the NMDevice.

-
+
+++ @@ -814,21 +767,25 @@ Gets the interface name of the Returns :

- +

device :

the interface of the device. This is the internal string used by the -device, and must not be modified.the NMDHCP4Config or NULL if the device is not activated or not +using DHCP. [transfer none] +
-

nm_device_get_ip4_config ()

-
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
+

nm_device_get_ip6_config ()

+
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);

-Gets the current NMIP4Config associated with the NMDevice. +Gets the current NMIP6Config associated with the NMDevice.

-
+
+++ @@ -837,7 +794,7 @@ Gets the current - @@ -845,13 +802,16 @@ Gets the current
-

nm_device_get_ip6_config ()

-
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
+

nm_device_get_dhcp6_config ()

+
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);

-Gets the current NMIP6Config associated with the NMDevice. +Gets the current NMDHCP6Config associated with the NMDevice.

-

device :

Returns :

the NMIP4Config or NULL if the device is not activated. [transfer none] +the NMIP6Config or NULL if the device is not activated. [transfer none]
+
+++ @@ -860,7 +820,8 @@ Gets the current - @@ -868,14 +829,16 @@ Gets the current
-

nm_device_get_ip_iface ()

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

nm_device_get_state ()

+
NMDeviceState       nm_device_get_state                 (NMDevice *device);

-Gets the IP interface name of the NMDevice over which IP traffic flows -when the device is in the ACTIVATED state. +Gets the current NMDevice state.

-

device :

Returns :

the NMIP6Config or NULL if the device is not activated. [transfer none] +the NMDHCP6Config or NULL if the device is not activated or not +using DHCP. [transfer none]
+
+++ @@ -884,21 +847,25 @@ when the device is in the ACTIVATED state. - +

device :

Returns :

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

nm_device_get_managed ()

-
gboolean            nm_device_get_managed               (NMDevice *device);
+

nm_device_get_state_reason ()

+
NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
+                                                         NMDeviceStateReason *reason);

-Whether the NMDevice is managed by NetworkManager. +Gets the current NMDevice state (return value) and the reason for entering +the state (reason argument).

-
+
+++ @@ -906,22 +873,29 @@ Whether the reason :

+ + + - +

device :

location to store reason (NMDeviceStateReason), or NULL. [out][allow-none] +

Returns :

 -TRUE if the device is managed by NetworkManagerthe current device state
-

nm_device_get_product ()

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

nm_device_get_active_connection ()

+
NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);

-Gets the product string of the NMDevice. +Gets the NMActiveConnection object which owns this device during activation.

-
+
+++ @@ -930,21 +904,26 @@ Gets the product string of the Returns :

- +

device :

the product name of the device. This is the internal string used by the -device, and must not be modified.the NMActiveConnection or NULL if the device is +not part of an active connection. [transfer none] +
-

nm_device_get_state ()

-
NMDeviceState       nm_device_get_state                 (NMDevice *device);
+

nm_device_get_available_connections ()

+
const GPtrArray *   nm_device_get_available_connections (NMDevice *device);

-Gets the current NMDevice state. +Gets the NMRemoteConnections currently known to the daemon that could +be activated on device.

-
+
+++ @@ -953,22 +932,27 @@ Gets the current - +

device :

Returns :

the current device statethe GPtrArray +containing NMRemoteConnections. This is the internal copy used by +the connection, and must not be modified. [element-type NMClient.RemoteConnection] +
+

Since 0.9.8

-

nm_device_get_state_reason ()

-
NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
-                                                         NMDeviceStateReason *reason);
+

nm_device_get_product ()

+
const char *        nm_device_get_product               (NMDevice *device);

-Gets the current NMDevice state (return value) and the reason for entering -the state (reason argument). +Gets the product string of the NMDevice.

-
+
+++ @@ -976,26 +960,64 @@ the state (reason argument). - - + + + +

device :

reason :

location to store reason (NMDeviceStateReason), or NULL. [out][allow-none] +

Returns :

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

+Gets the vendor string of the NMDevice. +

+
++++ + + + + - +

device :

a NMDevice

Returns :

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

nm_device_get_udi ()

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

NMDeviceDeactivateFn ()

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

-Gets the Unique Device Identifier of the NMDevice.

-
+ +
+
+

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

+
+++ @@ -1003,85 +1025,144 @@ Gets the Unique Device Identifier of the - - + + + + + +

device :

Returns :

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.

callback :

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

user_data :

caller-specific data passed to callback. [closure] +
-

nm_device_get_vendor ()

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

nm_device_filter_connections ()

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

-Gets the vendor string of the NMDevice. +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. To get the full list of connections see +nm_remote_settings_list_connections().

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

device :

a NMDevice +an NMDevice to filter connections for

connections :

a list of NMConnection objects to filter. [element-type NetworkManager.Connection]

Returns :

the vendor name of the device. This is the internal string used by the -device, and must not be modified.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] +
-

nm_device_new ()

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

nm_device_connection_valid ()

+
gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);

-Creates a new NMDevice. +Validates a given connection for a given NMDevice object and returns +whether the connection may be activated with the device. For example if +device is a WiFi device that supports only WEP encryption, the connection +will only be valid if it is a WiFi connection which describes a WEP or open +network, and will not be valid if it describes a WPA network, or if it is +an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the +device.

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

connection :

the DBusGConnection -

device :

an NMDevice to validate connection against

path :

the DBus object path of the device

connection :

an NMConnection to validate against device +

Returns :

a new device. [transfer full] - +TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.
-

nm_device_set_autoconnect ()

-
void                nm_device_set_autoconnect           (NMDevice *device,
-                                                         gboolean autoconnect);
+

nm_device_connection_compatible ()

+
gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);

-Enables or disables automatic activation of the NMDevice. +Validates a given connection for a given NMDevice object and returns +whether the connection may be activated with the device. For example if +device is a WiFi device that supports only WEP encryption, the connection +will only be valid if it is a WiFi connection which describes a WEP or open +network, and will not be valid if it describes a WPA network, or if it is +an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the +device. +

+

+This function does the same as nm_device_connection_valid(), i.e. checking +compatibility of the given device and connection. But, in addition, it sets +GError when FALSE is returned.

-
+
+++ - + + + + - + + + + + +TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.

device :

a NMDevice +an NMDevice to validate connection against

connection :

an NMConnection to validate against device

autoconnect :

error :

return location for a GError, or NULL +

Returns :

 -TRUE to enable autoconnecting
@@ -1291,8 +1372,11 @@ The vendor string of the device.

Notifies the state change of a NMDevice.

-
+
+++ @@ -1321,6 +1405,6 @@ Notifies the state change of a
- Generated by GTK-Doc V1.18 + Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

device :