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 typedef struct DBusMutex DBusMutex;
  36 typedef struct DBusCondVar DBusCondVar;
  37
  38 typedef DBusMutex*  (* DBusMutexNewFunction)    (void);
  39 typedef void        (* DBusMutexFreeFunction)   (DBusMutex *mutex);
  40 typedef dbus_bool_t (* DBusMutexLockFunction)   (DBusMutex *mutex);
  41 typedef dbus_bool_t (* DBusMutexUnlockFunction) (DBusMutex *mutex);
  42
  43 typedef DBusCondVar*  (* DBusCondVarNewFunction)         (void);
  44 typedef void          (* DBusCondVarFreeFunction)        (DBusCondVar *cond);
  45 typedef void          (* DBusCondVarWaitFunction)        (DBusCondVar *cond,
  46                                                           DBusMutex   *mutex);
  47 typedef dbus_bool_t   (* DBusCondVarWaitTimeoutFunction) (DBusCondVar *cond,
  48                                                           DBusMutex   *mutex,
  49                                                           int          timeout_milliseconds);
  50 typedef void          (* DBusCondVarWakeOneFunction) (DBusCondVar *cond);
  51 typedef void          (* DBusCondVarWakeAllFunction) (DBusCondVar *cond);
  52
  53 typedef enum
  54 {
  55   DBUS_THREAD_FUNCTIONS_MUTEX_NEW_MASK      = 1 << 0,
  56   DBUS_THREAD_FUNCTIONS_MUTEX_FREE_MASK     = 1 << 1,
  57   DBUS_THREAD_FUNCTIONS_MUTEX_LOCK_MASK     = 1 << 2,
  58   DBUS_THREAD_FUNCTIONS_MUTEX_UNLOCK_MASK   = 1 << 3,
  59   DBUS_THREAD_FUNCTIONS_CONDVAR_NEW_MASK    = 1 << 4,
  60   DBUS_THREAD_FUNCTIONS_CONDVAR_FREE_MASK   = 1 << 5,
  61   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_MASK   = 1 << 6,
  62   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_TIMEOUT_MASK   = 1 << 7,
  63   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ONE_MASK = 1 << 8,
  64   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ALL_MASK = 1 << 9,
  65
  66   DBUS_THREAD_FUNCTIONS_ALL_MASK     = (1 << 10) - 1
  67 } DBusThreadFunctionsMask;
  68
  69 /**
  70  * Functions that must be implemented to make the D-BUS
  71  * library thread-aware.
  72  */
  73 typedef struct
  74 {
  75   unsigned int mask; /**< Mask indicating which functions are present. */
  76
  77   DBusMutexNewFunction mutex_new; /**< Function to create a mutex */
  78   DBusMutexFreeFunction mutex_free; /**< Function to free a mutex */
  79   DBusMutexLockFunction mutex_lock; /**< Function to lock a mutex */
  80   DBusMutexUnlockFunction mutex_unlock; /**< Function to unlock a mutex */
  81
  82   DBusCondVarNewFunction condvar_new; /**< Function to create a condition variable */
  83   DBusCondVarFreeFunction condvar_free; /**< Function to free a condition variable */
  84   DBusCondVarWaitFunction condvar_wait; /**< Function to wait on a condition */
  85   DBusCondVarWaitTimeoutFunction condvar_wait_timeout; /**< Function to wait on a condition with a timeout */
  86   DBusCondVarWakeOneFunction condvar_wake_one; /**< Function to wake one thread waiting on the condition */
  87   DBusCondVarWakeAllFunction condvar_wake_all; /**< Function to wake all threads waiting on the condition */
  88
  89   void (* padding1) (void); /**< Reserved for future expansion */
  90   void (* padding2) (void); /**< Reserved for future expansion */
  91   void (* padding3) (void); /**< Reserved for future expansion */
  92   void (* padding4) (void); /**< Reserved for future expansion */
  93   void (* padding5) (void); /**< Reserved for future expansion */
  94   void (* padding6) (void); /**< Reserved for future expansion */
  95   void (* padding7) (void); /**< Reserved for future expansion */
  96   void (* padding8) (void); /**< Reserved for future expansion */
  97
  98 } DBusThreadFunctions;
  99
 100
 101 DBusMutex*   dbus_mutex_new            (void);
 102 void         dbus_mutex_free           (DBusMutex                 *mutex);
 103 dbus_bool_t  dbus_mutex_lock           (DBusMutex                 *mutex);
 104 dbus_bool_t  dbus_mutex_unlock         (DBusMutex                 *mutex);
 105
 106 DBusCondVar* dbus_condvar_new          (void);
 107 void         dbus_condvar_free         (DBusCondVar               *cond);
 108 void         dbus_condvar_wait         (DBusCondVar               *cond,
 109                                         DBusMutex                 *mutex);
 110 dbus_bool_t  dbus_condvar_wait_timeout (DBusCondVar               *cond,
 111                                         DBusMutex                 *mutex,
 112                                         int                        timeout_milliseconds);
 113 void         dbus_condvar_wake_one     (DBusCondVar               *cond);
 114 void         dbus_condvar_wake_all     (DBusCondVar               *cond);
 115
 116 dbus_bool_t  dbus_threads_init         (const DBusThreadFunctions *functions);
 117
 118
 119
 120 DBUS_END_DECLS
 121
 122 #endif /* DBUS_THREADS_H */