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/NMDeviceTeam.html | 532 ++++++++++++++++++--------------- 1 file changed, 292 insertions(+), 240 deletions(-) (limited to 'docs/libnm-glib/html/NMDeviceTeam.html') diff --git a/docs/libnm-glib/html/NMDeviceTeam.html b/docs/libnm-glib/html/NMDeviceTeam.html index 9160805e..0b07f9eb 100644 --- a/docs/libnm-glib/html/NMDeviceTeam.html +++ b/docs/libnm-glib/html/NMDeviceTeam.html @@ -2,36 +2,28 @@ -NMDeviceTeam +libnm-glib Reference Manual: NMDeviceTeam - + - - - - - - - - - - + + + + + + +
@@ -39,316 +31,376 @@

NMDeviceTeam

NMDeviceTeam

- +
-
-

Synopsis

-
enum                NMDeviceTeamError;
-#define             NM_DEVICE_TEAM_ERROR
-GQuark              nm_device_team_error_quark          (void);
-#define             NM_DEVICE_TEAM_HW_ADDRESS
-#define             NM_DEVICE_TEAM_CARRIER
-#define             NM_DEVICE_TEAM_SLAVES
-                    NMDeviceTeam;
-                    NMDeviceTeamClass;
-GObject *           nm_device_team_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_team_get_hw_address       (NMDeviceTeam *device);
-gboolean            nm_device_team_get_carrier          (NMDeviceTeam *device);
-const GPtrArray *   nm_device_team_get_slaves           (NMDeviceTeam *device);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceTeam
-
-
-
-

Implemented Interfaces

-

-NMDeviceTeam implements - GInitable and GAsyncInitable.

-
-
-

Properties

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

Description

-

-

-
-
-

Details

-
-

enum NMDeviceTeamError

-
typedef enum {
-	NM_DEVICE_TEAM_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_TEAM_ERROR_NOT_TEAM_CONNECTION,     /*< nick=NotTeamConnection >*/
-	NM_DEVICE_TEAM_ERROR_INVALID_TEAM_CONNECTION, /*< nick=InvalidTeamConnection >*/
-	NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH,      /*< nick=InterfaceMismatch >*/
-} NMDeviceTeamError;
-
-
+

Functions

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

NM_DEVICE_TEAM_ERROR_UNKNOWN

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

NM_DEVICE_TEAM_ERROR_NOT_TEAM_CONNECTION

the connection was not of team type + +GObject * + +nm_device_team_new ()

NM_DEVICE_TEAM_ERROR_INVALID_TEAM_CONNECTION

the team connection was invalid +const char * + +nm_device_team_get_hw_address () +
+gboolean + +nm_device_team_get_carrier ()

NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH

the interfaces of the connection and the device mismatched +const GPtrArray * + +nm_device_team_get_slaves ()
-
-
-

NM_DEVICE_TEAM_ERROR

-
#define NM_DEVICE_TEAM_ERROR nm_device_team_error_quark ()
-
-

-

-
-
-
-

nm_device_team_error_quark ()

-
GQuark              nm_device_team_error_quark          (void);
-

-Registers an error quark for NMDeviceTeam if necessary. -

-
+
+

Properties

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

Returns :

the error quark used for NMDeviceTeam errors.
gbooleancarrierRead
+gchar *hw-addressRead
+NMObjectArray *slavesRead
-

Since 0.9.10

-
-
-

NM_DEVICE_TEAM_HW_ADDRESS

-
#define NM_DEVICE_TEAM_HW_ADDRESS  "hw-address"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
enumNMDeviceTeamError
#defineNM_DEVICE_TEAM_ERROR
#defineNM_DEVICE_TEAM_HW_ADDRESS
#defineNM_DEVICE_TEAM_CARRIER
#defineNM_DEVICE_TEAM_SLAVES
-
-
-

NM_DEVICE_TEAM_CARRIER

-
#define NM_DEVICE_TEAM_CARRIER     "carrier"
+

+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceTeam
 

-

-

 

-

-

-
NM_DEVICE_TEAM_SLAVES

-
#define NM_DEVICE_TEAM_SLAVES      "slaves"
-

+

+
Description

 

 

 

-

+

+
Functions

 

-
NMDeviceTeam

-
typedef struct _NMDeviceTeam NMDeviceTeam;

-

-

+
nm_device_team_error_quark ()

+
GQuark
+nm_device_team_error_quark (void);

+
Registers an error quark for NMDeviceTeam if necessary.

+

+
Returns

+
 the error quark used for NMDeviceTeam errors.

+

 

-

-

-
NMDeviceTeamClass

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

-

-

+
Since 0.9.10

 

 

 

-
nm_device_team_new ()

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

-

-Creates a new NMDeviceTeam.
-

-

+
nm_device_team_new ()

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

+
Creates a new NMDeviceTeam.

+

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

+

 
Since 0.9.10

 

 

 

-
nm_device_team_get_hw_address ()

-
const char *        nm_device_team_get_hw_address       (NMDeviceTeam *device);

-

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

-

+
nm_device_team_get_hw_address ()

+
const char *
+nm_device_team_get_hw_address (NMDeviceTeam *device);

+
Gets the hardware (MAC) address of the NMDeviceTeam

+

+
Parameters

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

 





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

 

+

+

+
Returns

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

+

+

 
Since 0.9.10

 

 

 

-
nm_device_team_get_carrier ()

-
gboolean            nm_device_team_get_carrier          (NMDeviceTeam *device);

-

-Whether the device has carrier.
-

-

+
nm_device_team_get_carrier ()

+
gboolean
+nm_device_team_get_carrier (NMDeviceTeam *device);

+
Whether the device has carrier.

+

+
Parameters

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

 





 
device :
a NMDeviceTeam
-
Returns :

-TRUE if the device has carrier
device
a NMDeviceTeam
 

 

+

+

+
Returns

+
 TRUE if the device has carrier

+

+

 
Since 0.9.10

 

 

 

-
nm_device_team_get_slaves ()

-
const GPtrArray *   nm_device_team_get_slaves           (NMDeviceTeam *device);

-

-Gets the devices currently enslaved to device.
-

-

+
nm_device_team_get_slaves ()

+
const GPtrArray *
+nm_device_team_get_slaves (NMDeviceTeam *device);

+
Gets the devices currently enslaved to device
+.

+

+
Parameters

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

 






device
a NMDeviceTeam
 

+

+

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

+
+
+
+

Types and Values

+
+

enum NMDeviceTeamError

+
+

Members

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

device :

a NMDeviceTeam +

NM_DEVICE_TEAM_ERROR_UNKNOWN

 +

unknown or unclassified error

+		 

NM_DEVICE_TEAM_ERROR_NOT_TEAM_CONNECTION

 +

the connection was not of team type

+		 

NM_DEVICE_TEAM_ERROR_INVALID_TEAM_CONNECTION

 +

the team connection was invalid

 

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

NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH

 +

the interfaces of the connection and the device mismatched

 
-

Since 0.9.10

-
-

Property Details

+
-

The "carrier" property

-
  "carrier"                  gboolean              : Read
+

NM_DEVICE_TEAM_ERROR

+
#define NM_DEVICE_TEAM_ERROR nm_device_team_error_quark ()
+

-Whether the device has carrier.

-

Default value: FALSE

-

The "hw-address" property

-
  "hw-address"               gchar*                : Read
+

NM_DEVICE_TEAM_HW_ADDRESS

+
#define NM_DEVICE_TEAM_HW_ADDRESS  "hw-address"
+

-The hardware (MAC) address of the device.

-

Default value: NULL

-

The "slaves" property

-
  "slaves"                   NMObjectArray*        : Read
+

NM_DEVICE_TEAM_CARRIER

+
#define NM_DEVICE_TEAM_CARRIER     "carrier"
+
+

+

+
+
+
+

NM_DEVICE_TEAM_SLAVES

+
#define NM_DEVICE_TEAM_SLAVES      "slaves"
+

-The devices (NMDevice) enslaved to the team device.

+
+

Property Details

+
+

The “carrier” property

+
  “carrier”                  gboolean
+

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “hw-address” property

+
  “hw-address”               gchar *
+

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “slaves” property

+
  “slaves”                   NMObjectArray *
+

+

Flags: Read

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