libnm-glib/nm-device-ethernet.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 2007 - 2008 Novell, Inc.
  19  * Copyright 2007 - 2012 Red Hat, Inc.
  20  */
  21
  22 #ifndef NM_DEVICE_ETHERNET_H
  23 #define NM_DEVICE_ETHERNET_H
  24
  25 #include "nm-device.h"
  26
  27 G_BEGIN_DECLS
  28
  29 #define NM_TYPE_DEVICE_ETHERNET            (nm_device_ethernet_get_type ())
  30 #define NM_DEVICE_ETHERNET(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE_ETHERNET, NMDeviceEthernet))
  31 #define NM_DEVICE_ETHERNET_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_DEVICE_ETHERNET, NMDeviceEthernetClass))
  32 #define NM_IS_DEVICE_ETHERNET(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE_ETHERNET))
  33 #define NM_IS_DEVICE_ETHERNET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DEVICE_ETHERNET))
  34 #define NM_DEVICE_ETHERNET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_DEVICE_ETHERNET, NMDeviceEthernetClass))
  35
  36 /**
  37  * NMDeviceEthernetError:
  38  * @NM_DEVICE_ETHERNET_ERROR_UNKNOWN: unknown or unclassified error
  39  * @NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION: the connection was not of Ethernet or PPPoE type
  40  * @NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION: the Ethernet connection was invalid
  41  * @NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC: the device's MAC was invalid
  42  * @NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH: the MACs of the connection and the device mismatched
  43  */
  44 typedef enum {
  45         NM_DEVICE_ETHERNET_ERROR_UNKNOWN = 0,                 /*< nick=UnknownError >*/
  46         NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION,     /*< nick=NotEthernetConnection >*/
  47         NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION, /*< nick=InvalidEthernetConnection >*/
  48         NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC,          /*< nick=InvalidDeviceMac >*/
  49         NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH,                /*< nick=MacMismatch >*/
  50 } NMDeviceEthernetError;
  51
  52 #define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
  53 GQuark nm_device_ethernet_error_quark (void);
  54
  55 #define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
  56 #define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
  57 #define NM_DEVICE_ETHERNET_SPEED       "speed"
  58 #define NM_DEVICE_ETHERNET_CARRIER     "carrier"
  59
  60 typedef struct {
  61         NMDevice parent;
  62 } NMDeviceEthernet;
  63
  64 typedef struct {
  65         NMDeviceClass parent;
  66
  67         /* Padding for future expansion */
  68         void (*_reserved1) (void);
  69         void (*_reserved2) (void);
  70         void (*_reserved3) (void);
  71         void (*_reserved4) (void);
  72         void (*_reserved5) (void);
  73         void (*_reserved6) (void);
  74 } NMDeviceEthernetClass;
  75
  76 GType nm_device_ethernet_get_type (void);
  77
  78 GObject *nm_device_ethernet_new (DBusGConnection *connection, const char *path);
  79
  80 const char * nm_device_ethernet_get_hw_address (NMDeviceEthernet *device);
  81 const char * nm_device_ethernet_get_permanent_hw_address (NMDeviceEthernet *device);
  82 guint32      nm_device_ethernet_get_speed   (NMDeviceEthernet *device);
  83 gboolean     nm_device_ethernet_get_carrier (NMDeviceEthernet *device);
  84
  85 G_END_DECLS
  86
  87 #endif /* NM_DEVICE_ETHERNET_H */