1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.h DBusConnection object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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-memory.h>
32 #include <dbus/dbus-message.h>
36 typedef struct DBusWatch DBusWatch;
37 typedef struct DBusTimeout DBusTimeout;
38 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
39 typedef struct DBusPendingCall DBusPendingCall;
40 typedef struct DBusConnection DBusConnection;
41 typedef struct DBusObjectPathVTable DBusObjectPathVTable;
45 DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
46 DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
47 DBUS_WATCH_ERROR = 1 << 2, /**< As in POLLERR (can't watch for this, but
48 * the flag can be passed to dbus_watch_handle()).
50 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for it, but
51 * can be present in current state). */
56 DBUS_DISPATCH_DATA_REMAINS, /**< There is more data to potentially convert to messages. */
57 DBUS_DISPATCH_COMPLETE, /**< All currently available data has been processed. */
58 DBUS_DISPATCH_NEED_MEMORY /**< More memory is needed to continue. */
63 DBUS_HANDLER_RESULT_HANDLED, /**< Message has had its effect */
64 DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect */
65 DBUS_HANDLER_RESULT_NEED_MEMORY /**< Need more memory to return another result */
68 typedef dbus_bool_t (* DBusAddWatchFunction) (DBusWatch *watch,
70 typedef void (* DBusWatchToggledFunction) (DBusWatch *watch,
72 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
74 typedef dbus_bool_t (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
76 typedef void (* DBusTimeoutToggledFunction) (DBusTimeout *timeout,
78 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
80 typedef void (* DBusDispatchStatusFunction) (DBusConnection *connection,
81 DBusDispatchStatus new_status,
83 typedef void (* DBusWakeupMainFunction) (void *data);
84 typedef dbus_bool_t (* DBusAllowUnixUserFunction) (DBusConnection *connection,
88 typedef void (* DBusPendingCallNotifyFunction) (DBusPendingCall *pending,
92 typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusConnection *connection,
96 DBusConnection* dbus_connection_open (const char *address,
98 void dbus_connection_ref (DBusConnection *connection);
99 void dbus_connection_unref (DBusConnection *connection);
100 void dbus_connection_disconnect (DBusConnection *connection);
101 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
102 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
103 void dbus_connection_flush (DBusConnection *connection);
104 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
105 void dbus_connection_return_message (DBusConnection *connection,
106 DBusMessage *message);
107 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
108 DBusMessage *message);
109 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
110 DBusDispatchStatus dbus_connection_get_dispatch_status (DBusConnection *connection);
111 DBusDispatchStatus dbus_connection_dispatch (DBusConnection *connection);
112 dbus_bool_t dbus_connection_send (DBusConnection *connection,
113 DBusMessage *message,
114 dbus_uint32_t *client_serial);
115 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
116 DBusMessage *message,
117 DBusPendingCall **pending_return,
118 int timeout_milliseconds);
119 DBusMessage * dbus_connection_send_with_reply_and_block (DBusConnection *connection,
120 DBusMessage *message,
121 int timeout_milliseconds,
123 dbus_bool_t dbus_connection_set_watch_functions (DBusConnection *connection,
124 DBusAddWatchFunction add_function,
125 DBusRemoveWatchFunction remove_function,
126 DBusWatchToggledFunction toggled_function,
128 DBusFreeFunction free_data_function);
129 dbus_bool_t dbus_connection_set_timeout_functions (DBusConnection *connection,
130 DBusAddTimeoutFunction add_function,
131 DBusRemoveTimeoutFunction remove_function,
132 DBusTimeoutToggledFunction toggled_function,
134 DBusFreeFunction free_data_function);
135 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
136 DBusWakeupMainFunction wakeup_main_function,
138 DBusFreeFunction free_data_function);
139 void dbus_connection_set_dispatch_status_function (DBusConnection *connection,
140 DBusDispatchStatusFunction function,
142 DBusFreeFunction free_data_function);
143 dbus_bool_t dbus_connection_get_unix_user (DBusConnection *connection,
145 void dbus_connection_set_unix_user_function (DBusConnection *connection,
146 DBusAllowUnixUserFunction function,
148 DBusFreeFunction free_data_function);
151 int dbus_watch_get_fd (DBusWatch *watch);
152 unsigned int dbus_watch_get_flags (DBusWatch *watch);
153 void* dbus_watch_get_data (DBusWatch *watch);
154 void dbus_watch_set_data (DBusWatch *watch,
156 DBusFreeFunction free_data_function);
157 dbus_bool_t dbus_watch_handle (DBusWatch *watch,
159 dbus_bool_t dbus_watch_get_enabled (DBusWatch *watch);
161 int dbus_timeout_get_interval (DBusTimeout *timeout);
162 void* dbus_timeout_get_data (DBusTimeout *timeout);
163 void dbus_timeout_set_data (DBusTimeout *timeout,
165 DBusFreeFunction free_data_function);
166 dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout);
167 dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout);
171 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
172 DBusHandleMessageFunction function,
174 DBusFreeFunction free_data_function);
175 void dbus_connection_remove_filter (DBusConnection *connection,
176 DBusHandleMessageFunction function,
181 dbus_bool_t dbus_connection_allocate_data_slot (dbus_int32_t *slot_p);
182 void dbus_connection_free_data_slot (dbus_int32_t *slot_p);
183 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
186 DBusFreeFunction free_data_func);
187 void* dbus_connection_get_data (DBusConnection *connection,
190 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
192 void dbus_connection_set_max_message_size (DBusConnection *connection,
194 long dbus_connection_get_max_message_size (DBusConnection *connection);
195 void dbus_connection_set_max_received_size (DBusConnection *connection,
197 long dbus_connection_get_max_received_size (DBusConnection *connection);
198 long dbus_connection_get_outgoing_size (DBusConnection *connection);
200 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
201 void dbus_connection_free_preallocated_send (DBusConnection *connection,
202 DBusPreallocatedSend *preallocated);
203 void dbus_connection_send_preallocated (DBusConnection *connection,
204 DBusPreallocatedSend *preallocated,
205 DBusMessage *message,
206 dbus_uint32_t *client_serial);
209 /* Object tree functionality */
211 typedef void (* DBusObjectPathUnregisterFunction) (DBusConnection *connection,
213 typedef DBusHandlerResult (* DBusObjectPathMessageFunction) (DBusConnection *connection,
214 DBusMessage *message,
218 * Virtual table that must be implemented to handle a portion of the
219 * object path hierarchy.
221 struct DBusObjectPathVTable
223 DBusObjectPathUnregisterFunction unregister_function; /**< Function to unregister this handler */
224 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
226 void (* dbus_internal_pad1) (void *); /**< Reserved for future expansion */
227 void (* dbus_internal_pad2) (void *); /**< Reserved for future expansion */
228 void (* dbus_internal_pad3) (void *); /**< Reserved for future expansion */
229 void (* dbus_internal_pad4) (void *); /**< Reserved for future expansion */
232 dbus_bool_t dbus_connection_register_object_path (DBusConnection *connection,
234 const DBusObjectPathVTable *vtable,
236 dbus_bool_t dbus_connection_register_fallback (DBusConnection *connection,
238 const DBusObjectPathVTable *vtable,
240 void dbus_connection_unregister_object_path (DBusConnection *connection,
246 #endif /* DBUS_CONNECTION_H */