From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMDevice.html | 2389 ++++++++++++++++++++---------------- 1 file changed, 1360 insertions(+), 1029 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 621a183b..35d1dd2a 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -2,38 +2,29 @@ -NMDevice +libnm-glib Reference Manual: NMDevice - + - - - - - - - - - - + + + + + + +
@@ -41,1370 +32,1710 @@

NMDevice

NMDevice

- +
-
-

Synopsis

-
#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_VERSION
-#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_DHCP6_CONFIG
-#define             NM_DEVICE_STATE
-#define             NM_DEVICE_STATE_REASON
-#define             NM_DEVICE_ACTIVE_CONNECTION
-#define             NM_DEVICE_AVAILABLE_CONNECTIONS
-#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);
-const char *        nm_device_get_driver_version        (NMDevice *device);
-const char *        nm_device_get_firmware_version      (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);
-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);
-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);
-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);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceEthernet
-               +----NMDeviceWifi
-               +----NMDeviceModem
-               +----NMDeviceBt
-               +----NMDeviceWimax
-               +----NMDeviceOlpcMesh
-               +----NMDeviceAdsl
-               +----NMDeviceInfiniband
-               +----NMDeviceBond
-               +----NMDeviceBridge
-               +----NMDeviceVlan
-
-
-

Implemented Interfaces

-

-NMDevice implements - GInitable and GAsyncInitable.

+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GObject * + +nm_device_new () +
const char * + +nm_device_get_iface () +
const char * + +nm_device_get_ip_iface () +
+NMDeviceType + +nm_device_get_device_type () +
const char * + +nm_device_get_udi () +
const char * + +nm_device_get_driver () +
const char * + +nm_device_get_driver_version () +
const char * + +nm_device_get_firmware_version () +
+NMDeviceCapabilities + +nm_device_get_capabilities () +
+gboolean + +nm_device_get_managed () +
+gboolean + +nm_device_get_autoconnect () +
+void + +nm_device_set_autoconnect () +
+gboolean + +nm_device_get_firmware_missing () +
+NMIP4Config * + +nm_device_get_ip4_config () +
+NMDHCP4Config * + +nm_device_get_dhcp4_config () +
+NMIP6Config * + +nm_device_get_ip6_config () +
+NMDHCP6Config * + +nm_device_get_dhcp6_config () +
+NMDeviceState + +nm_device_get_state () +
+NMDeviceState + +nm_device_get_state_reason () +
+NMActiveConnection * + +nm_device_get_active_connection () +
const GPtrArray * + +nm_device_get_available_connections () +
const char * + +nm_device_get_product () +
const char * + +nm_device_get_vendor () +
+void + +(*NMDeviceDeactivateFn) () +
+void + +nm_device_disconnect () +
+GSList * + +nm_device_filter_connections () +
+gboolean + +nm_device_connection_valid () +
+gboolean + +nm_device_connection_compatible () +

Properties

-
-  "active-connection"        NMActiveConnection*   : Read
-  "autoconnect"              gboolean              : Read / Write
-  "available-connections"    NMObjectArray*        : Read
-  "capabilities"             guint                 : Read
-  "device-type"              guint                 : Read
-  "dhcp4-config"             NMDHCP4Config*        : Read
-  "dhcp6-config"             NMDHCP6Config*        : Read
-  "driver"                   gchar*                : Read
-  "driver-version"           gchar*                : Read
-  "firmware-missing"         gboolean              : Read
-  "firmware-version"         gchar*                : Read
-  "interface"                gchar*                : Read
-  "ip-interface"             gchar*                : Read
-  "ip4-config"               NMIP4Config*          : Read
-  "ip6-config"               NMIP6Config*          : Read
-  "managed"                  gboolean              : Read
-  "product"                  gchar*                : Read
-  "state"                    guint                 : Read
-  "state-reason"             GValueArray_guint+guint_*  : Read
-  "udi"                      gchar*                : Read
-  "vendor"                   gchar*                : Read
-
-
-
-

Signals

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

-

-
-
-
-

NM_DEVICE_INTERFACE

-
#define NM_DEVICE_INTERFACE "interface"
-
-

-

-
-
-
-

NM_DEVICE_IP_INTERFACE

-
#define NM_DEVICE_IP_INTERFACE "ip-interface"
-
-

-

-
-
-
-

NM_DEVICE_DRIVER

-
#define NM_DEVICE_DRIVER "driver"
-
-

-

-
-
-
-

NM_DEVICE_DRIVER_VERSION

-
#define NM_DEVICE_DRIVER_VERSION "driver-version"
-
-

-

-
-
-
-

NM_DEVICE_FIRMWARE_VERSION

-
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
-
-

-

-
-
-
-

NM_DEVICE_CAPABILITIES

-
#define NM_DEVICE_CAPABILITIES "capabilities"
-
-

-

-
-
-
-

NM_DEVICE_MANAGED

-
#define NM_DEVICE_MANAGED "managed"
-
-

-

-
-
-
-

NM_DEVICE_AUTOCONNECT

-
#define NM_DEVICE_AUTOCONNECT "autoconnect"
-
-

-

-
-
-
-

NM_DEVICE_FIRMWARE_MISSING

-
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
-
-

-

-
-
-
-

NM_DEVICE_IP4_CONFIG

-
#define NM_DEVICE_IP4_CONFIG "ip4-config"
-
-

-

-
-
-
-

NM_DEVICE_DHCP4_CONFIG

-
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
-
-

-

-
-
-
-

NM_DEVICE_IP6_CONFIG

-
#define NM_DEVICE_IP6_CONFIG "ip6-config"
-
-

-

-
-
-
-

NM_DEVICE_DHCP6_CONFIG

-
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
-
-

-

-
-
-
-

NM_DEVICE_STATE

-
#define NM_DEVICE_STATE "state"
-
-

-

-
-
-
-

NM_DEVICE_STATE_REASON

-
#define NM_DEVICE_STATE_REASON "state-reason"
-
-

-

-
-
-
-

NM_DEVICE_ACTIVE_CONNECTION

-
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
-
-

-

-
-
-
-

NM_DEVICE_AVAILABLE_CONNECTIONS

-
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
-
-

-

-
-
-
-

NM_DEVICE_VENDOR

-
#define NM_DEVICE_VENDOR "vendor"
-
-

-

-
-
-
-

NM_DEVICE_PRODUCT

-
#define NM_DEVICE_PRODUCT "product"
-
-

-

-
-
-
-

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

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

-Creates a new NMDevice. -

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

connection :

the DBusGConnection - +NMActiveConnection *active-connectionRead
gbooleanautoconnectRead / Write
+NMObjectArray *available-connectionsRead
guintcapabilitiesRead
guintdevice-typeRead
+NMDHCP4Config *dhcp4-configRead
+NMDHCP6Config *dhcp6-configRead
+gchar *driverRead
+gchar *driver-versionRead
gbooleanfirmware-missingRead
+gchar *firmware-versionRead
+gchar *interfaceRead
+gchar *ip-interfaceRead
+NMIP4Config *ip4-configRead
+NMIP6Config *ip6-configRead
gbooleanmanagedRead
+gchar *productRead
guintstateRead
GValueArray_guint+guint_*state-reasonRead

path :

the DBus object path of the device +gchar *udiRead

Returns :

a new device. [transfer full] - +gchar *vendorRead
-
-
-

nm_device_get_iface ()

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

-Gets the interface name of the NMDevice. -

-
+
+

Signals

+
+++++ + + + + + +
voidstate-changedRun First
+
+
+

Types and Values

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

device :

a NMDevice -#defineNM_DEVICE_DEVICE_TYPE
#defineNM_DEVICE_UDI
#defineNM_DEVICE_INTERFACE
#defineNM_DEVICE_IP_INTERFACE
#defineNM_DEVICE_DRIVER
#defineNM_DEVICE_DRIVER_VERSION
#defineNM_DEVICE_FIRMWARE_VERSION
#defineNM_DEVICE_CAPABILITIES
#defineNM_DEVICE_MANAGED
#defineNM_DEVICE_AUTOCONNECT
#defineNM_DEVICE_FIRMWARE_MISSING
#defineNM_DEVICE_IP4_CONFIG
#defineNM_DEVICE_DHCP4_CONFIG
#defineNM_DEVICE_IP6_CONFIG
#defineNM_DEVICE_DHCP6_CONFIG
#defineNM_DEVICE_STATE
#defineNM_DEVICE_STATE_REASON
#defineNM_DEVICE_ACTIVE_CONNECTION
#defineNM_DEVICE_AVAILABLE_CONNECTIONS
#defineNM_DEVICE_VENDOR

Returns :

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

nm_device_get_ip_iface ()

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

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ├── NMDeviceEthernet
+            ├── NMDeviceWifi
+            ├── NMDeviceModem
+            ├── NMDeviceBt
+            ├── NMDeviceWimax
+            ├── NMDeviceOlpcMesh
+            ├── NMDeviceAdsl
+            ├── NMDeviceInfiniband
+            ├── NMDeviceBond
+            ├── NMDeviceBridge
+            ╰── NMDeviceVlan
+
+
+
+

Description

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

-
+ +
+

Functions

+
+

nm_device_new ()

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

Creates a new NMDevice.

+
+

Parameters

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

device :

a NMDevice -

connection

the DBusGConnection

 

Returns :

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

path

the DBus object path of the device

 
+
+

Returns

+

a new device.

+

[transfer full]

+
+
-

nm_device_get_device_type ()

-
NMDeviceType        nm_device_get_device_type           (NMDevice *device);
-

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

-
+

nm_device_get_iface ()

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

Gets the interface name of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

the device type

device

a NMDevice

 
+
+

Returns

+

the interface 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);
-

-Gets the Unique Device Identifier of the NMDevice. -

-
+

nm_device_get_ip_iface ()

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

+
+

Parameters

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

device :

a NMDevice -

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.

device

a NMDevice

 
+
+

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

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

-Gets the driver of the NMDevice. -

-
+

nm_device_get_device_type ()

+
NMDeviceType
+nm_device_get_device_type (NMDevice *device);
+

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

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

the device type

+

+
+
-

nm_device_get_driver_version ()

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

-Gets the driver version of the NMDevice. -

-
+

nm_device_get_udi ()

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

Gets the Unique Device Identifier of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

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

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

-Gets the firmware version of the NMDevice. -

-
+

nm_device_get_driver ()

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

Gets the driver of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

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

-Gets the device' capabilities. -

-
+

nm_device_get_driver_version ()

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

Gets the driver version of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

the capabilities

device

a NMDevice

 
+
+

Returns

+

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

+

+
+
-

nm_device_get_managed ()

-
gboolean            nm_device_get_managed               (NMDevice *device);
-

-Whether the NMDevice is managed by NetworkManager. -

-
+

nm_device_get_firmware_version ()

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

Gets the firmware version of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

 -TRUE if the device is managed by NetworkManager

device

a NMDevice

 
+
+

Returns

+

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

+

+
+
-

nm_device_get_autoconnect ()

-
gboolean            nm_device_get_autoconnect           (NMDevice *device);
-

-Whether the NMDevice can be autoconnected. -

-
+

nm_device_get_capabilities ()

+
NMDeviceCapabilities
+nm_device_get_capabilities (NMDevice *device);
+

Gets the device' capabilities.

+
+

Parameters

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

device :

a NMDevice -

Returns :

 -TRUE if the device is allowed to be autoconnected

device

a NMDevice

 
+
+

Returns

+

the capabilities

+

+
+
-

nm_device_set_autoconnect ()

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

-Enables or disables automatic activation of the NMDevice. -

-
+

nm_device_get_managed ()

+
gboolean
+nm_device_get_managed (NMDevice *device);
+

Whether the NMDevice is managed by NetworkManager.

+
+

Parameters

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

device :

a NMDevice -

autoconnect :

 -TRUE to enable autoconnecting

device

a NMDevice

 
+
+

Returns

+

TRUE if the device is managed by NetworkManager

+

+
+
-

nm_device_get_firmware_missing ()

-
gboolean            nm_device_get_firmware_missing      (NMDevice *device);
-

-Indicates that firmware required for the device's operation is likely -to be missing. -

-
+

nm_device_get_autoconnect ()

+
gboolean
+nm_device_get_autoconnect (NMDevice *device);
+

Whether the NMDevice can be autoconnected.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

TRUE if the device is allowed to be autoconnected

+

+
+
-

nm_device_get_ip4_config ()

-
NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
-

-Gets the current NMIP4Config associated with the NMDevice. -

-
+

nm_device_set_autoconnect ()

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

Enables or disables automatic activation of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

device

a NMDevice

 

Returns :

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

autoconnect

TRUE to enable autoconnecting

 
+
-

nm_device_get_dhcp4_config ()

-
NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
-

-Gets the current NMDHCP4Config associated with the NMDevice. -

-
+

nm_device_get_firmware_missing ()

+
gboolean
+nm_device_get_firmware_missing (NMDevice *device);
+

Indicates that firmware required for the device's operation is likely +to be missing.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

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

+

+
+
-

nm_device_get_ip6_config ()

-
NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
-

-Gets the current NMIP6Config associated with the NMDevice. -

-
+

nm_device_get_ip4_config ()

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

Gets the current NMIP4Config associated with the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

the NMIP4Config or NULL if the device is not activated.

+

[transfer none]

+
+
-

nm_device_get_dhcp6_config ()

-
NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
-

-Gets the current NMDHCP6Config associated with the NMDevice. -

-
+

nm_device_get_dhcp4_config ()

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

Gets the current NMDHCP4Config associated with the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

the NMDHCP4Config or NULL if the device is not activated or not +using DHCP.

+

[transfer none]

+
+
-

nm_device_get_state ()

-
NMDeviceState       nm_device_get_state                 (NMDevice *device);
-

-Gets the current NMDevice state. -

-
+

nm_device_get_ip6_config ()

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

Gets the current NMIP6Config associated with the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

the current device state

device

a NMDevice

 
+
+

Returns

+

the NMIP6Config or NULL if the device is not activated.

+

[transfer none]

+
+
-

nm_device_get_state_reason ()

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

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

-
+

nm_device_get_dhcp6_config ()

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

Gets the current NMDHCP6Config associated with the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

reason :

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

Returns :

the current device state

device

a NMDevice

 
+
+

Returns

+

the NMDHCP6Config or NULL if the device is not activated or not +using DHCP.

+

[transfer none]

+
+
-

nm_device_get_active_connection ()

-
NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
-

-Gets the NMActiveConnection object which owns this device during activation. -

-
+

nm_device_get_state ()

+
NMDeviceState
+nm_device_get_state (NMDevice *device);
+

Gets the current NMDevice state.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

the current device state

+

+
+
-

nm_device_get_available_connections ()

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

-Gets the NMRemoteConnections currently known to the daemon that could -be activated on device. -

-
+

nm_device_get_state_reason ()

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

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

+
+

Parameters

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

device :

a NMDevice -

device

a NMDevice

 

Returns :

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

reason

location to store reason (NMDeviceStateReason), or NULL.

[out][allow-none]
+
+
+

Returns

+

the current device state

+

+
+ +
+
+

nm_device_get_active_connection ()

+
NMActiveConnection *
+nm_device_get_active_connection (NMDevice *device);
+

Gets the NMActiveConnection object which owns this device during activation.

+
+

Parameters

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

device

a NMDevice

 
+
+
+

Returns

+

the NMActiveConnection or NULL if the device is +not part of an active connection.

+

[transfer none]

+
+
+
+
+

nm_device_get_available_connections ()

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

Gets the NMRemoteConnections currently known to the daemon that could +be activated on device +.

+
+

Parameters

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

device

a NMDevice

 
+
+
+

Returns

+

the 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_product ()

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

-Gets the product string of the NMDevice. -

-
+

nm_device_get_product ()

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

Gets the product string of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

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

-
+

nm_device_get_vendor ()

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

Gets the vendor string of the NMDevice.

+
+

Parameters

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

device :

a NMDevice -

Returns :

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

device

a NMDevice

 
+
+

Returns

+

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

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 +

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

-
+request.

+
+

Parameters

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

device :

a NMDevice -

device

a NMDevice

 

callback :

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

callback

callback to be called when disconnect +operation completes.

[scope async][allow-none]

user_data :

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

user_data

caller-specific data passed to callback +.

[closure]
+
-

nm_device_filter_connections ()

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

-Filters a given list of connections for a given NMDevice object and return +

nm_device_filter_connections ()

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

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

-
+nm_remote_settings_list_connections().

+
+

Parameters

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

device :

an NMDevice to filter connections for

connections :

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

device

an NMDevice to filter connections for

 

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

connections

a list of NMConnection objects to filter.

[element-type NetworkManager.Connection]
+
+

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]

+
+
-

nm_device_connection_valid ()

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

-Validates a given connection for a given NMDevice object and returns +

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

+
+

Parameters

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

device :

an NMDevice to validate connection against

connection :

an NMConnection to validate against device -

device

an NMDevice to validate connection +against

 

Returns :

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

connection

an NMConnection to validate against 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_compatible ()

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

-Validates a given connection for a given NMDevice object and returns +

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

-
+GError when FALSE is returned.

+
+

Parameters

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

device :

an NMDevice to validate connection against

device

an NMDevice to validate connection +against

 

connection :

an NMConnection to validate against device -

error :

return location for a GError, or NULL -

connection

an NMConnection to validate against device +

 

Returns :

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

error

return location for a GError, or NULL

 
+
+

Returns

+

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

+

+
+
-

Property Details

+

Types and Values

-

The "active-connection" property

-
  "active-connection"        NMActiveConnection*   : Read
+

NM_DEVICE_DEVICE_TYPE

+
#define NM_DEVICE_DEVICE_TYPE "device-type"
+

-The NMActiveConnection object that "owns" this device during activation.

-

The "autoconnect" property

-
  "autoconnect"              gboolean              : Read / Write
+

NM_DEVICE_UDI

+
#define NM_DEVICE_UDI "udi"
+

-Whether the device can auto-activate a connection.

-

Default value: TRUE

-

The "available-connections" property

-
  "available-connections"    NMObjectArray*        : Read
+

NM_DEVICE_INTERFACE

+
#define NM_DEVICE_INTERFACE "interface"
+

-The available connections (NMRemoteConnection) of the device

-

Since 0.9.8

-

The "capabilities" property

-
  "capabilities"             guint                 : Read
+

NM_DEVICE_IP_INTERFACE

+
#define NM_DEVICE_IP_INTERFACE "ip-interface"
+

-The capabilities of the device.

-

Default value: 0

-

The "device-type" property

-
  "device-type"              guint                 : Read
+

NM_DEVICE_DRIVER

+
#define NM_DEVICE_DRIVER "driver"
+

-The numeric type of the device.

-

Default value: 0

-

The "dhcp4-config" property

-
  "dhcp4-config"             NMDHCP4Config*        : Read
+

NM_DEVICE_DRIVER_VERSION

+
#define NM_DEVICE_DRIVER_VERSION "driver-version"
+

-The NMDHCP4Config of the device.

-

The "dhcp6-config" property

-
  "dhcp6-config"             NMDHCP6Config*        : Read
+

NM_DEVICE_FIRMWARE_VERSION

+
#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
+

-The NMDHCP6Config of the device.

-

The "driver" property

-
  "driver"                   gchar*                : Read
+

NM_DEVICE_CAPABILITIES

+
#define NM_DEVICE_CAPABILITIES "capabilities"
+

-The driver of the device.

-

Default value: NULL

-

The "driver-version" property

-
  "driver-version"           gchar*                : Read
+

NM_DEVICE_MANAGED

+
#define NM_DEVICE_MANAGED "managed"
+

-The version of the device driver.

-

Default value: NULL

-

The "firmware-missing" property

-
  "firmware-missing"         gboolean              : Read
+

NM_DEVICE_AUTOCONNECT

+
#define NM_DEVICE_AUTOCONNECT "autoconnect"
+

-When TRUE indicates the device is likely missing firmware required -for its operation.

-

Default value: FALSE

-

The "firmware-version" property

-
  "firmware-version"         gchar*                : Read
+

NM_DEVICE_FIRMWARE_MISSING

+
#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+

-The firmware version of the device.

-

Default value: NULL

-

The "interface" property

-
  "interface"                gchar*                : Read
+

NM_DEVICE_IP4_CONFIG

+
#define NM_DEVICE_IP4_CONFIG "ip4-config"
+

-The interface of the device.

-

Default value: NULL

-

The "ip-interface" property

-
  "ip-interface"             gchar*                : Read
+

NM_DEVICE_DHCP4_CONFIG

+
#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+

-The IP interface of the device which should be used for all IP-related -operations like addressing and routing.

-

Default value: NULL

-

The "ip4-config" property

-
  "ip4-config"               NMIP4Config*          : Read
+

NM_DEVICE_IP6_CONFIG

+
#define NM_DEVICE_IP6_CONFIG "ip6-config"
+

-The NMIP4Config of the device.

-

The "ip6-config" property

-
  "ip6-config"               NMIP6Config*          : Read
+

NM_DEVICE_DHCP6_CONFIG

+
#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+

-The NMIP6Config of the device.

-

The "managed" property

-
  "managed"                  gboolean              : Read
+

NM_DEVICE_STATE

+
#define NM_DEVICE_STATE "state"
+

-Whether the device is managed by NetworkManager.

-

Default value: FALSE

-

The "product" property

-
  "product"                  gchar*                : Read
+

NM_DEVICE_STATE_REASON

+
#define NM_DEVICE_STATE_REASON "state-reason"
+

-The product string of the device.

-

Default value: NULL

-

The "state" property

-
  "state"                    guint                 : Read
+

NM_DEVICE_ACTIVE_CONNECTION

+
#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+

-The state of the device.

-

Default value: 0

-

The "state-reason" property

-
  "state-reason"             GValueArray_guint+guint_*  : Read
+

NM_DEVICE_AVAILABLE_CONNECTIONS

+
#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
+

-The state and reason of the device.

-

The "udi" property

-
  "udi"                      gchar*                : Read
+

NM_DEVICE_VENDOR

+
#define NM_DEVICE_VENDOR "vendor"
+

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

-

Default value: NULL

-

The "vendor" property

-
  "vendor"                   gchar*                : Read
+

NM_DEVICE_PRODUCT

+
#define NM_DEVICE_PRODUCT "product"
+

-The vendor string of the device.

+
+
+
+

Property Details

+
+

The “active-connection” property

+
  “active-connection”        NMActiveConnection *
+

Active Connection.

+

Flags: Read

+
+
+
+

The “autoconnect” property

+
  “autoconnect”              gboolean
+

Autoconnect.

+

Flags: Read / Write

+

Default value: TRUE

+
+
+
+

The “available-connections” property

+
  “available-connections”    NMObjectArray *
+

Available Connections.

+

Flags: Read

+

Since 0.9.8

+
+
+
+

The “capabilities” property

+
  “capabilities”             guint
+

Capabilities.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “device-type” property

+
  “device-type”              guint
+

Numeric device type (ie ethernet, wifi, etc).

+

Flags: Read

+

Default value: 0

+
+
+
+

The “dhcp4-config” property

+
  “dhcp4-config”             NMDHCP4Config *
+

DHCP4 Config.

+

Flags: Read

+
+
+
+

The “dhcp6-config” property

+
  “dhcp6-config”             NMDHCP6Config *
+

DHCP6 Config.

+

Flags: Read

+
+
+
+

The “driver” property

+
  “driver”                   gchar *
+

Driver.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “driver-version” property

+
  “driver-version”           gchar *
+

Driver Version.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “firmware-missing” property

+
  “firmware-missing”         gboolean
+

Firmware missing.

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “firmware-version” property

+
  “firmware-version”         gchar *
+

Firmware Version.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “interface” property

+
  “interface”                gchar *
+

Interface name.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “ip-interface” property

+
  “ip-interface”             gchar *
+

IP Interface name.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “ip4-config” property

+
  “ip4-config”               NMIP4Config *
+

IP4 Config.

+

Flags: Read

+
+
+
+

The “ip6-config” property

+
  “ip6-config”               NMIP6Config *
+

IP6 Config.

+

Flags: Read

+
+
+
+

The “managed” property

+
  “managed”                  gboolean
+

Managed.

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “product” property

+
  “product”                  gchar *
+

Product string.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “state” property

+
  “state”                    guint
+

State.

+

Flags: Read

+

Default value: 0

+
+
+
+

The “state-reason” property

+
  “state-reason”             GValueArray_guint+guint_*
+

StateReason.

+

Flags: Read

+
+
+
+

The “udi” property

+
  “udi”                      gchar *
+

Unique Device Identifier.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “vendor” property

+
  “vendor”                   gchar *
+

Vendor string.

+

Flags: Read

Default value: NULL

Signal Details

-

The "state-changed" signal

-
void                user_function                      (NMDevice *device,
-                                                        guint     new_state,
-                                                        guint     old_state,
-                                                        guint     reason,
-                                                        gpointer  user_data)      : Run First
-

-Notifies the state change of a NMDevice. -

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

device :

the device object that received the signal

new_state :

the new state of the device

old_state :

the previous state of the device

reason :

the reason describing the state change

user_data :

user data set when the signal handler was connected.
+

The “state-changed” signal

+
void
+user_function (NMDevice *device,
+               guint     new_state,
+               guint     old_state,
+               guint     reason,
+               gpointer  user_data)
+

Flags: Run First

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file -- cgit 1.3.0-6-gf8a5