This is the trivial-timer Reference Manual, version 0.3.10, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:58:34 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-timer
Easy scheduling of tasks (functions).
Eric Diethelm <ediethelm@yahoo.com>
MIT
0.3.10
trivial-utilities
(system).
log4cl
(system).
bordeaux-threads
(system).
chanl
(system).
iterate
(system).
package.lisp
(file).
trivial-timer.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-timer/trivial-timer.lisp
trivial-timer
(system).
*ms-tolerance*
(special variable).
cancel-timer-call
(function).
initialize-timer
(function).
register-timer-call
(function).
register-timer-recurring-call
(function).
shutdown-timer
(function).
*call-id*
(special variable).
*call-queue*
(special variable).
*call-queue-lock*
(special variable).
*ms-to-ticks*
(special variable).
*shutdown-requested*
(special variable).
*thread-pool*
(special variable).
*thread-pool-size*
(special variable).
*ticks-tolerance*
(special variable).
*timer-initialized*
(special variable).
*timer-thread*
(special variable).
call-fn
(reader method).
call-id
(reader method).
call-offset
(reader method).
enqueue
(function).
expected-call-ts
(reader method).
(setf expected-call-ts)
(writer method).
make-thread-pool-thread
(function).
queue
(reader method).
(setf queue)
(writer method).
queue-lock
(reader method).
(setf queue-lock)
(writer method).
queue-size
(reader method).
(setf queue-size)
(writer method).
recurringp
(reader method).
registered-call
(class).
thread
(reader method).
(setf thread)
(writer method).
thread-free?
(function).
threadpool-thread
(class).
timer-process
(function).
Packages are listed by definition order.
trivial-timer
Trivial Timer allows for easy scheduling of tasks (functions). The default tolerance is +- 10ms as defined by **ms-tolerance**.
common-lisp
.
*ms-tolerance*
(special variable).
cancel-timer-call
(function).
initialize-timer
(function).
register-timer-call
(function).
register-timer-recurring-call
(function).
shutdown-timer
(function).
*call-id*
(special variable).
*call-queue*
(special variable).
*call-queue-lock*
(special variable).
*ms-to-ticks*
(special variable).
*shutdown-requested*
(special variable).
*thread-pool*
(special variable).
*thread-pool-size*
(special variable).
*ticks-tolerance*
(special variable).
*timer-initialized*
(special variable).
*timer-thread*
(special variable).
call-fn
(generic reader).
call-id
(generic reader).
call-offset
(generic reader).
enqueue
(function).
expected-call-ts
(generic reader).
(setf expected-call-ts)
(generic writer).
make-thread-pool-thread
(function).
queue
(generic reader).
(setf queue)
(generic writer).
queue-lock
(generic reader).
(setf queue-lock)
(generic writer).
queue-size
(generic reader).
(setf queue-size)
(generic writer).
recurringp
(generic reader).
registered-call
(class).
thread
(generic reader).
(setf thread)
(generic writer).
thread-free?
(function).
threadpool-thread
(class).
timer-process
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Time tolerance (default +/- 10ms)
Cancel a timer call identified by *ID*.
Returns **T** if the call identified by *ID* was removed.
Initialization of trivial-timer. This **MUST** be called before any other function from this library.
Register a function *call* to be executed in *offset* milliseconds from now. If *recurring* is **T** then *call* will be repeated every *offset* milliseconds. Returns the ID of the registration (to be used with *cancel-timer-call*).
Register a function *call* to be (recurrently) executed every *offset* milliseconds. Returns the ID of the registration (to be used with *cancel-timer-call*).
Shutdown the timer. No further calls can be registered. Atention: Stopping is an asynchronous request, meaning that some registered call might still be executed after calling *shutdown-timer*
registered-call
)) ¶automatically generated reader method
registered-call
)) ¶automatically generated reader method
id
.
registered-call
)) ¶automatically generated reader method
registered-call
)) ¶automatically generated reader method
registered-call
)) ¶automatically generated writer method
threadpool-thread
)) ¶automatically generated reader method
threadpool-thread
)) ¶automatically generated writer method
threadpool-thread
)) ¶automatically generated reader method
threadpool-thread
)) ¶automatically generated writer method
threadpool-thread
)) ¶automatically generated reader method
threadpool-thread
)) ¶automatically generated writer method
registered-call
)) ¶automatically generated reader method
threadpool-thread
)) ¶automatically generated reader method
threadpool-thread
)) ¶automatically generated writer method
(unsigned-byte 62)
:expected-call-ts
(unsigned-byte 62)
:offset
This slot is read-only.
boolean
:recurring
This slot is read-only.
fixnum
:queue-size
bordeaux-threads:thread
:thread
chanl:bounded-channel
:queue
bordeaux-threads:lock
:queue-lock
Jump to: | (
C E F G I M Q R S T |
---|
Jump to: | (
C E F G I M Q R S T |
---|
Jump to: | *
C E I O Q R S T |
---|
Jump to: | *
C E I O Q R S T |
---|
Jump to: | C F P R S T |
---|
Jump to: | C F P R S T |
---|