IPC@CHIP® RTOS-LNX – API Documentation

Header image

Main page


◆ RTX_NewTimerCB()

RTX_ID RTX_NewTimerCB ( const char *  tag,
RTX_TIMER_CALLBACK  proc,
long  interval,
unsigned long  lParam 
)

The specified procedure proc will be called based on a timer.

You must call either the RTX_Start_Timer(), RTX_Timer_Delay() or RTX_Timer_Delay_RTI() API to get the kernel to start calling your new timer procedure.

Timers require the use of one general purpose kernel object, of which the system has a total of 1000.

Important:
Timer procedures are executed in a top priority task, so the timer user callback procedure should be as short as possible. Avoid calling time consuming functions. It is not legal to call any API which may block from a timer callback. The system is not protected against such a violation and to do so may cause the system to crash. The total stack space available is ???? bytes, a few of which are used by the system on entry into the callback.
Parameters
tagUp to 4 character name to give timer. Nil terminator is optional.
procVector to timer procedure.
intervalTimer interval in milliseconds. This value must be non-negative, and when multiplied by the RTI rate must not exceed 31 bits. Otherwise this API will either fail with return value zero or create a timer with an undesired interval (depending on the nature of the count overflow).
lParamOptional 32 bit parameter to pass to timer callback procedure proc.
Returns
Timer ID (handle) on success, else zero on failure.
See also
RTX_NewFineTimerCB()     RTX_Remove_Timer()
Compatibility:
This API is not compatible with the SC1x, SC2x and SC1x3 C-library. The legacy function RTX_Install_Timer() may be used when cross system source compatibility is required.
Since
V0.80





Top of page | Main page

Copyright © 2018 Beck IPC GmbH
Generated on Fri Jun 8 2018 12:48:21 by Doxygen 1.8.13