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/NMDeviceVlan.html | 526 ++++++++++++++++++--------------- 1 file changed, 290 insertions(+), 236 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceVlan.html') diff --git a/docs/libnm-glib/html/NMDeviceVlan.html b/docs/libnm-glib/html/NMDeviceVlan.html index 7ca398c1..b7952355 100644 --- a/docs/libnm-glib/html/NMDeviceVlan.html +++ b/docs/libnm-glib/html/NMDeviceVlan.html @@ -2,36 +2,28 @@ -NMDeviceVlan +libnm-glib Reference Manual: NMDeviceVlan - + - - - - - - - - - - + + + + + + +
@@ -39,306 +31,368 @@

NMDeviceVlan

NMDeviceVlan

- +
-
-

Synopsis

-
enum                NMDeviceVlanError;
-#define             NM_DEVICE_VLAN_ERROR
-GQuark              nm_device_vlan_error_quark          (void);
-#define             NM_DEVICE_VLAN_HW_ADDRESS
-#define             NM_DEVICE_VLAN_CARRIER
-#define             NM_DEVICE_VLAN_VLAN_ID
-                    NMDeviceVlan;
-                    NMDeviceVlanClass;
-GObject *           nm_device_vlan_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
-gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
-guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);
-
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceVlan
-
-
-
-

Implemented Interfaces

-

-NMDeviceVlan implements - GInitable and GAsyncInitable.

-
-
-

Properties

-
-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "vlan-id"                  guint                 : Read
-
-
-
-

Description

-

-

-
-

Details

-
-

enum NMDeviceVlanError

-
typedef enum {
-	NM_DEVICE_VLAN_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION,     /*< nick=NotVlanConnection >*/
-	NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION, /*< nick=InvalidVlanConnection >*/
-	NM_DEVICE_VLAN_ERROR_ID_MISMATCH,             /*< nick=IdMismatch >*/
-	NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH,      /*< nick=InterfaceMismatch >*/
-} NMDeviceVlanError;
-
-
+

Functions

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

NM_DEVICE_VLAN_ERROR_UNKNOWN

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

NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION

the connection was not of VLAN type + +GObject * + +nm_device_vlan_new ()

NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION

the VLAN connection was invalid +const char * + +nm_device_vlan_get_hw_address ()

NM_DEVICE_VLAN_ERROR_ID_MISMATCH

the VLAN identifiers of the connection and the device mismatched + +gboolean + +nm_device_vlan_get_carrier ()

NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH

the interfaces of the connection and the device mismatched + +guint + +nm_device_vlan_get_vlan_id ()
-
-
-

NM_DEVICE_VLAN_ERROR

-
#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark ()
-
-

-

-
-
-
-

nm_device_vlan_error_quark ()

-
GQuark              nm_device_vlan_error_quark          (void);
-

-Registers an error quark for NMDeviceVlan if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMDeviceVlan errors.
gbooleancarrierRead
+gchar *hw-addressRead
guintvlan-idRead
-
-
-

NM_DEVICE_VLAN_HW_ADDRESS

-
#define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
enumNMDeviceVlanError
#defineNM_DEVICE_VLAN_ERROR
#defineNM_DEVICE_VLAN_HW_ADDRESS
#defineNM_DEVICE_VLAN_CARRIER
#defineNM_DEVICE_VLAN_VLAN_ID
-
-
-

NM_DEVICE_VLAN_CARRIER

-
#define NM_DEVICE_VLAN_CARRIER     "carrier"
+

+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceVlan
 

-

-

 

-

-

-
NM_DEVICE_VLAN_VLAN_ID

-
#define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"
-

+

+
Description

 

 

 

-

+

+
Functions

 

-
NMDeviceVlan

-
typedef struct _NMDeviceVlan NMDeviceVlan;

-

-

+
nm_device_vlan_error_quark ()

+
GQuark
+nm_device_vlan_error_quark (void);

+
Registers an error quark for NMDeviceVlan if necessary.

+

+
Returns

+
 the error quark used for NMDeviceVlan errors.

+

 

-

-

-
NMDeviceVlanClass

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

-

-

 

 

 

-
nm_device_vlan_new ()

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

-

-Creates a new NMDeviceVlan.
-

-

+
nm_device_vlan_new ()

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

+
Creates a new NMDeviceVlan.

+

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

-
const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);

-

-Gets the hardware (MAC) address of the NMDeviceVlan
-

-

+
nm_device_vlan_get_hw_address ()

+
const char *
+nm_device_vlan_get_hw_address (NMDeviceVlan *device);

+
Gets the hardware (MAC) address of the NMDeviceVlan

+

+
Parameters

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

 





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

 

 

+

+
Returns

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

+

+

+

 

 

-
nm_device_vlan_get_carrier ()

-
gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);

-

-Whether the device has carrier.
-

-

+
nm_device_vlan_get_carrier ()

+
gboolean
+nm_device_vlan_get_carrier (NMDeviceVlan *device);

+
Whether the device has carrier.

+

+
Parameters

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

 





 
device :
a NMDeviceVlan
-
Returns :

-TRUE if the device has carrier
device
a NMDeviceVlan
 

 

 

+

+
Returns

+
 TRUE if the device has carrier

+

+

+

 

 

-
nm_device_vlan_get_vlan_id ()

-
guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);

-

+
nm_device_vlan_get_vlan_id ()

+
guint
+nm_device_vlan_get_vlan_id (NMDeviceVlan *device);

+

+
Parameters

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

 






device
a NMDeviceVlan
 

+

+

+
Returns

+
 the device's VLAN ID

+

+

+
+
+
+

Types and Values

+
+

enum NMDeviceVlanError

+
+

Members

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

device :

a NMDeviceVlan +

NM_DEVICE_VLAN_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION

 +

the connection was not of VLAN type

+		 

NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION

 +

the VLAN connection was invalid

+		 

NM_DEVICE_VLAN_ERROR_ID_MISMATCH

 +

the VLAN identifiers of the connection and the device mismatched

 

Returns :

the device's VLAN ID

NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH

 +

the interfaces of the connection and the device mismatched

+		 
-
-

Property Details

+
-

The "carrier" property

-
  "carrier"                  gboolean              : Read
+

NM_DEVICE_VLAN_ERROR

+
#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark ()
+

-Whether the device has carrier.

-

Default value: FALSE

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
+

NM_DEVICE_VLAN_HW_ADDRESS

+
#define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"
+

-The hardware (MAC) address of the device.

-

Default value: NULL

-

The "vlan-id" property

-
  "vlan-id"                  guint                 : Read
+

NM_DEVICE_VLAN_CARRIER

+
#define NM_DEVICE_VLAN_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_VLAN_VLAN_ID

+
#define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"
+

-The device's VLAN ID.

+
+
+
+

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 “vlan-id” property

+
  “vlan-id”                  guint
+

VLAN ID.

+

Flags: Read

Allowed values: <= 4095

Default value: 0

@@ -346,6 +400,6 @@ The device's VLAN ID.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file -- cgit 1.3.0-6-gf8a5