schedule-timer Function

Summary

Schedules a timer to expire at a given time after the start of the program.

Package

mp

Signature

schedule-timer timer absolute-expiration-time &optional repeat-time => timer

Arguments

Values

Description

The function schedule-timer schedules a timer to expire at a given time after the start of the program. timer is a timer, returned by make-timer or make-named-timer. absolute-expiration-time is a non-negative real number of seconds since the start of the program at which timer is to expire. If repeat-time is specified, it is a non-negative real number of seconds that specifies a repeat interval. Each time timer expires, it is rescheduled to expire after this repeat interval.

If timer is already scheduled to expire at the time this function is called, it is rescheduled to expire at the time specified by absolute-expiration-time. If that argument is nil, timer is not rescheduled, but the repeat interval is set to the interval specified by repeat-time.

If timer is not scheduled or has already expired and absolute-expiration-time is nil and repeat-time is non-nil, then timer is scheduled to the current time plus repeat-time. Note: this is new in LispWorks 8.0. In previous versions, this would have signaled an error.

The function schedule-timer-relative schedules a timer to expire at a time relative to the call to that function.

Examples

The following example schedules a timer to expire 15 minutes after the start of the program and every 5 minutes thereafter.

(setq timer
      (mp:make-timer 'print 10 *standard-output*))

#<Time Event : PRINT>

(mp:schedule-timer timer 900 300)

#<Time Event : PRINT>

See also

make-named-timer
make-timer
schedule-timer-milliseconds
schedule-timer-relative
schedule-timer-relative-milliseconds
timer-expired-p
timer-name
unschedule-timer
19.9 Timers