1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.h DBusConnection object
4 * Copyright (C) 2002 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-message.h>
32 #include <dbus/dbus-memory.h>
36 typedef struct DBusConnection DBusConnection;
37 typedef struct DBusWatch DBusWatch;
38 typedef struct DBusTimeout DBusTimeout;
39 typedef struct DBusMessageHandler DBusMessageHandler;
40 typedef struct DBusPreallocatedSend DBusPreallocatedSend;
44 DBUS_HANDLER_RESULT_REMOVE_MESSAGE, /**< Remove this message, no further processing. */
45 DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS /**< Run any additional handlers that are interested in this message. */
50 DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
51 DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
52 DBUS_WATCH_ERROR = 1 << 2, /**< As in POLLERR (can't watch for this, but
53 * the flag can be passed to dbus_connection_handle_watch()).
55 DBUS_WATCH_HANGUP = 1 << 3 /**< As in POLLHUP (can't watch for it, but
56 * can be present in current state). */
59 typedef void (* DBusAddWatchFunction) (DBusWatch *watch,
62 typedef void (* DBusRemoveWatchFunction) (DBusWatch *watch,
65 typedef void (* DBusWakeupMainFunction) (void *data);
66 typedef void (* DBusAddTimeoutFunction) (DBusTimeout *timeout,
68 typedef void (* DBusRemoveTimeoutFunction) (DBusTimeout *timeout,
71 DBusConnection* dbus_connection_open (const char *address,
72 DBusResultCode *result);
73 void dbus_connection_ref (DBusConnection *connection);
74 void dbus_connection_unref (DBusConnection *connection);
75 void dbus_connection_disconnect (DBusConnection *connection);
76 dbus_bool_t dbus_connection_get_is_connected (DBusConnection *connection);
77 dbus_bool_t dbus_connection_get_is_authenticated (DBusConnection *connection);
78 void dbus_connection_flush (DBusConnection *connection);
79 int dbus_connection_get_n_messages (DBusConnection *connection);
80 DBusMessage* dbus_connection_borrow_message (DBusConnection *connection);
81 void dbus_connection_return_message (DBusConnection *connection,
82 DBusMessage *message);
83 void dbus_connection_steal_borrowed_message (DBusConnection *connection,
84 DBusMessage *message);
85 DBusMessage* dbus_connection_pop_message (DBusConnection *connection);
86 dbus_bool_t dbus_connection_dispatch_message (DBusConnection *connection);
89 dbus_bool_t dbus_connection_send (DBusConnection *connection,
91 dbus_int32_t *client_serial);
92 dbus_bool_t dbus_connection_send_with_reply (DBusConnection *connection,
94 DBusMessageHandler *reply_handler,
95 int timeout_milliseconds);
96 DBusMessage *dbus_connection_send_with_reply_and_block (DBusConnection *connection,
98 int timeout_milliseconds,
103 void dbus_connection_set_watch_functions (DBusConnection *connection,
104 DBusAddWatchFunction add_function,
105 DBusRemoveWatchFunction remove_function,
107 DBusFreeFunction free_data_function);
108 void dbus_connection_set_timeout_functions (DBusConnection *connection,
109 DBusAddTimeoutFunction add_function,
110 DBusRemoveTimeoutFunction remove_function,
112 DBusFreeFunction free_data_function);
113 void dbus_connection_set_wakeup_main_function (DBusConnection *connection,
114 DBusWakeupMainFunction wakeup_main_function,
116 DBusFreeFunction free_data_function);
117 void dbus_connection_handle_watch (DBusConnection *connection,
119 unsigned int condition);
123 int dbus_watch_get_fd (DBusWatch *watch);
124 unsigned int dbus_watch_get_flags (DBusWatch *watch);
125 void* dbus_watch_get_data (DBusWatch *watch);
126 void dbus_watch_set_data (DBusWatch *watch,
128 DBusFreeFunction free_data_function);
130 int dbus_timeout_get_interval (DBusTimeout *timeout);
131 void* dbus_timeout_get_data (DBusTimeout *timeout);
132 void dbus_timeout_set_data (DBusTimeout *timeout,
134 DBusFreeFunction free_data_function);
135 void dbus_timeout_handle (DBusTimeout *timeout);
139 dbus_bool_t dbus_connection_add_filter (DBusConnection *connection,
140 DBusMessageHandler *handler);
141 void dbus_connection_remove_filter (DBusConnection *connection,
142 DBusMessageHandler *handler);
144 dbus_bool_t dbus_connection_register_handler (DBusConnection *connection,
145 DBusMessageHandler *handler,
146 const char **messages_to_handle,
148 void dbus_connection_unregister_handler (DBusConnection *connection,
149 DBusMessageHandler *handler,
150 const char **messages_to_handle,
154 int dbus_connection_allocate_data_slot (void);
155 void dbus_connection_free_data_slot (int slot);
156 dbus_bool_t dbus_connection_set_data (DBusConnection *connection,
159 DBusFreeFunction free_data_func);
160 void* dbus_connection_get_data (DBusConnection *connection,
163 void dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe);
165 void dbus_connection_set_max_message_size (DBusConnection *connection,
167 long dbus_connection_get_max_message_size (DBusConnection *connection);
168 void dbus_connection_set_max_live_messages_size (DBusConnection *connection,
170 long dbus_connection_get_max_live_messages_size (DBusConnection *connection);
172 DBusPreallocatedSend* dbus_connection_preallocate_send (DBusConnection *connection);
173 void dbus_connection_free_preallocated_send (DBusConnection *connection,
174 DBusPreallocatedSend *preallocated);
175 void dbus_connection_send_preallocated (DBusConnection *connection,
176 DBusPreallocatedSend *preallocated,
177 DBusMessage *message,
178 dbus_int32_t *client_serial);
183 #endif /* DBUS_CONNECTION_H */