KDE 4.0 API Reference kstars
IE Functions: Functions drivers call to register with the INDI event utilities.
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.
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) |
| void | IERmCallback (int callbackid) |
| int | IEAddTimer (int millisecs, IE_TCF *fp, void *userpointer) |
| void | IERmTimer (int timerid) |
| int | IEAddWorkProc (IE_WPF *fp, void *userpointer) |
| void | IERmWorkProc (int workprocid) |
| int | IEDeferLoop (int maxms, int *flagp) |
| int | IEDeferLoop0 (int maxms, int *flagp) |
Typedef Documentation
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().
| int IEDeferLoop | ( | int | maxms, | |
| int * | flagp | |||
| ) |
| int IEDeferLoop0 | ( | int | maxms, | |
| int * | flagp | |||
| ) |
| 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 a work procedure.
- Parameters:
-
workprocid The unique ID for the work procedure to be removed.
