b05d9c4b05f68b8094ba98f379ff8ecf7f3aa0ed
[platform/upstream/dbus.git] / 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 struct DBusObjectInfo
43 {
44   void               *object_impl; /**< Object information */
45   DBusObjectID        object_id;
46   DBusConnection     *connection;
47 };
48
49 typedef void (* DBusObjectRegisteredFunction)   (DBusObjectInfo *info);
50 typedef void (* DBusObjectUnregisteredFunction) (DBusObjectInfo *info);
51 typedef void (* DBusObjectMessageFunction)      (DBusObjectInfo *info,
52                                                  DBusMessage    *message);
53
54 struct DBusObjectVTable
55 {
56   DBusObjectRegisteredFunction   registered;
57   DBusObjectUnregisteredFunction unregistered;
58   DBusObjectMessageFunction      message;
59 };
60
61 extern const DBusObjectVTable *dbus_callback_object_vtable;
62
63 DBusCallbackObject* dbus_callback_object_new          (DBusObjectMessageFunction   function,
64                                                        void                       *user_data,
65                                                        DBusFreeFunction            free_user_data);
66 void                dbus_callback_object_ref          (DBusCallbackObject         *callback);
67 void                dbus_callback_object_unref        (DBusCallbackObject         *callback);
68 void*               dbus_callback_object_get_data     (DBusCallbackObject         *callback);
69 void                dbus_callback_object_set_data     (DBusCallbackObject         *callback,
70                                                        void                       *data,
71                                                        DBusFreeFunction            free_user_data);
72 void                dbus_callback_object_set_function (DBusCallbackObject         *callback,
73                                                        DBusObjectMessageFunction   function);
74
75
76 DBUS_END_DECLS;
77
78 #endif /* DBUS_OBJECT_H */