The clerk Reference Manual

4.1.1 clerk/clerk.asd

Source

clerk.asd.

Parent Component

clerk (system).

ASDF Systems

clerk.

Packages

clerk-asd.

---

4.1.2 clerk/src/time.lisp

Source

clerk.asd.

Parent Component

src (module).

Packages

clerk.time.

Public Interface

timejump (function).

Internals

• *days-of-the-week* (special variable).
• current-day-of-the-week (function).
• day-as-number (function).
• day-of-the-week-p (function).
• days-to-add (function).
• interval->seconds (function).
• interval-as-list (function).
• interval-as-list-p (function).
• interval-type->seconds (function).
• seconds-to-day-of-the-week (function).
• seconds-to-end-of-the-day (function).
• split-interval (function).

---

4.1.3 clerk/src/clerk.lisp

Source

clerk.asd.

Parent Component

src (module).

Packages

clerk.

Public Interface

• *jobs* (special variable).
• calendar (function).
• empty-jobs-queue (function).
• initialize-instance (method).
• job (macro).
• job (class).
• job-fn (function).
• job-function (function).
• start (function).
• stop (function).

Internals

• *main-thread* (special variable).
• add-to-jobs-queue (function).
• continuous-job (class).
• delay (reader method).
• fire-job (method).
• fire-job (method).
• fire-job-if-needed (function).
• fire-job-p (function).
• fire-time (reader method).
• (setf fire-time) (writer method).
• interval (reader method).
• name (reader method).
• one-time-job (class).
• payload (reader method).
• print-job (generic function).
• process-pairs (function).

---

6.1.1 Special variables

Special Variable: *jobs* ¶

All scheduled jobs

Package

clerk.

Source

clerk.lisp.

---

6.1.2 Macros

Macro: job (name &rest type/interval-pairs-and-body) ¶

Package

clerk.

Source

clerk.lisp.

---

6.1.3 Ordinary functions

Function: calendar (&optional stream) ¶

Print the scheduled jobs

Package

clerk.

Source

clerk.lisp.

Function: empty-jobs-queue () ¶

Package

clerk.

Source

clerk.lisp.

Function: job-fn (name type interval fn) ¶

Package

clerk.

Source

clerk.lisp.

Function: job-function (func &key name in every after) ¶

Package

clerk.

Source

clerk.lisp.

Function: start () ¶

Start the thread that waits for a jobs to fire.

Package

clerk.

Source

clerk.lisp.

Function: stop () ¶

Stop scheduler

Package

clerk.

Source

clerk.lisp.

Function: timejump (start-time interval) ¶

Package

clerk.time.

Source

time.lisp.

---

6.1.4 Standalone methods

Method: initialize-instance :after ((job job) &key) ¶

Source

clerk.lisp.

---

6.1.5 Classes

Class: job ¶

Package

clerk.

Source

clerk.lisp.

Direct subclasses

• continuous-job.
• one-time-job.

Direct methods

• delay.
• fire-job.
• (setf fire-time).
• fire-time.
• initialize-instance.
• name.
• payload.
• print-job.

Direct slots

Slot: name ¶

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: delay ¶

Initargs

:delay

Readers

delay.

Writers

This slot is read-only.

Slot: fire-time ¶

Initargs

:fire-time

Readers

fire-time.

Writers

(setf fire-time).

Slot: payload ¶

Initargs

:payload

Readers

payload.

Writers

This slot is read-only.

---

6.2.1 Special variables

Special Variable: *days-of-the-week* ¶

Package

clerk.time.

Source

time.lisp.

Special Variable: *main-thread* ¶

Package

clerk.

Source

clerk.lisp.

---

6.2.2 Ordinary functions

Function: add-to-jobs-queue (job) ¶

Package

clerk.

Source

clerk.lisp.

Function: current-day-of-the-week () ¶

Returns the current day of the week as an integer. Monday is 0.

Package

clerk.time.

Source

time.lisp.

Function: day-as-number (day-as-symbol) ¶

Package

clerk.time.

Source

time.lisp.

Function: day-of-the-week-p (interval) ¶

Package

clerk.time.

Source

time.lisp.

Function: days-to-add (current target) ¶

Calculates how far are the current day of the week to the target day of the week.

Package

clerk.time.

Source

time.lisp.

Function: fire-job-if-needed () ¶

Package

clerk.

Source

clerk.lisp.

Function: fire-job-p (job) ¶

Check if it is time to fire a job

Package

clerk.

Source

clerk.lisp.

Function: interval->seconds (interval) ¶

Package

clerk.time.

Source

time.lisp.

Function: interval-as-list (interval) ¶

Package

clerk.time.

Source

time.lisp.

Function: interval-as-list-p (interval) ¶

Check if an interval is given as a list

Package

clerk.time.

Source

time.lisp.

Function: interval-type->seconds (interval-type) ¶

Package

clerk.time.

Source

time.lisp.

Function: process-pairs (pairs) ¶

Package

clerk.

Source

clerk.lisp.

Function: seconds-to-day-of-the-week (day-of-the-week) ¶

Returns the seconds to the day of the week

Package

clerk.time.

Source

time.lisp.

Function: seconds-to-end-of-the-day (current) ¶

Package

clerk.time.

Source

time.lisp.

Function: split-interval (interval) ¶

Package

clerk.time.

Source

time.lisp.

---

6.2.3 Generic functions

Generic Reader: delay (object) ¶

Package

clerk.

Methods

Reader Method: delay ((job job)) ¶

automatically generated reader method

Source

clerk.lisp.

Target Slot

delay.

Generic Function: fire-job (job) ¶

Package

clerk.

Methods

Method: fire-job :before ((job continuous-job)) ¶

Create the next job in the job queue when firing continuous jobs.

Source

clerk.lisp.

Method: fire-job ((job job)) ¶

Source

clerk.lisp.

Generic Reader: fire-time (object) ¶

Package

clerk.

Methods

Reader Method: fire-time ((job job)) ¶

automatically generated reader method

Source

clerk.lisp.

Target Slot

fire-time.

Generic Writer: (setf fire-time) (object) ¶

Package

clerk.

Methods

Writer Method: (setf fire-time) ((job job)) ¶

automatically generated writer method

Source

clerk.lisp.

Target Slot

fire-time.

Generic Reader: interval (object) ¶

Package

clerk.

Methods

Reader Method: interval ((continuous-job continuous-job)) ¶

automatically generated reader method

Source

clerk.lisp.

Target Slot

interval.

Generic Reader: name (object) ¶

Package

clerk.

Methods

Reader Method: name ((job job)) ¶

automatically generated reader method

Source

clerk.lisp.

Target Slot

name.

Generic Reader: payload (object) ¶

Package

clerk.

Methods

Reader Method: payload ((job job)) ¶

automatically generated reader method

Source

clerk.lisp.

Target Slot

payload.

Generic Function: print-job (job stream) ¶

Package

clerk.

Source

clerk.lisp.

Methods

Method: print-job ((job continuous-job) stream) ¶

Method: print-job ((job job) stream) ¶

---

6.2.4 Classes

Class: continuous-job ¶

Package

clerk.

Source

clerk.lisp.

Direct superclasses

job.

Direct methods

• fire-job.
• interval.
• print-job.

Direct slots

Slot: interval ¶

Initargs

:interval

Readers

interval.

Writers

This slot is read-only.

Class: one-time-job ¶

Package

clerk.

Source

clerk.lisp.

Direct superclasses

job.

---