GBBopen 1.4 Reference -- schedule-function

schedule-function

schedule-function name-or-scheduled-function invocation-time &key marker repeat-interval verbose [Function]

Purpose
Schedule a scheduled function at an absolute invocation time.

Package :portable-threads

Module :portable-threads

Arguments and values

name-or-scheduled-function		An object (typically a string or a symbol) naming a currently scheduled scheduled function or a `scheduled-function` object
invocation-time		A universal time
marker		An object (default is `nil`)
repeat-interval		A positive integer (representing seconds) or `nil` (default is `nil`)
verbose		A generalized boolean (default is *schedule-function-verbose*)

Errors
Threads (multiprocessing) is not supported on the Common Lisp implementation.

Description
If the scheduled function is unscheduled, the scheduled-function object must be specified as the name-or-scheduled-function value. In this case, the scheduled function it is added to the list of currently scheduled scheduled functions with the specified invocation-time and optional repeat-interval, if specified.

If the scheduled-function object is currently scheduled, either the scheduled-function object or the optional name value that was specified when the scheduled-function object was created with make-scheduled-function can be specified as the name-or-scheduled-function value. If a name is specified as the name-or-scheduled-function value and more than one scheduled function with the specified name is currently scheduled, the scheduled function with the earliest invocation time is selected. If an optional marker value was specified along with name when the scheduled-function object was created with make-scheduled-function, the marker value can also be specified to restrict the selected scheduled function to the one with the earliest invocation time that matches both the name and marker values. The selected scheduled function is first unscheduled and then rescheduled with the specified invocation-time and optional repeat-interval, if specified.

Examples
Schedule a scheduled function that simply prints "Happy New Year!" at midnight (local time) on January 1, 2010:

  > (schedule-function
      (make-scheduled-function
        #'(lambda (scheduled-function)
            (declare (ignore scheduled-function))
            (print "Happy New Year!")))
       (encode-universal-time 0 0 0 1 1 2010))
  > (all-scheduled-functions)
  (#<scheduled-function nil [Jan 1, 2010 00:00:00]>)
  >

Schedule a scheduled function that prints

"It's quitting
time!"

every day at 5pm:

  > (schedule-function
      (make-scheduled-function
        #'(lambda (scheduled-function)
            (declare (ignore scheduled-function))
            (print "It's quitting time!"))
        :name 'quitting-time)
       (encode-time-of-day 17 0 0) :repeat-interval #.(* 24 60 60))
  >

Verbosely change quitting-time to 5:30pm every day:

  > (schedule-function 'quitting-time (encode-time-of-day 17 30 0)
      :repeat-interval #.(* 24 60 60)
      :verbose 't)
  ;; Unscheduling #<scheduled-function quitting-time [17:00:00]>...
  ;; Scheduling #<scheduled-function quitting-time [17:30:00]> 
  ;; as the next scheduled-function...
  >

The GBBopen Project

schedule-function