framework/c/inc/le_thread.h

Go to the documentation of this file.

#ifndef LEGATO_THREAD_INCLUDE_GUARD
#define LEGATO_THREAD_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_thread* le_thread_Ref_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_THREAD_PRIORITY_IDLE = 0,    
    LE_THREAD_PRIORITY_NORMAL,      
    LE_THREAD_PRIORITY_RT_1,        

    LE_THREAD_PRIORITY_RT_2,        
    LE_THREAD_PRIORITY_RT_3,        
    LE_THREAD_PRIORITY_RT_4,        
    LE_THREAD_PRIORITY_RT_5,        
    LE_THREAD_PRIORITY_RT_6,        
    LE_THREAD_PRIORITY_RT_7,        
    LE_THREAD_PRIORITY_RT_8,        
    LE_THREAD_PRIORITY_RT_9,        
    LE_THREAD_PRIORITY_RT_10,       
    LE_THREAD_PRIORITY_RT_11,       
    LE_THREAD_PRIORITY_RT_12,       
    LE_THREAD_PRIORITY_RT_13,       
    LE_THREAD_PRIORITY_RT_14,       
    LE_THREAD_PRIORITY_RT_15,       
    LE_THREAD_PRIORITY_RT_16,       
    LE_THREAD_PRIORITY_RT_17,       
    LE_THREAD_PRIORITY_RT_18,       
    LE_THREAD_PRIORITY_RT_19,       
    LE_THREAD_PRIORITY_RT_20,       
    LE_THREAD_PRIORITY_RT_21,       
    LE_THREAD_PRIORITY_RT_22,       
    LE_THREAD_PRIORITY_RT_23,       
    LE_THREAD_PRIORITY_RT_24,       
    LE_THREAD_PRIORITY_RT_25,       
    LE_THREAD_PRIORITY_RT_26,       
    LE_THREAD_PRIORITY_RT_27,       
    LE_THREAD_PRIORITY_RT_28,       
    LE_THREAD_PRIORITY_RT_29,       
    LE_THREAD_PRIORITY_RT_30,       
    LE_THREAD_PRIORITY_RT_31,       
    LE_THREAD_PRIORITY_RT_32        
}
le_thread_Priority_t;

#define LE_THREAD_PRIORITY_RT_LOWEST    LE_THREAD_PRIORITY_RT_1     ///< Lowest real-time priority.
#define LE_THREAD_PRIORITY_RT_HIGHEST   LE_THREAD_PRIORITY_RT_32    ///< Highest real-time priority.


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void* (* le_thread_MainFunc_t)
(
    void* context   
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_thread_Ref_t le_thread_Create
(
    const char*             name,       
    le_thread_MainFunc_t    mainFunc,   
    void*                   context     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_thread_SetPriority
(
    le_thread_Ref_t         thread,     
    le_thread_Priority_t    priority    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_thread_SetStackSize
(
    le_thread_Ref_t     thread,     
    size_t              size        

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_SetJoinable
(
    le_thread_Ref_t         thread  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_Start
(
    le_thread_Ref_t     thread      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_thread_Join
(
    le_thread_Ref_t     thread,         
    void**              resultValuePtr  


);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_Exit
(
    void*   resultValue     


);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_thread_Cancel
(
    le_thread_Ref_t     threadToCancel
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_thread_Ref_t le_thread_GetCurrent
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_GetName
(
    le_thread_Ref_t threadRef,  
    char* buffPtr,              
    size_t buffSize             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_thread_GetMyName
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (* le_thread_Destructor_t)
(
    void* context   

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_AddDestructor
(
    le_thread_Destructor_t  destructor, 
    void*                   context     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_thread_AddChildDestructor
(
    le_thread_Ref_t         thread,     
    le_thread_Destructor_t  destructor, 
    void*                   context     
);


#endif // LEGATO_THREAD_INCLUDE_GUARD