framework/c/inc/le_mutex.h

Go to the documentation of this file.

#ifndef LEGATO_MUTEX_INCLUDE_GUARD
#define LEGATO_MUTEX_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mutex* le_mutex_Ref_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mutex_Ref_t le_mutex_CreateRecursive
(
    const char* nameStr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mutex_Ref_t le_mutex_CreateNonRecursive
(
    const char* nameStr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mutex_Ref_t le_mutex_CreateTraceableRecursive
(
    const char* nameStr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mutex_Ref_t le_mutex_CreateTraceableNonRecursive
(
    const char* nameStr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mutex_Delete
(
    le_mutex_Ref_t    mutexRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mutex_Lock
(
    le_mutex_Ref_t    mutexRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mutex_TryLock
(
    le_mutex_Ref_t    mutexRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mutex_Unlock
(
    le_mutex_Ref_t    mutexRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MUTEX_DECLARE_REF(refName) \
    static le_mutex_Ref_t refName; \
    static inline void Lock(void) { le_mutex_Lock(refName); } \
    static inline void Unlock(void) { le_mutex_Unlock(refName); }

#endif /* LEGATO_MUTEX_INCLUDE_GUARD */