## NMDeviceOlpcMesh

NMDeviceOlpcMesh

## Synopsis

    enum                NMDeviceOlpcMeshError;
    #define             NM_DEVICE_OLPC_MESH_ERROR
    GQuark              nm_device_olpc_mesh_error_quark     (void);
    #define             NM_DEVICE_OLPC_MESH_HW_ADDRESS
    #define             NM_DEVICE_OLPC_MESH_COMPANION
    #define             NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL
                        NMDeviceOlpcMesh;
                        NMDeviceOlpcMeshClass;
    GObject *           nm_device_olpc_mesh_new             (DBusGConnection *connection,
                                                             const char *path);
    const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);
    NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
    guint32             nm_device_olpc_mesh_get_active_channel
                                                            (NMDeviceOlpcMesh *device);

## Object Hierarchy

      GObject
       +----NMObject
             +----NMDevice
                   +----NMDeviceOlpcMesh

## Implemented Interfaces

NMDeviceOlpcMesh implements GInitable and GAsyncInitable.

## Properties

      "active-channel"           guint                 : Read
      "companion"                NMDeviceWifi*         : Read
      "hw-address"               gchar*                : Read

## Description

## Details

### enum NMDeviceOlpcMeshError

    typedef enum {
    	NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
    	NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION,     /*< nick=NotOlpcMeshConnection >*/
    	NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION, /*< nick=InvalidOlpcMeshConnection >*/
    } NMDeviceOlpcMeshError;

`NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN` | unknown or unclassified error
`NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION` | the connection was not of Olpc Mesh type
`NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION` | the Olpc Mesh connection was invalid

### NM_DEVICE_OLPC_MESH_ERROR

    #define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()

### nm_device_olpc_mesh_error_quark ()

    GQuark              nm_device_olpc_mesh_error_quark     (void);

Registers an error quark for NMDeviceOlpcMesh if necessary.

Returns : | the error quark used for NMDeviceOlpcMesh errors.

### NM_DEVICE_OLPC_MESH_HW_ADDRESS

    #define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"

### NM_DEVICE_OLPC_MESH_COMPANION

    #define NM_DEVICE_OLPC_MESH_COMPANION      "companion"

### NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

    #define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"

### NMDeviceOlpcMesh

    typedef struct _NMDeviceOlpcMesh NMDeviceOlpcMesh;

### NMDeviceOlpcMeshClass

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

### nm_device_olpc_mesh_new ()

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

Creates a new NMDeviceOlpcMesh.

`connection` : | the DBusGConnection
`path` : | the DBus object path of the device
Returns : | a new OlpcMesh device. [transfer full]

### nm_device_olpc_mesh_get_hw_address ()

    const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);

Gets the hardware (MAC) address of the NMDeviceOlpcMesh

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

### nm_device_olpc_mesh_get_companion ()

    NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);

Gets the companion device of the NMDeviceOlpcMesh.

`device` : | a NMDeviceOlpcMesh
Returns : | the companion of the device of `NULL`. [transfer none]

### nm_device_olpc_mesh_get_active_channel ()

    guint32             nm_device_olpc_mesh_get_active_channel
                                                            (NMDeviceOlpcMesh *device);

Returns the active channel of the NMDeviceOlpcMesh device.

`device` : | a NMDeviceOlpcMesh
Returns : | active channel of the device

## Property Details

### The `"active-channel"` property

      "active-channel"           guint                 : Read

The device's active channel.

Default value: 0

### The `"companion"` property

      "companion"                NMDeviceWifi*         : Read

The companion device.

### The `"hw-address"` property

      "hw-address"               gchar*                : Read

The hardware (MAC) address of the device.

Default value: NULL