This is the cl-schedule Reference Manual, version 0.0.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:01:23 2022 GMT+0.
Next: Modules, Previous: The cl-schedule Reference Manual, Up: The cl-schedule Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
cl-schedule is a cron-like scheduling library in
common-lisp. It subsumes and replaces traditional cron managers
thanks to richer expressiveness of Lisp.
Gábor Melis <mega@retes.hu>
Jin-Cheng Guu <jcguu95@gmail.com>
MIT
0.0.6
src (module).
Next: Files, Previous: Systems, Up: The cl-schedule Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
cl-schedule (system).
Next: Packages, Previous: Modules, Up: The cl-schedule Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-schedule/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-schedule (system).
Next: cl-schedule/src/user.lisp, Previous: cl-schedule/cl-schedule.asd, Up: Lisp [Contents][Index]
src (module).
Next: cl-schedule/src/cl-schedule.lisp, Previous: cl-schedule/src/package.lisp, Up: Lisp [Contents][Index]
src (module).
Previous: cl-schedule/src/user.lisp, Up: Lisp [Contents][Index]
src (module).
Next: Definitions, Previous: Files, Up: The cl-schedule Reference Manual [Contents][Index]
Packages are listed by definition order.
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-schedule Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
The default time limit for NEXT-TIME searches.
Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Dry-run N times for the schedule defined by the SCHEDULE-DEFINITION.
Schedule the FORM to be run with NAME and time spec TIME.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Return the first valid value not less than VALUE that is of TYPE.
Construct a cron-like scheduler from the SECOND, MINUTE, etc
bumpers for components of decoded times (using the default time zone
for the time being). A bumper in its most generic from a function of
three arguments: the current value, the whole decoded time, and the
index of the current value in the decoded time. A bumper is expected
to return the smallest value that is valid for that component and not
less than the current value or NIL if it cannot find a valid value.
Returning a value that is smaller than the current one is the same as
returning NIL. A bumper can simply be a number which is equivalent to
(CONSTANTLY NUMBER).
Bumpers are not allowed to depend on ‘lower’ components of the decoded
time. The allowed dependency graph is this:
SECOND -> MINUTE -> HOUR -> (DAY-OF-MONTH <-> DAY-OF-WEEK) -> MONTH -> YEAR
That is, the SECOND bumper may look at the whole decoded time but the
MINUTE bumper may not look at seconds. DAY-OF-WEEK and DAY-OF-MONTH
may depend on each other to allow specifying the ’last Friday of the
month’.
The resolution of the schedule is defined implicitly by the lowest
bumper. NEXT-TIME always bumps the component of the decoded time that
belongs to the lowest bumper before trying to find mathces if its
LAST-TIME argument is not NIL. Of course, DAY-OF-WEEK is the odd one
out: it is the day-of-month component that is bumped if DAY-OF-WEEK is
the lowest bumper.
This scheme allows (MAKE-CRON-SCHEDULE :MONTH 12) trigger only once
per year instead of every second in December. For a more packed
schedule one can use the symbol ’* as a bumper: (MAKE-CRON-SCHEDULE
:HOUR ’* :MONTH 12) which makes hour the lowest bumper and the
schedule triggers every hour in December.
It is an error if all bumpers are NIL.
Return a ‘scheduler’ function of no arguments that returns times
from init-time on by repeatedly calling NEXT-TIME on SCHEDULE. ALLOW-NOW-P
is passed to the first invocation of NEXT-TIME.
Return a bumper function suitable for MAKE-CRON-SCHEDULE that returns the first valid value according to TYPE. Convenience function on top of FIND-DECODED-TIME-COMPONENT-BY-TYPE.
A convenience function much like MAKE-CRON-SCHEDULE but assumes that no bumper can be a function designator so it must be a number, the symbol * or a type specifier in which case it calls MAKE-TYPED-CRON-BUMPER on it providing a terser syntax.
Create a timer just as with TRIVIAL-TIMERS:MAKE-TIMER but schedule
and reschedule FUNCTION according to SCHEDULER that is a function of
no parameters that returns a universal time or NIL. The returned timer
can be shut down with TRIVIAL-TIMERS:UNSCHEDULE-TIMER.
If IMMEDIATE is NON-NIL, call the FUNCTION immediately after
this function is called. Otherwise, call the FUNCTION at the next
time given by the SCHEDULER.
If IGNORE-SKIPPED is NON-NIL, ignore the skipped jobs and emits
warnings accordingly. Otherwise, call the FUNCTION immediately
for each skipped instance. IGNORE-SKIPPED is by default set as
NIL for backward compatibility.
Next: Classes, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Return the next time according to SCHEDULE or
NIL if there is no next time. If ALLOW-NOW-P the earliest
possible time to be returned is INIT-TIME, else it is usually
INIT-TIME + the resolution of the schedule. The default value of
INIT-TIME is (GET-UNIVERSAL-TIME), ALLOW-NOW-P is NIL and LIMIT
is *DEFAULT-NEXT-TIME-LIMIT*
Previous: Generic functions, Up: Public Interface [Contents][Index]
A cron-like schedule. See MAKE-CRON-SCHEDULE for details.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
Extra hair due to the circular dependency between DAY-OF-MONTH and DAY-OF-WEEK bumpers. This function rolls the two bumpers into one.
Increment the Nth component of decoded TIME, handle overflows, zero the lower components. Return changed decoded time and the highest index that was changed.
Bump the lowest component of decoded TIME that has a bumper. Return it as a universal time.
Return the index of the decoded time component that is effect by bumper I. Day of week is lumped together with day of month.
Return the number of days in the month DECODED-TIME.
Return the decoded time components as a list instead of multiple values.
Encode DECODED-TIME that is a decoded time in list form such as one that was returned by DECODE-UNIVERSAL-TIME*.
Return the the index of what is basically the root of current dependency graph.
Return the largest valid value for the Nth component of DECODED-TIME or NIL if there is no limit. Passing DECODED-TIME is necessary only for the day of month component because the number of days in a month varies.
Return the smallest valid value for the Nth decoded time component.
Invoke BUMPER on the Nth component of DECODED-TIME. Return its value if it can ever be valid (not necessarily in the context of DECODED-TIME) or else NIL.
See if value can ever be a valid value as the Nth component of a decoded time.
Set the first N components of DECODED-TIME to their MIN-VALID-DECODED-TIME-COMPONENT values.
Previous: Ordinary functions, Up: Internals [Contents][Index]
The bumpers in decoded time component order.
Previous: Definitions, Up: The cl-schedule Reference Manual [Contents][Index]
| Jump to: | A B D E F G L M N S U V Z |
|---|
| Jump to: | A B D E F G L M N S U V Z |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | *
B S |
|---|
| Jump to: | *
B S |
|---|
| Jump to: | C F M P S U |
|---|
| Jump to: | C F M P S U |
|---|