blob: 4b9a754b4ef0ede46e6ceadeda5910403ea1b696 [file] [log] [blame]
Emeric Vigier2f625822012-08-06 11:09:52 -04001/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* connection.h Client connections
3 *
4 * Copyright (C) 2003, 2004 Red Hat, Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
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.
12 *
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.
17 *
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
21 *
22 */
23
24#ifndef BUS_CONNECTION_H
25#define BUS_CONNECTION_H
26
27#include <dbus/dbus.h>
28#include <dbus/dbus-list.h>
29#include "bus.h"
30
31typedef dbus_bool_t (* BusConnectionForeachFunction) (DBusConnection *connection,
32 void *data);
33
34
35BusConnections* bus_connections_new (BusContext *context);
36BusConnections* bus_connections_ref (BusConnections *connections);
37void bus_connections_unref (BusConnections *connections);
38dbus_bool_t bus_connections_setup_connection (BusConnections *connections,
39 DBusConnection *connection);
40void bus_connections_foreach (BusConnections *connections,
41 BusConnectionForeachFunction function,
42 void *data);
43void bus_connections_foreach_active (BusConnections *connections,
44 BusConnectionForeachFunction function,
45 void *data);
46BusContext* bus_connections_get_context (BusConnections *connections);
47void bus_connections_increment_stamp (BusConnections *connections);
48BusContext* bus_connection_get_context (DBusConnection *connection);
49BusConnections* bus_connection_get_connections (DBusConnection *connection);
50BusRegistry* bus_connection_get_registry (DBusConnection *connection);
51BusActivation* bus_connection_get_activation (DBusConnection *connection);
52BusMatchmaker* bus_connection_get_matchmaker (DBusConnection *connection);
53const char * bus_connection_get_loginfo (DBusConnection *connection);
54BusSELinuxID* bus_connection_get_selinux_id (DBusConnection *connection);
55dbus_bool_t bus_connections_check_limits (BusConnections *connections,
56 DBusConnection *requesting_completion,
57 DBusError *error);
58void bus_connections_expire_incomplete (BusConnections *connections);
59
60dbus_bool_t bus_connections_expect_reply (BusConnections *connections,
61 BusTransaction *transaction,
62 DBusConnection *will_get_reply,
63 DBusConnection *will_send_reply,
64 DBusMessage *reply_to_this,
65 DBusError *error);
66dbus_bool_t bus_connections_check_reply (BusConnections *connections,
67 BusTransaction *transaction,
68 DBusConnection *sending_reply,
69 DBusConnection *receiving_reply,
70 DBusMessage *reply,
71 DBusError *error);
72
73dbus_bool_t bus_connection_mark_stamp (DBusConnection *connection);
74
75dbus_bool_t bus_connection_is_active (DBusConnection *connection);
76const char *bus_connection_get_name (DBusConnection *connection);
77
78dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
79void bus_connection_send_oom_error (DBusConnection *connection,
80 DBusMessage *in_reply_to);
81
82/* called by signals.c */
83dbus_bool_t bus_connection_add_match_rule (DBusConnection *connection,
84 BusMatchRule *rule);
85void bus_connection_add_match_rule_link (DBusConnection *connection,
86 DBusList *link);
87void bus_connection_remove_match_rule (DBusConnection *connection,
88 BusMatchRule *rule);
89int bus_connection_get_n_match_rules (DBusConnection *connection);
90
91
92/* called by services.c */
93dbus_bool_t bus_connection_add_owned_service (DBusConnection *connection,
94 BusService *service);
95void bus_connection_remove_owned_service (DBusConnection *connection,
96 BusService *service);
97void bus_connection_add_owned_service_link (DBusConnection *connection,
98 DBusList *link);
99int bus_connection_get_n_services_owned (DBusConnection *connection);
100
101/* called by driver.c */
102dbus_bool_t bus_connection_complete (DBusConnection *connection,
103 const DBusString *name,
104 DBusError *error);
105
106/* called by dispatch.c when the connection is dropped */
107void bus_connection_disconnected (DBusConnection *connection);
108
109dbus_bool_t bus_connection_is_in_unix_group (DBusConnection *connection,
110 unsigned long gid);
111dbus_bool_t bus_connection_get_unix_groups (DBusConnection *connection,
112 unsigned long **groups,
113 int *n_groups,
114 DBusError *error);
115BusClientPolicy* bus_connection_get_policy (DBusConnection *connection);
116
117/* transaction API so we can send or not send a block of messages as a whole */
118
119typedef void (* BusTransactionCancelFunction) (void *data);
120
121BusTransaction* bus_transaction_new (BusContext *context);
122BusContext* bus_transaction_get_context (BusTransaction *transaction);
123BusConnections* bus_transaction_get_connections (BusTransaction *transaction);
124dbus_bool_t bus_transaction_send (BusTransaction *transaction,
125 DBusConnection *connection,
126 DBusMessage *message);
127dbus_bool_t bus_transaction_send_from_driver (BusTransaction *transaction,
128 DBusConnection *connection,
129 DBusMessage *message);
130dbus_bool_t bus_transaction_send_error_reply (BusTransaction *transaction,
131 DBusConnection *connection,
132 const DBusError *error,
133 DBusMessage *in_reply_to);
134void bus_transaction_cancel_and_free (BusTransaction *transaction);
135void bus_transaction_execute_and_free (BusTransaction *transaction);
136dbus_bool_t bus_transaction_add_cancel_hook (BusTransaction *transaction,
137 BusTransactionCancelFunction cancel_function,
138 void *data,
139 DBusFreeFunction free_data_function);
140
141#endif /* BUS_CONNECTION_H */