os/ossrv/ofdbus/dbus/bus/connection.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 /* -*- mode: C; c-file-style: "gnu" -*- */
     2 /* connection.h  Client connections
     3  *
     4  * Copyright (C) 2003, 2004  Red Hat, Inc.
     5  * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
     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., 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 #ifndef __SYMBIAN32__
    29 #include <dbus/dbus-list.h>
    30 #else
    31 #include "dbus-list.h"
    32 #endif //__SYMBIAN32__
    33 #include "bus.h"
    34 
    35 typedef dbus_bool_t (* BusConnectionForeachFunction) (DBusConnection *connection, 
    36                                                       void           *data);
    37 
    38 
    39 BusConnections* bus_connections_new               (BusContext                   *context);
    40 BusConnections* bus_connections_ref               (BusConnections               *connections);
    41 void            bus_connections_unref             (BusConnections               *connections);
    42 dbus_bool_t     bus_connections_setup_connection  (BusConnections               *connections,
    43                                                    DBusConnection               *connection);
    44 void            bus_connections_foreach           (BusConnections               *connections,
    45                                                    BusConnectionForeachFunction  function,
    46                                                    void                         *data);
    47 void            bus_connections_foreach_active    (BusConnections               *connections,
    48                                                    BusConnectionForeachFunction  function,
    49                                                    void                         *data);
    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 BusSELinuxID*   bus_connection_get_selinux_id     (DBusConnection               *connection);
    58 dbus_bool_t     bus_connections_check_limits      (BusConnections               *connections,
    59                                                    DBusConnection               *requesting_completion,
    60                                                    DBusError                    *error);
    61 void            bus_connections_expire_incomplete (BusConnections               *connections);
    62 
    63 dbus_bool_t     bus_connections_expect_reply      (BusConnections               *connections,
    64                                                    BusTransaction               *transaction,
    65                                                    DBusConnection               *will_get_reply,
    66                                                    DBusConnection               *will_send_reply,
    67                                                    DBusMessage                  *reply_to_this,
    68                                                    DBusError                    *error);
    69 dbus_bool_t     bus_connections_check_reply       (BusConnections               *connections,
    70                                                    BusTransaction               *transaction,
    71                                                    DBusConnection               *sending_reply,
    72                                                    DBusConnection               *receiving_reply,
    73                                                    DBusMessage                  *reply,
    74                                                    DBusError                    *error);
    75 
    76 dbus_bool_t     bus_connection_mark_stamp         (DBusConnection               *connection);
    77 
    78 dbus_bool_t bus_connection_is_active (DBusConnection *connection);
    79 const char *bus_connection_get_name  (DBusConnection *connection);
    80 
    81 dbus_bool_t bus_connection_preallocate_oom_error (DBusConnection *connection);
    82 void        bus_connection_send_oom_error        (DBusConnection *connection,
    83                                                   DBusMessage    *in_reply_to);
    84 
    85 /* called by signals.c */
    86 dbus_bool_t bus_connection_add_match_rule      (DBusConnection *connection,
    87                                                 BusMatchRule   *rule);
    88 void        bus_connection_add_match_rule_link (DBusConnection *connection,
    89                                                 DBusList       *link);
    90 void        bus_connection_remove_match_rule   (DBusConnection *connection,
    91                                                 BusMatchRule   *rule);
    92 int         bus_connection_get_n_match_rules   (DBusConnection *connection);
    93 
    94 
    95 /* called by services.c */
    96 dbus_bool_t bus_connection_add_owned_service      (DBusConnection *connection,
    97                                                    BusService     *service);
    98 void        bus_connection_remove_owned_service   (DBusConnection *connection,
    99                                                    BusService     *service);
   100 void        bus_connection_add_owned_service_link (DBusConnection *connection,
   101                                                    DBusList       *link);
   102 int         bus_connection_get_n_services_owned   (DBusConnection *connection);
   103 
   104 /* called by driver.c */
   105 dbus_bool_t bus_connection_complete (DBusConnection               *connection,
   106 				     const DBusString             *name,
   107                                      DBusError                    *error);
   108 
   109 /* called by dispatch.c when the connection is dropped */
   110 void        bus_connection_disconnected (DBusConnection *connection);
   111 
   112 dbus_bool_t      bus_connection_is_in_group (DBusConnection       *connection,
   113                                              unsigned long         gid);
   114 dbus_bool_t      bus_connection_get_groups  (DBusConnection       *connection,
   115                                              unsigned long       **groups,
   116                                              int                  *n_groups,
   117                                              DBusError            *error);
   118 BusClientPolicy* bus_connection_get_policy  (DBusConnection       *connection);
   119 
   120 /* transaction API so we can send or not send a block of messages as a whole */
   121 
   122 typedef void (* BusTransactionCancelFunction) (void *data);
   123 
   124 BusTransaction* bus_transaction_new              (BusContext                   *context);
   125 BusContext*     bus_transaction_get_context      (BusTransaction               *transaction);
   126 BusConnections* bus_transaction_get_connections  (BusTransaction               *transaction);
   127 dbus_bool_t     bus_transaction_send             (BusTransaction               *transaction,
   128                                                   DBusConnection               *connection,
   129                                                   DBusMessage                  *message);
   130 dbus_bool_t     bus_transaction_send_from_driver (BusTransaction               *transaction,
   131                                                   DBusConnection               *connection,
   132                                                   DBusMessage                  *message);
   133 dbus_bool_t     bus_transaction_send_error_reply (BusTransaction               *transaction,
   134                                                   DBusConnection               *connection,
   135                                                   const DBusError              *error,
   136                                                   DBusMessage                  *in_reply_to);
   137 void            bus_transaction_cancel_and_free  (BusTransaction               *transaction);
   138 void            bus_transaction_execute_and_free (BusTransaction               *transaction);
   139 dbus_bool_t     bus_transaction_add_cancel_hook  (BusTransaction               *transaction,
   140                                                   BusTransactionCancelFunction  cancel_function,
   141                                                   void                         *data,
   142                                                   DBusFreeFunction              free_data_function);
   143 
   144 #endif /* BUS_CONNECTION_H */