oc_event.h

Go to the documentation of this file.

#ifndef INC_KERNEL_OC_EVENT_H_
#define INC_KERNEL_OC_EVENT_H_

#include <stdbool.h>
#include <oc_time.h>
#include <oc_stdlib.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef struct Event_t * oC_Event_t;

typedef enum
{
    oC_Event_State_Active               = 0xFFFFFFFFU ,
    oC_Event_State_Inactive             = 0 ,
} oC_Event_State_t;

typedef enum
{
    oC_Event_StateMask_Full             = oC_Event_State_Active,
    oC_Event_StateMask_DifferentThan    = 0 ,
} oC_Event_StateMask_t;

typedef enum
{
    oC_Event_Protect_NotProtected   = 0 ,
    oC_Event_Protect_Protected      = 0xFF
} oC_Event_Protect_t;

typedef enum
{
    oC_Event_CompareType_Equal ,
    oC_Event_CompareType_Less ,
    oC_Event_CompareType_LessOrEqual ,
    oC_Event_CompareType_Greater ,
    oC_Event_CompareType_GreaterOrEqual ,
    oC_Event_CompareType_NumberOfElements
} oC_Event_CompareType_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

extern oC_Event_t       oC_Event_New            ( oC_Event_State_t InitState , Allocator_t Allocator , AllocationFlags_t Flags );
extern bool             oC_Event_Delete         ( oC_Event_t * Event , AllocationFlags_t Flags );
extern bool             oC_Event_ProtectDelete  ( oC_Event_t Event , Allocator_t Allocator , oC_Event_Protect_t Protection );
extern bool             oC_Event_IsCorrect      ( oC_Event_t Event );
extern oC_Event_State_t oC_Event_GetState       ( oC_Event_t Event );
extern bool             oC_Event_SetState       ( oC_Event_t Event , oC_Event_State_t State );
extern bool             oC_Event_ClearStateBits ( oC_Event_t Event , uint32_t StateMask );
extern bool             oC_Event_ReadState      ( oC_Event_t Event , oC_Event_State_t * outState );
extern bool             oC_Event_WaitForState   ( oC_Event_t Event , oC_Event_State_t State , oC_Event_StateMask_t StateMask , oC_Time_t Timeout );
extern bool             oC_Event_WaitForValue   ( oC_Event_t Event , oC_Event_State_t Value , oC_Event_CompareType_t CompareType, oC_Time_t Timeout );


#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

#endif /* INC_KERNEL_OC_EVENT_H_ */