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 #ifdef ENABLE_KDBUS_TRANSPORT
47 DBusConnection* bus_connections_find_conn_by_name (BusConnections *connections,
50 BusContext* bus_connections_get_context (BusConnections *connections);
51 void bus_connections_increment_stamp (BusConnections *connections);
52 BusContext* bus_connection_get_context (DBusConnection *connection);
53 BusConnections* bus_connection_get_connections (DBusConnection *connection);
54 BusRegistry* bus_connection_get_registry (DBusConnection *connection);
55 BusActivation* bus_connection_get_activation (DBusConnection *connection);
56 BusMatchmaker* bus_connection_get_matchmaker (DBusConnection *connection);
57 const char * bus_connection_get_loginfo (DBusConnection *connection);
58 BusSELinuxID* bus_connection_get_selinux_id (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 #ifdef ENABLE_KDBUS_TRANSPORT
87 DBusList** bus_connection_get_services_owned (DBusConnection *connection);
90 /* called by signals.c */
91 dbus_bool_t bus_connection_add_match_rule (DBusConnection *connection,
93 void bus_connection_add_match_rule_link (DBusConnection *connection,
95 void bus_connection_remove_match_rule (DBusConnection *connection,
97 int bus_connection_get_n_match_rules (DBusConnection *connection);
100 /* called by services.c */
101 dbus_bool_t bus_connection_add_owned_service (DBusConnection *connection,
102 BusService *service);
103 void bus_connection_remove_owned_service (DBusConnection *connection,
104 BusService *service);
105 void bus_connection_add_owned_service_link (DBusConnection *connection,
107 int bus_connection_get_n_services_owned (DBusConnection *connection);
109 /* called by driver.c */
110 dbus_bool_t bus_connection_complete (DBusConnection *connection,
111 const DBusString *name,
114 /* called by dispatch.c when the connection is dropped */
115 void bus_connection_disconnected (DBusConnection *connection);
117 dbus_bool_t bus_connection_is_in_unix_group (DBusConnection *connection,
119 dbus_bool_t bus_connection_get_unix_groups (DBusConnection *connection,
120 unsigned long **groups,
123 BusClientPolicy* bus_connection_get_policy (DBusConnection *connection);
125 /* transaction API so we can send or not send a block of messages as a whole */
127 typedef void (* BusTransactionCancelFunction) (void *data);
129 BusTransaction* bus_transaction_new (BusContext *context);
130 BusContext* bus_transaction_get_context (BusTransaction *transaction);
131 BusConnections* bus_transaction_get_connections (BusTransaction *transaction);
132 dbus_bool_t bus_transaction_send (BusTransaction *transaction,
133 DBusConnection *connection,
134 DBusMessage *message);
135 dbus_bool_t bus_transaction_send_from_driver (BusTransaction *transaction,
136 DBusConnection *connection,
137 DBusMessage *message);
138 dbus_bool_t bus_transaction_send_error_reply (BusTransaction *transaction,
139 DBusConnection *connection,
140 const DBusError *error,
141 DBusMessage *in_reply_to);
142 void bus_transaction_cancel_and_free (BusTransaction *transaction);
143 void bus_transaction_execute_and_free (BusTransaction *transaction);
144 #ifdef ENABLE_KDBUS_TRANSPORT
145 void bus_transaction_free (BusTransaction *transaction);
147 dbus_bool_t bus_transaction_add_cancel_hook (BusTransaction *transaction,
148 BusTransactionCancelFunction cancel_function,
150 DBusFreeFunction free_data_function);
152 /* called by stats.c, only present if DBUS_ENABLE_STATS */
153 int bus_connections_get_n_active (BusConnections *connections);
154 int bus_connections_get_n_incomplete (BusConnections *connections);
155 int bus_connections_get_total_match_rules (BusConnections *connections);
156 int bus_connections_get_peak_match_rules (BusConnections *connections);
157 int bus_connections_get_peak_match_rules_per_conn (BusConnections *connections);
158 int bus_connections_get_total_bus_names (BusConnections *connections);
159 int bus_connections_get_peak_bus_names (BusConnections *connections);
160 int bus_connections_get_peak_bus_names_per_conn (BusConnections *connections);
162 int bus_connection_get_peak_match_rules (DBusConnection *connection);
163 int bus_connection_get_peak_bus_names (DBusConnection *connection);
165 #endif /* BUS_CONNECTION_H */