The simple-tasks Reference Manual

This is the simple-tasks Reference Manual, version 1.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:17:15 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 simple-tasks

A very simple task scheduling framework.

Maintainer

Nicolas Hafner <>

Author

Nicolas Hafner <>

Home Page

https://Shinmera.github.io/simple-tasks/

Source Control

(GIT https://github.com/Shinmera/simple-tasks.git)

Bug Tracker

https://github.com/Shinmera/simple-tasks/issues

License

zlib

Version

1.3.0

Dependencies
  • bordeaux-threads (system).
  • array-utils (system).
  • dissect (system).
Source

simple-tasks.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 simple-tasks/simple-tasks.asd

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

ASDF Systems

simple-tasks.


3.1.2 simple-tasks/package.lisp

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Packages

simple-tasks.


3.1.3 simple-tasks/toolkit.lisp

Dependency

package.lisp (file).

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Public Interface

3.1.4 simple-tasks/status.lisp

Dependency

toolkit.lisp (file).

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Public Interface
Internals

status-list-p (function).


3.1.5 simple-tasks/runner.lisp

Dependency

status.lisp (file).

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Public Interface
Internals

3.1.6 simple-tasks/task.lisp

Dependency

runner.lisp (file).

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Public Interface

3.1.7 simple-tasks/documentation.lisp

Dependency

task.lisp (file).

Source

simple-tasks.asd.

Parent Component

simple-tasks (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 simple-tasks

Source

package.lisp.

Nickname

org.shirakumo.simple-tasks

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *runner*

Bound to the current runner if within a runner context. Otherwise, set to NIL. Useful to detect if a task is run in a particular runner to avoid conflicts.

Package

simple-tasks.

Source

runner.lisp.

Special Variable: +no-threading-stump+

Constant to hold an instance of NO-THREADING-STUMP.

Package

simple-tasks.

Source

toolkit.lisp.

Special Variable: +status-ended+

Constant matching any ended (not necessarily successful) status.

:STOPPING Object is in the process of being stopped. :STOPPED Object has been stopped.
:COMPLETED Object successfully completed execution. :ERRORED Object ended execution with an error.

Package

simple-tasks.

Source

status.lisp.

Special Variable: +status-running+

Constant matching a running status.

:RUNNING Object is currently executing.

Package

simple-tasks.

Source

status.lisp.

Special Variable: +status-started+

Constant matching any started (not necessarily running) status.

:CREATED Object has been initialized, but not started. :SCHEDULED Object has been scheduled for execution. :RUNNING Object is currently executing.

Package

simple-tasks.

Source

status.lisp.


5.1.2 Macros

Macro: with-body-as-task ((runner &optional task-class) &body body)

Evaluate BODY within a task, usually a BLOCKING-CALL-TASK.

See CALL-AS-TASK

Package

simple-tasks.

Source

task.lisp.


5.1.3 Ordinary functions

Function: call-as-task (function runner &optional task-class)

Call function within a task, usually a BLOCKING-CALL-TASK.
Depending on the task’s STATUS after SCHEDULE-TASK returns, the following happens. :COMPLETED The task’s return values are returned.
:ERRORED A condition of type TASK-ERRORED is signalled.
T The task is returned.

See SCHEDULE-TASK
See BLOCKING-CALL-TASK

Package

simple-tasks.

Source

task.lisp.

Function: make-runner-thread (runner)

Make a thread to call START-RUNNER on RUNNER in.

On platforms with thread support, this returns the new thread.
On platforms without, this simply calls START-RUNNER and returns NIL.

See START-RUNNER

Package

simple-tasks.

Source

runner.lisp.


5.1.4 Generic functions

Generic Function: await (task status)

Wait for the TASK to match a certain STATUS.

On systems without thread support this does nothing.

See STATUS=

Package

simple-tasks.

Source

task.lisp.

Methods
Method: await ((task notifying-task) status)
Method: await ((task task) status)
Generic Reader: back-queue (runner)

The current back-queue of the runner.

Used to swap with QUEUE when events are handled.

See QUEUE

Package

simple-tasks.

Source

runner.lisp.

Methods
Reader Method: back-queue ((queued-runner queued-runner))

automatically generated reader method

Target Slot

back-queue.

Generic Reader: callback (callback-task)

The function to call upon completion of the task.

See CALLBACK-TASK

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: callback ((callback-task callback-task))

automatically generated reader method

Target Slot

callback.

Generic Writer: (setf callback) (object)
Package

simple-tasks.

Methods
Writer Method: (setf callback) ((callback-task callback-task))

automatically generated writer method

Source

task.lisp.

Target Slot

callback.

Generic Reader: cvar (object)

The condition variable used to exchange signals.

See QUEUED-RUNNER
See BLOCKING-CALL-TASK

Package

simple-tasks.

Source

runner.lisp.

Methods
Reader Method: cvar ((notifying-task notifying-task))

automatically generated reader method

Source

task.lisp.

Target Slot

cvar.

Reader Method: cvar ((queued-runner queued-runner))

automatically generated reader method

Target Slot

cvar.

Generic Writer: (setf cvar) (object)
Package

simple-tasks.

Methods
Writer Method: (setf cvar) ((notifying-task notifying-task))

automatically generated writer method

Source

task.lisp.

Target Slot

cvar.

Generic Reader: error-environment (task)

An environment object that is stored in case the task fails to run properly.

See DISSECT:ENVIRONMENT

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: error-environment ((task task))

automatically generated reader method

Target Slot

error-environment.

Generic Writer: (setf error-environment) (object)
Package

simple-tasks.

Methods
Writer Method: (setf error-environment) ((task task))

automatically generated writer method

Source

task.lisp.

Target Slot

error-environment.

Generic Reader: func (call-task)

The function the call-task calls once it is run.

See CALL-TASK

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: func ((call-task call-task))

automatically generated reader method

Target Slot

func.

Generic Writer: (setf func) (object)
Package

simple-tasks.

Methods
Writer Method: (setf func) ((call-task call-task))

automatically generated writer method

Source

task.lisp.

Target Slot

func.

Generic Function: interrupt-task (task runner)

Interrupt the TASK to stop it from execution on RUNNER.

If the task is currently on the RUNNER’s queue to be executed (:SCHEDULED), it is removed from the queue. If the task is currently running, it is forcibly aborted. In either case, the task’s status is changed to :STOPPED and it will not execute further. On systems without thread support this does nothing.

If this is called with the RUNNER being T, the current runner of the TASK is used, if possible. If this is called with the RUNNER being NIL, the actual termination mechanism for the task is performed, leading it to be terminated.

Package

simple-tasks.

Source

runner.lisp.

Methods
Method: interrupt-task ((task task) (true (eql t)))
Source

task.lisp.

Method: interrupt-task ((task task) (null null))
Source

task.lisp.

Method: interrupt-task (task (runner queued-runner))
Method: interrupt-task (task (runner runner))
Generic Reader: lock (object)

The lock used to coordinate task scheduling with the runner.

See QUEUED-RUNNER

Package

simple-tasks.

Source

runner.lisp.

Methods
Reader Method: lock ((notifying-task notifying-task))

automatically generated reader method

Source

task.lisp.

Target Slot

lock.

Reader Method: lock ((queued-runner queued-runner))

automatically generated reader method

Target Slot

lock.

Generic Writer: (setf lock) (object)
Package

simple-tasks.

Methods
Writer Method: (setf lock) ((notifying-task notifying-task))

automatically generated writer method

Source

task.lisp.

Target Slot

lock.

Generic Reader: queue (runner)

The current task queue of the runner.

Do not directly push tasks to this! Use SCHEDULE-TASK instead.
This queue is also NOT indicative of which tasks have yet to be run, or which ones have. When the queued runner runs, it retains the current queue for processing and sets a new, empty queue on the runner. As such, when you look at the queue at any particular moment, tasks that are not in it might not have run yet.

Package

simple-tasks.

Source

runner.lisp.

Methods
Reader Method: queue ((queued-runner queued-runner))

automatically generated reader method

Target Slot

queue.

Generic Function: return-values (call-task)

Returns the values that the call returned.

See CALL-TASK

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: return-values :around ((task call-task))
Target Slot

return-values.

Method: return-values ((call-task call-task))

automatically generated reader method

Generic Writer: (setf return-values) (object)
Package

simple-tasks.

Methods
Writer Method: (setf return-values) ((call-task call-task))

automatically generated writer method

Source

task.lisp.

Target Slot

return-values.

Generic Function: run-task (task)

Run the given task object directly.

One restart is established:
STOP to forcibly stop (interrupt) the task. Assigns the :STOPPED status.

Package

simple-tasks.

Source

runner.lisp.

Methods
Method: run-task :after ((task callback-task))
Source

task.lisp.

Method: run-task :around ((task notifying-task))
Source

task.lisp.

Method: run-task ((task call-task))
Source

task.lisp.

Method: run-task :around ((task task))
Source

task.lisp.

Generic Reader: runner (task)

The runner the task is scheduled on.

See TASK

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: runner ((task task))

automatically generated reader method

Target Slot

runner.

Reader Method: runner ((condition runner-condition))
Source

runner.lisp.

Target Slot

runner.

Generic Writer: (setf runner) (condition)
Package

simple-tasks.

Methods
Writer Method: (setf runner) ((task task))

automatically generated writer method

Source

task.lisp.

Target Slot

runner.

Writer Method: (setf runner) ((condition runner-condition))
Source

runner.lisp.

Target Slot

runner.

Generic Function: schedule-task (task runner)

Schedule the task object for running.
The task may or may not be run immediately, depending on the runner and given system support. Tasks are guaranteed to be run in the same order as they are scheduled.

See RUN-TASK

Package

simple-tasks.

Source

runner.lisp.

Methods
Method: schedule-task :after ((task blocking-task) runner)
Source

task.lisp.

Method: schedule-task ((task blocking-task) runner)
Source

task.lisp.

Method: schedule-task :around ((task blocking-task) runner)
Source

task.lisp.

Method: schedule-task :before ((task task) runner)
Source

task.lisp.

Method: schedule-task (task (runner queued-runner))
Method: schedule-task (task (runner runner))
Method: schedule-task :before (task (runner runner))
Generic Function: start-runner (runner)

Start the the runner.

Package

simple-tasks.

Source

runner.lisp.

Methods
Method: start-runner ((runner queued-runner))
Method: start-runner ((runner runner))
Method: start-runner :around ((runner runner))
Method: start-runner :before ((runner runner))
Generic Reader: status (status-object)

Current status indicator of the status-object.

Package

simple-tasks.

Source

status.lisp.

Methods
Reader Method: status ((status-object status-object))

automatically generated reader method

Target Slot

status.

Generic Writer: (setf status) (object)
Package

simple-tasks.

Methods
Writer Method: (setf status) ((status-object status-object))

automatically generated writer method

Source

status.lisp.

Target Slot

status.

Generic Function: status= (a b)

Compare two statuses with each other (commutative).

Package

simple-tasks.

Source

status.lisp.

Methods
Method: status= ((a list) (b list))
Method: status= (b (a status-object))
Method: status= ((b list) (a status-object))
Method: status= ((a status-object) b)
Method: status= ((a status-object) (b list))
Method: status= ((a status-object) (b status-object))
Generic Function: stop-runner (runner)

Stop the the runner.

Package

simple-tasks.

Source

runner.lisp.

Methods
Method: stop-runner ((runner queued-runner))
Method: stop-runner ((runner runner))
Method: stop-runner :before ((runner runner))
Generic Reader: task (task-condition)

The task related to the condition.

Package

simple-tasks.

Source

task.lisp.

Methods
Reader Method: task ((condition task-condition))
Target Slot

task.

Generic Writer: (setf task) (condition)
Package

simple-tasks.

Methods
Writer Method: (setf task) ((condition task-condition))
Source

task.lisp.

Target Slot

task.

Generic Function: task-ready-p (task)

Returns T if the task is ready to be run.

Package

simple-tasks.

Source

task.lisp.

Methods
Method: task-ready-p ((task task))
Generic Reader: thread (object)

Returns the current thread associated with the queued-runner if any.

See QUEUED-RUNNER

Package

simple-tasks.

Source

runner.lisp.

Methods
Reader Method: thread ((queued-runner queued-runner))

automatically generated reader method

Target Slot

thread.


5.1.5 Standalone methods

Method: print-object ((task call-task) stream)
Source

task.lisp.

Method: print-object ((o no-threading-stump) stream)
Source

toolkit.lisp.

Method: print-object ((runner runner) stream)
Source

runner.lisp.

Method: print-object ((task task) stream)
Source

task.lisp.


5.1.6 Conditions

Condition: runner-condition

Condition superclass for conditions related to runner operations.

Package

simple-tasks.

Source

runner.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:runner(error runner required.)
Direct slots
Slot: runner
Initargs

:runner

Readers

runner.

Writers

(setf runner).

Condition: runner-not-started

Condition signalled when the runner is not yet started, but has to be.

Package

simple-tasks.

Source

runner.lisp.

Direct superclasses
Condition: runner-not-stopped

Condition signalled when the runner did not stop properly.

Package

simple-tasks.

Source

runner.lisp.

Direct superclasses
Condition: task-already-scheduled

Condition signalled when attempting to reschedule an already scheduled task.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses
Condition: task-condition

Condition superclass for task operation related conditions.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:task(error task required.)
Direct slots
Slot: task
Initargs

:task

Readers

task.

Writers

(setf task).

Condition: task-errored

Condition signalled when a task failed to run properly.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

5.1.7 Classes

Class: blocking-call-task

Task class to perform a function call once run. Blocks the scheduling thread until it is done.

See CALL-TASK
See BLOCKING-TASK

Package

simple-tasks.

Source

task.lisp.

Direct superclasses
Class: blocking-task

A task that will block after being scheduled until it is done or interrupted.

When SCHEDULE-TASK is called on this, it establishes two restarts:
ABORT to forcibly abort (interrupt) the task.
UNBLOCK to resume execution in the current thread and leave the task running.

If a restart or similar exit functionality is invoked that leaves the scope of SCHEDULE-TASK, the task is interrupted.

Note that the restarts are not useful on systems without thread support. In such a case the task will be interrupted either way, due to the very nature of running in the current thread.

See AWAIT
See INTERRUPT-TASK
See NOTIFYING-TASK

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

notifying-task.

Direct subclasses

blocking-call-task.

Direct methods
Class: call-task

Task class to perform a function call once run. Stores the return values.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

task.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:func(error func required.)
Direct slots
Slot: func
Initargs

:func

Readers

func.

Writers

(setf func).

Slot: return-values
Readers

return-values.

Writers

(setf return-values).

Class: callback-task

Task class to perform a function call once run and call a callback upon completion.

If the task completes successfully, the callback function is called with each return value as an argument. Note that the callback function is called within the runner environment which may be different from the scheduler environment.

See CALL-TASK

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

call-task.

Direct methods
Direct Default Initargs
InitargValue
:callback(error callback required.)
Direct slots
Slot: callback
Initargs

:callback

Readers

callback.

Writers

(setf callback).

Class: no-threading-stump

Stump class to stand in place of a value on systems without threading support.

Package

simple-tasks.

Source

toolkit.lisp.

Direct methods

print-object.

Class: notifying-task

A task that will notify a condition upon completion.

This is particularly useful in conjunction with AWAIT.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

task.

Direct subclasses

blocking-task.

Direct methods
Direct Default Initargs
InitargValue
:lock(make-lock notifying-task)
:cvar(make-condition-variable name notifying-task)
Direct slots
Slot: lock
Initargs

:lock

Readers

lock.

Writers

(setf lock).

Slot: cvar
Initargs

:cvar

Readers

cvar.

Writers

(setf cvar).

Class: queued-runner

Queued runner. Runs tasks in a thread if threading is available. Noe that START-RUNNER for this runner will block the current thread.

Package

simple-tasks.

Source

runner.lisp.

Direct superclasses

runner.

Direct methods
Direct Default Initargs
InitargValue
:queue(make-array 100 adjustable t fill-pointer 0)
:back-queue(make-array 100 adjustable t fill-pointer 0)
:lock(make-lock task-runner-queue-lock)
:cvar(make-condition-variable name task-runner-condition)
:threadnil
Direct slots
Slot: queue
Initargs

:queue

Readers

queue.

Writers

%set-queue.

Slot: back-queue
Initargs

:back-queue

Readers

back-queue.

Writers

%set-back-queue.

Slot: lock
Initargs

:lock

Readers

lock.

Writers

This slot is read-only.

Slot: cvar
Initargs

:cvar

Readers

cvar.

Writers

This slot is read-only.

Slot: thread
Initargs

:thread

Readers

thread.

Writers

%set-thread.

Class: runner

Basic runner. Runs task as soon as scheduled.

Package

simple-tasks.

Source

runner.lisp.

Direct superclasses

status-object.

Direct subclasses

queued-runner.

Direct methods
Class: status-object

A class that has a status.

Package

simple-tasks.

Source

status.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: status
Initform

:created

Readers

status.

Writers

(setf status).

Class: task

Basic task class.

Package

simple-tasks.

Source

task.lisp.

Direct superclasses

status-object.

Direct subclasses
Direct methods
Direct slots
Slot: runner
Readers

runner.

Writers

(setf runner).

Slot: error-environment
Readers

error-environment.

Writers

(setf error-environment).


5.1.8 Types

Type: status ()

A status can be a SYMBOL, a STATUS-OBJECT, or a LIST composed of SYMBOLs.

Package

simple-tasks.

Source

status.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *current-queue*

Bound to either NIL or the current queue being processed by the queued-runner.

See QUEUED-RUNNER

Package

simple-tasks.

Source

runner.lisp.

Special Variable: *current-task*

Bound to either NIL or the current task being processed by the queued-runner.

Package

simple-tasks.

Source

runner.lisp.


5.2.2 Macros

Macro: setdocs (&body pairs)

Easily set the documentation.

Package

simple-tasks.

Source

documentation.lisp.


5.2.3 Ordinary functions

Function: checkdocs (&optional package)

Check that all functions, classes, and variables have docstrings.

Package

simple-tasks.

Source

documentation.lisp.

Function: status-list-p (list)

Returns true if every element in the list is a symbol and the list thus qualifies as a STATUS.

Package

simple-tasks.

Source

status.lisp.


5.2.4 Generic functions

Generic Writer: %set-back-queue (new-value object)
Package

simple-tasks.

Methods
Writer Method: %set-back-queue ((new-value queued-runner) queued-runner)

automatically generated writer method

Source

runner.lisp.

Target Slot

back-queue.

Generic Writer: %set-queue (new-value object)
Package

simple-tasks.

Methods
Writer Method: %set-queue ((new-value queued-runner) queued-runner)

automatically generated writer method

Source

runner.lisp.

Target Slot

queue.

Generic Writer: %set-thread (new-value object)
Package

simple-tasks.

Methods
Writer Method: %set-thread ((new-value queued-runner) queued-runner)

automatically generated writer method

Source

runner.lisp.

Target Slot

thread.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   E   F   G   I   L   M   P   Q   R   S   T   W  
Index Entry  Section

%
%set-back-queue: Private generic functions
%set-back-queue: Private generic functions
%set-queue: Private generic functions
%set-queue: Private generic functions
%set-thread: Private generic functions
%set-thread: Private generic functions

(
(setf callback): Public generic functions
(setf callback): Public generic functions
(setf cvar): Public generic functions
(setf cvar): Public generic functions
(setf error-environment): Public generic functions
(setf error-environment): Public generic functions
(setf func): Public generic functions
(setf func): Public generic functions
(setf lock): Public generic functions
(setf lock): Public generic functions
(setf return-values): Public generic functions
(setf return-values): Public generic functions
(setf runner): Public generic functions
(setf runner): Public generic functions
(setf runner): Public generic functions
(setf status): Public generic functions
(setf status): Public generic functions
(setf task): Public generic functions
(setf task): Public generic functions

A
await: Public generic functions
await: Public generic functions
await: Public generic functions

B
back-queue: Public generic functions
back-queue: Public generic functions

C
call-as-task: Public ordinary functions
callback: Public generic functions
callback: Public generic functions
checkdocs: Private ordinary functions
cvar: Public generic functions
cvar: Public generic functions
cvar: Public generic functions

E
error-environment: Public generic functions
error-environment: Public generic functions

F
func: Public generic functions
func: Public generic functions
Function, call-as-task: Public ordinary functions
Function, checkdocs: Private ordinary functions
Function, make-runner-thread: Public ordinary functions
Function, status-list-p: Private ordinary functions

G
Generic Function, %set-back-queue: Private generic functions
Generic Function, %set-queue: Private generic functions
Generic Function, %set-thread: Private generic functions
Generic Function, (setf callback): Public generic functions
Generic Function, (setf cvar): Public generic functions
Generic Function, (setf error-environment): Public generic functions
Generic Function, (setf func): Public generic functions
Generic Function, (setf lock): Public generic functions
Generic Function, (setf return-values): Public generic functions
Generic Function, (setf runner): Public generic functions
Generic Function, (setf status): Public generic functions
Generic Function, (setf task): Public generic functions
Generic Function, await: Public generic functions
Generic Function, back-queue: Public generic functions
Generic Function, callback: Public generic functions
Generic Function, cvar: Public generic functions
Generic Function, error-environment: Public generic functions
Generic Function, func: Public generic functions
Generic Function, interrupt-task: Public generic functions
Generic Function, lock: Public generic functions
Generic Function, queue: Public generic functions
Generic Function, return-values: Public generic functions
Generic Function, run-task: Public generic functions
Generic Function, runner: Public generic functions
Generic Function, schedule-task: Public generic functions
Generic Function, start-runner: Public generic functions
Generic Function, status: Public generic functions
Generic Function, status=: Public generic functions
Generic Function, stop-runner: Public generic functions
Generic Function, task: Public generic functions
Generic Function, task-ready-p: Public generic functions
Generic Function, thread: Public generic functions

I
interrupt-task: Public generic functions
interrupt-task: Public generic functions
interrupt-task: Public generic functions
interrupt-task: Public generic functions
interrupt-task: Public generic functions

L
lock: Public generic functions
lock: Public generic functions
lock: Public generic functions

M
Macro, setdocs: Private macros
Macro, with-body-as-task: Public macros
make-runner-thread: Public ordinary functions
Method, %set-back-queue: Private generic functions
Method, %set-queue: Private generic functions
Method, %set-thread: Private generic functions
Method, (setf callback): Public generic functions
Method, (setf cvar): Public generic functions
Method, (setf error-environment): Public generic functions
Method, (setf func): Public generic functions
Method, (setf lock): Public generic functions
Method, (setf return-values): Public generic functions
Method, (setf runner): Public generic functions
Method, (setf runner): Public generic functions
Method, (setf status): Public generic functions
Method, (setf task): Public generic functions
Method, await: Public generic functions
Method, await: Public generic functions
Method, back-queue: Public generic functions
Method, callback: Public generic functions
Method, cvar: Public generic functions
Method, cvar: Public generic functions
Method, error-environment: Public generic functions
Method, func: Public generic functions
Method, interrupt-task: Public generic functions
Method, interrupt-task: Public generic functions
Method, interrupt-task: Public generic functions
Method, interrupt-task: Public generic functions
Method, lock: Public generic functions
Method, lock: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, queue: Public generic functions
Method, return-values: Public generic functions
Method, return-values: Public generic functions
Method, run-task: Public generic functions
Method, run-task: Public generic functions
Method, run-task: Public generic functions
Method, run-task: Public generic functions
Method, runner: Public generic functions
Method, runner: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, schedule-task: Public generic functions
Method, start-runner: Public generic functions
Method, start-runner: Public generic functions
Method, start-runner: Public generic functions
Method, start-runner: Public generic functions
Method, status: Public generic functions
Method, status=: Public generic functions
Method, status=: Public generic functions
Method, status=: Public generic functions
Method, status=: Public generic functions
Method, status=: Public generic functions
Method, status=: Public generic functions
Method, stop-runner: Public generic functions
Method, stop-runner: Public generic functions
Method, stop-runner: Public generic functions
Method, task: Public generic functions
Method, task-ready-p: Public generic functions
Method, thread: Public generic functions

P
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

Q
queue: Public generic functions
queue: Public generic functions

R
return-values: Public generic functions
return-values: Public generic functions
return-values: Public generic functions
run-task: Public generic functions
run-task: Public generic functions
run-task: Public generic functions
run-task: Public generic functions
run-task: Public generic functions
runner: Public generic functions
runner: Public generic functions
runner: Public generic functions

S
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
schedule-task: Public generic functions
setdocs: Private macros
start-runner: Public generic functions
start-runner: Public generic functions
start-runner: Public generic functions
start-runner: Public generic functions
start-runner: Public generic functions
status: Public generic functions
status: Public generic functions
status-list-p: Private ordinary functions
status=: Public generic functions
status=: Public generic functions
status=: Public generic functions
status=: Public generic functions
status=: Public generic functions
status=: Public generic functions
status=: Public generic functions
stop-runner: Public generic functions
stop-runner: Public generic functions
stop-runner: Public generic functions
stop-runner: Public generic functions

T
task: Public generic functions
task: Public generic functions
task-ready-p: Public generic functions
task-ready-p: Public generic functions
thread: Public generic functions
thread: Public generic functions

W
with-body-as-task: Public macros


A.3 Variables

Jump to:   *   +  
B   C   E   F   L   Q   R   S   T  
Index Entry  Section

*
*current-queue*: Private special variables
*current-task*: Private special variables
*runner*: Public special variables

+
+no-threading-stump+: Public special variables
+status-ended+: Public special variables
+status-running+: Public special variables
+status-started+: Public special variables

B
back-queue: Public classes

C
callback: Public classes
cvar: Public classes
cvar: Public classes

E
error-environment: Public classes

F
func: Public classes

L
lock: Public classes
lock: Public classes

Q
queue: Public classes

R
return-values: Public classes
runner: Public conditions
runner: Public classes

S
Slot, back-queue: Public classes
Slot, callback: Public classes
Slot, cvar: Public classes
Slot, cvar: Public classes
Slot, error-environment: Public classes
Slot, func: Public classes
Slot, lock: Public classes
Slot, lock: Public classes
Slot, queue: Public classes
Slot, return-values: Public classes
Slot, runner: Public conditions
Slot, runner: Public classes
Slot, status: Public classes
Slot, task: Public conditions
Slot, thread: Public classes
Special Variable, *current-queue*: Private special variables
Special Variable, *current-task*: Private special variables
Special Variable, *runner*: Public special variables
Special Variable, +no-threading-stump+: Public special variables
Special Variable, +status-ended+: Public special variables
Special Variable, +status-running+: Public special variables
Special Variable, +status-started+: Public special variables
status: Public classes

T
task: Public conditions
thread: Public classes


A.4 Data types

Jump to:   B   C   D   F   N   P   Q   R   S   T  
Index Entry  Section

B
blocking-call-task: Public classes
blocking-task: Public classes

C
call-task: Public classes
callback-task: Public classes
Class, blocking-call-task: Public classes
Class, blocking-task: Public classes
Class, call-task: Public classes
Class, callback-task: Public classes
Class, no-threading-stump: Public classes
Class, notifying-task: Public classes
Class, queued-runner: Public classes
Class, runner: Public classes
Class, status-object: Public classes
Class, task: Public classes
Condition, runner-condition: Public conditions
Condition, runner-not-started: Public conditions
Condition, runner-not-stopped: Public conditions
Condition, task-already-scheduled: Public conditions
Condition, task-condition: Public conditions
Condition, task-errored: Public conditions

D
documentation.lisp: The simple-tasks/documentation․lisp file

F
File, documentation.lisp: The simple-tasks/documentation․lisp file
File, package.lisp: The simple-tasks/package․lisp file
File, runner.lisp: The simple-tasks/runner․lisp file
File, simple-tasks.asd: The simple-tasks/simple-tasks․asd file
File, status.lisp: The simple-tasks/status․lisp file
File, task.lisp: The simple-tasks/task․lisp file
File, toolkit.lisp: The simple-tasks/toolkit․lisp file

N
no-threading-stump: Public classes
notifying-task: Public classes

P
Package, simple-tasks: The simple-tasks package
package.lisp: The simple-tasks/package․lisp file

Q
queued-runner: Public classes

R
runner: Public classes
runner-condition: Public conditions
runner-not-started: Public conditions
runner-not-stopped: Public conditions
runner.lisp: The simple-tasks/runner․lisp file

S
simple-tasks: The simple-tasks system
simple-tasks: The simple-tasks package
simple-tasks.asd: The simple-tasks/simple-tasks․asd file
status: Public types
status-object: Public classes
status.lisp: The simple-tasks/status․lisp file
System, simple-tasks: The simple-tasks system

T
task: Public classes
task-already-scheduled: Public conditions
task-condition: Public conditions
task-errored: Public conditions
task.lisp: The simple-tasks/task․lisp file
toolkit.lisp: The simple-tasks/toolkit․lisp file
Type, status: Public types