stop

2007-01-10T08:51:00Z

stop()

Stops the periodical executer (there will be no further triggers).

Once a PeriodicalExecuter is created, it constitues an infinite loop, triggering at the given interval until the page unloads. This method lets you stop it any time you want.

While there currently is a registerCallback method that technically re-enables the executer, it is unclear whether it is considered internal (and therefore should not be used as a feature) or not. In doubt, always instantiate a fresh PeriodicalExecuter when you need to start one.

Examples


var gCallCount = 0;
new PeriodicalExecuter(function(pe) {
  if (++gCallCount > 3)
    pe.stop();
  else
    alert(gCallCount);
}, 1);
// Will only alert 1, 2 and 3, then the PE stops.

PeriodicalExecuter

2007-01-10T08:49:00Z

This is a simple facility for periodical execution of a function. This essentially encapsulates the native clearInterval/setInterval mechanism found in native Window objects.

The only notable advantage provided by PeriodicalExecuter is that it shields you against multiple parallel executions of the callback function, should it take longer than the given interval to execute (it maintains an internal “running” flag, which is shielded against exceptions in the callback function). This is especially useful if you use one to interact with the user at given intervals (e.g. use a prompt or confirm call): this will avoid multiple message boxes all waiting to be actioned.

Of course, one might very well argue that using an actual object, not needing to maintain a global interval handle, etc. constitute notable advantages as well.

Creating a `PeriodicalExecuter`

The constructor takes two arguments: the callback function, and the interval (in seconds) between executions. Once launched, a PeriodicalExecuter triggers indefinitely, until the page unloads (which browsers usually take as an opportunity to clear all intervals and timers) or the executer is manually stopped.


// Campfire style :-)
new PeriodicalExecuter(pollChatRoom, 3);

new PeriodicalExecuter(function(pe) {
  if (!confirm('Want me to annoy you again later?'))
    pe.stop();
}, 5);
// Note that there won't be a stack of such messages if the user takes too long
// answering to the question...

Prototype JavaScript framework - PeriodicalExecuter

stop

Examples

PeriodicalExecuter

Creating a PeriodicalExecuter

Creating a `PeriodicalExecuter`