NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO
#include <etimer/chEtimer.h>int timerCreate(KnCap *actor, int clock, KnThreadPool *threadPool, void *cookie, int *timerLi);
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
TIMER
timerCreate() creates a timer relative to the clock type clock in the actor specified by actor. If actor has the value K_MYACTOR, the timer is created in the current actor. timerCreate() returns the local ID of the new timer in timerLi. The timer may then be armed using timerSet(2K).
The only clock type currently supported is K_CLOCK_REALTIME. This clock corresponds to the system time as returned by sysTime(2K).
threadPool must point to an initialized KnThreadPool object (see timerThreadPoolInit(2K)). At each timer expiration for the newly created timer, a thread blocked on the designated KnThreadPool object will be awakened so as to return from its timerThreadPoolWait(2K) system call.
The cookie value will be provided to that thread on return from timerThreadPoolWait(2K). Library or application code may create and use this type of thread to execute timer notification handlers. The cookie value can be used to address a library object corresponding to the particular timer.
On successful completion, K_OK is returned. Otherwise, a negative error code is returned.
clock is not equal to K_CLOCK_REALTIME, or threadPool has not been initialized.
The maximum number of timers has been reached.
An address argument falls outside the caller's address space.
actor does not specify a reachable actor.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO