libnm/nm-object.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_OBJECT_H__
  23 #define __NM_OBJECT_H__
  24
  25 #if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
  26 #error "Only <NetworkManager.h> can be included directly."
  27 #endif
  28
  29 #include <nm-types.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define NM_TYPE_OBJECT            (nm_object_get_type ())
  34 #define NM_OBJECT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_OBJECT, NMObject))
  35 #define NM_OBJECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_OBJECT, NMObjectClass))
  36 #define NM_IS_OBJECT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_OBJECT))
  37 #define NM_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_OBJECT))
  38 #define NM_OBJECT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_OBJECT, NMObjectClass))
  39
  40 #define NM_OBJECT_PATH "path"
  41 #define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
  42
  43 struct _NMObject {
  44         GObject parent;
  45 };
  46
  47 typedef struct {
  48         GObjectClass parent;
  49
  50         /* Methods */
  51         void (*init_dbus) (NMObject *object);
  52
  53         /* The "object-creation-failed" method is PRIVATE for libnm and
  54          * is not meant for any external usage.  It indicates that an error
  55          * occured during creation of an object.
  56          */
  57         void (*object_creation_failed) (NMObject *master_object,
  58                                         const char *failed_path);
  59
  60         /*< private >*/
  61         gpointer padding[8];
  62 } NMObjectClass;
  63
  64 GType nm_object_get_type (void);
  65
  66 const char      *nm_object_get_path            (NMObject *object);
  67
  68 G_END_DECLS
  69
  70 #endif /* __NM_OBJECT_H__ */