Embedded Multicore Building Blocks V1.0.0
condition_variable.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_BASE_C_CONDITION_VARIABLE_H_
28 #define EMBB_BASE_C_CONDITION_VARIABLE_H_
29 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 #include <embb/base/c/internal/platform.h>
47 #include <embb/base/c/time.h>
48 #include <embb/base/c/errors.h>
49 
50 #ifdef DOXYGEN
51 
54 typedef opaque_type embb_condition_t;
55 #endif /* DOXYGEN */
56 
69  embb_condition_t* condition_var
71  );
72 
84  embb_condition_t* condition_var
86  );
87 
99  embb_condition_t* condition_var
101  );
102 
118  embb_condition_t* condition_var,
120  embb_mutex_t* mutex
122  );
123 
142  embb_condition_t* condition_var,
144  embb_mutex_t* mutex,
146  const embb_time_t* time
148  );
149 
168  embb_condition_t* condition_var,
170  embb_mutex_t* mutex,
172  const embb_duration_t* duration
174  );
175 
189  embb_condition_t* condition_var
191  );
192 
193 #ifdef __cplusplus
194 } /* Close extern "C" { */
195 #endif
196 
201 #endif /* EMBB_BASE_C_CONDITION_VARIABLE_H_ */
int embb_condition_notify_all(embb_condition_t *condition_var)
Wakes up all threads waiting for condition_var.
int embb_condition_wait_until(embb_condition_t *condition_var, embb_mutex_t *mutex, const embb_time_t *time)
Unlocks mutex and waits until the thread is woken up or time has passed.
opaque_type embb_condition_t
Opaque type representing a condition variable.
Definition: condition_variable.h:54
int embb_condition_wait_for(embb_condition_t *condition_var, embb_mutex_t *mutex, const embb_duration_t *duration)
Unlocks mutex and waits until the thread is woken up or duration has passed.
int embb_condition_notify_one(embb_condition_t *condition_var)
Wakes up one thread waiting for condition_var.
int embb_condition_init(embb_condition_t *condition_var)
Initializes a condition variable.
opaque_type embb_time_t
Opaque type representing an absolute time point.
Definition: time.h:48
int embb_condition_wait(embb_condition_t *condition_var, embb_mutex_t *mutex)
Unlocks mutex and waits until the thread is woken up.
int embb_condition_destroy(embb_condition_t *condition_var)
Destroys condition_var and frees used memory.
opaque_type embb_duration_t
Opaque type representing a relative time duration.
Definition: duration.h:52
opaque_type embb_mutex_t
Opaque type representing a mutex.
Definition: mutex.h:55