1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-connection.h DBusConnection object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
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."
27 #ifndef DBUS_CONNECTION_H
28 #define DBUS_CONNECTION_H
30 #include <dbus/dbus-errors.h>
31 #include <dbus/dbus-macros.h>
32 #include <dbus/dbus-memory.h>
33 #include <dbus/dbus-message.h>
34 #include <dbus/dbus-shared.h>
39 * @addtogroup DBusConnection
43 /* documented in dbus-watch.c */
44 typedef struct DBusWatch DBusWatch;
45 /* documented in dbus-timeout.c */
46 typedef struct DBusTimeout DBusTimeout;
47 /** Opaque type representing preallocated resources so a message can be sent without further memory allocation. */
48 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
49 /** Opaque type representing a method call that has not yet received a reply. */
50 typedef struct DBusPendingCall DBusPendingCall;
51 /** Opaque type representing a connection to a remote application and associated incoming/outgoing message queues. */
52 typedef struct DBusConnection DBusConnection;
53 /** Set of functions that must be implemented to handle messages sent to a particular object path. */
54 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
57 * Indicates the status of a #DBusWatch.
61 DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
62 DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
63 DBUS_WATCH_ERROR = 1 << 2, /**< As in POLLERR (can't watch for
64 * this, but can be present in
65 * current state passed to
66 * dbus_watch_handle()).
68 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for
69 * it, but can be present in current
71 * dbus_watch_handle()).
73 /* Internal to libdbus, there is also _DBUS_WATCH_NVAL in dbus-watch.h */
77 * Indicates the status of incoming data on a #DBusConnection. This determines whether
78 * dbus_connection_dispatch() needs to be called.
82 DBUS_DISPATCH_DATA_REMAINS, /**< There is more data to potentially convert to messages. */
83 DBUS_DISPATCH_COMPLETE, /**< All currently available data has been processed. */
84 DBUS_DISPATCH_NEED_MEMORY /**< More memory is needed to continue. */
87 /** Called when libdbus needs a new watch to be monitored by the main
88 * loop. Returns #FALSE if it lacks enough memory to add the
89 * watch. Set by dbus_connection_set_watch_functions() or
90 * dbus_server_set_watch_functions().
92 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
94 /** Called when dbus_watch_get_enabled() may return a different value
95 * than it did before. Set by dbus_connection_set_watch_functions()
96 * or dbus_server_set_watch_functions().
98 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
100 /** Called when libdbus no longer needs a watch to be monitored by the
101 * main loop. Set by dbus_connection_set_watch_functions() or
102 * dbus_server_set_watch_functions().
104 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
106 /** Called when libdbus needs a new timeout to be monitored by the main
107 * loop. Returns #FALSE if it lacks enough memory to add the
108 * watch. Set by dbus_connection_set_timeout_functions() or
109 * dbus_server_set_timeout_functions().
111 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
113 /** Called when dbus_timeout_get_enabled() may return a different
114 * value than it did before.
115 * Set by dbus_connection_set_timeout_functions() or
116 * dbus_server_set_timeout_functions().
118 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
120 /** Called when libdbus no longer needs a timeout to be monitored by the
121 * main loop. Set by dbus_connection_set_timeout_functions() or
122 * dbus_server_set_timeout_functions().
124 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
126 /** Called when the return value of dbus_connection_get_dispatch_status()
127 * may have changed. Set with dbus_connection_set_dispatch_status_function().
129 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
130 DBusDispatchStatus new_status,
133 * Called when the main loop's thread should be notified that there's now work
134 * to do. Set with dbus_connection_set_wakeup_main_function().
136 typedef void (* DBusWakeupMainFunction) (void *data);
139 * Called during authentication to check whether the given UNIX user
140 * ID is allowed to connect, if the client tried to auth as a UNIX
141 * user ID. Normally on Windows this would never happen. Set with
142 * dbus_connection_set_unix_user_function().
144 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
149 * Called during authentication to check whether the given Windows user
150 * ID is allowed to connect, if the client tried to auth as a Windows
151 * user ID. Normally on UNIX this would never happen. Set with
152 * dbus_connection_set_windows_user_function().
154 typedef dbus_bool_t (* DBusAllowWindowsUserFunction) (DBusConnection *connection,
155 const char *user_sid,
160 * Called when a pending call now has a reply available. Set with
161 * dbus_pending_call_set_notify().
163 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
167 * Called when a message needs to be handled. The result indicates whether or
168 * not more handlers should be run. Set with dbus_connection_add_filter().
170 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
171 DBusMessage *message,
174 DBusConnection* dbus_connection_open (const char *address,
177 DBusConnection* dbus_connection_open_private (const char *address,
180 DBusConnection* dbus_connection_ref (DBusConnection *connection);
182 void dbus_connection_unref (DBusConnection *connection);
184 void dbus_connection_close (DBusConnection *connection);
186 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
188 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
190 dbus_bool_t dbus_connection_get_is_anonymous (DBusConnection *connection);
192 char* dbus_connection_get_server_id (DBusConnection *connection);
194 dbus_bool_t dbus_connection_can_send_type (DBusConnection *connection,
198 void dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
199 dbus_bool_t exit_on_disconnect);
201 void dbus_connection_flush (DBusConnection *connection);
203 dbus_bool_t dbus_connection_read_write_dispatch (DBusConnection *connection,
204 int timeout_milliseconds);
206 dbus_bool_t dbus_connection_read_write (DBusConnection *connection,
207 int timeout_milliseconds);
209 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
211 void dbus_connection_return_message (DBusConnection *connection,
212 DBusMessage *message);
214 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
215 DBusMessage *message);
217 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
219 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
221 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
223 dbus_bool_t dbus_connection_has_messages_to_send (DBusConnection *connection);
225 dbus_bool_t dbus_connection_send (DBusConnection *connection,
226 DBusMessage *message,
227 dbus_uint32_t *client_serial);
229 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
230 DBusMessage *message,
231 DBusPendingCall **pending_return,
232 int timeout_milliseconds);
234 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
235 DBusMessage *message,
236 int timeout_milliseconds,
239 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
240 DBusAddWatchFunction add_function,
241 DBusRemoveWatchFunction remove_function,
242 DBusWatchToggledFunction toggled_function,
244 DBusFreeFunction free_data_function);
246 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
247 DBusAddTimeoutFunction add_function,
248 DBusRemoveTimeoutFunction remove_function,
249 DBusTimeoutToggledFunction toggled_function,
251 DBusFreeFunction free_data_function);
253 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
254 DBusWakeupMainFunction wakeup_main_function,
256 DBusFreeFunction free_data_function);
258 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
259 DBusDispatchStatusFunction function,
261 DBusFreeFunction free_data_function);
263 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
266 dbus_bool_t dbus_connection_get_unix_process_id (DBusConnection *connection,
269 dbus_bool_t dbus_connection_get_adt_audit_session_data (DBusConnection *connection,
271 dbus_int32_t *data_size);
273 void dbus_connection_set_unix_user_function (DBusConnection *connection,
274 DBusAllowUnixUserFunction function,
276 DBusFreeFunction free_data_function);
278 dbus_bool_t dbus_connection_get_windows_user (DBusConnection *connection,
279 char **windows_sid_p);
281 void dbus_connection_set_windows_user_function (DBusConnection *connection,
282 DBusAllowWindowsUserFunction function,
284 DBusFreeFunction free_data_function);
286 void dbus_connection_set_allow_anonymous (DBusConnection *connection,
289 void dbus_connection_set_route_peer_messages (DBusConnection *connection,
296 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
297 DBusHandleMessageFunction function,
299 DBusFreeFunction free_data_function);
301 void dbus_connection_remove_filter (DBusConnection *connection,
302 DBusHandleMessageFunction function,
308 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
310 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
312 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
315 DBusFreeFunction free_data_func);
317 void* dbus_connection_get_data (DBusConnection *connection,
321 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
324 void dbus_connection_set_max_message_size (DBusConnection *connection,
327 long dbus_connection_get_max_message_size (DBusConnection *connection);
329 void dbus_connection_set_max_received_size (DBusConnection *connection,
332 long dbus_connection_get_max_received_size (DBusConnection *connection);
335 void dbus_connection_set_max_message_unix_fds (DBusConnection *connection,
338 long dbus_connection_get_max_message_unix_fds (DBusConnection *connection);
340 void dbus_connection_set_max_received_unix_fds(DBusConnection *connection,
343 long dbus_connection_get_max_received_unix_fds(DBusConnection *connection);
346 long dbus_connection_get_outgoing_size (DBusConnection *connection);
348 long dbus_connection_get_outgoing_unix_fds (DBusConnection *connection);
351 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
353 void dbus_connection_free_preallocated_send (DBusConnection *connection,
354 DBusPreallocatedSend *preallocated);
356 void dbus_connection_send_preallocated (DBusConnection *connection,
357 DBusPreallocatedSend *preallocated,
358 DBusMessage *message,
359 dbus_uint32_t *client_serial);
362 /* Object tree functionality */
365 * Called when a #DBusObjectPathVTable is unregistered (or its connection is freed).
366 * Found in #DBusObjectPathVTable.
368 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
371 * Called when a message is sent to a registered object path. Found in
372 * #DBusObjectPathVTable which is registered with dbus_connection_register_object_path()
373 * or dbus_connection_register_fallback().
375 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
376 DBusMessage *message,
380 * Virtual table that must be implemented to handle a portion of the
381 * object path hierarchy. Attach the vtable to a particular path using
382 * dbus_connection_register_object_path() or
383 * dbus_connection_register_fallback().
385 struct DBusObjectPathVTable
387 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */
388 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
390 void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
391 void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
392 void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
393 void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
397 dbus_bool_t dbus_connection_try_register_object_path (DBusConnection *connection,
399 const DBusObjectPathVTable *vtable,
404 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
406 const DBusObjectPathVTable *vtable,
410 dbus_bool_t dbus_connection_try_register_fallback (DBusConnection *connection,
412 const DBusObjectPathVTable *vtable,
417 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
419 const DBusObjectPathVTable *vtable,
422 dbus_bool_t dbus_connection_unregister_object_path (DBusConnection *connection,
426 dbus_bool_t dbus_connection_get_object_path_data (DBusConnection *connection,
431 dbus_bool_t dbus_connection_list_registered (DBusConnection *connection,
432 const char *parent_path,
433 char ***child_entries);
436 dbus_bool_t dbus_connection_get_unix_fd (DBusConnection *connection,
439 dbus_bool_t dbus_connection_get_socket (DBusConnection *connection,
443 * Clear a variable or struct member that contains a #DBusConnection.
444 * If it does not contain #NULL, the connection that was previously
445 * there is unreferenced with dbus_connection_unref().
447 * For example, this function and the similar functions for
448 * other reference-counted types can be used in code like this:
451 * DBusConnection *conn = NULL;
452 * struct { ...; DBusMessage *m; ... } *larger_structure = ...;
454 * ... code that might set conn or m to be non-NULL ...
456 * dbus_clear_connection (&conn);
457 * dbus_clear_message (&larger_structure->m);
460 * @param pointer_to_connection A pointer to a variable or struct member.
461 * pointer_to_connection must not be #NULL, but *pointer_to_connection
465 dbus_clear_connection (DBusConnection **pointer_to_connection)
467 _dbus_clear_pointer_impl (DBusConnection, pointer_to_connection,
468 dbus_connection_unref);
475 * @addtogroup DBusWatch
479 #ifndef DBUS_DISABLE_DEPRECATED
481 DBUS_DEPRECATED int dbus_watch_get_fd (DBusWatch *watch);
485 int dbus_watch_get_unix_fd (DBusWatch *watch);
487 int dbus_watch_get_socket (DBusWatch *watch);
489 unsigned int dbus_watch_get_flags (DBusWatch *watch);
491 void* dbus_watch_get_data (DBusWatch *watch);
493 void dbus_watch_set_data (DBusWatch *watch,
495 DBusFreeFunction free_data_function);
497 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
500 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
505 * @addtogroup DBusTimeout
510 int dbus_timeout_get_interval (DBusTimeout *timeout);
512 void* dbus_timeout_get_data (DBusTimeout *timeout);
514 void dbus_timeout_set_data (DBusTimeout *timeout,
516 DBusFreeFunction free_data_function);
518 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
520 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
526 #endif /* DBUS_CONNECTION_H */