Content-type: text/html Manpage of RTTimer

RTTimer

Section: Chronolytix (3)
Updated: 2005-07-07
Index Return to Main Contents

NAME

RTEvent - Chronolytix Timer Class

SYNOPSYS

#include <RTTimer.h>

RTTimerId RTTimer_Arm_Absolute(RTReactiveTask *rtp, struct timeval *tvp);

RTTimerId RTTimer_Arm_Relative(RTReactiveTask *rtp, RTClockMicroSecs usecs);

void RTTimer_Cancel(RTTimerId timer);

void RTTimer_Release(RTTimerId timer);

DESCRIPTION

RTTimer is the Chronolytix class for accurate, scalable, high-resolution timing. An expired timer invokes the RTReactiveTask passed in the Arm call on the task whose is bound to it. A timer may be armed relative to the current time or to an absolute time. If the time of expiration passes before being armed, RTTimer runs the timer immediately. The returned RTTimerId is a RTRefCnt_Object. This property makes the tricky timer races with cancel, expire and when the timer memory should be deallocated "go away". However, memory leaks will occur if every armed timer (ie., non-NULL RTTimerId) is not disposed of properly by calling either RTTimer_Cancel or RTTimer_Release. RTTimer_Cancel will attempt to cancel an armed timer such that the RTReactiveTask is not invoked. If a timer has expired, RTTimer_Cancel acts as a mildly more expensive RTTimer_Release.

RTTimer is a core Chronolytix function.

MAGIC

RTTimer "Timr"