TimerClearEvent

Message

TimerClearEvent <timername>

Originator

Client

Response (immediate socket)

Success

Failure

Response

Info: killed all timers called <eventname>

Info: no timers to kill called <eventname>

SyntaxError: invalid parameters to TimerClearEvent

SyntaxError: insufficient parameters to TimerClearEvent

Details

I hope this is self-explanatory!        

SDK Control Method

TimerClearEvent(Timer as String)        

Clears any scheduled timer called Timer.

ClientLib

void TimerClearEvent(const CString& strTimer);

Clears any scheduled timer called strTimer.

Revision history

Implemented in WhiskerServer version 1 as KillTimer.

Renamed in WhiskerServer version 2.3.

"No timers to kill" message changed from Warning to Info, March 2004 (server v2.8.03), since it's common practice to delete a timer that may or may not have fired already.

See also