Semaphore.h

Go to the documentation of this file.

#ifndef INCLUDE_DISTORTOS_C_API_SEMAPHORE_H_
#define INCLUDE_DISTORTOS_C_API_SEMAPHORE_H_

#include "estd/C-API/IntrusiveList.h"

#include <limits.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif  /* def __cplusplus */

/*---------------------------------------------------------------------------------------------------------------------+
| global types
+---------------------------------------------------------------------------------------------------------------------*/

struct distortos_Semaphore
{
    struct estd_IntrusiveList blockedList;

    unsigned int value;

    unsigned int maxValue;
};

/*---------------------------------------------------------------------------------------------------------------------+
| global defines
+---------------------------------------------------------------------------------------------------------------------*/

#define DISTORTOS_SEMAPHORE_INITIALIZER(self, value, maxValue) \
        {ESTD_INTRUSIVELIST_INITIALIZER((self).blockedList), (value) < (maxValue) ? (value) : (maxValue), (maxValue)}

#define DISTORTOS_SEMAPHORE_CONSTRUCT_1(name, value, maxValue) \
        struct distortos_Semaphore name = DISTORTOS_SEMAPHORE_INITIALIZER(name, value, maxValue)

#define DISTORTOS_SEMAPHORE_CONSTRUCT(name, value)  DISTORTOS_SEMAPHORE_CONSTRUCT_1(name, value, UINT_MAX)

/*---------------------------------------------------------------------------------------------------------------------+
| global functions
+---------------------------------------------------------------------------------------------------------------------*/

int distortos_Semaphore_construct_1(struct distortos_Semaphore* semaphore, unsigned int value, unsigned int maxValue);

static inline int distortos_Semaphore_construct(struct distortos_Semaphore* const semaphore, const unsigned int value)
{
    return distortos_Semaphore_construct_1(semaphore, value, UINT_MAX);
}

int distortos_Semaphore_destruct(struct distortos_Semaphore* semaphore);

int distortos_Semaphore_getMaxValue(const struct distortos_Semaphore* semaphore, unsigned int* maxValue);

int distortos_Semaphore_getValue(const struct distortos_Semaphore* semaphore, unsigned int* value);

int distortos_Semaphore_post(struct distortos_Semaphore* semaphore);

int distortos_Semaphore_tryWait(struct distortos_Semaphore* semaphore);

int distortos_Semaphore_tryWaitFor(struct distortos_Semaphore* semaphore, int64_t duration);

int distortos_Semaphore_tryWaitUntil(struct distortos_Semaphore* semaphore, int64_t timePoint);

int distortos_Semaphore_wait(struct distortos_Semaphore* semaphore);

#ifdef __cplusplus
}   /* extern "C" */
#endif  /* def __cplusplus */

#endif  /* INCLUDE_DISTORTOS_C_API_SEMAPHORE_H_ */