dbus/dbus-threads-internal.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-threads-internal.h  D-Bus thread primitives
   3  *
   4  * Copyright (C) 2002, 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23 #ifndef DBUS_THREADS_INTERNAL_H
  24 #define DBUS_THREADS_INTERNAL_H
  25
  26 #include <dbus/dbus-macros.h>
  27 #include <dbus/dbus-types.h>
  28 #include <dbus/dbus-threads.h>
  29
  30 /**
  31  * @addtogroup DBusThreadsInternals
  32  * @{
  33  */
  34
  35 /* glibc can implement global locks without needing an initialization step,
  36  * which improves our thread-safety-by-default further. */
  37 #if defined(__GLIBC__) && defined(PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP)
  38 #   define DBUS_HAVE_STATIC_RECURSIVE_MUTEXES 1
  39 #endif
  40
  41 /**
  42  * A mutex which is recursive if possible, else non-recursive.
  43  * This is typically recursive, but that cannot be relied upon.
  44  */
  45 typedef struct DBusRMutex DBusRMutex;
  46
  47 /**
  48  * A mutex suitable for use with condition variables.
  49  * This is typically non-recursive.
  50  */
  51 typedef struct DBusCMutex DBusCMutex;
  52
  53 /** @} */
  54
  55 DBUS_BEGIN_DECLS
  56
  57 void         _dbus_rmutex_lock               (DBusRMutex       *mutex);
  58 void         _dbus_rmutex_unlock             (DBusRMutex       *mutex);
  59 void         _dbus_rmutex_new_at_location    (DBusRMutex      **location_p);
  60 void         _dbus_rmutex_free_at_location   (DBusRMutex      **location_p);
  61
  62 void         _dbus_cmutex_lock               (DBusCMutex       *mutex);
  63 void         _dbus_cmutex_unlock             (DBusCMutex       *mutex);
  64 void         _dbus_cmutex_new_at_location    (DBusCMutex      **location_p);
  65 void         _dbus_cmutex_free_at_location   (DBusCMutex      **location_p);
  66
  67 DBusCondVar* _dbus_condvar_new               (void);
  68 void         _dbus_condvar_free              (DBusCondVar       *cond);
  69 void         _dbus_condvar_wait              (DBusCondVar       *cond,
  70                                               DBusCMutex        *mutex);
  71 dbus_bool_t  _dbus_condvar_wait_timeout      (DBusCondVar       *cond,
  72                                               DBusCMutex        *mutex,
  73                                               int                timeout_milliseconds);
  74 void         _dbus_condvar_wake_one          (DBusCondVar       *cond);
  75 void         _dbus_condvar_new_at_location   (DBusCondVar      **location_p);
  76 void         _dbus_condvar_free_at_location  (DBusCondVar      **location_p);
  77
  78 /* Private to threading implementations and dbus-threads.c */
  79
  80 DBusRMutex  *_dbus_platform_rmutex_new       (void);
  81 void         _dbus_platform_rmutex_free      (DBusRMutex       *mutex);
  82 void         _dbus_platform_rmutex_lock      (DBusRMutex       *mutex);
  83 void         _dbus_platform_rmutex_unlock    (DBusRMutex       *mutex);
  84
  85 DBusCMutex  *_dbus_platform_cmutex_new       (void);
  86 void         _dbus_platform_cmutex_free      (DBusCMutex       *mutex);
  87 void         _dbus_platform_cmutex_lock      (DBusCMutex       *mutex);
  88 void         _dbus_platform_cmutex_unlock    (DBusCMutex       *mutex);
  89
  90 DBusCondVar* _dbus_platform_condvar_new      (void);
  91 void         _dbus_platform_condvar_free     (DBusCondVar       *cond);
  92 void         _dbus_platform_condvar_wait     (DBusCondVar       *cond,
  93                                               DBusCMutex        *mutex);
  94 dbus_bool_t  _dbus_platform_condvar_wait_timeout (DBusCondVar   *cond,
  95                                               DBusCMutex        *mutex,
  96                                               int                timeout_milliseconds);
  97 void         _dbus_platform_condvar_wake_one (DBusCondVar       *cond);
  98
  99 DBUS_END_DECLS
 100
 101 #endif /* DBUS_THREADS_INTERNAL_H */