xref: /nrf52832-nimble/rt-thread/components/cplusplus/Semaphore.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /*
2*10465441SEvalZero  * Copyright (c) 2006-2018, RT-Thread Development Team
3*10465441SEvalZero  *
4*10465441SEvalZero  * SPDX-License-Identifier: Apache-2.0
5*10465441SEvalZero  *
6*10465441SEvalZero  * Change Logs:
7*10465441SEvalZero  * Date           Author       Notes
8*10465441SEvalZero  * 2016/10/1      Bernard      The first version
9*10465441SEvalZero  */
10*10465441SEvalZero 
11*10465441SEvalZero #pragma once
12*10465441SEvalZero 
13*10465441SEvalZero #include <stdint.h>
14*10465441SEvalZero #include <rtthread.h>
15*10465441SEvalZero 
16*10465441SEvalZero namespace rtthread {
17*10465441SEvalZero 
18*10465441SEvalZero /** The Semaphore class is used to manage and protect access to a set of shared resources. */
19*10465441SEvalZero class Semaphore
20*10465441SEvalZero {
21*10465441SEvalZero public:
22*10465441SEvalZero     /** Create and Initialize a Semaphore object used for managing resources.
23*10465441SEvalZero       @param number of available resources; maximum index value is (count-1).
24*10465441SEvalZero     */
25*10465441SEvalZero     Semaphore(const char *name = "sem", int32_t count = 0);
26*10465441SEvalZero     ~Semaphore();
27*10465441SEvalZero 
28*10465441SEvalZero     /** Wait until a Semaphore resource becomes available.
29*10465441SEvalZero       @param   millisec  timeout value or 0 in case of no time-out.
30*10465441SEvalZero       @return  true on success.
31*10465441SEvalZero     */
32*10465441SEvalZero     bool wait(int32_t millisec = -1);
33*10465441SEvalZero 
34*10465441SEvalZero     /** Release a Semaphore resource that was obtain with Semaphore::wait.
35*10465441SEvalZero     */
36*10465441SEvalZero     void release(void);
37*10465441SEvalZero 
38*10465441SEvalZero private:
39*10465441SEvalZero     struct rt_semaphore mID;
40*10465441SEvalZero };
41*10465441SEvalZero 
42*10465441SEvalZero }
43