dbus/dbus-threads.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-threads.h  D-Bus threads handling
   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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_THREADS_H
  28 #define DBUS_THREADS_H
  29
  30 #include <dbus/dbus-macros.h>
  31 #include <dbus/dbus-types.h>
  32
  33 DBUS_BEGIN_DECLS
  34
  35 /**
  36  * @addtogroup DBusThreads
  37  * @{
  38  */
  39
  40 /** An opaque mutex type provided by the #DBusThreadFunctions implementation installed by dbus_threads_init(). */
  41 typedef struct DBusMutex DBusMutex;
  42 /** An opaque condition variable type provided by the #DBusThreadFunctions implementation installed by dbus_threads_init(). */
  43 typedef struct DBusCondVar DBusCondVar;
  44
  45 /** Deprecated, provide DBusRecursiveMutexNewFunction instead. */
  46 typedef DBusMutex*  (* DBusMutexNewFunction)    (void);
  47 /** Deprecated, provide DBusRecursiveMutexFreeFunction instead. */
  48 typedef void        (* DBusMutexFreeFunction)   (DBusMutex *mutex);
  49 /** Deprecated, provide DBusRecursiveMutexLockFunction instead. */
  50 typedef dbus_bool_t (* DBusMutexLockFunction)   (DBusMutex *mutex);
  51 /** Deprecated, provide DBusRecursiveMutexUnlockFunction instead. */
  52 typedef dbus_bool_t (* DBusMutexUnlockFunction) (DBusMutex *mutex);
  53
  54 /** Creates a new recursively-lockable mutex, or returns #NULL if not enough memory.
  55  * Found in #DBusThreadFunctions
  56  */
  57 typedef DBusMutex*  (* DBusRecursiveMutexNewFunction)    (void);
  58 /** Frees a recursively-lockable mutex.  Found in #DBusThreadFunctions.
  59  */
  60 typedef void        (* DBusRecursiveMutexFreeFunction)   (DBusMutex *mutex);
  61 /** Locks a recursively-lockable mutex.  Found in #DBusThreadFunctions.
  62  */
  63 typedef void        (* DBusRecursiveMutexLockFunction)   (DBusMutex *mutex);
  64 /** Unlocks a recursively-lockable mutex.  Found in #DBusThreadFunctions.
  65  */
  66 typedef void        (* DBusRecursiveMutexUnlockFunction) (DBusMutex *mutex);
  67
  68 /** Creates a new condition variable.  Found in #DBusThreadFunctions.
  69  */
  70 typedef DBusCondVar*  (* DBusCondVarNewFunction)         (void);
  71 /** Frees a condition variable.  Found in #DBusThreadFunctions.
  72  */
  73 typedef void          (* DBusCondVarFreeFunction)        (DBusCondVar *cond);
  74 /** Waits on a condition variable.  Found in #DBusThreadFunctions.
  75  */
  76 typedef void          (* DBusCondVarWaitFunction)        (DBusCondVar *cond,
  77                                                           DBusMutex   *mutex);
  78 /** Waits on a condition variable with a timeout.  Found in #DBusThreadFunctions.
  79  */
  80 typedef dbus_bool_t   (* DBusCondVarWaitTimeoutFunction) (DBusCondVar *cond,
  81                                                           DBusMutex   *mutex,
  82                                                           int          timeout_milliseconds);
  83 /** Wakes one waiting thread on a condition variable.  Found in #DBusThreadFunctions.
  84  */
  85 typedef void          (* DBusCondVarWakeOneFunction) (DBusCondVar *cond);
  86 /** Wakes all waiting threads on a condition variable.  Found in #DBusThreadFunctions.
  87  */
  88 typedef void          (* DBusCondVarWakeAllFunction) (DBusCondVar *cond);
  89
  90 /**
  91  * Flags indicating which functions are present in #DBusThreadFunctions. Used to allow
  92  * the library to detect older callers of dbus_threads_init() if new possible functions
  93  * are added to #DBusThreadFunctions.
  94  */
  95 typedef enum
  96 {
  97   DBUS_THREAD_FUNCTIONS_MUTEX_NEW_MASK      = 1 << 0,
  98   DBUS_THREAD_FUNCTIONS_MUTEX_FREE_MASK     = 1 << 1,
  99   DBUS_THREAD_FUNCTIONS_MUTEX_LOCK_MASK     = 1 << 2,
 100   DBUS_THREAD_FUNCTIONS_MUTEX_UNLOCK_MASK   = 1 << 3,
 101   DBUS_THREAD_FUNCTIONS_CONDVAR_NEW_MASK    = 1 << 4,
 102   DBUS_THREAD_FUNCTIONS_CONDVAR_FREE_MASK   = 1 << 5,
 103   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_MASK   = 1 << 6,
 104   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_TIMEOUT_MASK   = 1 << 7,
 105   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ONE_MASK = 1 << 8,
 106   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ALL_MASK = 1 << 9,
 107   DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_NEW_MASK    = 1 << 10,
 108   DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_FREE_MASK   = 1 << 11,
 109   DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_LOCK_MASK   = 1 << 12,
 110   DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_UNLOCK_MASK = 1 << 13,
 111   DBUS_THREAD_FUNCTIONS_ALL_MASK     = (1 << 13) - 1
 112 } DBusThreadFunctionsMask;
 113
 114 /**
 115  * Functions that must be implemented to make the D-Bus library
 116  * thread-aware. The recursive mutex functions should be specified
 117  * rather than the old, deprecated nonrecursive ones.
 118  */
 119 typedef struct
 120 {
 121   unsigned int mask; /**< Mask indicating which functions are present. */
 122
 123   DBusMutexNewFunction mutex_new; /**< Function to create a mutex; optional and deprecated. */
 124   DBusMutexFreeFunction mutex_free; /**< Function to free a mutex; optional and deprecated. */
 125   DBusMutexLockFunction mutex_lock; /**< Function to lock a mutex; optional and deprecated. */
 126   DBusMutexUnlockFunction mutex_unlock; /**< Function to unlock a mutex; optional and deprecated. */
 127
 128   DBusCondVarNewFunction condvar_new; /**< Function to create a condition variable */
 129   DBusCondVarFreeFunction condvar_free; /**< Function to free a condition variable */
 130   DBusCondVarWaitFunction condvar_wait; /**< Function to wait on a condition */
 131   DBusCondVarWaitTimeoutFunction condvar_wait_timeout; /**< Function to wait on a condition with a timeout */
 132   DBusCondVarWakeOneFunction condvar_wake_one; /**< Function to wake one thread waiting on the condition */
 133   DBusCondVarWakeAllFunction condvar_wake_all; /**< Function to wake all threads waiting on the condition */
 134
 135   DBusRecursiveMutexNewFunction recursive_mutex_new; /**< Function to create a recursive mutex */
 136   DBusRecursiveMutexFreeFunction recursive_mutex_free; /**< Function to free a recursive mutex */
 137   DBusRecursiveMutexLockFunction recursive_mutex_lock; /**< Function to lock a recursive mutex */
 138   DBusRecursiveMutexUnlockFunction recursive_mutex_unlock; /**< Function to unlock a recursive mutex */
 139
 140   void (* padding1) (void); /**< Reserved for future expansion */
 141   void (* padding2) (void); /**< Reserved for future expansion */
 142   void (* padding3) (void); /**< Reserved for future expansion */
 143   void (* padding4) (void); /**< Reserved for future expansion */
 144
 145 } DBusThreadFunctions;
 146
 147 dbus_bool_t  dbus_threads_init         (const DBusThreadFunctions *functions);
 148 dbus_bool_t  dbus_threads_init_default (void);
 149
 150 /** @} */
 151
 152 DBUS_END_DECLS
 153
 154 #endif /* DBUS_THREADS_H */