GNOME.org

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;

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

NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH

 the interfaces of the connection and the device mismatched

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.

Returns :

 the error quark used for NMDeviceTeam errors.

Since 0.9.10

NM_DEVICE_TEAM_HW_ADDRESS

#define NM_DEVICE_TEAM_HW_ADDRESS  "hw-address"

NM_DEVICE_TEAM_CARRIER

#define NM_DEVICE_TEAM_CARRIER     "carrier"

NM_DEVICE_TEAM_SLAVES

#define NM_DEVICE_TEAM_SLAVES      "slaves"

NMDeviceTeam

typedef struct _NMDeviceTeam NMDeviceTeam;

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;

nm_device_team_new ()

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

Creates a new NMDeviceTeam.

connection :

 the DBusGConnection

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

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.

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.

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 NMClient.Device]

Since 0.9.10

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) enslaved to the team device.

Generated by GTK-Doc V1.19