bus/connection.h

   1 /* -*- 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
  31 typedef dbus_bool_t (* BusConnectionForeachFunction) (DBusConnection *connection,
  32                                                       void           *data);
  33
  34
  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,
  42                                                    void                         *data);
  43 void            bus_connections_foreach_active    (BusConnections               *connections,
  44                                                    BusConnectionForeachFunction  function,
  45                                                    void                         *data);
  46 DBusConnection* bus_connections_find_conn_by_name (BusConnections *connections,
  47                                                    const char* name);
  48 BusContext*     bus_connections_get_context       (BusConnections               *connections);
  49 void            bus_connections_increment_stamp   (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 dbus_bool_t     bus_connections_check_limits      (BusConnections               *connections,
  58                                                    DBusConnection               *requesting_completion,
  59                                                    DBusError                    *error);
  60 void            bus_connections_expire_incomplete (BusConnections               *connections);
  61
  62 dbus_bool_t     bus_connections_expect_reply      (BusConnections               *connections,
  63                                                    BusTransaction               *transaction,
  64                                                    DBusConnection               *will_get_reply,
  65                                                    DBusConnection               *will_send_reply,
  66                                                    DBusMessage                  *reply_to_this,
  67                                                    DBusError                    *error);
  68 dbus_bool_t     bus_connections_check_reply       (BusConnections               *connections,
  69                                                    BusTransaction               *transaction,
  70                                                    DBusConnection               *sending_reply,
  71                                                    DBusConnection               *receiving_reply,
  72                                                    DBusMessage                  *reply,
  73                                                    DBusError                    *error);
  74
  75 dbus_bool_t     bus_connection_mark_stamp         (DBusConnection               *connection);
  76
  77 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
  78 const char *bus_connection_get_name  (DBusConnection *connection);
  79
  80 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
  81 void        bus_connection_send_oom_error        (DBusConnection *connection,
  82                                                   DBusMessage    *in_reply_to);
  83
  84 /* called by signals.c */
  85 dbus_bool_t bus_connection_add_match_rule      (DBusConnection *connection,
  86                                                 BusMatchRule   *rule);
  87 void        bus_connection_add_match_rule_link (DBusConnection *connection,
  88                                                 DBusList       *link);
  89 void        bus_connection_remove_match_rule   (DBusConnection *connection,
  90                                                 BusMatchRule   *rule);
  91 int         bus_connection_get_n_match_rules   (DBusConnection *connection);
  92
  93
  94 /* called by services.c */
  95 dbus_bool_t bus_connection_add_owned_service      (DBusConnection *connection,
  96                                                    BusService     *service);
  97 void        bus_connection_remove_owned_service   (DBusConnection *connection,
  98                                                    BusService     *service);
  99 void        bus_connection_add_owned_service_link (DBusConnection *connection,
 100                                                    DBusList       *link);
 101 int         bus_connection_get_n_services_owned   (DBusConnection *connection);
 102
 103 /* called by driver.c */
 104 dbus_bool_t bus_connection_complete (DBusConnection               *connection,
 105                                      const DBusString             *name,
 106                                      DBusError                    *error);
 107
 108 /* called by dispatch.c when the connection is dropped */
 109 void        bus_connection_disconnected (DBusConnection *connection);
 110
 111 dbus_bool_t      bus_connection_is_in_unix_group (DBusConnection       *connection,
 112                                                   unsigned long         gid);
 113 dbus_bool_t      bus_connection_get_unix_groups  (DBusConnection       *connection,
 114                                                   unsigned long       **groups,
 115                                                   int                  *n_groups,
 116                                                   DBusError            *error);
 117 BusClientPolicy* bus_connection_get_policy  (DBusConnection       *connection);
 118
 119 /* transaction API so we can send or not send a block of messages as a whole */
 120
 121 typedef void (* BusTransactionCancelFunction) (void *data);
 122
 123 BusTransaction* bus_transaction_new              (BusContext                   *context);
 124 BusContext*     bus_transaction_get_context      (BusTransaction               *transaction);
 125 BusConnections* bus_transaction_get_connections  (BusTransaction               *transaction);
 126 dbus_bool_t     bus_transaction_send             (BusTransaction               *transaction,
 127                                                   DBusConnection               *connection,
 128                                                   DBusMessage                  *message);
 129 dbus_bool_t     bus_transaction_send_from_driver (BusTransaction               *transaction,
 130                                                   DBusConnection               *connection,
 131                                                   DBusMessage                  *message);
 132 dbus_bool_t     bus_transaction_send_error_reply (BusTransaction               *transaction,
 133                                                   DBusConnection               *connection,
 134                                                   const DBusError              *error,
 135                                                   DBusMessage                  *in_reply_to);
 136 void            bus_transaction_cancel_and_free  (BusTransaction               *transaction);
 137 void            bus_transaction_execute_and_free (BusTransaction               *transaction);
 138 dbus_bool_t     bus_transaction_add_cancel_hook  (BusTransaction               *transaction,
 139                                                   BusTransactionCancelFunction  cancel_function,
 140                                                   void                         *data,
 141                                                   DBusFreeFunction              free_data_function);
 142
 143 /* called by stats.c, only present if DBUS_ENABLE_STATS */
 144 int bus_connections_get_n_active                  (BusConnections *connections);
 145 int bus_connections_get_n_incomplete              (BusConnections *connections);
 146 int bus_connections_get_total_match_rules         (BusConnections *connections);
 147 int bus_connections_get_peak_match_rules          (BusConnections *connections);
 148 int bus_connections_get_peak_match_rules_per_conn (BusConnections *connections);
 149 int bus_connections_get_total_bus_names           (BusConnections *connections);
 150 int bus_connections_get_peak_bus_names            (BusConnections *connections);
 151 int bus_connections_get_peak_bus_names_per_conn   (BusConnections *connections);
 152
 153 int bus_connection_get_peak_match_rules           (DBusConnection *connection);
 154 int bus_connection_get_peak_bus_names             (DBusConnection *connection);
 155
 156 #endif /* BUS_CONNECTION_H */