timer - Tool

Postscript file available

Execute functions periodically, wait for a specified time

include "timer.g"

Constructors
Functions

execute	execute a function periodically
remove	remove a callback function from the timer
wait	wait a specified amount of time

Description
timer is an tool which is used to execute a function periodically (or once after a timeout), or to wait for a specified period of time.

timer is a single tool, only one will be created in a given glish session. The timer is created the first time timer.g is included in a glish session.

Example
We can implement a simple ``reminder'' as follows:

- reminder := function(interval, name) { print 'Do not forget your meeting!'; }
-                                                # Run reminder every 5 minutes
- id := timer.execute(reminder, interval=300, oneshot=F)
- ... time passes ... the following message comes up every 5 minutes
Do not forget your meeting!
- ...
- timer.remove(id);   # Turn off reminder

Next: timer.execute - Function Up: misc - Module Previous: plugins.attach - Function Contents Index

	Package	utility
	Module	misc