kstars
Functions Drivers call to register with the INDI event utilities.
Callbacks are called when a read on a file descriptor will not block. More...
Typedefs | |
typedef void( | IE_CBF )(int readfiledes, void *userpointer) |
typedef void( | IE_TCF )(void *userpointer) |
typedef void( | IE_WPF )(void *userpointer) |
Functions | |
int | IEAddCallback (int readfiledes, IE_CBF *fp, void *userpointer) |
int | IEAddTimer (int millisecs, IE_TCF *fp, void *userpointer) |
int | IEAddWorkProc (IE_WPF *fp, void *userpointer) |
void | IERmCallback (int callbackid) |
void | IERmTimer (int timerid) |
void | IERmWorkProc (int workprocid) |
Detailed Description
Callbacks are called when a read on a file descriptor will not block.Timers are called once after a specified interval. Workprocs are called when there is nothing else to do. The "Add" functions return a unique id for use with their corresponding "Rm" removal function. An arbitrary pointer may be specified when a function is registered which will be stored and forwarded unchanged when the function is later invoked.
Typedef Documentation
typedef void( IE_CBF)(int readfiledes, void *userpointer) |
Definition at line 226 of file indidevapi.h.
typedef void( IE_TCF)(void *userpointer) |
Definition at line 228 of file indidevapi.h.
typedef void( IE_WPF)(void *userpointer) |
Definition at line 230 of file indidevapi.h.
Function Documentation
int IEAddCallback | ( | int | readfiledes, | |
IE_CBF * | fp, | |||
void * | userpointer | |||
) |
Register a new callback, fp, to be called with userpointer as argument when readfiledes is ready.
- Parameters:
-
readfiledes file descriptor. fp a pointer to the callback function. userpointer a pointer to be passed to the callback function when called.
- Returns:
- a unique callback id for use with IERmCallback().
int IEAddTimer | ( | int | millisecs, | |
IE_TCF * | fp, | |||
void * | userpointer | |||
) |
Register a new timer function, fp, to be called with ud as argument after ms.
Add to list in order of decreasing time from epoch, ie, last entry runs soonest. The timer will only invoke the callback function once. You need to call addTimer again if you want to repeat the process.
- Parameters:
-
millisecs timer period in milliseconds. fp a pointer to the callback function. userpointer a pointer to be passed to the callback function when called.
- Returns:
- a unique id for use with IERmTimer().
int IEAddWorkProc | ( | IE_WPF * | fp, | |
void * | userpointer | |||
) |
Add a new work procedure, fp, to be called with ud when nothing else to do.
- Parameters:
-
fp a pointer to the work procedure callback function. userpointer a pointer to be passed to the callback function when called.
- Returns:
- a unique id for use with IERmWorkProc().
void IERmCallback | ( | int | callbackid | ) |
void IERmTimer | ( | int | timerid | ) |
Remove the timer with the given timerid, as returned from IEAddTimer.
- Parameters:
-
timerid the timer callback ID returned from IEAddTimer().
void IERmWorkProc | ( | int | workprocid | ) |
Remove the work procedure with the given workprocid, as returned from IEAddWorkProc().
- Parameters:
-
workprocid the work procedure callback ID returned from IEAddWorkProc().