blob: 2365cf4e969b63e759687d4eee7f0e04d4e0bfaf (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/**
* This file is part of Hercules.
* http://herc.ws - http://github.com/HerculesWS/Hercules
*
* Copyright (C) 2012-2016 Hercules Dev Team
* Copyright (C) rAthena Project (www.rathena.org)
*
* Hercules is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef COMMON_MUTEX_H
#define COMMON_MUTEX_H
#include "common/hercules.h"
/* Opaque types */
struct mutex_data; ///< Mutex
struct cond_data; ///< Conditional variable
/* Interface */
struct mutex_interface {
/**
* Creates a Mutex
*
* @return The created mutex.
*/
struct mutex_data *(*create) (void);
/**
* Destroys a Mutex.
*
* @param m the mutex to destroy.
*/
void (*destroy) (struct mutex_data *m);
/**
* Gets a lock.
*
* @param m The mutex to lock.
*/
void (*lock) (struct mutex_data *m);
/**
* Tries to get a lock.
*
* @param m The mutex to try to lock.
* @return success status.
* @retval true if the lock was acquired.
* @retval false if the mutex couldn't be locked.
*/
bool (*trylock) (struct mutex_data *m);
/**
* Unlocks a mutex.
*
* @param m The mutex to unlock.
*/
void (*unlock) (struct mutex_data *m);
/**
* Creates a Condition variable.
*
* @return the created condition variable.
*/
struct cond_data *(*cond_create) (void);
/**
* Destroys a Condition variable.
*
* @param c the condition variable to destroy.
*/
void (*cond_destroy) (struct cond_data *c);
/**
* Waits Until state is signaled.
*
* @param c The condition var to wait for signaled state.
* @param m The mutex used for synchronization.
* @param timeout_ticks Timeout in ticks (-1 = INFINITE)
*/
void (*cond_wait) (struct cond_data *c, struct mutex_data *m, sysint timeout_ticks);
/**
* Sets the given condition var to signaled state.
*
* @remark
* Only one waiter gets notified.
*
* @param c Condition var to set in signaled state.
*/
void (*cond_signal) (struct cond_data *c);
/**
* Sets notifies all waiting threads thats signaled.
*
* @remark
* All Waiters getting notified.
*
* @param c Condition var to set in signaled state.
*/
void (*cond_broadcast) (struct cond_data *c);
};
#ifdef HERCULES_CORE
void mutex_defaults(void);
#endif // HERCULES_CORE
HPShared struct mutex_interface *mutex;
#endif /* COMMON_MUTEX_H */
|
