This is the rate-monotonic Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:32:47 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
rate-monotonic
A periodic thread scheduler inspired by RTEMS.
Nick Patrick <npatrick04@gmail.com>
GPL-v3
bordeaux-threads
(system).
timer-wheel
(system).
src
(module).
Modules are listed depth-first from the system components tree.
rate-monotonic/src
rate-monotonic
(system).
package.lisp
(file).
statistics.lisp
(file).
rate-monotonic.lisp
(file).
timer-period.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
rate-monotonic/rate-monotonic.asd
rate-monotonic/src/package.lisp
rate-monotonic/src/statistics.lisp
rate-monotonic/src/rate-monotonic.lisp
rate-monotonic/src/timer-period.lisp
rate-monotonic/rate-monotonic.asd
rate-monotonic
(system).
rate-monotonic/src/statistics.lisp
src
(module).
print-object
(method).
reset-statistics
(function).
stat-count
(reader).
(setf stat-count)
(writer).
stat-last-start
(reader).
(setf stat-last-start)
(writer).
stat-max-runtime
(reader).
(setf stat-max-runtime)
(writer).
stat-min-runtime
(reader).
(setf stat-min-runtime)
(writer).
stat-missed-count
(reader).
(setf stat-missed-count)
(writer).
stat-total-runtime
(reader).
(setf stat-total-runtime)
(writer).
copy-stat
(function).
make-stat
(function).
stat
(structure).
stat-p
(function).
update-statistics
(function).
rate-monotonic/src/rate-monotonic.lisp
src
(module).
cancel
(generic function).
finish-period
(generic function).
period
(generic function).
period
(class).
period-statistics
(reader method).
(setf period-statistics)
(writer method).
state
(type).
status
(generic function).
period-interval
(reader method).
(setf period-interval)
(writer method).
period-name
(reader method).
(setf period-name)
(writer method).
period-state
(reader method).
(setf period-state)
(writer method).
rate-monotonic/src/timer-period.lisp
src
(module).
cancel
(method).
finish-period
(method).
make-timer-period
(function).
period
(method).
period
(method).
period
(method).
status
(method).
timer-period-init
(function).
timer-period-stop
(function).
with-timer-period
(macro).
*timer-wheel*
(special variable).
make-timer-period-timeout
(function).
timer-cv
(reader method).
(setf timer-cv)
(writer method).
timer-lock
(reader method).
(setf timer-lock)
(writer method).
timer-period
(class).
timer-period-timer
(reader method).
(setf timer-period-timer)
(writer method).
Packages are listed by definition order.
rate-monotonic
rm
common-lisp
.
cancel
(generic function).
finish-period
(generic function).
make-timer-period
(function).
period
(generic function).
period
(class).
period-statistics
(generic reader).
(setf period-statistics)
(generic writer).
reset-statistics
(function).
stat-count
(reader).
(setf stat-count)
(writer).
stat-last-start
(reader).
(setf stat-last-start)
(writer).
stat-max-runtime
(reader).
(setf stat-max-runtime)
(writer).
stat-min-runtime
(reader).
(setf stat-min-runtime)
(writer).
stat-missed-count
(reader).
(setf stat-missed-count)
(writer).
stat-total-runtime
(reader).
(setf stat-total-runtime)
(writer).
state
(type).
status
(generic function).
timer-period-init
(function).
timer-period-stop
(function).
with-timer-period
(macro).
*timer-wheel*
(special variable).
copy-stat
(function).
make-stat
(function).
make-timer-period-timeout
(function).
period-interval
(generic reader).
(setf period-interval)
(generic writer).
period-name
(generic reader).
(setf period-name)
(generic writer).
period-state
(generic reader).
(setf period-state)
(generic writer).
stat
(structure).
stat-p
(function).
timer-cv
(generic reader).
(setf timer-cv)
(generic writer).
timer-lock
(generic reader).
(setf timer-lock)
(generic writer).
timer-period
(class).
timer-period-timer
(generic reader).
(setf timer-period-timer)
(generic writer).
update-statistics
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Execute BODY with the *TIMER-WHEEL* initialized and running.
A helper function to make a timer period object.
Reset the values in a STAT struct.
Initialize the underlying *TIMER-WHEEL* with provided RESOLUTION-MS and WHEEL-SIZE.
Shut down the underlying *TIMER-WHEEL*.
Cancel a period, putting it into the inactive state.
timer-period
)) ¶Complete a running PERIOD without restarting it. The period
will not block on this call. The return value is :SUCCESSFUL when calling
prior to the previous interval.
If a running period interval has already elapsed, the call returns :TIMEOUT.
This does essentially the same thing as CANCEL, but this captures statistics.
timer-period
)) ¶Initiate a PERIOD with the provided INTERVAL. If a PERIOD is
already running, then the thread will block for the remainder of the interval
at which point the thread is unblocked for the new duration. The return value
is :SUCCESSFUL when initiating or calling prior to the previous interval.
If a running period interval has already elapsed, the period is re-initiated
with the new interval, and the call returns :TIMEOUT.
TYPE can be one of the following:
- :TICKS - INTERVAL is an unsigned integer indicating an interval in the
underlying resolution.
- :SECONDS - INTERVAL is a real value.
- :MS - INTERVAL is an integral millisecond interval.
timer-period
) (type (eql :ms)
) interval) ¶timer-period
) (type (eql :seconds)
) interval) ¶timer-period
) (type (eql :ticks)
) interval) ¶Return the status of the period in 2 values.
- State - :EXPIRED, :READY, :INACTIVE, or :RUNNING
- Time since last period.
timer-period
)) ¶""
:name
(quote rate-monotonic:state)
:inactive
(rate-monotonic::make-stat)
:interval
An internal function that returns a timeout lambda for the given TIMER-PERIOD.
Update STAT object with internal-real-time deltat THIS-TIME for a period.
timer-period
)) ¶automatically generated reader method
cv
.
timer-period
)) ¶automatically generated writer method
cv
.
timer-period
)) ¶automatically generated reader method
lock
.
timer-period
)) ¶automatically generated writer method
lock
.
timer-period
)) ¶automatically generated reader method
timer-period
)) ¶automatically generated writer method
structure-object
.
common-lisp
.
0
0
0
0
0
0
Jump to: | (
C F G M P R S T U W |
---|
Jump to: | (
C F G M P R S T U W |
---|
Jump to: | *
C I L M N S T |
---|
Jump to: | *
C I L M N S T |
---|
Jump to: | C F M P R S T |
---|
Jump to: | C F M P R S T |
---|