11055
|
1 /**
|
|
2 * @file dbus-server.h Gaim DBUS Server
|
|
3 * @ingroup core
|
|
4 *
|
|
5 * gaim
|
|
6 *
|
|
7 * Gaim is the legal property of its developers, whose names are too numerous
|
|
8 * to list here. Please refer to the COPYRIGHT file distributed with this
|
|
9 * source distribution.
|
|
10 *
|
|
11 * This program is free software; you can redistribute it and/or modify
|
|
12 * it under the terms of the GNU General Public License as published by
|
|
13 * the Free Software Foundation; either version 2 of the License, or
|
|
14 * (at your option) any later version.
|
|
15 *
|
|
16 * This program is distributed in the hope that it will be useful,
|
|
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
19 * GNU General Public License for more details.
|
|
20 *
|
|
21 * You should have received a copy of the GNU General Public License
|
|
22 * along with this program; if not, write to the Free Software
|
|
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
24 *
|
|
25 */
|
|
26
|
|
27 #ifndef _GAIM_DBUS_SERVER_H_
|
|
28 #define _GAIM_DBUS_SERVER_H_
|
|
29
|
11080
|
30 #include <glib-object.h>
|
|
31 #include "value.h"
|
11067
|
32
|
11055
|
33 G_BEGIN_DECLS
|
|
34
|
11067
|
35 /* These are the categories of codes used by gaim dbus implementation
|
|
36 for remote calls. In practice, they don't matter
|
|
37 */
|
|
38 typedef enum {
|
|
39 DBUS_ERROR_NONE = 0,
|
|
40 DBUS_ERROR_NOT_FOUND = 1
|
|
41 } DbusErrorCodes;
|
|
42
|
|
43 /* Types of pointers that can be registered with the gaim dbus pointer
|
|
44 registration engine. See below */
|
|
45 typedef enum {
|
11146
|
46 DBUS_POINTER_NONE = 0,
|
|
47 #include "dbus-auto-enum-types.h"
|
|
48 DBUS_POINTER_LASTTYPE
|
11067
|
49 } GaimDBusPointerType;
|
|
50
|
11080
|
51 typedef struct _GaimObject GaimObject;
|
|
52
|
|
53 /** The main GaimObject */
|
|
54 GaimObject * gaim_dbus_object;
|
11067
|
55
|
11055
|
56 /**
|
|
57 * Starts the gaim DBUS server. It is responsible for handling DBUS
|
|
58 * requests from other applications.
|
|
59 *
|
|
60 * @return TRUE if successful, FALSE otherwise.
|
|
61 */
|
11080
|
62 gboolean gaim_dbus_init(void);
|
|
63
|
|
64 gboolean gaim_dbus_connect(GaimObject *object);
|
11055
|
65
|
11067
|
66 /**
|
|
67 Initializes gaim dbus pointer registration engine.
|
|
68
|
|
69 Remote dbus applications need a way of addressing objects exposed
|
|
70 by gaim to the outside world. In gaim itself, these objects (such
|
|
71 as GaimBuddy and company) are identified by pointers. The gaim
|
|
72 dbus pointer registration engine converts pointers to handles and
|
|
73 back.
|
|
74
|
|
75 In order for an object to participate in the scheme, it must
|
|
76 register itself and its type with the engine. This registration
|
|
77 allocates an integer id which can be resolved to the pointer and
|
|
78 back.
|
|
79
|
|
80 Handles are not persistent. They are reissued every time gaim is
|
|
81 started. This is not good; external applications that use gaim
|
|
82 should work even whether gaim was restarted in the middle of the
|
|
83 interaction.
|
|
84
|
|
85 Pointer registration is only a temporary solution. When GaimBuddy
|
|
86 and similar structures have been converted into gobjects, this
|
|
87 registration will be done automatically by objects themselves.
|
|
88
|
|
89 By the way, this kind of object-handle translation should be so
|
|
90 common that there must be a library (maybe even glib) that
|
|
91 implements it. I feel a bit like reinventing the wheel here.
|
|
92 */
|
|
93 void gaim_dbus_init_ids(void);
|
|
94
|
|
95 /**
|
|
96 Registers a typed pointer.
|
|
97
|
11129
|
98 @param node The pointer to register.
|
|
99 @param type Type of that pointer.
|
11067
|
100 */
|
|
101 void gaim_dbus_register_pointer(gpointer node, GaimDBusPointerType type);
|
|
102
|
|
103 /**
|
|
104 Unregisters a pointer previously registered with
|
|
105 gaim_dbus_register_pointer.
|
|
106
|
11129
|
107 @param node The pointer to register.
|
11067
|
108 */
|
|
109 void gaim_dbus_unregister_pointer(gpointer node);
|
|
110
|
11080
|
111
|
|
112
|
|
113 /**
|
|
114 Emits a dbus signal.
|
|
115
|
|
116 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
117 @param dbus_id Id of the signal.
|
|
118 @param num_values The number of parameters.
|
|
119 @param values Array of pointers to #GaimValue objects representing
|
|
120 the types of the parameters.
|
|
121 @param vargs A va_list containing the actual parameters.
|
|
122
|
|
123 This function is intended to be used in signal.h, where it
|
|
124 automatically emits all gaim signals to dbus. For your own dbus
|
|
125 signals, use #gaim_dbus_emit.
|
|
126 */
|
11146
|
127 void gaim_dbus_signal_emit_gaim(GaimObject *object, char *name,
|
|
128 int num_values, GaimValue **values,
|
|
129 va_list vargs);
|
11080
|
130
|
|
131
|
11067
|
132
|
11055
|
133 G_END_DECLS
|
|
134
|
|
135 #endif /* _GAIM_DBUS_SERVER_H_ */
|