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,
35 BusConnections* bus_connections_new (BusContext *context);
36 BusConnections* bus_connections_ref (BusConnections *connections);
37 void bus_connections_unref (BusConnections *connections);
38 dbus_bool_t bus_connections_setup_connection (BusConnections *connections,
39 DBusConnection *connection);
40 void bus_connections_foreach (BusConnections *connections,
41 BusConnectionForeachFunction function,
43 void bus_connections_foreach_active (BusConnections *connections,
44 BusConnectionForeachFunction function,
46 BusContext* bus_connections_get_context (BusConnections *connections);
47 void bus_connections_increment_stamp (BusConnections *connections);
48 dbus_bool_t bus_connections_reload_policy (BusConnections *connections,
50 BusContext* bus_connection_get_context (DBusConnection *connection);
51 BusConnections* bus_connection_get_connections (DBusConnection *connection);
52 BusRegistry* bus_connection_get_registry (DBusConnection *connection);
53 BusActivation* bus_connection_get_activation (DBusConnection *connection);
54 BusMatchmaker* bus_connection_get_matchmaker (DBusConnection *connection);
55 const char * bus_connection_get_loginfo (DBusConnection *connection);
56 BusSELinuxID* bus_connection_get_selinux_id (DBusConnection *connection);
57 BusAppArmorConfinement* bus_connection_dup_apparmor_confinement (DBusConnection *connection);
58 dbus_bool_t bus_connections_check_limits (BusConnections *connections,
59 DBusConnection *requesting_completion,
60 const char **limit_name_out,
63 void bus_connections_expire_incomplete (BusConnections *connections);
65 dbus_bool_t bus_connections_expect_reply (BusConnections *connections,
66 BusTransaction *transaction,
67 DBusConnection *will_get_reply,
68 DBusConnection *will_send_reply,
69 DBusMessage *reply_to_this,
71 dbus_bool_t bus_connections_check_reply (BusConnections *connections,
72 BusTransaction *transaction,
73 DBusConnection *sending_reply,
74 DBusConnection *receiving_reply,
78 dbus_bool_t bus_connection_mark_stamp (DBusConnection *connection);
80 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
81 const char *bus_connection_get_name (DBusConnection *connection);
83 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
84 void bus_connection_send_oom_error (DBusConnection *connection,
85 DBusMessage *in_reply_to);
87 /* called by signals.c */
88 dbus_bool_t bus_connection_add_match_rule (DBusConnection *connection,
90 void bus_connection_add_match_rule_link (DBusConnection *connection,
92 void bus_connection_remove_match_rule (DBusConnection *connection,
94 int bus_connection_get_n_match_rules (DBusConnection *connection);
97 /* called by services.c */
98 dbus_bool_t bus_connection_add_owned_service (DBusConnection *connection,
100 void bus_connection_remove_owned_service (DBusConnection *connection,
101 BusService *service);
102 void bus_connection_add_owned_service_link (DBusConnection *connection,
104 int bus_connection_get_n_services_owned (DBusConnection *connection);
106 /* called by driver.c */
107 dbus_bool_t bus_connection_complete (DBusConnection *connection,
108 const DBusString *name,
111 /* called by dispatch.c when the connection is dropped */
112 void bus_connection_disconnected (DBusConnection *connection);
114 dbus_bool_t bus_connection_is_in_unix_group (DBusConnection *connection,
116 dbus_bool_t bus_connection_get_unix_groups (DBusConnection *connection,
117 unsigned long **groups,
120 BusClientPolicy* bus_connection_get_policy (DBusConnection *connection);
122 dbus_bool_t bus_connection_is_monitor (DBusConnection *connection);
123 dbus_bool_t bus_connection_be_monitor (DBusConnection *connection,
124 BusTransaction *transaction,
128 /* transaction API so we can send or not send a block of messages as a whole */
130 typedef void (* BusTransactionCancelFunction) (void *data);
132 BusTransaction* bus_transaction_new (BusContext *context);
133 BusContext* bus_transaction_get_context (BusTransaction *transaction);
134 dbus_bool_t bus_transaction_send (BusTransaction *transaction,
135 DBusConnection *connection,
136 DBusMessage *message);
137 dbus_bool_t bus_transaction_capture (BusTransaction *transaction,
138 DBusConnection *connection,
139 DBusConnection *addressed_recipient,
140 DBusMessage *message);
141 dbus_bool_t bus_transaction_capture_error_reply (BusTransaction *transaction,
142 DBusConnection *addressed_recipient,
143 const DBusError *error,
144 DBusMessage *in_reply_to);
145 dbus_bool_t bus_transaction_send_from_driver (BusTransaction *transaction,
146 DBusConnection *connection,
147 DBusMessage *message);
148 dbus_bool_t bus_transaction_send_error_reply (BusTransaction *transaction,
149 DBusConnection *connection,
150 const DBusError *error,
151 DBusMessage *in_reply_to);
152 void bus_transaction_cancel_and_free (BusTransaction *transaction);
153 void bus_transaction_execute_and_free (BusTransaction *transaction);
154 dbus_bool_t bus_transaction_add_cancel_hook (BusTransaction *transaction,
155 BusTransactionCancelFunction cancel_function,
157 DBusFreeFunction free_data_function);
159 int bus_connections_get_n_active (BusConnections *connections);
160 int bus_connections_get_n_incomplete (BusConnections *connections);
162 /* called by stats.c, only present if DBUS_ENABLE_STATS */
163 int bus_connections_get_total_match_rules (BusConnections *connections);
164 int bus_connections_get_peak_match_rules (BusConnections *connections);
165 int bus_connections_get_peak_match_rules_per_conn (BusConnections *connections);
166 int bus_connections_get_total_bus_names (BusConnections *connections);
167 int bus_connections_get_peak_bus_names (BusConnections *connections);
168 int bus_connections_get_peak_bus_names_per_conn (BusConnections *connections);
170 int bus_connection_get_peak_match_rules (DBusConnection *connection);
171 int bus_connection_get_peak_bus_names (DBusConnection *connection);
173 #endif /* BUS_CONNECTION_H */