From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-glib/html/NMDeviceBridge.html | 536 ++++++++++++++----------------- 1 file changed, 242 insertions(+), 294 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceBridge.html') diff --git a/docs/libnm-glib/html/NMDeviceBridge.html b/docs/libnm-glib/html/NMDeviceBridge.html index 6ef3f5e4..2b7594ad 100644 --- a/docs/libnm-glib/html/NMDeviceBridge.html +++ b/docs/libnm-glib/html/NMDeviceBridge.html @@ -2,28 +2,36 @@ -libnm-glib Reference Manual: NMDeviceBridge +NMDeviceBridge - - + + - - - - - - - + + + + + + + + + +
@@ -31,123 +39,46 @@

NMDeviceBridge

NMDeviceBridge

- +
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_device_bridge_error_quark () -
-GObject * - -nm_device_bridge_new () -
const char * - -nm_device_bridge_get_hw_address () -
-gboolean - -nm_device_bridge_get_carrier () -
const GPtrArray * - -nm_device_bridge_get_slaves () -
+
+

Synopsis

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

Properties

-
----- - - - - - - - - - - - - - - - - - -
gbooleancarrierRead
-gchar *hw-addressRead
-NMObjectArray *slavesRead
+

Object Hierarchy

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

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - -
enumNMDeviceBridgeError
#defineNM_DEVICE_BRIDGE_ERROR
#defineNM_DEVICE_BRIDGE_HW_ADDRESS
#defineNM_DEVICE_BRIDGE_CARRIER
#defineNM_DEVICE_BRIDGE_SLAVES
+

Implemented Interfaces

+

+NMDeviceBridge implements + GInitable and GAsyncInitable.

-

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMDevice
-            ╰── NMDeviceBridge
+
Properties

+
+  "carrier"                  gboolean              : Read
+  "hw-address"               gchar*                : Read
+  "slaves"                   NMObjectArray*        : Read
@@ -156,255 +87,272 @@

-

Functions

+

Details

-

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.

-

-
-

Since 0.9.8

-
-
-
-

nm_device_bridge_new ()

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

Creates a new NMDeviceBridge.

-
-

Parameters

-
+

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

connection

the DBusGConnection

 

NM_DEVICE_BRIDGE_ERROR_UNKNOWN

unknown or unclassified error +

NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION

the connection was not of bridge type +

path

the DBus object path of the device

 

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

Returns

-

a new device.

-

[transfer full]

-

Since 0.9.8

-

nm_device_bridge_get_hw_address ()

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

Gets the hardware (MAC) address of the NMDeviceBridge

-
-

Parameters

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

device

a NMDeviceBridge

 
-
-
-

Returns

-

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

-

-
-

Since 0.9.8

+

NM_DEVICE_BRIDGE_ERROR

+
#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
+
+

+

-

nm_device_bridge_get_carrier ()

-
gboolean
-nm_device_bridge_get_carrier (NMDeviceBridge *device);
-

Whether the device has carrier.

-
-

Parameters

-
+

nm_device_bridge_error_quark ()

+
GQuark              nm_device_bridge_error_quark        (void);
+

+Registers an error quark for NMDeviceBridge if necessary. +

+
---++ - - - + +

device

a NMDeviceBridge

 

Returns :

the error quark used for NMDeviceBridge errors.
-
-
-

Returns

-

TRUE if the device has carrier

-

-

Since 0.9.8

-

nm_device_bridge_get_slaves ()

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

Gets the devices currently slaved to device -.

-
-

Parameters

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

device

a NMDeviceBridge

 
+

NM_DEVICE_BRIDGE_HW_ADDRESS

+
#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
+
+

+

-
-

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_CARRIER

+
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
+
+

+

-

Since 0.9.8

+
+
+

NM_DEVICE_BRIDGE_SLAVES

+
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
+
+

+

+
+
+

NMDeviceBridge

+
typedef struct _NMDeviceBridge NMDeviceBridge;
+

+

-
-

Types and Values

+
-

enum NMDeviceBridgeError

-
-

Members

-
+

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

+

+ +
+
+

nm_device_bridge_new ()

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

+Creates a new NMDeviceBridge. +

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

NM_DEVICE_BRIDGE_ERROR_UNKNOWN

 -

unknown or unclassified error

-		 

NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION

 -

the connection was not of bridge type

+

connection :

the DBusGConnection  

NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION

 -

the bridge connection was invalid

-		 

path :

the DBus object path of the device

NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH

 -

the interfaces of the connection and the device mismatched

+

Returns :

a new device. [transfer full]  
-

Since 0.9.8

-

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

Since 0.9.8

-

NM_DEVICE_BRIDGE_CARRIER

-
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
-
+

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
+

Since 0.9.8

-

NM_DEVICE_BRIDGE_SLAVES

-
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
-
+

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

Since 0.9.8

Property Details

-

The “carrier” property

-
  “carrier”                  gboolean
-

Carrier.

-

Flags: Read

+

The "carrier" property

+
  "carrier"                  gboolean              : Read
+

+Whether the device has carrier. +

Default value: FALSE

Since 0.9.8

-

The “hw-address” property

-
  “hw-address”               gchar *
-

Currently set hardware MAC address.

-

Flags: Read

+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+

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

Default value: NULL

Since 0.9.8

-

The “slaves” property

-
  “slaves”                   NMObjectArray *
-

Slaves.

-

Flags: Read

+

The "slaves" property

+
  "slaves"                   NMObjectArray*        : Read
+

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

Since 0.9.8

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