le_semaphore.h

Go to the documentation of this file.

#ifndef LEGATO_SEMAPHORE_INCLUDE_GUARD
#define LEGATO_SEMAPHORE_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sem_t* le_sem_Ref_t;


#if LE_CONFIG_SEM_NAMES_ENABLED
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sem_Ref_t le_sem_Create
(
    const char *name,
    int32_t initialCount
);
#else /* if not LE_CONFIG_SEM_NAMES_ENABLED */
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sem_Ref_t _le_sem_Create(int32_t initialCount);
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE le_sem_Ref_t le_sem_Create
(
    const char *name,
    int32_t initialCount
)
{
    LE_UNUSED(name);
    return _le_sem_Create(initialCount);
}
#endif /* end LE_CONFIG_SEM_NAMES_ENABLED */


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sem_Delete
(
    le_sem_Ref_t    semaphorePtr   
);


#if LE_CONFIG_SEM_NAMES_ENABLED
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sem_Ref_t le_sem_FindSemaphore
(
    const char* name
);
#else /* if not LE_CONFIG_SEM_NAMES_ENABLED */
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE le_sem_Ref_t le_sem_FindSemaphore
(
    const char* name
)
{
    LE_UNUSED(name);
    // Cannot look up semaphores by name if names do not exist.
    return NULL;
}
#endif /* end LE_CONFIG_SEM_NAMES_ENABLED */

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sem_Wait
(
    le_sem_Ref_t    semaphorePtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sem_TryWait
(
    le_sem_Ref_t    semaphorePtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sem_WaitWithTimeOut
(
    le_sem_Ref_t    semaphorePtr,   
    le_clk_Time_t   timeToWait      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sem_Post
(
    le_sem_Ref_t    semaphorePtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_sem_GetValue
(
    le_sem_Ref_t    semaphorePtr   
);

#endif // LEGATO_SEMAPHORE_INCLUDE_GUARD