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