Class CommTimer

class CommTimer;

Description

Static utility class for global timer handling designed for use by Serial Server plug-ins (CSYs).

Members

Defined in CommTimer:
Queue(), Remove()

static IMPORT_C void Queue(TTimeIntervalMicroSeconds32 aTimeInMicroSeconds, TDeltaTimerEntry &aHandle);

Description

Queue a timer on the global timer.

This class is only suitable for CSYs since it currently has no direct mechanism through which to release the Thread Local Storage and heap resources it allocates. In the case of CSYs these resources are managed separately by C32.

Note:

1. The Thread Local Storage of the calling thread must be available for use.

2. The first time this is called for a thread, a small amount of heap memory is required. If no memory is available, a "c32-fault" panic of type 7 is raised. Subsequent calls are not affected since they reuse this memory.

Parameters

TTimeIntervalMicroSeconds32 aTimeInMicroSeconds the timeout value in micro seconds TDeltaTimerEntry &aHandle handle to the delta timer entry

static IMPORT_C void Remove(TDeltaTimerEntry &aHandle);

Description

Call cancel on the global timer

Note: This does not free the Thread Local Storage for the calling thread.

Parameters

TDeltaTimerEntry &aHandle the timer to cancel