libnm-glib/nm-device-olpc-mesh.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
   2 /*
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16  * Boston, MA 02110-1301 USA.
  17  *
  18  * Copyright 2012 Red Hat, Inc.
  19  */
  20
  21 #ifndef NM_DEVICE_OLPC_MESH_H
  22 #define NM_DEVICE_OLPC_MESH_H
  23
  24 #include "nm-device.h"
  25 #include "nm-device-wifi.h"
  26
  27 G_BEGIN_DECLS
  28
  29 #define NM_TYPE_DEVICE_OLPC_MESH            (nm_device_olpc_mesh_get_type ())
  30 #define NM_DEVICE_OLPC_MESH(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE_OLPC_MESH, NMDeviceOlpcMesh))
  31 #define NM_DEVICE_OLPC_MESH_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_DEVICE_OLPC_MESH, NMDeviceOlpcMeshClass))
  32 #define NM_IS_DEVICE_OLPC_MESH(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE_OLPC_MESH))
  33 #define NM_IS_DEVICE_OLPC_MESH_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DEVICE_OLPC_MESH))
  34 #define NM_DEVICE_OLPC_MESH_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_DEVICE_OLPC_MESH, NMDeviceOlpcMeshClass))
  35
  36 /**
  37  * NMDeviceOlpcMeshError:
  38  * @NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN: unknown or unclassified error
  39  * @NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION: the connection was not of Olpc Mesh type
  40  * @NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION: the Olpc Mesh connection was invalid
  41  */
  42 typedef enum {
  43         NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
  44         NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION,     /*< nick=NotOlpcMeshConnection >*/
  45         NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION, /*< nick=InvalidOlpcMeshConnection >*/
  46 } NMDeviceOlpcMeshError;
  47
  48 #define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
  49 GQuark nm_device_olpc_mesh_error_quark (void);
  50
  51 #define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
  52 #define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
  53 #define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
  54
  55 typedef struct {
  56         NMDevice parent;
  57 } NMDeviceOlpcMesh;
  58
  59 typedef struct {
  60         NMDeviceClass parent;
  61
  62         /* Padding for future expansion */
  63         void (*_reserved1) (void);
  64         void (*_reserved2) (void);
  65         void (*_reserved3) (void);
  66         void (*_reserved4) (void);
  67         void (*_reserved5) (void);
  68         void (*_reserved6) (void);
  69 } NMDeviceOlpcMeshClass;
  70
  71 GType nm_device_olpc_mesh_get_type (void);
  72
  73 GObject *nm_device_olpc_mesh_new (DBusGConnection *connection, const char *path);
  74
  75 const char   *nm_device_olpc_mesh_get_hw_address     (NMDeviceOlpcMesh *device);
  76 NMDeviceWifi *nm_device_olpc_mesh_get_companion      (NMDeviceOlpcMesh *device);
  77 guint32       nm_device_olpc_mesh_get_active_channel (NMDeviceOlpcMesh *device);
  78
  79 G_END_DECLS
  80
  81 #endif /* NM_DEVICE_OLPC_MESH_H */