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 {
|
|
46 DBUS_POINTER_GROUP,
|
|
47 DBUS_POINTER_CONTACT,
|
|
48 DBUS_POINTER_BUDDY,
|
|
49 DBUS_POINTER_CHAT,
|
|
50 DBUS_POINTER_ACCOUNT
|
|
51 } GaimDBusPointerType;
|
|
52
|
11080
|
53 typedef struct _GaimObject GaimObject;
|
|
54
|
|
55 /** The main GaimObject */
|
|
56 GaimObject * gaim_dbus_object;
|
11067
|
57
|
11055
|
58 /**
|
|
59 * Starts the gaim DBUS server. It is responsible for handling DBUS
|
|
60 * requests from other applications.
|
|
61 *
|
|
62 * @return TRUE if successful, FALSE otherwise.
|
|
63 */
|
11080
|
64 gboolean gaim_dbus_init(void);
|
|
65
|
|
66 gboolean gaim_dbus_connect(GaimObject *object);
|
11055
|
67
|
11067
|
68 /**
|
|
69 Initializes gaim dbus pointer registration engine.
|
|
70
|
|
71 Remote dbus applications need a way of addressing objects exposed
|
|
72 by gaim to the outside world. In gaim itself, these objects (such
|
|
73 as GaimBuddy and company) are identified by pointers. The gaim
|
|
74 dbus pointer registration engine converts pointers to handles and
|
|
75 back.
|
|
76
|
|
77 In order for an object to participate in the scheme, it must
|
|
78 register itself and its type with the engine. This registration
|
|
79 allocates an integer id which can be resolved to the pointer and
|
|
80 back.
|
|
81
|
|
82 Handles are not persistent. They are reissued every time gaim is
|
|
83 started. This is not good; external applications that use gaim
|
|
84 should work even whether gaim was restarted in the middle of the
|
|
85 interaction.
|
|
86
|
|
87 Pointer registration is only a temporary solution. When GaimBuddy
|
|
88 and similar structures have been converted into gobjects, this
|
|
89 registration will be done automatically by objects themselves.
|
|
90
|
|
91 By the way, this kind of object-handle translation should be so
|
|
92 common that there must be a library (maybe even glib) that
|
|
93 implements it. I feel a bit like reinventing the wheel here.
|
|
94 */
|
|
95 void gaim_dbus_init_ids(void);
|
|
96
|
|
97 /**
|
|
98 Registers a typed pointer.
|
|
99
|
|
100 @node The pointer to register.
|
|
101 @type Type of that pointer.
|
|
102 */
|
|
103 void gaim_dbus_register_pointer(gpointer node, GaimDBusPointerType type);
|
|
104
|
|
105 /**
|
|
106 Unregisters a pointer previously registered with
|
|
107 gaim_dbus_register_pointer.
|
|
108
|
|
109 @node The pointer to register.
|
|
110 */
|
|
111 void gaim_dbus_unregister_pointer(gpointer node);
|
|
112
|
11080
|
113 /**
|
|
114 Registers a gaim signal with a #GaimObject.
|
|
115
|
|
116 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
117 @param name Name of the signal
|
|
118 @param marshaller Marshaller for the signal.
|
|
119 @param num_values The number of parameters.
|
|
120 @param values Array of pointers to #GaimValue objects representing
|
|
121 the types of the parameters.
|
|
122 @result The dbus id of the registered signal.
|
|
123
|
|
124 This function is intended to be used in signal.h, where it
|
|
125 automatically registers all gaim signals with dbus. For your own
|
|
126 dbus signals, use #gaim_dbus_register.
|
|
127
|
|
128 The name of the signal, usually in the form "aaa-bbb-ccc", is
|
|
129 converted into DBus standard, "AaaBbbCcc", because "aaa-bbb-ccc"
|
|
130 doesn't work with DBus GObject binding version 0.34 (cvs version is ok).
|
|
131
|
|
132 The #marshaller can be set to gaim_dbus_invalid_marshaller because
|
|
133 DBus signals are never passed to any local handler.
|
|
134 */
|
|
135 int gaim_dbus_signal_register_gaim(GaimObject *object, const char *name,
|
|
136 GSignalCMarshaller marshaller,
|
|
137 int num_values, GaimValue **values);
|
|
138
|
|
139 /**
|
|
140 Emits a dbus signal.
|
|
141
|
|
142 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
143 @param dbus_id Id of the signal.
|
|
144 @param num_values The number of parameters.
|
|
145 @param values Array of pointers to #GaimValue objects representing
|
|
146 the types of the parameters.
|
|
147 @param vargs A va_list containing the actual parameters.
|
|
148
|
|
149 This function is intended to be used in signal.h, where it
|
|
150 automatically emits all gaim signals to dbus. For your own dbus
|
|
151 signals, use #gaim_dbus_emit.
|
|
152 */
|
|
153 void gaim_dbus_signal_emit_gaim(GaimObject *object, int dbus_id,
|
|
154 int num_values, GaimValue **values, va_list vargs);
|
|
155
|
|
156 /**
|
|
157 A marshaller that emits an "assertion failed" message if called.
|
|
158
|
|
159 This marshaller is intended to use with signal that will never need to be marshalled.
|
|
160 */
|
|
161 void gaim_dbus_invalid_marshaller(GClosure *closure,
|
|
162 GValue *return_value,
|
|
163 guint n_param_values,
|
|
164 const GValue *param_values,
|
|
165 gpointer invocation_hint,
|
|
166 gpointer marshal_data);
|
|
167
|
|
168 /**
|
|
169 Registers a gaim signal with a #GaimObject.
|
|
170
|
|
171 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
172 @param name Name of the signal
|
|
173 @param marshaller Marshaller for the signal.
|
|
174 @param num_values The number of parameters.
|
|
175 @param ... List of GType of the parameter types.
|
|
176
|
|
177 @result The dbus id of the registered signal.
|
|
178 */
|
|
179 int gaim_dbus_signal_register(GaimObject *object, const char *name,
|
|
180 GSignalCMarshaller marshaller,
|
|
181 int num_values, ...);
|
|
182
|
|
183 /**
|
|
184 Emits a dbus signal.
|
|
185
|
|
186 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
187 @param dbus_id Id of the signal.
|
|
188 @param ... Actual parameters.
|
|
189 */
|
|
190 void gaim_dbus_signal_emit(GaimObject *object, int dbus_id, ...);
|
|
191
|
|
192 /**
|
|
193 Emits a dbus signal.
|
|
194
|
|
195 @param object The #GaimObject (usually #gaim_dbus_object)
|
|
196 @param dbus_id Id of the signal.
|
|
197 @param vargs A va_list containing the actual parameters.
|
|
198 */
|
|
199 void gaim_dbus_signal_emit_valist(GaimObject *object, int dbus_id, va_list args);
|
|
200
|
11067
|
201
|
11055
|
202 G_END_DECLS
|
|
203
|
|
204 #endif /* _GAIM_DBUS_SERVER_H_ */
|