From 9c202e3e860b3be9e1f8882630b69affbb130102 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 3 Feb 2013 14:49:22 +0100 Subject: Imported Upstream version 0.9.7.995 --- docs/libnm-glib/html/NMDeviceBridge.html | 331 +++++++++++++++++++++++++++++++ 1 file changed, 331 insertions(+) create mode 100644 docs/libnm-glib/html/NMDeviceBridge.html (limited to 'docs/libnm-glib/html/NMDeviceBridge.html') diff --git a/docs/libnm-glib/html/NMDeviceBridge.html b/docs/libnm-glib/html/NMDeviceBridge.html new file mode 100644 index 00000000..4a9b431f --- /dev/null +++ b/docs/libnm-glib/html/NMDeviceBridge.html @@ -0,0 +1,331 @@ + + + + +NMDeviceBridge + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMDeviceBridge

+

NMDeviceBridge

+
+
+

Synopsis

+
                    NMDeviceBridge;
+                    NMDeviceBridgeClass;
+enum                NMDeviceBridgeError;
+#define             NM_DEVICE_BRIDGE_CARRIER
+#define             NM_DEVICE_BRIDGE_ERROR
+#define             NM_DEVICE_BRIDGE_HW_ADDRESS
+#define             NM_DEVICE_BRIDGE_SLAVES
+GQuark              nm_device_bridge_error_quark        (void);
+gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
+const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);
+const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);
+GObject *           nm_device_bridge_new                (DBusGConnection *connection,
+                                                         const char *path);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceBridge
+
+
+
+

Implemented Interfaces

+

+NMDeviceBridge implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "slaves"                   NMObjectArray*        : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NMDeviceBridge

+
typedef struct _NMDeviceBridge NMDeviceBridge;
+

+

+
+
+
+

NMDeviceBridgeClass

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

+

+
+
+
+

enum NMDeviceBridgeError

+
typedef enum {
+	NM_DEVICE_BRIDGE_ERROR_UNKNOWN = 0,               /*< nick=UnknownError >*/
+	NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION,     /*< nick=NotBridgeConnection >*/
+	NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION, /*< nick=InvalidBridgeConnection >*/
+	NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH,        /*< nick=InterfaceMismatch >*/
+} NMDeviceBridgeError;
+
+
++ + + + + + + + + + + + + + + + + + +

NM_DEVICE_BRIDGE_ERROR_UNKNOWN

unknown or unclassified error +

NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION

the connection was not of bridge type +

NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION

the bridge connection was invalid +

NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH

the interfaces of the connection and the device mismatched +
+
+
+
+

NM_DEVICE_BRIDGE_CARRIER

+
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_ERROR

+
#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_HW_ADDRESS

+
#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_SLAVES

+
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
+
+

+

+
+
+
+

nm_device_bridge_error_quark ()

+
GQuark              nm_device_bridge_error_quark        (void);
+

+Registers an error quark for NMDeviceBridge if necessary. +

+
++ + + + +

Returns :

the error quark used for NMDeviceBridge errors.
+
+
+
+

nm_device_bridge_get_carrier ()

+
gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
+

+Whether the device has carrier. +

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

device :

a NMDeviceBridge +

Returns :

 +TRUE if the device has carrier
+
+
+
+

nm_device_bridge_get_hw_address ()

+
const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);
+

+Gets the hardware (MAC) address of the NMDeviceBridge +

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

device :

a NMDeviceBridge +

Returns :

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

nm_device_bridge_get_slaves ()

+
const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);
+

+Gets the devices currently slaved to device. +

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

device :

a NMDeviceBridge +

Returns :

the GPtrArray containing +NMDevices that are slaves of device. This is the internal +copy used by the device, and must not be modified. [element-type NMClient.Device] +
+
+
+
+

nm_device_bridge_new ()

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

+Creates a new NMDeviceBridge. +

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

connection :

the DBusGConnection +

path :

the DBus object path of the device

Returns :

a new device. [transfer full] +
+
+
+
+

Property Details

+
+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

+

Default value: FALSE

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

+The hardware (MAC) address of the device. +

+

Default value: NULL

+
+
+
+

The "slaves" property

+
  "slaves"                   NMObjectArray*        : Read
+

+The devices (NMDevice) slaved to the bridge device. +

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