dbus/dbus-connection-internal.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-connection-internal.h DBusConnection internal interfaces
   3  *
   4  * Copyright (C) 2002  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 #ifndef DBUS_CONNECTION_INTERNAL_H
  24 #define DBUS_CONNECTION_INTERNAL_H
  25
  26 #include <dbus/dbus-internals.h>
  27 #include <dbus/dbus-connection.h>
  28 #include <dbus/dbus-message.h>
  29 #include <dbus/dbus-transport.h>
  30 #include <dbus/dbus-resources.h>
  31 #include <dbus/dbus-list.h>
  32 #include <dbus/dbus-timeout.h>
  33 #include <dbus/dbus-dataslot.h>
  34
  35 DBUS_BEGIN_DECLS
  36
  37 typedef enum
  38 {
  39   DBUS_ITERATION_DO_WRITING = 1 << 0, /**< Write messages out. */
  40   DBUS_ITERATION_DO_READING = 1 << 1, /**< Read messages in. */
  41   DBUS_ITERATION_BLOCK      = 1 << 2  /**< Block if nothing to do. */
  42 } DBusIterationFlags;
  43
  44 /** default timeout value when waiting for a message reply, 25 seconds */
  45 #define _DBUS_DEFAULT_TIMEOUT_VALUE (25 * 1000)
  46
  47 typedef void (* DBusPendingFdsChangeFunction) (void *data);
  48
  49 DBUS_PRIVATE_EXPORT
  50 void              _dbus_connection_lock                        (DBusConnection     *connection);
  51 DBUS_PRIVATE_EXPORT
  52 void              _dbus_connection_unlock                      (DBusConnection     *connection);
  53 DBUS_PRIVATE_EXPORT
  54 DBusConnection *  _dbus_connection_ref_unlocked                (DBusConnection     *connection);
  55 DBUS_PRIVATE_EXPORT
  56 void              _dbus_connection_unref_unlocked              (DBusConnection     *connection);
  57 void              _dbus_connection_queue_received_message_link (DBusConnection     *connection,
  58                                                                 DBusList           *link);
  59 dbus_bool_t       _dbus_connection_has_messages_to_send_unlocked (DBusConnection     *connection);
  60 DBusMessage*      _dbus_connection_get_message_to_send         (DBusConnection     *connection);
  61 void              _dbus_connection_message_sent_unlocked       (DBusConnection     *connection,
  62                                                                 DBusMessage        *message);
  63 dbus_bool_t       _dbus_connection_add_watch_unlocked          (DBusConnection     *connection,
  64                                                                 DBusWatch          *watch);
  65 void              _dbus_connection_remove_watch_unlocked       (DBusConnection     *connection,
  66                                                                 DBusWatch          *watch);
  67 void              _dbus_connection_toggle_watch_unlocked       (DBusConnection     *connection,
  68                                                                 DBusWatch          *watch,
  69                                                                 dbus_bool_t         enabled);
  70 dbus_bool_t       _dbus_connection_handle_watch                (DBusWatch          *watch,
  71                                                                 unsigned int        condition,
  72                                                                 void               *data);
  73 dbus_bool_t       _dbus_connection_add_timeout_unlocked        (DBusConnection     *connection,
  74                                                                 DBusTimeout        *timeout);
  75 void              _dbus_connection_remove_timeout_unlocked     (DBusConnection     *connection,
  76                                                                 DBusTimeout        *timeout);
  77 void              _dbus_connection_toggle_timeout_unlocked     (DBusConnection     *connection,
  78                                                                 DBusTimeout        *timeout,
  79                                                                 dbus_bool_t         enabled);
  80 DBusConnection*   _dbus_connection_new_for_transport           (DBusTransport      *transport);
  81 void              _dbus_connection_do_iteration_unlocked       (DBusConnection     *connection,
  82                                                                 DBusPendingCall    *pending,
  83                                                                 unsigned int        flags,
  84                                                                 int                 timeout_milliseconds);
  85 void              _dbus_connection_close_possibly_shared       (DBusConnection     *connection);
  86 void              _dbus_connection_close_if_only_one_ref       (DBusConnection     *connection);
  87
  88 DBusPendingCall*  _dbus_pending_call_new                       (DBusConnection     *connection,
  89                                                                 int                 timeout_milliseconds,
  90                                                                 DBusTimeoutHandler  timeout_handler);
  91 void              _dbus_pending_call_notify                    (DBusPendingCall    *pending);
  92 void              _dbus_connection_remove_pending_call         (DBusConnection     *connection,
  93                                                                 DBusPendingCall    *pending);
  94 void              _dbus_connection_block_pending_call          (DBusPendingCall    *pending);
  95 void              _dbus_pending_call_complete_and_unlock       (DBusPendingCall    *pending,
  96                                                                 DBusMessage        *message);
  97 dbus_bool_t       _dbus_connection_send_and_unlock             (DBusConnection     *connection,
  98                                                                 DBusMessage        *message,
  99                                                                 dbus_uint32_t      *client_serial);
 100
 101 void              _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
 102                                                                    DBusList *link);
 103 DBUS_PRIVATE_EXPORT
 104 void              _dbus_connection_test_get_locks                 (DBusConnection *conn,
 105                                                                    DBusMutex **mutex_loc,
 106                                                                    DBusMutex **dispatch_mutex_loc,
 107                                                                    DBusMutex **io_path_mutex_loc,
 108                                                                    DBusCondVar **dispatch_cond_loc,
 109                                                                    DBusCondVar **io_path_cond_loc);
 110 DBUS_PRIVATE_EXPORT
 111 int               _dbus_connection_get_pending_fds_count          (DBusConnection *connection);
 112 DBUS_PRIVATE_EXPORT
 113 void              _dbus_connection_set_pending_fds_function       (DBusConnection *connection,
 114                                                                    DBusPendingFdsChangeFunction callback,
 115                                                                    void *data);
 116
 117 DBUS_PRIVATE_EXPORT
 118 dbus_bool_t       _dbus_connection_get_linux_security_label       (DBusConnection  *connection,
 119                                                                    char           **label_p);
 120
 121 DBUS_PRIVATE_EXPORT
 122 void              _dbus_connection_enable_dispatch                (DBusConnection *connection);
 123 DBUS_PRIVATE_EXPORT
 124 void              _dbus_connection_disable_dispatch               (DBusConnection *connection);
 125 DBUS_PRIVATE_EXPORT
 126 dbus_bool_t       _dbus_connection_putback_message                (DBusConnection *connection,
 127                                                                    DBusMessage    *after_message,
 128                                                                    DBusMessage    *message,
 129                                                                    DBusError      *error);
 130
 131 DBUS_PRIVATE_EXPORT
 132 dbus_bool_t       _dbus_connection_remove_message                 (DBusConnection *connection,
 133                                                                    DBusMessage    *message);
 134 int               _dbus_connection_get_n_incoming               (DBusConnection *connection);
 135
 136 DBUS_PRIVATE_EXPORT
 137 dbus_bool_t       _dbus_connection_is_overflowed                   (DBusConnection *connection);
 138
 139 /* if DBUS_ENABLE_STATS */
 140 DBUS_PRIVATE_EXPORT
 141 void _dbus_connection_get_stats (DBusConnection *connection,
 142                                  dbus_uint32_t  *in_messages,
 143                                  dbus_uint32_t  *in_bytes,
 144                                  dbus_uint32_t  *in_fds,
 145                                  dbus_uint32_t  *in_peak_bytes,
 146                                  dbus_uint32_t  *in_peak_fds,
 147                                  dbus_uint32_t  *out_messages,
 148                                  dbus_uint32_t  *out_bytes,
 149                                  dbus_uint32_t  *out_fds,
 150                                  dbus_uint32_t  *out_peak_bytes,
 151                                  dbus_uint32_t  *out_peak_fds);
 152
 153
 154 /* if DBUS_ENABLE_EMBEDDED_TESTS */
 155 const char* _dbus_connection_get_address (DBusConnection *connection);
 156
 157 /* This _dbus_bus_* stuff doesn't really belong here, but dbus-bus-internal.h seems
 158  * silly for one function
 159  */
 160 /**
 161  * @addtogroup DBusBusInternals
 162  * @{
 163  */
 164
 165 void           _dbus_bus_notify_shared_connection_disconnected_unlocked (DBusConnection *connection);
 166
 167 /** @} */
 168
 169
 170 DBUS_END_DECLS
 171
 172 #endif /* DBUS_CONNECTION_INTERNAL_H */