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/NMDeviceEthernet.html | 618 ++++++++++++++++------------- 1 file changed, 342 insertions(+), 276 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceEthernet.html') diff --git a/docs/libnm-glib/html/NMDeviceEthernet.html b/docs/libnm-glib/html/NMDeviceEthernet.html index 4dec91a2..98767b2e 100644 --- a/docs/libnm-glib/html/NMDeviceEthernet.html +++ b/docs/libnm-glib/html/NMDeviceEthernet.html @@ -2,36 +2,28 @@ -NMDeviceEthernet +libnm-glib Reference Manual: NMDeviceEthernet - + - - - - - - - - - - + + + + + + +
@@ -39,363 +31,437 @@

NMDeviceEthernet

NMDeviceEthernet

- +
-
-

Synopsis

-
enum                NMDeviceEthernetError;
-#define             NM_DEVICE_ETHERNET_ERROR
-GQuark              nm_device_ethernet_error_quark      (void);
-#define             NM_DEVICE_ETHERNET_HW_ADDRESS
-#define             NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
-#define             NM_DEVICE_ETHERNET_SPEED
-#define             NM_DEVICE_ETHERNET_CARRIER
-                    NMDeviceEthernet;
-                    NMDeviceEthernetClass;
-GObject *           nm_device_ethernet_new              (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
-const char *        nm_device_ethernet_get_permanent_hw_address
-                                                        (NMDeviceEthernet *device);
-guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
-gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceEthernet
-
-
-
-

Implemented Interfaces

-

-NMDeviceEthernet implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "perm-hw-address"          gchar*                : Read
-  "speed"                    guint                 : Read
-
-
-

Description

-

-

-
-
-

Details

-
-

enum NMDeviceEthernetError

-
typedef enum {
-	NM_DEVICE_ETHERNET_ERROR_UNKNOWN = 0,                 /*< nick=UnknownError >*/
-	NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION,     /*< nick=NotEthernetConnection >*/
-	NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION, /*< nick=InvalidEthernetConnection >*/
-	NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC,          /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH,                /*< nick=MacMismatch >*/
-} NMDeviceEthernetError;
-
-
+

Functions

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

NM_DEVICE_ETHERNET_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_device_ethernet_error_quark ()

NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION

the connection was not of ethernet or PPPoE type + +GObject * + +nm_device_ethernet_new () +
const char * + +nm_device_ethernet_get_hw_address ()

NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION

the ethernet connection was invalid +const char * + +nm_device_ethernet_get_permanent_hw_address ()

NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC

the device's MAC was invalid + +guint32 + +nm_device_ethernet_get_speed ()

NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH

the MACs of the connection and the device mismatched + +gboolean + +nm_device_ethernet_get_carrier ()
-
-
-

NM_DEVICE_ETHERNET_ERROR

-
#define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
-
-

-

-
-
-
-

nm_device_ethernet_error_quark ()

-
GQuark              nm_device_ethernet_error_quark      (void);
-

-Registers an error quark for NMDeviceEthernet if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMDeviceEthernet errors.
gbooleancarrierRead
+gchar *hw-addressRead
+gchar *perm-hw-addressRead
guintspeedRead
-
-
-

NM_DEVICE_ETHERNET_HW_ADDRESS

-
#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
-
-

-

-
-
-
-

NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS

-
#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
enumNMDeviceEthernetError
#defineNM_DEVICE_ETHERNET_ERROR
#defineNM_DEVICE_ETHERNET_HW_ADDRESS
#defineNM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
#defineNM_DEVICE_ETHERNET_SPEED
#defineNM_DEVICE_ETHERNET_CARRIER
-
-
-

NM_DEVICE_ETHERNET_SPEED

-
#define NM_DEVICE_ETHERNET_SPEED       "speed"
+

+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceEthernet
 

-

-

 

-

-

-
NM_DEVICE_ETHERNET_CARRIER

-
#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
-

+

+
Description

 

 

 

-

+

+
Functions

 

-
NMDeviceEthernet

-
typedef struct _NMDeviceEthernet NMDeviceEthernet;

-

-

+
nm_device_ethernet_error_quark ()

+
GQuark
+nm_device_ethernet_error_quark (void);

+
Registers an error quark for NMDeviceEthernet if necessary.

+

+
Returns

+
 the error quark used for NMDeviceEthernet errors.

+

 

-

-

-
NMDeviceEthernetClass

-
typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceEthernetClass;
-

-

-

 

 

 

-
nm_device_ethernet_new ()

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

-

-Creates a new NMDeviceEthernet.
-

-

+
nm_device_ethernet_new ()

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

+
Creates a new NMDeviceEthernet.

+

+
Parameters

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

 





 
 
 
connection :
the DBusGConnection
-
path :
the DBus object path of the device
connection
the DBusGConnection
 
 

 
Returns :
a new device. [transfer full]
-
path
the DBus object path of the device
 
 

 
 

 

+

+
Returns

+
 a new device. 

+
[transfer full]

+

+

 

 

-
nm_device_ethernet_get_hw_address ()

-
const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);

-

-Gets the active hardware (MAC) address of the NMDeviceEthernet
-

-

+
nm_device_ethernet_get_hw_address ()

+
const char *
+nm_device_ethernet_get_hw_address (NMDeviceEthernet *device);

+
Gets the active hardware (MAC) address of the NMDeviceEthernet

+

+
Parameters

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

 





 
device :
a NMDeviceEthernet
-
Returns :
the active hardware address. This is the internal string used by the
-device, and must not be modified.
device
a NMDeviceEthernet
 

 

 

+

+
Returns

+
 the active hardware address. This is the internal string used by the
+device, and must not be modified.

+

+

+

 

 

-
nm_device_ethernet_get_permanent_hw_address ()

-
const char *        nm_device_ethernet_get_permanent_hw_address
-                                                        (NMDeviceEthernet *device);

-

-Gets the permanent hardware (MAC) address of the NMDeviceEthernet
-

-

+
nm_device_ethernet_get_permanent_hw_address ()

+
const char *
+nm_device_ethernet_get_permanent_hw_address
+                               (NMDeviceEthernet *device);

+
Gets the permanent hardware (MAC) address of the NMDeviceEthernet

+

+
Parameters

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

 





 
device :
a NMDeviceEthernet
-
Returns :
the permanent hardware address. This is the internal string used by the
-device, and must not be modified.
device
a NMDeviceEthernet
 

 

 

+

+
Returns

+
 the permanent hardware address. This is the internal string used by the
+device, and must not be modified.

+

+

+

 

 

-
nm_device_ethernet_get_speed ()

-
guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);

-

-Gets the speed of the NMDeviceEthernet.
-

-

+
nm_device_ethernet_get_speed ()

+
guint32
+nm_device_ethernet_get_speed (NMDeviceEthernet *device);

+
Gets the speed of the NMDeviceEthernet.

+

+
Parameters

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

 





 
device :
a NMDeviceEthernet
-
Returns :
the speed of the device
device
a NMDeviceEthernet
 

 

 

+

+
Returns

+
 the speed of the device

+

+

+
-

nm_device_ethernet_get_carrier ()

-
gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
-

-Whether the device has carrier. -

-
+

nm_device_ethernet_get_carrier ()

+
gboolean
+nm_device_ethernet_get_carrier (NMDeviceEthernet *device);
+

Whether the device has carrier.

+
+

Parameters

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

device

a NMDeviceEthernet

 
+
+
+

Returns

+

TRUE if the device has carrier

+

+
+
+
+
+

Types and Values

+
+

enum NMDeviceEthernetError

+
+

Members

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

device :

a NMDeviceEthernet +

NM_DEVICE_ETHERNET_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

 -TRUE if the device has carrier

NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION

 +

the connection was not of ethernet or PPPoE type

+		 

NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION

 +

the ethernet connection was invalid

+		 

NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC

 +

the device's MAC was invalid

+		 

NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH

 +

the MACs of the connection and the device mismatched

+		 
-
-

Property Details

+
-

The "carrier" property

-
  "carrier"                  gboolean              : Read
+

NM_DEVICE_ETHERNET_ERROR

+
#define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
+

-Whether the device has carrier.

-

Default value: FALSE

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
+

NM_DEVICE_ETHERNET_HW_ADDRESS

+
#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
+

-The active hardware (MAC) address of the device.

-

Default value: NULL

-

The "perm-hw-address" property

-
  "perm-hw-address"          gchar*                : Read
+

NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS

+
#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
+

-The permanent hardware (MAC) address of the device.

-

Default value: NULL

-

The "speed" property

-
  "speed"                    guint                 : Read
+

NM_DEVICE_ETHERNET_SPEED

+
#define NM_DEVICE_ETHERNET_SPEED       "speed"
+
+

+

+
+
+
+

NM_DEVICE_ETHERNET_CARRIER

+
#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
+

-The speed of the device.

+
+
+
+

Property Details

+
+

The “carrier” property

+
  “carrier”                  gboolean
+

Carrier.

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “hw-address” property

+
  “hw-address”               gchar *
+

Currently set hardware MAC address.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “perm-hw-address” property

+
  “perm-hw-address”          gchar *
+

Permanent hardware MAC address.

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “speed” property

+
  “speed”                    guint
+

Speed.

+

Flags: Read

Default value: 0

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