class TimedThread

Timed Thread. More...

Contains pure virtuals
Full nameCoral::TimedThread
Definition#include <timedthread.h>
InheritsCoral::Thread
Inherited byAdvancedAudioDecoder, AudioServer, CongestionManager, CongestionManagerClient, CongestionMonitor, NetLogWriter, RTCPAbstractServer, RTCPSender, RTPSender, RoundTripTimePinger, TrafficShaperSingleton
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

This abstract class realizes a timed thread based on Thread. The user of this class has to implement timerEvent(). Inaccurate system timers are corrected by calling user's timerEvent() implementation multiple times if necessary. This feature can be modified by setTimerCorrection (Default is on at a maximum of 10 calls). IMPORTANT: Do *not* use Thread methods within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

 TimedThread (const card64 usec, const cardinal flags = ThreadCancelAsynchronous)

Constructor. A new timed thread with a given interval will be created but *not* started! To start the new thread, call start(). The interval gives the time for the interval in microseconds, the virtual function timerEvent() is called. The default timer correction is set to 10. See setTimerCorrection() for more information on timer correction. The first call of timerEvent() will be made immediately, if the fast start option is set (default). Otherwise it will be made after the given interval.

Parameters:
usecInterval in microseconds.
flagsThread flags

See also: Thread#start, timerEvent, Thread#Thread, setTimerCorrection, setFastStart

TimedThread ()

Destructor.

inline card64  getInterval ()

[const]

Get timed thread's interval.

Returns: Interval in microseconds.

void  setInterval (const card64 usec)

Set timed thread's interval.

Parameters:
usecInterval in microseconds.

inline cardinal  getTimerCorrection ()

[const]

Get maxCorrection value for inaccurate system timer.

Returns: true, if activated; false if not.

inline void  setTimerCorrection (const cardinal maxCorrection = 0)

Set correction of inaccurate system timer to given value. This on will cause the timerEvent() function to be called a maximum of maxCorrection times, if the total number of calls is lower than the calculated number of times the function should have been called. If the number of correction calls is higher than maxCorrection, *no* correction will be done! Default is 0, which turns correction off.

Parameters:
oftrue to activate correction; false to deactivate.

inline void  leaveCorrectionLoop ()

Leave timer correction loop: If the thread is in a timer correction loop, the loop will be finished after the current timerEvent() call returns.

inline void  setFastStart (const bool on)

Set fast start option: If false, the first call of timerEvent() will be made *after* the given interval; otherwise it will be made immediately. The default is true.

Parameters:
ontrue, to set option; false otherwise.

inline bool  getFastStart ()

[const]

Get fast start option: If false, the first call of timerEvent() will be made *after* the given interval; otherwise it will be made immediately.

Returns: true, if option is set; false otherwise.

void  stop ()

Reimplementation of stop().

Reimplemented from Thread.

inline bool  pendingTimerEvent ()

[const]

Check for pending timer event(). This can be used to check for a pending timer event() (SIGALRM signal) within the current timerEvent() run.

void  timerEvent ()

[protected pure virtual]

The virtual timerEvent() method, which contains the timed thread's implementation. It has to be implemented by classes, which inherit TimedThread. This method is called regularly with the given interval.