D-Bus  1.13.7
dbus-threads.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 
34 
41 typedef struct DBusMutex DBusMutex;
43 typedef struct DBusCondVar DBusCondVar;
44 
46 typedef DBusMutex* (* DBusMutexNewFunction) (void);
48 typedef void (* DBusMutexFreeFunction) (DBusMutex *mutex);
53 
61 typedef DBusMutex* (* DBusRecursiveMutexNewFunction) (void);
64 typedef void (* DBusRecursiveMutexFreeFunction) (DBusMutex *mutex);
68 typedef void (* DBusRecursiveMutexLockFunction) (DBusMutex *mutex);
72 typedef void (* DBusRecursiveMutexUnlockFunction) (DBusMutex *mutex);
73 
77 typedef DBusCondVar* (* DBusCondVarNewFunction) (void);
81 
93  DBusMutex *mutex);
94 
102  DBusMutex *mutex,
103  int timeout_milliseconds);
109 
115 
121 typedef enum
122 {
123  DBUS_THREAD_FUNCTIONS_MUTEX_NEW_MASK = 1 << 0,
124  DBUS_THREAD_FUNCTIONS_MUTEX_FREE_MASK = 1 << 1,
125  DBUS_THREAD_FUNCTIONS_MUTEX_LOCK_MASK = 1 << 2,
126  DBUS_THREAD_FUNCTIONS_MUTEX_UNLOCK_MASK = 1 << 3,
127  DBUS_THREAD_FUNCTIONS_CONDVAR_NEW_MASK = 1 << 4,
128  DBUS_THREAD_FUNCTIONS_CONDVAR_FREE_MASK = 1 << 5,
129  DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_MASK = 1 << 6,
130  DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_TIMEOUT_MASK = 1 << 7,
131  DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ONE_MASK = 1 << 8,
132  DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ALL_MASK = 1 << 9,
133  DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_NEW_MASK = 1 << 10,
134  DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_FREE_MASK = 1 << 11,
135  DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_LOCK_MASK = 1 << 12,
136  DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_UNLOCK_MASK = 1 << 13,
137  DBUS_THREAD_FUNCTIONS_ALL_MASK = (1 << 14) - 1
139 
152 typedef struct
153 {
154  unsigned int mask;
173  void (* padding1) (void);
174  void (* padding2) (void);
175  void (* padding3) (void);
176  void (* padding4) (void);
179 
180 DBUS_EXPORT
182 DBUS_EXPORT
184 
188 
189 #endif /* DBUS_THREADS_H */
Functions that must be implemented to make the D-Bus library thread-aware.
Definition: dbus-threads.h:152
dbus_bool_t(* DBusMutexLockFunction)(DBusMutex *mutex)
Deprecated, provide DBusRecursiveMutexLockFunction instead.
Definition: dbus-threads.h:50
DBusMutex *(* DBusMutexNewFunction)(void)
Deprecated, provide DBusRecursiveMutexNewFunction instead.
Definition: dbus-threads.h:46
DBusThreadFunctionsMask
Flags indicating which functions are present in DBusThreadFunctions.
Definition: dbus-threads.h:121
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBusRecursiveMutexUnlockFunction recursive_mutex_unlock
Function to unlock a recursive mutex.
Definition: dbus-threads.h:171
void(* DBusRecursiveMutexFreeFunction)(DBusMutex *mutex)
Frees a recursively-lockable mutex.
Definition: dbus-threads.h:64
struct DBusMutex DBusMutex
An opaque mutex type provided by the DBusThreadFunctions implementation installed by dbus_threads_ini...
Definition: dbus-threads.h:41
DBusCondVarWakeAllFunction condvar_wake_all
Function to wake all threads waiting on the condition.
Definition: dbus-threads.h:166
DBusCondVarNewFunction condvar_new
Function to create a condition variable.
Definition: dbus-threads.h:161
DBusMutexLockFunction mutex_lock
Function to lock a mutex; optional and deprecated.
Definition: dbus-threads.h:158
void(* DBusRecursiveMutexUnlockFunction)(DBusMutex *mutex)
Unlocks a recursively-lockable mutex.
Definition: dbus-threads.h:72
void(* DBusMutexFreeFunction)(DBusMutex *mutex)
Deprecated, provide DBusRecursiveMutexFreeFunction instead.
Definition: dbus-threads.h:48
DBusRecursiveMutexLockFunction recursive_mutex_lock
Function to lock a recursive mutex.
Definition: dbus-threads.h:170
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusCondVarWaitFunction condvar_wait
Function to wait on a condition.
Definition: dbus-threads.h:163
void(* DBusCondVarWakeOneFunction)(DBusCondVar *cond)
Wakes one waiting thread on a condition variable.
Definition: dbus-threads.h:108
dbus_bool_t(* DBusMutexUnlockFunction)(DBusMutex *mutex)
Deprecated, provide DBusRecursiveMutexUnlockFunction instead.
Definition: dbus-threads.h:52
DBusMutexFreeFunction mutex_free
Function to free a mutex; optional and deprecated.
Definition: dbus-threads.h:157
unsigned int mask
Mask indicating which functions are present.
Definition: dbus-threads.h:154
dbus_bool_t(* DBusCondVarWaitTimeoutFunction)(DBusCondVar *cond, DBusMutex *mutex, int timeout_milliseconds)
Waits on a condition variable with a timeout.
Definition: dbus-threads.h:101
DBusCondVarWaitTimeoutFunction condvar_wait_timeout
Function to wait on a condition with a timeout.
Definition: dbus-threads.h:164
DBusMutexNewFunction mutex_new
Function to create a mutex; optional and deprecated.
Definition: dbus-threads.h:156
void(* DBusRecursiveMutexLockFunction)(DBusMutex *mutex)
Locks a recursively-lockable mutex.
Definition: dbus-threads.h:68
DBusCondVarWakeOneFunction condvar_wake_one
Function to wake one thread waiting on the condition.
Definition: dbus-threads.h:165
DBusMutex *(* DBusRecursiveMutexNewFunction)(void)
Creates a new recursively-lockable mutex, or returns NULL if not enough memory.
Definition: dbus-threads.h:61
void(* DBusCondVarWakeAllFunction)(DBusCondVar *cond)
Wakes all waiting threads on a condition variable.
Definition: dbus-threads.h:114
void(* DBusCondVarFreeFunction)(DBusCondVar *cond)
Frees a condition variable.
Definition: dbus-threads.h:80
dbus_bool_t dbus_threads_init(const DBusThreadFunctions *functions)
Initializes threads, like dbus_threads_init_default().
Definition: dbus-threads.c:391
pthread_cond_t cond
the condition
DBusRecursiveMutexNewFunction recursive_mutex_new
Function to create a recursive mutex.
Definition: dbus-threads.h:168
void(* DBusCondVarWaitFunction)(DBusCondVar *cond, DBusMutex *mutex)
Waits on a condition variable.
Definition: dbus-threads.h:92
DBusMutexUnlockFunction mutex_unlock
Function to unlock a mutex; optional and deprecated.
Definition: dbus-threads.h:159
DBusCondVar *(* DBusCondVarNewFunction)(void)
Creates a new condition variable.
Definition: dbus-threads.h:77
dbus_bool_t dbus_threads_init_default(void)
Initializes threads.
Definition: dbus-threads.c:438
DBusRecursiveMutexFreeFunction recursive_mutex_free
Function to free a recursive mutex.
Definition: dbus-threads.h:169
DBusCondVarFreeFunction condvar_free
Function to free a condition variable.
Definition: dbus-threads.h:162
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.