bus/connection.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* connection.h  Client connections
   3  *
   4  * Copyright (C) 2003  Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 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,
  42                                                   void                         *data);
  43 BusContext*     bus_connections_get_context      (BusConnections               *connections);
  44
  45 BusContext*     bus_connection_get_context       (DBusConnection               *connection);
  46 BusConnections* bus_connection_get_connections   (DBusConnection               *connection);
  47 BusRegistry*    bus_connection_get_registry      (DBusConnection               *connection);
  48 BusActivation*  bus_connection_get_activation    (DBusConnection               *connection);
  49
  50 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
  51
  52 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
  53 void        bus_connection_send_oom_error        (DBusConnection *connection,
  54                                                   DBusMessage    *in_reply_to);
  55
  56 /* called by services.c */
  57 dbus_bool_t bus_connection_add_owned_service      (DBusConnection *connection,
  58                                                    BusService     *service);
  59 void        bus_connection_remove_owned_service   (DBusConnection *connection,
  60                                                    BusService     *service);
  61 void        bus_connection_add_owned_service_link (DBusConnection *connection,
  62                                                    DBusList       *link);
  63
  64
  65 /* called by driver.c */
  66 dbus_bool_t bus_connection_set_name (DBusConnection               *connection,
  67                                      const DBusString             *name);
  68 const char *bus_connection_get_name (DBusConnection               *connection);
  69
  70 /* called by dispatch.c when the connection is dropped */
  71 void        bus_connection_disconnected (DBusConnection *connection);
  72
  73 dbus_bool_t      bus_connection_is_in_group (DBusConnection       *connection,
  74                                              unsigned long         gid);
  75 dbus_bool_t      bus_connection_get_groups  (DBusConnection       *connection,
  76                                              const unsigned long **groups,
  77                                              int                  *n_groups);
  78 BusClientPolicy* bus_connection_get_policy  (DBusConnection       *connection);
  79
  80 /* transaction API so we can send or not send a block of messages as a whole */
  81
  82 typedef void (* BusTransactionCancelFunction) (void *data);
  83
  84 BusTransaction* bus_transaction_new              (BusContext                   *context);
  85 BusContext*     bus_transaction_get_context      (BusTransaction               *transaction);
  86 BusConnections* bus_transaction_get_connections  (BusTransaction               *transaction);
  87 dbus_bool_t     bus_transaction_send             (BusTransaction               *transaction,
  88                                                   DBusConnection               *connection,
  89                                                   DBusMessage                  *message);
  90 dbus_bool_t     bus_transaction_send_from_driver (BusTransaction               *transaction,
  91                                                   DBusConnection               *connection,
  92                                                   DBusMessage                  *message);
  93 dbus_bool_t     bus_transaction_send_error_reply (BusTransaction               *transaction,
  94                                                   DBusConnection               *connection,
  95                                                   const DBusError              *error,
  96                                                   DBusMessage                  *in_reply_to);
  97 void            bus_transaction_cancel_and_free  (BusTransaction               *transaction);
  98 void            bus_transaction_execute_and_free (BusTransaction               *transaction);
  99 dbus_bool_t     bus_transaction_add_cancel_hook  (BusTransaction               *transaction,
 100                                                   BusTransactionCancelFunction  cancel_function,
 101                                                   void                         *data,
 102                                                   DBusFreeFunction              free_data_function);
 103
 104 #endif /* BUS_CONNECTION_H */