D-Bus  1.16.2
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  * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7  *
8  * Licensed under the Academic Free License version 2.1
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 #ifndef DBUS_THREADS_INTERNAL_H
26 #define DBUS_THREADS_INTERNAL_H
27 
28 #include <dbus/dbus-macros.h>
29 #include <dbus/dbus-types.h>
30 #include <dbus/dbus-threads.h>
31 
41 typedef struct DBusRMutex DBusRMutex;
42 
47 typedef struct DBusCMutex DBusCMutex;
48 
52 
53 DBUS_PRIVATE_EXPORT
54 void _dbus_rmutex_lock (DBusRMutex *mutex);
55 DBUS_PRIVATE_EXPORT
56 void _dbus_rmutex_unlock (DBusRMutex *mutex);
57 void _dbus_rmutex_new_at_location (DBusRMutex **location_p);
58 void _dbus_rmutex_free_at_location (DBusRMutex **location_p);
59 
60 void _dbus_cmutex_lock (DBusCMutex *mutex);
61 void _dbus_cmutex_unlock (DBusCMutex *mutex);
62 void _dbus_cmutex_new_at_location (DBusCMutex **location_p);
63 void _dbus_cmutex_free_at_location (DBusCMutex **location_p);
64 
66 void _dbus_condvar_free (DBusCondVar *cond);
68  DBusCMutex *mutex);
70  DBusCMutex *mutex,
71  int timeout_milliseconds);
73 void _dbus_condvar_new_at_location (DBusCondVar **location_p);
75 
76 /* Private to threading implementations and dbus-threads.c */
77 
86 DBUS_EMBEDDED_TESTS_EXPORT
87 DBusRMutex *_dbus_platform_rmutex_new (void);
88 
94 DBUS_EMBEDDED_TESTS_EXPORT
95 void _dbus_platform_rmutex_free (DBusRMutex *mutex);
96 
107 DBUS_EMBEDDED_TESTS_EXPORT
108 void _dbus_platform_rmutex_lock (DBusRMutex *mutex);
109 
115 DBUS_EMBEDDED_TESTS_EXPORT
116 void _dbus_platform_rmutex_unlock (DBusRMutex *mutex);
117 
123 DBUS_EMBEDDED_TESTS_EXPORT
124 DBusCMutex *_dbus_platform_cmutex_new (void);
125 
130 DBUS_EMBEDDED_TESTS_EXPORT
131 void _dbus_platform_cmutex_free (DBusCMutex *mutex);
132 
146 DBUS_EMBEDDED_TESTS_EXPORT
147 void _dbus_platform_cmutex_lock (DBusCMutex *mutex);
148 
154 DBUS_EMBEDDED_TESTS_EXPORT
155 void _dbus_platform_cmutex_unlock (DBusCMutex *mutex);
156 
157 DBusCondVar* _dbus_platform_condvar_new (void);
158 void _dbus_platform_condvar_free (DBusCondVar *cond);
159 void _dbus_platform_condvar_wait (DBusCondVar *cond,
160  DBusCMutex *mutex);
161 dbus_bool_t _dbus_platform_condvar_wait_timeout (DBusCondVar *cond,
162  DBusCMutex *mutex,
163  int timeout_milliseconds);
164 void _dbus_platform_condvar_wake_one (DBusCondVar *cond);
165 
167 
168 #endif /* DBUS_THREADS_INTERNAL_H */
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
void _dbus_condvar_wait(DBusCondVar *cond, DBusCMutex *mutex)
Atomically unlocks the mutex and waits for the conditions variable to be signalled.
Definition: dbus-threads.c:243
dbus_bool_t _dbus_condvar_wait_timeout(DBusCondVar *cond, DBusCMutex *mutex, int timeout_milliseconds)
Atomically unlocks the mutex and waits for the conditions variable to be signalled, or for a timeout.
Definition: dbus-threads.c:264
void _dbus_rmutex_new_at_location(DBusRMutex **location_p)
Creates a new mutex or creates a no-op mutex if threads are not initialized.
Definition: dbus-threads.c:56
DBUS_PRIVATE_EXPORT void _dbus_rmutex_unlock(DBusRMutex *mutex)
Unlocks a mutex.
Definition: dbus-threads.c:153
void _dbus_condvar_free(DBusCondVar *cond)
Frees a conditional variable created with dbus_condvar_new(); does nothing if passed a NULL pointer...
Definition: dbus-threads.c:215
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
void _dbus_cmutex_unlock(DBusCMutex *mutex)
Unlocks a mutex.
Definition: dbus-threads.c:167
void _dbus_condvar_new_at_location(DBusCondVar **location_p)
This does the same thing as _dbus_condvar_new.
Definition: dbus-threads.c:202
void _dbus_condvar_wake_one(DBusCondVar *cond)
If there are threads waiting on the condition variable, wake up exactly one.
Definition: dbus-threads.c:281
DBusCondVar * _dbus_condvar_new(void)
Creates a new condition variable using the function supplied to dbus_threads_init(), or creates a no-op condition variable if threads are not initialized.
Definition: dbus-threads.c:184
void _dbus_rmutex_free_at_location(DBusRMutex **location_p)
Frees a DBusRMutex; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:97
void _dbus_cmutex_lock(DBusCMutex *mutex)
Locks a mutex.
Definition: dbus-threads.c:139
DBUS_PRIVATE_EXPORT void _dbus_rmutex_lock(DBusRMutex *mutex)
Locks a mutex.
Definition: dbus-threads.c:125
void _dbus_cmutex_free_at_location(DBusCMutex **location_p)
Frees a DBusCMutex; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:110
void _dbus_condvar_free_at_location(DBusCondVar **location_p)
Frees a condition variable; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:227
void _dbus_cmutex_new_at_location(DBusCMutex **location_p)
Creates a new mutex or creates a no-op mutex if threads are not initialized.
Definition: dbus-threads.c:80
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.