1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* connection.h Client connections
4 * Copyright (C) 2003, 2004 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
24 #ifndef BUS_CONNECTION_H
25 #define BUS_CONNECTION_H
27 #include <dbus/dbus.h>
28 #include <dbus/dbus-list.h>
31 typedef dbus_bool_t (* BusConnectionForeachFunction) (DBusConnection *connection,
34 DBusLoop* bus_connection_get_loop (DBusConnection *connection);
36 BusConnections* bus_connections_new (BusContext *context);
37 BusConnections* bus_connections_ref (BusConnections *connections);
38 void bus_connections_unref (BusConnections *connections);
39 dbus_bool_t bus_connections_setup_connection (BusConnections *connections,
40 DBusConnection *connection);
41 void bus_connections_foreach (BusConnections *connections,
42 BusConnectionForeachFunction function,
44 void bus_connections_foreach_active (BusConnections *connections,
45 BusConnectionForeachFunction function,
47 BusContext* bus_connections_get_context (BusConnections *connections);
48 void bus_connections_increment_stamp (BusConnections *connections);
49 dbus_bool_t bus_connections_reload_policy (BusConnections *connections,
51 BusContext* bus_connection_get_context (DBusConnection *connection);
52 BusConnections* bus_connection_get_connections (DBusConnection *connection);
53 BusRegistry* bus_connection_get_registry (DBusConnection *connection);
54 BusActivation* bus_connection_get_activation (DBusConnection *connection);
55 BusMatchmaker* bus_connection_get_matchmaker (DBusConnection *connection);
56 const char * bus_connection_get_loginfo (DBusConnection *connection);
57 BusSELinuxID* bus_connection_get_selinux_id (DBusConnection *connection);
58 BusAppArmorConfinement* bus_connection_dup_apparmor_confinement (DBusConnection *connection);
59 dbus_bool_t bus_connections_check_limits (BusConnections *connections,
60 DBusConnection *requesting_completion,
62 void bus_connections_expire_incomplete (BusConnections *connections);
64 dbus_bool_t bus_connections_expect_reply (BusConnections *connections,
65 BusTransaction *transaction,
66 DBusConnection *will_get_reply,
67 DBusConnection *will_send_reply,
68 DBusMessage *reply_to_this,
70 dbus_bool_t bus_connections_check_reply (BusConnections *connections,
71 BusTransaction *transaction,
72 DBusConnection *sending_reply,
73 DBusConnection *receiving_reply,
77 dbus_bool_t bus_connection_mark_stamp (DBusConnection *connection);
79 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
80 const char *bus_connection_get_name (DBusConnection *connection);
82 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
83 void bus_connection_send_oom_error (DBusConnection *connection,
84 DBusMessage *in_reply_to);
86 dbus_bool_t bus_connection_has_deferred_messages (DBusConnection *connection);
87 dbus_bool_t bus_connection_queue_deferred_message (DBusConnection *connection,
88 BusDeferredMessage *message,
90 BusDeferredMessage *bus_connection_pop_deferred_message (DBusConnection *connection);
91 dbus_bool_t bus_connection_putback_deferred_message (DBusConnection *connection,
92 BusDeferredMessage *message);
93 void bus_connection_remove_deferred_message (DBusConnection *connection,
94 BusDeferredMessage *message);
95 dbus_bool_t bus_connection_replace_deferred_message (DBusConnection *connection,
96 BusDeferredMessage *oldMessage,
97 BusDeferredMessage *newMessage);
98 void bus_connection_dispatch_deferred (DBusConnection *connection);
99 void bus_connection_clear_deferred_messages (DBusConnection *connection);
102 /* called by signals.c */
103 dbus_bool_t bus_connection_add_match_rule (DBusConnection *connection,
105 void bus_connection_add_match_rule_link (DBusConnection *connection,
107 void bus_connection_remove_match_rule (DBusConnection *connection,
109 int bus_connection_get_n_match_rules (DBusConnection *connection);
112 /* called by services.c */
113 dbus_bool_t bus_connection_add_owned_service (DBusConnection *connection,
114 BusService *service);
115 void bus_connection_remove_owned_service (DBusConnection *connection,
116 BusService *service);
117 void bus_connection_add_owned_service_link (DBusConnection *connection,
119 int bus_connection_get_n_services_owned (DBusConnection *connection);
121 /* called by driver.c */
122 dbus_bool_t bus_connection_complete (DBusConnection *connection,
123 const DBusString *name,
126 /* called by dispatch.c when the connection is dropped */
127 void bus_connection_disconnected (DBusConnection *connection);
129 dbus_bool_t bus_connection_is_in_unix_group (DBusConnection *connection,
131 dbus_bool_t bus_connection_get_unix_groups (DBusConnection *connection,
132 unsigned long **groups,
135 BusClientPolicy* bus_connection_get_policy (DBusConnection *connection);
137 dbus_bool_t bus_connection_is_monitor (DBusConnection *connection);
138 dbus_bool_t bus_connection_be_monitor (DBusConnection *connection,
139 BusTransaction *transaction,
142 #ifdef DBUS_ENABLE_CYNARA
143 const char *bus_connection_get_cynara_session_id (DBusConnection *connection);
146 /* transaction API so we can send or not send a block of messages as a whole */
148 typedef void (* BusTransactionCancelFunction) (void *data);
150 BusTransaction* bus_transaction_new (BusContext *context);
151 BusContext* bus_transaction_get_context (BusTransaction *transaction);
152 dbus_bool_t bus_transaction_send (BusTransaction *transaction,
153 DBusConnection *connection,
154 DBusMessage *message,
155 dbus_bool_t deferred_dispatch);
156 dbus_bool_t bus_transaction_capture (BusTransaction *transaction,
157 DBusConnection *connection,
158 DBusMessage *message);
159 dbus_bool_t bus_transaction_capture_error_reply (BusTransaction *transaction,
160 const DBusError *error,
161 DBusMessage *in_reply_to);
162 dbus_bool_t bus_transaction_send_from_driver (BusTransaction *transaction,
163 DBusConnection *connection,
164 DBusMessage *message);
165 dbus_bool_t bus_transaction_send_error_reply (BusTransaction *transaction,
166 DBusConnection *connection,
167 const DBusError *error,
168 DBusMessage *in_reply_to);
169 void bus_transaction_cancel_and_free (BusTransaction *transaction);
170 void bus_transaction_execute_and_free (BusTransaction *transaction);
171 dbus_bool_t bus_transaction_add_cancel_hook (BusTransaction *transaction,
172 BusTransactionCancelFunction cancel_function,
174 DBusFreeFunction free_data_function);
176 int bus_connections_get_n_active (BusConnections *connections);
177 int bus_connections_get_n_incomplete (BusConnections *connections);
179 /* called by stats.c, only present if DBUS_ENABLE_STATS */
180 int bus_connections_get_total_match_rules (BusConnections *connections);
181 int bus_connections_get_peak_match_rules (BusConnections *connections);
182 int bus_connections_get_peak_match_rules_per_conn (BusConnections *connections);
183 int bus_connections_get_total_bus_names (BusConnections *connections);
184 int bus_connections_get_peak_bus_names (BusConnections *connections);
185 int bus_connections_get_peak_bus_names_per_conn (BusConnections *connections);
187 int bus_connection_get_peak_match_rules (DBusConnection *connection);
188 int bus_connection_get_peak_bus_names (DBusConnection *connection);
190 #endif /* BUS_CONNECTION_H */