le_fdMonitor.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_FDMONITOR_INCLUDE_GUARD
#define LEGATO_FDMONITOR_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_fdMonitor* le_fdMonitor_Ref_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_fdMonitor_HandlerFunc_t)
(
    int   fd,
    short events
);


#if LE_CONFIG_FD_MONITOR_NAMES_ENABLED
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_fdMonitor_Ref_t le_fdMonitor_Create
(
    const char                  *name,
    int                          fd,
    le_fdMonitor_HandlerFunc_t   handlerFunc,
    short                        events
);
#else /* if not LE_CONFIG_FD_MONITOR_NAMES_ENABLED */
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_fdMonitor_Ref_t _le_fdMonitor_Create
(
    int                          fd,
    le_fdMonitor_HandlerFunc_t   handlerFunc,
    short                        events
);
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE le_fdMonitor_Ref_t le_fdMonitor_Create
(
    const char                  *name,
    int                          fd,
    le_fdMonitor_HandlerFunc_t   handlerFunc,
    short                        events
)
{
    LE_UNUSED(name);
    return _le_fdMonitor_Create(fd, handlerFunc, events);
}
#endif /* end LE_CONFIG_FD_MONITOR_NAMES_ENABLED */


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_fdMonitor_Enable
(
    le_fdMonitor_Ref_t  monitorRef, 
    short               events      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_fdMonitor_Disable
(
    le_fdMonitor_Ref_t  monitorRef, 
    short               events      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_fdMonitor_SetDeferrable
(
    le_fdMonitor_Ref_t monitorRef,  
    bool               isDeferrable 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_fdMonitor_SetContextPtr
(
    le_fdMonitor_Ref_t  monitorRef, 
    void*               contextPtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_fdMonitor_GetContextPtr
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_fdMonitor_GetFd
(
    le_fdMonitor_Ref_t  monitorRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_fdMonitor_Ref_t le_fdMonitor_GetMonitor
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_fdMonitor_Delete
(
    le_fdMonitor_Ref_t monitorRef  
);


#endif // LEGATO_FDMONITOR_INCLUDE_GUARD