This is the cl-cron Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:06:50 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-cronA simple tool that provides cron like facilities directly inside of common lisp. For this to work properly note that your lisp implementation should have support for threads
Mackram G Raydan
GPL
0.1
bordeaux-threads (system).
packages.lisp (file).
cl-cron.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-cron/cl-cron.lisppackages.lisp (file).
cl-cron (system).
*cron-load-file* (special variable).
*cron-log-file* (special variable).
delete-cron-job (function).
gen-list (function).
log-cron-message (function).
make-cron-job (function).
max-list (function).
min-list (function).
restart-cron (function).
start-cron (function).
stop-cron (function).
*cron-dispatcher-processing* (special variable).
*cron-dispatcher-thread* (special variable).
*cron-jobs-hash* (special variable).
*day-list* (special variable).
*month-list* (special variable).
cron-dispatcher (function).
cron-job (class).
current-time-as-str (function).
def-cron-get-methods (macro).
elements-within-step (function).
expand-internal-lists (function).
get-days-of-month (function).
get-days-of-week (function).
get-hours (function).
get-minutes (function).
get-months (function).
job-@boot (reader method).
(setf job-@boot) (writer method).
job-dom (reader method).
(setf job-dom) (writer method).
job-dow (reader method).
(setf job-dow) (writer method).
job-func (reader method).
(setf job-func) (writer method).
job-hour (reader method).
(setf job-hour) (writer method).
job-minute (reader method).
(setf job-minute) (writer method).
job-month (reader method).
(setf job-month) (writer method).
run-job-if-boot (function).
run-job-if-time (function).
time-to-run-job (function).
time-until-full-minute (function).
Packages are listed by definition order.
cl-croncron
common-lisp.
*cron-load-file* (special variable).
*cron-log-file* (special variable).
delete-cron-job (function).
gen-list (function).
log-cron-message (function).
make-cron-job (function).
max-list (function).
min-list (function).
restart-cron (function).
start-cron (function).
stop-cron (function).
*cron-dispatcher-processing* (special variable).
*cron-dispatcher-thread* (special variable).
*cron-jobs-hash* (special variable).
*day-list* (special variable).
*month-list* (special variable).
cron-dispatcher (function).
cron-job (class).
current-time-as-str (function).
def-cron-get-methods (macro).
elements-within-step (function).
expand-internal-lists (function).
get-days-of-month (function).
get-days-of-week (function).
get-hours (function).
get-minutes (function).
get-months (function).
job-@boot (generic reader).
(setf job-@boot) (generic writer).
job-dom (generic reader).
(setf job-dom) (generic writer).
job-dow (generic reader).
(setf job-dow) (generic writer).
job-func (generic reader).
(setf job-func) (generic writer).
job-hour (generic reader).
(setf job-hour) (generic writer).
job-minute (generic reader).
(setf job-minute) (generic writer).
job-month (generic reader).
(setf job-month) (generic writer).
run-job-if-boot (function).
run-job-if-time (function).
time-to-run-job (function).
time-until-full-minute (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
a parameter which points to a lisp or fasl file which would be loaded once start-cron is called. The boot file should be made of as many make-cron-job calls as you like one after the other in normal s-expression fashion.
a parameter to set the cron file log location.
deletes the cron job with the corresponding hash key
functions that returns a list of numbers starting with start-list and ending with end-list
Simply log the message sent with type as well
creates a new instance of a cron-job object and appends it to the cron-jobs-list after processing its time. Note that if you wish to use multiple values for each parameter you need to provide a list of numbers or use the gen-list function. You can not have a list of symbols when it comes to month or day-of-week. Please note that as by ANSI Common Lisp for the month variable the possible values are between 1 and 12 inclusive with January=1 and for day of week the possible values are between 0 and 6 with Monday=0. Returns the hash-key
finds the minimum element of a list
finds the minimum element of a list
function that starts up cron but without loading the file or running any of the boot only cron jobs in the list
function that starts cron by first loading the cron file defined in the variable, then it runs any cron-job that has the job-only-at-boot property set to t. Finally, it starts a thread that runs cron-dispatcher
allows the stoppage of cron through the killing of the cron-dispatcher. Note that cron-dispatcher is killed only if it is sleeping otherwise we wait till the cron jobs finish. To reuse cron after calling stop-cron, you would need to recall start-cron which would go through all the steps as if cron has just booted. If you wish to prevent these actions when you restart cron then please you restart-cron.
allows us to not kill the thread unless the lock can be acquired
a parameter to that holds the cron-dispatcher thread
contains a hash of all cron-job objects that need to be run
function that dispatches the jobs that are ready to be run
function that returns a list of elements that are within a step from each other starting with the first element in the list
function that takes a list and returns a list but with all internal lists expanded
runs the cron-job object in a separate thread if it is a boot job
runs the cron-job object in a separate thread if it is its time
checks if it is time to run the current job based on the current time
:every
:job-minute
:every
:job-hour
:every
:job-dom
:every
:job-month
:every
:job-dow
:job-@boot
:job-func
| Jump to: | (
C D E F G J L M R S T |
|---|
| Jump to: | (
C D E F G J L M R S T |
|---|
| Jump to: | *
A D F H M S |
|---|
| Jump to: | *
A D F H M S |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|