Time events in Javascript

From Yate Documentation
Revision as of 16:32, 31 October 2013 by Monica (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Timers in Javascript are used to callback a method at a certain time interval. Timeout method creates an one shoot time event.

You can use this methods instead of using engine.timer message.

This events are used to make an action in a certain period of time.

Timer and Timeouts in JavaScript

The Engine class from JavaScript has 4 methods to process and cancel timeouts:

Note: The time interval values are in milliseconds.
  • Engine.setInterval(callback,expireInterval)

This method will create a repeated time event. Each time expireInterval passes, callback method is called.

This method returns an id which can be used to cancel the timer with the help of Engine.clearInterval method.

  • Engine.clearInterval(id)

This method clears a time event installed with Engine.setInterval method.

The id parameter represents the value returned by Engine.setInterval method.

The method returns true if the time event was cleared.

  • Engine.setTimeout(callback,expireInterval)

This method creates an one shoot time event. After the expireInterval has passed the callback method is called; after this the time event is cleared.

This method returns an id, which can be used to clear the timeout event.

  • Engine.clearTimeout(id)

This method clears a time event installed with Engine.setTimeout method.


In the example below the method intervalCallback will be called each second.

The timeoutCallback method will be called after 10 seconds and will clear the interval timeout. So after 10 seconds no message will be shown.

var intervalId;

function timeoutCallback() {
    Engine.debug(Engine.DebugAll,"Got timeout event!");

function intervalCallback() {
    Engine.debug(Engine.DebugAll,"Got interval event!");

intervalId = Engine.setInterval(intervalCallback,1000);

See also

Personal tools