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
  39 /**
  40  * Virtual table to be implemented by all server "subclasses"
  41  */
  42 struct DBusServerVTable
  43 {
  44   void        (* finalize)      (DBusServer *server);
  45   /**< The finalize method must free the server. */
  46
  47   void        (* disconnect)    (DBusServer *server);
  48   /**< Disconnect this server. */
  49 };
  50
  51 /**
  52  * Internals of DBusServer object
  53  */
  54 struct DBusServer
  55 {
  56   DBusAtomic refcount;                        /**< Reference count. */
  57   const DBusServerVTable *vtable;             /**< Virtual methods for this instance. */
  58   DBusMutex *mutex;                           /**< Lock on the server object */
  59   DBusWatchList *watches;                     /**< Our watches */
  60   DBusTimeoutList *timeouts;                  /**< Our timeouts */
  61
  62   char *address;                              /**< Address this server is listening on. */
  63
  64   int max_connections;                        /**< Max number of connections allowed at once. */
  65
  66   DBusDataSlotList slot_list;   /**< Data stored by allocated integer ID */
  67
  68   DBusNewConnectionFunction  new_connection_function;
  69   /**< Callback to invoke when a new connection is created. */
  70   void *new_connection_data;
  71   /**< Data for new connection callback */
  72   DBusFreeFunction new_connection_free_data_function;
  73   /**< Callback to invoke to free new_connection_data
  74    * when server is finalized or data is replaced.
  75    */
  76
  77   char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
  78
  79   unsigned int disconnected : 1;              /**< TRUE if we are disconnected. */
  80
  81 #ifndef DBUS_DISABLE_CHECKS
  82   unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */
  83 #endif
  84 };
  85
  86 dbus_bool_t _dbus_server_init_base      (DBusServer             *server,
  87                                          const DBusServerVTable *vtable,
  88                                          const DBusString       *address);
  89 void        _dbus_server_finalize_base  (DBusServer             *server);
  90 dbus_bool_t _dbus_server_add_watch      (DBusServer             *server,
  91                                          DBusWatch              *watch);
  92 void        _dbus_server_remove_watch   (DBusServer             *server,
  93                                          DBusWatch              *watch);
  94 void        _dbus_server_toggle_watch   (DBusServer             *server,
  95                                          DBusWatch              *watch,
  96                                          dbus_bool_t             enabled);
  97 dbus_bool_t _dbus_server_add_timeout    (DBusServer             *server,
  98                                          DBusTimeout            *timeout);
  99 void        _dbus_server_remove_timeout (DBusServer             *server,
 100                                          DBusTimeout            *timeout);
 101 void        _dbus_server_toggle_timeout (DBusServer             *server,
 102                                          DBusTimeout            *timeout,
 103                                          dbus_bool_t             enabled);
 104
 105 void        _dbus_server_ref_unlocked   (DBusServer             *server);
 106 void        _dbus_server_unref_unlocked (DBusServer             *server);
 107
 108 #ifdef DBUS_DISABLE_CHECKS
 109 #define TOOK_LOCK_CHECK(server)
 110 #define RELEASING_LOCK_CHECK(server)
 111 #define HAVE_LOCK_CHECK(server)
 112 #else
 113 #define TOOK_LOCK_CHECK(server) do {                \
 114     _dbus_assert (!(server)->have_server_lock); \
 115     (server)->have_server_lock = TRUE;          \
 116   } while (0)
 117 #define RELEASING_LOCK_CHECK(server) do {            \
 118     _dbus_assert ((server)->have_server_lock);   \
 119     (server)->have_server_lock = FALSE;          \
 120   } while (0)
 121 #define HAVE_LOCK_CHECK(server)        _dbus_assert ((server)->have_server_lock)
 122 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
 123 #endif
 124
 125 #define TRACE_LOCKS 0
 126
 127 #define SERVER_LOCK(server)   do {                                              \
 128     if (TRACE_LOCKS) { _dbus_verbose ("  LOCK: %s\n", _DBUS_FUNCTION_NAME); }   \
 129     _dbus_mutex_lock ((server)->mutex);                                          \
 130     TOOK_LOCK_CHECK (server);                                                   \
 131   } while (0)
 132
 133 #define SERVER_UNLOCK(server) do {                                                      \
 134     if (TRACE_LOCKS) { _dbus_verbose ("  UNLOCK: %s\n", _DBUS_FUNCTION_NAME);  }        \
 135     RELEASING_LOCK_CHECK (server);                                                      \
 136     _dbus_mutex_unlock ((server)->mutex);                                                \
 137   } while (0)
 138
 139 DBUS_END_DECLS
 140
 141 #endif /* DBUS_SERVER_PROTECTED_H */