dbus/dbus-server-protected.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server-protected.h Used by subclasses of DBusServer object (internal to D-BUS implementation)
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #ifndef DBUS_SERVER_PROTECTED_H
  24 #define DBUS_SERVER_PROTECTED_H
  25
  26 #include <config.h>
  27 #include <dbus/dbus-internals.h>
  28 #include <dbus/dbus-threads-internal.h>
  29 #include <dbus/dbus-server.h>
  30 #include <dbus/dbus-timeout.h>
  31 #include <dbus/dbus-watch.h>
  32 #include <dbus/dbus-resources.h>
  33 #include <dbus/dbus-dataslot.h>
  34
  35 DBUS_BEGIN_DECLS
  36
  37 typedef struct DBusServerVTable DBusServerVTable;
  38 typedef union DBusGUID DBusGUID;
  39
  40 /**
  41  * A server's globally unique ID
  42  */
  43 union DBusGUID
  44 {
  45   dbus_uint32_t as_uint32s[4];
  46   unsigned char as_bytes[16];
  47 };
  48
  49 /**
  50  * Virtual table to be implemented by all server "subclasses"
  51  */
  52 struct DBusServerVTable
  53 {
  54   void        (* finalize)      (DBusServer *server);
  55   /**< The finalize method must free the server. */
  56
  57   void        (* disconnect)    (DBusServer *server);
  58   /**< Disconnect this server. */
  59 };
  60
  61 /**
  62  * Internals of DBusServer object
  63  */
  64 struct DBusServer
  65 {
  66   DBusAtomic refcount;                        /**< Reference count. */
  67   const DBusServerVTable *vtable;             /**< Virtual methods for this instance. */
  68   DBusMutex *mutex;                           /**< Lock on the server object */
  69
  70   DBusGUID guid;                              /**< Globally unique ID of server */
  71
  72   DBusWatchList *watches;                     /**< Our watches */
  73   DBusTimeoutList *timeouts;                  /**< Our timeouts */
  74
  75   char *address;                              /**< Address this server is listening on. */
  76
  77   int max_connections;                        /**< Max number of connections allowed at once. */
  78
  79   DBusDataSlotList slot_list;   /**< Data stored by allocated integer ID */
  80
  81   DBusNewConnectionFunction  new_connection_function;
  82   /**< Callback to invoke when a new connection is created. */
  83   void *new_connection_data;
  84   /**< Data for new connection callback */
  85   DBusFreeFunction new_connection_free_data_function;
  86   /**< Callback to invoke to free new_connection_data
  87    * when server is finalized or data is replaced.
  88    */
  89
  90   char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
  91
  92   unsigned int disconnected : 1;              /**< TRUE if we are disconnected. */
  93
  94 #ifndef DBUS_DISABLE_CHECKS
  95   unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */
  96 #endif
  97 };
  98
  99 dbus_bool_t _dbus_server_init_base      (DBusServer             *server,
 100                                          const DBusServerVTable *vtable,
 101                                          const DBusString       *address);
 102 void        _dbus_server_finalize_base  (DBusServer             *server);
 103 dbus_bool_t _dbus_server_add_watch      (DBusServer             *server,
 104                                          DBusWatch              *watch);
 105 void        _dbus_server_remove_watch   (DBusServer             *server,
 106                                          DBusWatch              *watch);
 107 void        _dbus_server_toggle_watch   (DBusServer             *server,
 108                                          DBusWatch              *watch,
 109                                          dbus_bool_t             enabled);
 110 dbus_bool_t _dbus_server_add_timeout    (DBusServer             *server,
 111                                          DBusTimeout            *timeout);
 112 void        _dbus_server_remove_timeout (DBusServer             *server,
 113                                          DBusTimeout            *timeout);
 114 void        _dbus_server_toggle_timeout (DBusServer             *server,
 115                                          DBusTimeout            *timeout,
 116                                          dbus_bool_t             enabled);
 117
 118 void        _dbus_server_ref_unlocked   (DBusServer             *server);
 119 void        _dbus_server_unref_unlocked (DBusServer             *server);
 120
 121 #ifdef DBUS_DISABLE_CHECKS
 122 #define TOOK_LOCK_CHECK(server)
 123 #define RELEASING_LOCK_CHECK(server)
 124 #define HAVE_LOCK_CHECK(server)
 125 #else
 126 #define TOOK_LOCK_CHECK(server) do {                \
 127     _dbus_assert (!(server)->have_server_lock); \
 128     (server)->have_server_lock = TRUE;          \
 129   } while (0)
 130 #define RELEASING_LOCK_CHECK(server) do {            \
 131     _dbus_assert ((server)->have_server_lock);   \
 132     (server)->have_server_lock = FALSE;          \
 133   } while (0)
 134 #define HAVE_LOCK_CHECK(server)        _dbus_assert ((server)->have_server_lock)
 135 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
 136 #endif
 137
 138 #define TRACE_LOCKS 0
 139
 140 #define SERVER_LOCK(server)   do {                                              \
 141     if (TRACE_LOCKS) { _dbus_verbose ("  LOCK: %s\n", _DBUS_FUNCTION_NAME); }   \
 142     _dbus_mutex_lock ((server)->mutex);                                          \
 143     TOOK_LOCK_CHECK (server);                                                   \
 144   } while (0)
 145
 146 #define SERVER_UNLOCK(server) do {                                                      \
 147     if (TRACE_LOCKS) { _dbus_verbose ("  UNLOCK: %s\n", _DBUS_FUNCTION_NAME);  }        \
 148     RELEASING_LOCK_CHECK (server);                                                      \
 149     _dbus_mutex_unlock ((server)->mutex);                                                \
 150   } while (0)
 151
 152 DBUS_END_DECLS
 153
 154 #endif /* DBUS_SERVER_PROTECTED_H */