From b436a68a20ff3114ded32a7a3d70cdd4954039f9 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 12 Nov 2011 01:36:14 +0100 Subject: Imported Upstream version 0.9.2.0 --- docs/libnm-glib/html/NMDevice.html | 496 ++++++++++++++++++------------------- 1 file changed, 248 insertions(+), 248 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 94866102..0ffed799 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -8,7 +8,7 @@ - + @@ -43,52 +43,52 @@

Synopsis

-
#define             NM_DEVICE_DEVICE_TYPE
-#define             NM_DEVICE_UDI
-#define             NM_DEVICE_INTERFACE
-#define             NM_DEVICE_IP_INTERFACE
-#define             NM_DEVICE_DRIVER
+
                    NMDevice;
+                    NMDeviceClass;
+void                (*NMDeviceDeactivateFn)             (NMDevice *device,
+                                                         GError *error,
+                                                         gpointer user_data);
+#define             NM_DEVICE_ACTIVE_CONNECTION
 #define             NM_DEVICE_CAPABILITIES
-#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_DEVICE_TYPE
+#define             NM_DEVICE_DHCP4_CONFIG
+#define             NM_DEVICE_DHCP6_CONFIG
+#define             NM_DEVICE_DRIVER
 #define             NM_DEVICE_FIRMWARE_MISSING
+#define             NM_DEVICE_INTERFACE
 #define             NM_DEVICE_IP4_CONFIG
-#define             NM_DEVICE_DHCP4_CONFIG
 #define             NM_DEVICE_IP6_CONFIG
-#define             NM_DEVICE_DHCP6_CONFIG
+#define             NM_DEVICE_IP_INTERFACE
+#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_PRODUCT
 #define             NM_DEVICE_STATE
-#define             NM_DEVICE_ACTIVE_CONNECTION
+#define             NM_DEVICE_UDI
 #define             NM_DEVICE_VENDOR
-#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);
-const char *          nm_device_get_udi                 (NMDevice *device);
-const char *          nm_device_get_driver              (NMDevice *device);
-NMDeviceCapabilities  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);
-NMDeviceState       nm_device_get_state                 (NMDevice *device);
-NMActiveConnection *  nm_device_get_active_connection   (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);
+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,
+GSList *            nm_device_filter_connections        (NMDevice *device,
                                                          const GSList *connections);
-gboolean            nm_device_connection_valid          (NMDevice *device,
-                                                         NMConnection *connection);
+NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+NMDeviceCapabilities nm_device_get_capabilities         (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_driver                (NMDevice *device);
+gboolean            nm_device_get_firmware_missing      (NMDevice *device);
+const char *        nm_device_get_iface                 (NMDevice *device);
+NMIP4Config *       nm_device_get_ip4_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);
+NMDeviceState       nm_device_get_state                 (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
+const char *        nm_device_get_vendor                (NMDevice *device);
+GObject *           nm_device_new                       (DBusGConnection *connection,
+                                                         const char *path);
 
@@ -139,120 +139,139 @@ const char *

Details

-

NM_DEVICE_DEVICE_TYPE

-
#define NM_DEVICE_DEVICE_TYPE "device-type"
-
+

NMDevice

+
typedef struct _NMDevice NMDevice;


-

NM_DEVICE_UDI

-
#define NM_DEVICE_UDI "udi"
+

NMDeviceClass

+
typedef struct {
+	NMObjectClass parent;
+
+	/* Signals */
+	void (*state_changed) (NMDevice *device,
+	                       NMDeviceState new_state,
+	                       NMDeviceState old_state,
+	                       NMDeviceStateReason reason);
+
+	gboolean (*connection_valid)   (NMDevice *device,
+	                                NMConnection *connection);
+
+	/* 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_INTERFACE

-
#define NM_DEVICE_INTERFACE "interface"
-
+

NMDeviceDeactivateFn ()

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


-

NM_DEVICE_IP_INTERFACE

-
#define NM_DEVICE_IP_INTERFACE "ip-interface"
+

NM_DEVICE_ACTIVE_CONNECTION

+
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
 


-

NM_DEVICE_DRIVER

-
#define NM_DEVICE_DRIVER "driver"
+

NM_DEVICE_CAPABILITIES

+
#define NM_DEVICE_CAPABILITIES "capabilities"
 


-

NM_DEVICE_CAPABILITIES

-
#define NM_DEVICE_CAPABILITIES "capabilities"
+

NM_DEVICE_DEVICE_TYPE

+
#define NM_DEVICE_DEVICE_TYPE "device-type"
 


-

NM_DEVICE_MANAGED

-
#define NM_DEVICE_MANAGED "managed"
+

NM_DEVICE_DHCP4_CONFIG

+
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
 


-

NM_DEVICE_FIRMWARE_MISSING

-
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+

NM_DEVICE_DHCP6_CONFIG

+
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
 


-

NM_DEVICE_IP4_CONFIG

-
#define NM_DEVICE_IP4_CONFIG "ip4-config"
+

NM_DEVICE_DRIVER

+
#define NM_DEVICE_DRIVER "driver"
 


-

NM_DEVICE_DHCP4_CONFIG

-
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+

NM_DEVICE_FIRMWARE_MISSING

+
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
 


-

NM_DEVICE_IP6_CONFIG

-
#define NM_DEVICE_IP6_CONFIG "ip6-config"
+

NM_DEVICE_INTERFACE

+
#define NM_DEVICE_INTERFACE "interface"
 


-

NM_DEVICE_DHCP6_CONFIG

-
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+

NM_DEVICE_IP4_CONFIG

+
#define NM_DEVICE_IP4_CONFIG "ip4-config"
 


-

NM_DEVICE_STATE

-
#define NM_DEVICE_STATE "state"
+

NM_DEVICE_IP6_CONFIG

+
#define NM_DEVICE_IP6_CONFIG "ip6-config"
 


-

NM_DEVICE_ACTIVE_CONNECTION

-
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+

NM_DEVICE_IP_INTERFACE

+
#define NM_DEVICE_IP_INTERFACE "ip-interface"
 


-

NM_DEVICE_VENDOR

-
#define NM_DEVICE_VENDOR "vendor"
+

NM_DEVICE_MANAGED

+
#define NM_DEVICE_MANAGED "managed"
 

@@ -267,72 +286,73 @@ const char * -

NMDevice

-
typedef struct _NMDevice NMDevice;
+

NM_DEVICE_STATE

+
#define NM_DEVICE_STATE "state"
+


-

NMDeviceClass

-
typedef struct {
-	NMObjectClass parent;
-
-	/* Signals */
-	void (*state_changed) (NMDevice *device,
-	                       NMDeviceState new_state,
-	                       NMDeviceState old_state,
-	                       NMDeviceStateReason reason);
-
-	gboolean (*connection_valid)   (NMDevice *device,
-	                                NMConnection *connection);
-
-	/* 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_UDI

+
#define NM_DEVICE_UDI "udi"
 


-

nm_device_new ()

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

NM_DEVICE_VENDOR

+
#define NM_DEVICE_VENDOR "vendor"
+

-Creates a new NMDevice. +

+
+
+
+

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.

- - + + - - + + - +

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

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

nm_device_disconnect ()

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

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

@@ -343,43 +363,63 @@ 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.

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

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

nm_device_filter_connections ()

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

-Gets the IP interface name of the NMDevice over which IP traffic flows -when the device is in the ACTIVATED state. +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.

- + + + + - +

device :

a NMDevice +an NMDevice to filter connections for

connections :

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

Returns :

the IP traffic interface 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_get_device_type ()

-
NMDeviceType        nm_device_get_device_type           (NMDevice *device);
+

nm_device_get_active_connection ()

+
NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);

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

@@ -391,17 +431,19 @@ Returns the numeric type of the Returns :

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

-

nm_device_get_udi ()

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

nm_device_get_capabilities ()

+
NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);

-Gets the Unique Device Identifier of the NMDevice. +Gets the device' capabilities.

@@ -413,19 +455,17 @@ Gets the Unique Device Identifier of the - +

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

-

nm_device_get_driver ()

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

nm_device_get_device_type ()

+
NMDeviceType        nm_device_get_device_type           (NMDevice *device);

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

@@ -437,18 +477,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 device type

-

nm_device_get_capabilities ()

-
NMDeviceCapabilities  nm_device_get_capabilities        (NMDevice *device);
+

nm_device_get_dhcp4_config ()

+
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);

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

@@ -460,17 +499,19 @@ Gets the device' capabilities. - +

Returns :

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

-

nm_device_get_managed ()

-
gboolean            nm_device_get_managed               (NMDevice *device);
+

nm_device_get_dhcp6_config ()

+
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);

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

@@ -482,19 +523,19 @@ Whether the Returns :

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

-

nm_device_get_firmware_missing ()

-
gboolean            nm_device_get_firmware_missing      (NMDevice *device);
+

nm_device_get_driver ()

+
const char *        nm_device_get_driver                (NMDevice *device);

-Indicates that firmware required for the device's operation is likely -to be missing. +Gets the driver of the NMDevice.

@@ -506,19 +547,19 @@ to be missing. - +

Returns :

-TRUE if firmware required for the device's operation is likely -to be missing.the driver of the device. This is the internal string used by the +device, and must not be modified.

-

nm_device_get_ip4_config ()

-
NMIP4Config *         nm_device_get_ip4_config          (NMDevice *device);
+

nm_device_get_firmware_missing ()

+
gboolean            nm_device_get_firmware_missing      (NMDevice *device);

-Gets the current NMIP4Config associated with the NMDevice. +Indicates that firmware required for the device's operation is likely +to be missing.

@@ -530,18 +571,19 @@ Gets the current - +

Returns :

the NMIP4Config or NULL if the device is not activated. [transfer none] - +TRUE if firmware required for the device's operation is likely +to be missing.

-

nm_device_get_dhcp4_config ()

-
NMDHCP4Config *       nm_device_get_dhcp4_config        (NMDevice *device);
+

nm_device_get_iface ()

+
const char *        nm_device_get_iface                 (NMDevice *device);

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

@@ -553,19 +595,18 @@ Gets the current - +

Returns :

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

-

nm_device_get_ip6_config ()

-
NMIP6Config *         nm_device_get_ip6_config          (NMDevice *device);
+

nm_device_get_ip4_config ()

+
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);

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

@@ -577,7 +618,7 @@ Gets the current - @@ -585,10 +626,10 @@ Gets the current
-

nm_device_get_dhcp6_config ()

-
NMDHCP6Config *       nm_device_get_dhcp6_config        (NMDevice *device);
+

nm_device_get_ip6_config ()

+
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);

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

Returns :

the NMIP6Config or NULL if the device is not activated. [transfer none] +the NMIP4Config or NULL if the device is not activated. [transfer none]
@@ -600,8 +641,7 @@ Gets the current - @@ -609,10 +649,11 @@ using DHCP. [ -

nm_device_get_state ()

-
NMDeviceState       nm_device_get_state                 (NMDevice *device);
+

nm_device_get_ip_iface ()

+
const char *        nm_device_get_ip_iface              (NMDevice *device);

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

Returns :

the NMDHCPConfig or NULL if the device is not activated or not -using DHCP. [transfer none] +the NMIP6Config or NULL if the device is not activated. [transfer none]
@@ -624,17 +665,18 @@ Gets the current - +

Returns :

the current device statethe 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_managed ()

+
gboolean            nm_device_get_managed               (NMDevice *device);

-Gets the NMActiveConnection object which owns this device during activation. +Whether the NMDevice is managed by NetworkManager.

@@ -646,9 +688,8 @@ Gets the Returns :

-
+
the NMActiveConnection or NULL if the device is -not part of an active connection. [transfer none] - +TRUE if the device is managed by NetworkManager
@@ -656,7 +697,7 @@ not part of an active connection. [

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.

@@ -678,10 +719,10 @@ device, and must not be modified.

-

nm_device_get_vendor ()

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

nm_device_get_state ()

+
NMDeviceState       nm_device_get_state                 (NMDevice *device);

-Gets the vendor string of the NMDevice. +Gets the current NMDevice state.

@@ -693,31 +734,17 @@ 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 current device state

-

NMDeviceDeactivateFn ()

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

-

-
-
-
-

nm_device_disconnect ()

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

nm_device_get_udi ()

+
const char *        nm_device_get_udi                   (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 Unique Device Identifier of the NMDevice.

@@ -728,88 +755,61 @@ request. - - - - - - + +

callback :

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

user_data :

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

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.

-

nm_device_filter_connections ()

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

nm_device_get_vendor ()

+
const char *        nm_device_get_vendor                (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. +Gets the vendor string of the NMDevice.

- - - - - - +

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

-

nm_device_connection_valid ()

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

nm_device_new ()

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

-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. +Creates a new NMDevice.

- - - - - + + + + - +

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device +the DBusGConnection

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.a new device. [transfer full] +
@@ -997,6 +997,6 @@ Notifies the state change of a
- Generated by GTK-Doc V1.17
+ Generated by GTK-Doc V1.18
\ No newline at end of file -- cgit 1.3.0-6-gf8a5