From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-glib/html/NMDeviceBridge.html | 534 +++++++++++++++++-------------- 1 file changed, 293 insertions(+), 241 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 e2bb740c..192be733 100644 --- a/docs/libnm-glib/html/NMDeviceBridge.html +++ b/docs/libnm-glib/html/NMDeviceBridge.html @@ -2,36 +2,28 @@ -NMDeviceBridge +libnm-glib Reference Manual: NMDeviceBridge - + - - - - - - - - - - + + + + + + +
@@ -39,46 +31,123 @@

NMDeviceBridge

NMDeviceBridge

- +
-
-

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

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

Object Hierarchy

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

Properties

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

Implemented Interfaces

-

-NMDeviceBridge implements - GInitable and GAsyncInitable.

+

Types and Values

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

Properties

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

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceBridge
@@ -87,272 +156,255 @@ NMDeviceBridge implements

-

Details

+

Functions

-

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

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

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 -

NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH

the interfaces of the connection and the device mismatched -

path

the DBus object path of the device

 
-

Since 0.9.8

-
-
-

NM_DEVICE_BRIDGE_ERROR

-
#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
-
-

-

+
+

Returns

+

a new device.

+

[transfer full]

+
+

Since 0.9.8

-

nm_device_bridge_error_quark ()

-
GQuark              nm_device_bridge_error_quark        (void);
-

-Registers an error quark for NMDeviceBridge if necessary. -

-
+

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

+
--+++ - - + + +

Returns :

the error quark used for NMDeviceBridge errors.

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_HW_ADDRESS

-
#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
-
-

-

+

nm_device_bridge_get_carrier ()

+
gboolean
+nm_device_bridge_get_carrier (NMDeviceBridge *device);
+

Whether the device has carrier.

+
+

Parameters

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

device

a NMDeviceBridge

 
-
-
-

NM_DEVICE_BRIDGE_CARRIER

-
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
-
-

-

+
+

Returns

+

TRUE if the device has carrier

+

-
-
-

NM_DEVICE_BRIDGE_SLAVES

-
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
-
-

-

+

Since 0.9.8

-

NMDeviceBridge

-
typedef struct _NMDeviceBridge NMDeviceBridge;
-

-

+

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

 
-
-
-

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

-

+
+

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

-
+

Since 0.9.8

+
+
+
+

Types and Values

-

nm_device_bridge_new ()

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

-Creates a new NMDeviceBridge. -

-
+

enum NMDeviceBridgeError

+
+

Members

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

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

+		 

Returns :

a new device. [transfer full] +

NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH

 +

the interfaces of the connection and the device mismatched

 
+

Since 0.9.8

-

nm_device_bridge_get_hw_address ()

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

NM_DEVICE_BRIDGE_ERROR

+
#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
+

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

-
gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
+

NM_DEVICE_BRIDGE_HW_ADDRESS

+
#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
+

-Whether the device has carrier.

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

device :

a NMDeviceBridge -

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

NM_DEVICE_BRIDGE_CARRIER

+
#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_BRIDGE_SLAVES

+
#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
+

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

Since 0.9.8

Property Details

-

The "carrier" property

-
  "carrier"                  gboolean              : Read
-

-Whether the device has carrier. -

+

The “carrier” property

+
  “carrier”                  gboolean
+

+

Flags: Read

Default value: FALSE

Since 0.9.8

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
-

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

+

The “hw-address” property

+
  “hw-address”               gchar *
+

+

Flags: Read

Default value: NULL

Since 0.9.8

-

The "slaves" property

-
  "slaves"                   NMObjectArray*        : Read
-

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

+

The “slaves” property

+
  “slaves”                   NMObjectArray *
+

+

Flags: Read

Since 0.9.8

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