framework/c/inc/le_eventLoop.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_EVENTLOOP_INCLUDE_GUARD
#define LEGATO_EVENTLOOP_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_event_Id* le_event_Id_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

// This macro is set by the build system.  However, if it hasn't been set, use a sensable default.
#ifndef COMPONENT_INIT
    #define COMPONENT_INIT  void _le_event_InitializeComponent(void)
#endif

#define LE_EVENT_INIT_HANDLER COMPONENT_INIT


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_event_HandlerFunc_t)
(
    void* reportPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_event_LayeredHandlerFunc_t)
(
    void*   reportPtr,
    void*   secondLayerFunc
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_event_FdHandlerFunc_t)
(
    int fd
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_event_DeferredFunc_t)
(
    void* param1Ptr,
    void* param2Ptr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_event_FdMonitor* le_event_FdMonitorRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_event_Handler* le_event_HandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_event_FdHandler* le_event_FdHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_EVENT_FD_READABLE,           
    LE_EVENT_FD_READABLE_URGENT,    
    LE_EVENT_FD_WRITEABLE,          
    LE_EVENT_FD_WRITE_HANG_UP,      
    LE_EVENT_FD_READ_HANG_UP,       
    LE_EVENT_FD_ERROR,              
}
le_event_FdEventType_t;

#define LE_EVENT_NUM_FD_EVENT_TYPES 6   ///< Number of members in the le_event_FdEventType_t enum.


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_Id_t le_event_CreateId
(
    const char* name,       
    size_t      payloadSize 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_Id_t le_event_CreateIdWithRefCounting
(
    const char* name        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_HandlerRef_t le_event_AddHandler
(
    const char*             name,           
    le_event_Id_t           eventId,        
    le_event_HandlerFunc_t  handlerFunc     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_HandlerRef_t le_event_AddLayeredHandler
(
    const char*                     name,           
    le_event_Id_t                   eventId,        
    le_event_LayeredHandlerFunc_t   firstLayerFunc, 
    void*                           secondLayerFunc 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_RemoveHandler
(
    le_event_HandlerRef_t   handlerRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_Report
(
    le_event_Id_t   eventId,    
    void*           payloadPtr, 
    size_t          payloadSize 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_ReportWithRefCounting
(
    le_event_Id_t   eventId,    
    void*           objectPtr   

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_SetContextPtr
(
    le_event_HandlerRef_t   handlerRef, 
    void*                   contextPtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_event_GetContextPtr
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_FdMonitorRef_t le_event_CreateFdMonitor
(
    const char*             name,       
    int                     fd          
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_FdHandlerRef_t le_event_SetFdHandler
(
    le_event_FdMonitorRef_t  monitorRef, 
    le_event_FdEventType_t   eventType,  
    le_event_FdHandlerFunc_t handlerFunc 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_SetFdHandlerContextPtr
(
    le_event_FdHandlerRef_t handlerRef, 
    void*                   contextPtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_ClearFdHandler
(
    le_event_FdHandlerRef_t  handlerRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_DeleteFdMonitor
(
    le_event_FdMonitorRef_t monitorRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_QueueFunction
(
    le_event_DeferredFunc_t func,       
    void*                   param1Ptr,  
    void*                   param2Ptr   
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_QueueFunctionToThread
(
    le_thread_Ref_t         thread,     
    le_event_DeferredFunc_t func,       
    void*                   param1Ptr,  
    void*                   param2Ptr   
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_event_RunLoop
(
    void
)
__attribute__ ((noreturn));


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_event_GetFd
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_event_ServiceLoop
(
    void
);


#endif // LEGATO_EVENTLOOP_INCLUDE_GUARD