1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* connection.h Client connections
4 * Copyright (C) 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
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 void 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 BusContext* bus_connection_get_context (DBusConnection *connection);
49 BusConnections* bus_connection_get_connections (DBusConnection *connection);
50 BusRegistry* bus_connection_get_registry (DBusConnection *connection);
51 BusActivation* bus_connection_get_activation (DBusConnection *connection);
52 BusMatchmaker* bus_connection_get_matchmaker (DBusConnection *connection);
53 dbus_bool_t bus_connections_check_limits (BusConnections *connections,
54 DBusConnection *requesting_completion,
56 void bus_connections_expire_incomplete (BusConnections *connections);
58 dbus_bool_t bus_connections_expect_reply (BusConnections *connections,
59 BusTransaction *transaction,
60 DBusConnection *will_get_reply,
61 DBusConnection *will_send_reply,
62 DBusMessage *reply_to_this,
64 dbus_bool_t bus_connections_check_reply (BusConnections *connections,
65 BusTransaction *transaction,
66 DBusConnection *sending_reply,
67 DBusConnection *receiving_reply,
71 dbus_bool_t bus_connection_mark_stamp (DBusConnection *connection);
73 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
74 const char *bus_connection_get_name (DBusConnection *connection);
76 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
77 void bus_connection_send_oom_error (DBusConnection *connection,
78 DBusMessage *in_reply_to);
80 /* called by signals.c */
81 dbus_bool_t bus_connection_add_match_rule (DBusConnection *connection,
83 void bus_connection_add_match_rule_link (DBusConnection *connection,
85 void bus_connection_remove_match_rule (DBusConnection *connection,
87 int bus_connection_get_n_match_rules (DBusConnection *connection);
90 /* called by services.c */
91 dbus_bool_t bus_connection_add_owned_service (DBusConnection *connection,
93 void bus_connection_remove_owned_service (DBusConnection *connection,
95 void bus_connection_add_owned_service_link (DBusConnection *connection,
97 int bus_connection_get_n_services_owned (DBusConnection *connection);
99 /* called by driver.c */
100 dbus_bool_t bus_connection_complete (DBusConnection *connection,
101 const DBusString *name,
104 /* called by dispatch.c when the connection is dropped */
105 void bus_connection_disconnected (DBusConnection *connection);
107 dbus_bool_t bus_connection_is_in_group (DBusConnection *connection,
109 dbus_bool_t bus_connection_get_groups (DBusConnection *connection,
110 unsigned long **groups,
113 BusClientPolicy* bus_connection_get_policy (DBusConnection *connection);
115 /* transaction API so we can send or not send a block of messages as a whole */
117 typedef void (* BusTransactionCancelFunction) (void *data);
119 BusTransaction* bus_transaction_new (BusContext *context);
120 BusContext* bus_transaction_get_context (BusTransaction *transaction);
121 BusConnections* bus_transaction_get_connections (BusTransaction *transaction);
122 dbus_bool_t bus_transaction_send (BusTransaction *transaction,
123 DBusConnection *connection,
124 DBusMessage *message);
125 dbus_bool_t bus_transaction_send_from_driver (BusTransaction *transaction,
126 DBusConnection *connection,
127 DBusMessage *message);
128 dbus_bool_t bus_transaction_send_error_reply (BusTransaction *transaction,
129 DBusConnection *connection,
130 const DBusError *error,
131 DBusMessage *in_reply_to);
132 void bus_transaction_cancel_and_free (BusTransaction *transaction);
133 void bus_transaction_execute_and_free (BusTransaction *transaction);
134 dbus_bool_t bus_transaction_add_cancel_hook (BusTransaction *transaction,
135 BusTransactionCancelFunction cancel_function,
137 DBusFreeFunction free_data_function);
139 #endif /* BUS_CONNECTION_H */