dbus/dbus-object.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-object.h  Objects
   3  *
   4  * Copyright (C) 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_OBJECT_H
  28 #define DBUS_OBJECT_H
  29
  30 #include <dbus/dbus-arch-deps.h>
  31 #include <dbus/dbus-types.h>
  32 #include <dbus/dbus-message.h>
  33 #include <dbus/dbus-objectid.h>
  34
  35 DBUS_BEGIN_DECLS;
  36
  37 typedef struct DBusConnection     DBusConnection;
  38 typedef struct DBusObjectVTable   DBusObjectVTable;
  39 typedef struct DBusObjectInfo     DBusObjectInfo;
  40 typedef struct DBusCallbackObject DBusCallbackObject;
  41
  42 typedef enum
  43 {
  44   DBUS_HANDLER_RESULT_HANDLED,             /**< Remove this message, no further processing. */
  45   DBUS_HANDLER_RESULT_NOT_YET_HANDLED,     /**< Run any additional handlers that are interested in this message. */
  46   DBUS_HANDLER_RESULT_NEED_MEMORY          /**< Need more memory to handle this message. */
  47 } DBusHandlerResult;
  48
  49 struct DBusObjectInfo
  50 {
  51   void               *object_impl; /**< Object implementation pointer provided by app */
  52   DBusObjectID        object_id;   /**< Object ID */
  53   DBusConnection     *connection;  /**< The connection object ID is for */
  54   void               *dbus_internal_pad1; /**< Padding, do not use */
  55   void               *dbus_internal_pad2; /**< Padding, do not use */
  56 };
  57
  58 typedef void (* DBusObjectRegisteredFunction)   (DBusObjectInfo *info);
  59 typedef void (* DBusObjectUnregisteredFunction) (DBusObjectInfo *info);
  60 typedef void (* DBusObjectMessageFunction)      (DBusObjectInfo *info,
  61                                                  DBusMessage    *message);
  62
  63 struct DBusObjectVTable
  64 {
  65   DBusObjectRegisteredFunction   registered;
  66   DBusObjectUnregisteredFunction unregistered;
  67   DBusObjectMessageFunction      message;
  68   void (* dbus_internal_pad1) (void *);
  69   void (* dbus_internal_pad2) (void *);
  70   void (* dbus_internal_pad3) (void *);
  71 };
  72
  73 extern const DBusObjectVTable *dbus_callback_object_vtable;
  74
  75 DBusCallbackObject* dbus_callback_object_new          (DBusObjectMessageFunction   function,
  76                                                        void                       *user_data,
  77                                                        DBusFreeFunction            free_user_data);
  78 void                dbus_callback_object_ref          (DBusCallbackObject         *callback);
  79 void                dbus_callback_object_unref        (DBusCallbackObject         *callback);
  80 void*               dbus_callback_object_get_data     (DBusCallbackObject         *callback);
  81 void                dbus_callback_object_set_data     (DBusCallbackObject         *callback,
  82                                                        void                       *data,
  83                                                        DBusFreeFunction            free_user_data);
  84 void                dbus_callback_object_set_function (DBusCallbackObject         *callback,
  85                                                        DBusObjectMessageFunction   function);
  86
  87
  88 DBUS_END_DECLS;
  89
  90 #endif /* DBUS_OBJECT_H */