schedule-timer

Function

Summary

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

Signature

schedule-timer timerabsolute-expiration-time

&optional repeat-time
=> timer

Package

mp

Arguments

timer

A timer

absolute-expiration-time

A non-negative real

repeat-time

A non-negative real

Values

timer

A timer

Description

The
schedule-timer
function schedules a timer to expire at a given time after the start of the program. The
timer
argument is a timer, returned by make-timer or make-named-timer. The
absolute-expiration-time
argument is a non-negative real number of seconds since the start of the program at which the 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 the timer expires, it is rescheduled to expire after this repeat interval.

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

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

Example

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