D-Bus: dbus-threads-internal.h Source File

D-Bus 1.12.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 * 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
39 typedef struct DBusRMutex DBusRMutex;
40
45 typedef struct DBusCMutex DBusCMutex;
46
49 DBUS_BEGIN_DECLS
50
51 DBUS_PRIVATE_EXPORT
52 void _dbus_rmutex_lock (DBusRMutex *mutex);
53 DBUS_PRIVATE_EXPORT
54 void _dbus_rmutex_unlock (DBusRMutex *mutex);
55 void _dbus_rmutex_new_at_location (DBusRMutex **location_p);
56 void _dbus_rmutex_free_at_location (DBusRMutex **location_p);
57
58 void _dbus_cmutex_lock (DBusCMutex *mutex);
59 void _dbus_cmutex_unlock (DBusCMutex *mutex);
60 void _dbus_cmutex_new_at_location (DBusCMutex **location_p);
61 void _dbus_cmutex_free_at_location (DBusCMutex **location_p);
62
63 DBusCondVar* _dbus_condvar_new (void);
64 void _dbus_condvar_free (DBusCondVar *cond);
65 void _dbus_condvar_wait (DBusCondVar *cond,
66 DBusCMutex *mutex);
67 dbus_bool_t _dbus_condvar_wait_timeout (DBusCondVar *cond,
68 DBusCMutex *mutex,
69 int timeout_milliseconds);
70 void _dbus_condvar_wake_one (DBusCondVar *cond);
71 void _dbus_condvar_new_at_location (DBusCondVar **location_p);
72 void _dbus_condvar_free_at_location (DBusCondVar **location_p);
73
74 /* Private to threading implementations and dbus-threads.c */
75
76 DBusRMutex *_dbus_platform_rmutex_new (void);
77 void _dbus_platform_rmutex_free (DBusRMutex *mutex);
78 void _dbus_platform_rmutex_lock (DBusRMutex *mutex);
79 void _dbus_platform_rmutex_unlock (DBusRMutex *mutex);
80
81 DBusCMutex *_dbus_platform_cmutex_new (void);
82 void _dbus_platform_cmutex_free (DBusCMutex *mutex);
83 void _dbus_platform_cmutex_lock (DBusCMutex *mutex);
84 void _dbus_platform_cmutex_unlock (DBusCMutex *mutex);
85
86 DBusCondVar* _dbus_platform_condvar_new (void);
87 void _dbus_platform_condvar_free (DBusCondVar *cond);
88 void _dbus_platform_condvar_wait (DBusCondVar *cond,
89 DBusCMutex *mutex);
90 dbus_bool_t _dbus_platform_condvar_wait_timeout (DBusCondVar *cond,
91 DBusCMutex *mutex,
92 int timeout_milliseconds);
93 void _dbus_platform_condvar_wake_one (DBusCondVar *cond);
94
95 DBUS_END_DECLS
96
97 #endif /* DBUS_THREADS_INTERNAL_H */
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_dbus_condvar_wait
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:240
_dbus_condvar_wait_timeout
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:261
_dbus_rmutex_new_at_location
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:53
DBusCMutex
Definition: dbus-sysdeps-pthread.c:53
_dbus_rmutex_unlock
DBUS_PRIVATE_EXPORT void _dbus_rmutex_unlock(DBusRMutex *mutex)
Unlocks a mutex.
Definition: dbus-threads.c:150
_dbus_condvar_free
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:212
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_cmutex_unlock
void _dbus_cmutex_unlock(DBusCMutex *mutex)
Unlocks a mutex.
Definition: dbus-threads.c:164
_dbus_condvar_new_at_location
void _dbus_condvar_new_at_location(DBusCondVar **location_p)
This does the same thing as _dbus_condvar_new.
Definition: dbus-threads.c:199
_dbus_condvar_wake_one
void _dbus_condvar_wake_one(DBusCondVar *cond)
If there are threads waiting on the condition variable, wake up exactly one.
Definition: dbus-threads.c:278
_dbus_condvar_new
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:181
_dbus_rmutex_free_at_location
void _dbus_rmutex_free_at_location(DBusRMutex **location_p)
Frees a DBusRMutex; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:94
DBusCondVar
Definition: dbus-sysdeps-pthread.c:57
_dbus_cmutex_lock
void _dbus_cmutex_lock(DBusCMutex *mutex)
Locks a mutex.
Definition: dbus-threads.c:136
_dbus_rmutex_lock
DBUS_PRIVATE_EXPORT void _dbus_rmutex_lock(DBusRMutex *mutex)
Locks a mutex.
Definition: dbus-threads.c:122
_dbus_cmutex_free_at_location
void _dbus_cmutex_free_at_location(DBusCMutex **location_p)
Frees a DBusCMutex; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:107
DBusRMutex
Definition: dbus-sysdeps-pthread.c:49
_dbus_condvar_free_at_location
void _dbus_condvar_free_at_location(DBusCondVar **location_p)
Frees a condition variable; does nothing if passed a NULL pointer.
Definition: dbus-threads.c:224
_dbus_cmutex_new_at_location
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:77
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.