D-Bus  1.8.2
dbus-connection.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.h DBusConnection object
3  *
4  * Copyright (C) 2002, 2003 Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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_CONNECTION_H
28 #define DBUS_CONNECTION_H
29 
30 #include <dbus/dbus-errors.h>
31 #include <dbus/dbus-memory.h>
32 #include <dbus/dbus-message.h>
33 #include <dbus/dbus-shared.h>
34 
35 DBUS_BEGIN_DECLS
36 
42 /* documented in dbus-watch.c */
43 typedef struct DBusWatch DBusWatch;
44 /* documented in dbus-timeout.c */
45 typedef struct DBusTimeout DBusTimeout;
47 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
49 typedef struct DBusPendingCall DBusPendingCall;
51 typedef struct DBusConnection DBusConnection;
53 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
54 
58 typedef enum
59 {
60  DBUS_WATCH_READABLE = 1 << 0,
61  DBUS_WATCH_WRITABLE = 1 << 1,
62  DBUS_WATCH_ERROR = 1 << 2,
67  DBUS_WATCH_HANGUP = 1 << 3
72  /* Internal to libdbus, there is also _DBUS_WATCH_NVAL in dbus-watch.h */
73 } DBusWatchFlags;
74 
79 typedef enum
80 {
81  DBUS_DISPATCH_DATA_REMAINS,
82  DBUS_DISPATCH_COMPLETE,
83  DBUS_DISPATCH_NEED_MEMORY
84 } DBusDispatchStatus;
85 
91 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
92  void *data);
97 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
98  void *data);
103 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
104  void *data);
110 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
111  void *data);
117 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
118  void *data);
123 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
124  void *data);
128 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
129  DBusDispatchStatus new_status,
130  void *data);
135 typedef void (* DBusWakeupMainFunction) (void *data);
136 
143 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
144  unsigned long uid,
145  void *data);
146 
153 typedef dbus_bool_t (* DBusAllowWindowsUserFunction) (DBusConnection *connection,
154  const char *user_sid,
155  void *data);
156 
157 
162 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
163  void *user_data);
164 
169 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
170  DBusMessage *message,
171  void *user_data);
172 DBUS_EXPORT
173 DBusConnection* dbus_connection_open (const char *address,
174  DBusError *error);
175 DBUS_EXPORT
176 DBusConnection* dbus_connection_open_private (const char *address,
177  DBusError *error);
178 DBUS_EXPORT
179 DBusConnection* dbus_connection_ref (DBusConnection *connection);
180 DBUS_EXPORT
181 void dbus_connection_unref (DBusConnection *connection);
182 DBUS_EXPORT
183 void dbus_connection_close (DBusConnection *connection);
184 DBUS_EXPORT
185 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
186 DBUS_EXPORT
187 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
188 DBUS_EXPORT
189 dbus_bool_t dbus_connection_get_is_anonymous (DBusConnection *connection);
190 DBUS_EXPORT
191 char* dbus_connection_get_server_id (DBusConnection *connection);
192 DBUS_EXPORT
193 dbus_bool_t dbus_connection_can_send_type (DBusConnection *connection,
194  int type);
195 
196 DBUS_EXPORT
197 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
198  dbus_bool_t exit_on_disconnect);
199 DBUS_EXPORT
200 void dbus_connection_flush (DBusConnection *connection);
201 DBUS_EXPORT
202 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
203  int timeout_milliseconds);
204 DBUS_EXPORT
205 dbus_bool_t dbus_connection_read_write (DBusConnection *connection,
206  int timeout_milliseconds);
207 DBUS_EXPORT
208 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
209 DBUS_EXPORT
210 void dbus_connection_return_message (DBusConnection *connection,
211  DBusMessage *message);
212 DBUS_EXPORT
213 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
214  DBusMessage *message);
215 DBUS_EXPORT
216 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
217 DBUS_EXPORT
218 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
219 DBUS_EXPORT
220 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
221 DBUS_EXPORT
222 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
223 DBUS_EXPORT
224 dbus_bool_t dbus_connection_send (DBusConnection *connection,
225  DBusMessage *message,
226  dbus_uint32_t *client_serial);
227 DBUS_EXPORT
228 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
229  DBusMessage *message,
230  DBusPendingCall **pending_return,
231  int timeout_milliseconds);
232 DBUS_EXPORT
233 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
234  DBusMessage *message,
235  int timeout_milliseconds,
236  DBusError *error);
237 DBUS_EXPORT
238 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
239  DBusAddWatchFunction add_function,
240  DBusRemoveWatchFunction remove_function,
241  DBusWatchToggledFunction toggled_function,
242  void *data,
243  DBusFreeFunction free_data_function);
244 DBUS_EXPORT
245 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
246  DBusAddTimeoutFunction add_function,
247  DBusRemoveTimeoutFunction remove_function,
248  DBusTimeoutToggledFunction toggled_function,
249  void *data,
250  DBusFreeFunction free_data_function);
251 DBUS_EXPORT
252 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
253  DBusWakeupMainFunction wakeup_main_function,
254  void *data,
255  DBusFreeFunction free_data_function);
256 DBUS_EXPORT
257 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
258  DBusDispatchStatusFunction function,
259  void *data,
260  DBusFreeFunction free_data_function);
261 DBUS_EXPORT
262 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
263  unsigned long *uid);
264 DBUS_EXPORT
265 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
266  unsigned long *pid);
267 #ifdef DBUS_ENABLE_SMACK
268 DBUS_EXPORT
269 dbus_bool_t dbus_connection_get_smack_label (DBusConnection *connection,
270  const char **label);
271 #endif
272 DBUS_EXPORT
273 dbus_bool_t dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
274  void **data,
275  dbus_int32_t *data_size);
276 DBUS_EXPORT
277 void dbus_connection_set_unix_user_function (DBusConnection *connection,
278  DBusAllowUnixUserFunction function,
279  void *data,
280  DBusFreeFunction free_data_function);
281 DBUS_EXPORT
282 dbus_bool_t dbus_connection_get_windows_user (DBusConnection *connection,
283  char **windows_sid_p);
284 DBUS_EXPORT
285 void dbus_connection_set_windows_user_function (DBusConnection *connection,
286  DBusAllowWindowsUserFunction function,
287  void *data,
288  DBusFreeFunction free_data_function);
289 DBUS_EXPORT
290 void dbus_connection_set_allow_anonymous (DBusConnection *connection,
291  dbus_bool_t value);
292 DBUS_EXPORT
293 void dbus_connection_set_route_peer_messages (DBusConnection *connection,
294  dbus_bool_t value);
295 
296 
297 /* Filters */
298 
299 DBUS_EXPORT
300 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
301  DBusHandleMessageFunction function,
302  void *user_data,
303  DBusFreeFunction free_data_function);
304 DBUS_EXPORT
305 void dbus_connection_remove_filter (DBusConnection *connection,
306  DBusHandleMessageFunction function,
307  void *user_data);
308 
309 
310 /* Other */
311 DBUS_EXPORT
312 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
313 DBUS_EXPORT
314 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
315 DBUS_EXPORT
316 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
317  dbus_int32_t slot,
318  void *data,
319  DBusFreeFunction free_data_func);
320 DBUS_EXPORT
321 void* dbus_connection_get_data (DBusConnection *connection,
322  dbus_int32_t slot);
323 
324 DBUS_EXPORT
325 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
326 
327 DBUS_EXPORT
328 void dbus_connection_set_max_message_size (DBusConnection *connection,
329  long size);
330 DBUS_EXPORT
331 long dbus_connection_get_max_message_size (DBusConnection *connection);
332 DBUS_EXPORT
333 void dbus_connection_set_max_received_size (DBusConnection *connection,
334  long size);
335 DBUS_EXPORT
336 long dbus_connection_get_max_received_size (DBusConnection *connection);
337 
338 DBUS_EXPORT
339 void dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
340  long n);
341 DBUS_EXPORT
342 long dbus_connection_get_max_message_unix_fds (DBusConnection *connection);
343 DBUS_EXPORT
344 void dbus_connection_set_max_received_unix_fds(DBusConnection *connection,
345  long n);
346 DBUS_EXPORT
347 long dbus_connection_get_max_received_unix_fds(DBusConnection *connection);
348 
349 DBUS_EXPORT
350 long dbus_connection_get_outgoing_size (DBusConnection *connection);
351 DBUS_EXPORT
352 long dbus_connection_get_outgoing_unix_fds (DBusConnection *connection);
353 
354 DBUS_EXPORT
355 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
356 DBUS_EXPORT
357 void dbus_connection_free_preallocated_send (DBusConnection *connection,
358  DBusPreallocatedSend *preallocated);
359 DBUS_EXPORT
360 void dbus_connection_send_preallocated (DBusConnection *connection,
361  DBusPreallocatedSend *preallocated,
362  DBusMessage *message,
363  dbus_uint32_t *client_serial);
364 
365 
366 /* Object tree functionality */
367 
372 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
373  void *user_data);
379 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
380  DBusMessage *message,
381  void *user_data);
382 
389 struct DBusObjectPathVTable
390 {
391  DBusObjectPathUnregisterFunction unregister_function;
392  DBusObjectPathMessageFunction message_function;
394  void (* dbus_internal_pad1) (void *);
395  void (* dbus_internal_pad2) (void *);
396  void (* dbus_internal_pad3) (void *);
397  void (* dbus_internal_pad4) (void *);
398 };
399 
400 DBUS_EXPORT
401 dbus_bool_t dbus_connection_try_register_object_path (DBusConnection *connection,
402  const char *path,
403  const DBusObjectPathVTable *vtable,
404  void *user_data,
405  DBusError *error);
406 
407 DBUS_EXPORT
408 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
409  const char *path,
410  const DBusObjectPathVTable *vtable,
411  void *user_data);
412 
413 DBUS_EXPORT
414 dbus_bool_t dbus_connection_try_register_fallback (DBusConnection *connection,
415  const char *path,
416  const DBusObjectPathVTable *vtable,
417  void *user_data,
418  DBusError *error);
419 
420 DBUS_EXPORT
421 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
422  const char *path,
423  const DBusObjectPathVTable *vtable,
424  void *user_data);
425 DBUS_EXPORT
426 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
427  const char *path);
428 
429 DBUS_EXPORT
430 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
431  const char *path,
432  void **data_p);
433 
434 DBUS_EXPORT
435 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
436  const char *parent_path,
437  char ***child_entries);
438 
439 DBUS_EXPORT
440 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
441  int *fd);
442 DBUS_EXPORT
443 dbus_bool_t dbus_connection_get_socket (DBusConnection *connection,
444  int *fd);
445 
454 #ifndef DBUS_DISABLE_DEPRECATED
455 DBUS_EXPORT
456 DBUS_DEPRECATED int dbus_watch_get_fd (DBusWatch *watch);
457 #endif
458 
459 DBUS_EXPORT
460 int dbus_watch_get_unix_fd (DBusWatch *watch);
461 DBUS_EXPORT
462 int dbus_watch_get_socket (DBusWatch *watch);
463 DBUS_EXPORT
464 unsigned int dbus_watch_get_flags (DBusWatch *watch);
465 DBUS_EXPORT
466 void* dbus_watch_get_data (DBusWatch *watch);
467 DBUS_EXPORT
468 void dbus_watch_set_data (DBusWatch *watch,
469  void *data,
470  DBusFreeFunction free_data_function);
471 DBUS_EXPORT
472 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
473  unsigned int flags);
474 DBUS_EXPORT
475 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
476 
484 DBUS_EXPORT
485 int dbus_timeout_get_interval (DBusTimeout *timeout);
486 DBUS_EXPORT
487 void* dbus_timeout_get_data (DBusTimeout *timeout);
488 DBUS_EXPORT
489 void dbus_timeout_set_data (DBusTimeout *timeout,
490  void *data,
491  DBusFreeFunction free_data_function);
492 DBUS_EXPORT
493 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
494 DBUS_EXPORT
495 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
496 
499 DBUS_END_DECLS
500 
501 #endif /* DBUS_CONNECTION_H */
Generated by   doxygen 1.8.2