This is the rt-events Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:37:43 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
rt-events
A simple real-time events API.
Nick Patrick <npatrick04@gmail.com>
MIT
This package provides a simple way to communicate event occurances between different threads.
bordeaux-threads
(system).
src
(module).
Modules are listed depth-first from the system components tree.
rt-events/src
rt-events
(system).
package.lisp
(file).
rt-events.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
rt-events/src/rt-events.lisp
src
(module).
*default-condition-type*
(special variable).
+all-events+
(constant).
+event-1+
(constant).
+event-10+
(constant).
+event-11+
(constant).
+event-12+
(constant).
+event-13+
(constant).
+event-14+
(constant).
+event-15+
(constant).
+event-16+
(constant).
+event-17+
(constant).
+event-18+
(constant).
+event-19+
(constant).
+event-2+
(constant).
+event-20+
(constant).
+event-21+
(constant).
+event-22+
(constant).
+event-23+
(constant).
+event-24+
(constant).
+event-25+
(constant).
+event-26+
(constant).
+event-27+
(constant).
+event-28+
(constant).
+event-29+
(constant).
+event-3+
(constant).
+event-30+
(constant).
+event-31+
(constant).
+event-32+
(constant).
+event-33+
(constant).
+event-34+
(constant).
+event-35+
(constant).
+event-36+
(constant).
+event-37+
(constant).
+event-38+
(constant).
+event-39+
(constant).
+event-4+
(constant).
+event-40+
(constant).
+event-41+
(constant).
+event-42+
(constant).
+event-43+
(constant).
+event-44+
(constant).
+event-45+
(constant).
+event-46+
(constant).
+event-47+
(constant).
+event-48+
(constant).
+event-49+
(constant).
+event-5+
(constant).
+event-50+
(constant).
+event-51+
(constant).
+event-52+
(constant).
+event-53+
(constant).
+event-54+
(constant).
+event-55+
(constant).
+event-56+
(constant).
+event-57+
(constant).
+event-58+
(constant).
+event-59+
(constant).
+event-6+
(constant).
+event-60+
(constant).
+event-61+
(constant).
+event-62+
(constant).
+event-7+
(constant).
+event-8+
(constant).
+event-9+
(constant).
+max-events+
(constant).
+no-events+
(constant).
bit->event
(function).
condition-type-t
(type).
event
(class).
event-number->event
(function).
pop-event
(macro).
pop-event-index
(macro).
receive
(generic function).
return-timeout
(function).
send
(generic function).
%receive
(function).
condition-met
(function).
define-constant
(macro).
define-event
(function).
define-event-set
(macro).
event-condition-type
(reader method).
(setf event-condition-type)
(writer method).
event-lock
(reader method).
(setf event-lock)
(writer method).
event-ready
(reader method).
(setf event-ready)
(writer method).
event-receive-set
(reader method).
(setf event-receive-set)
(writer method).
event-wait-set
(reader method).
(setf event-wait-set)
(writer method).
Packages are listed by definition order.
rt-events
common-lisp
.
*default-condition-type*
(special variable).
+all-events+
(constant).
+event-1+
(constant).
+event-10+
(constant).
+event-11+
(constant).
+event-12+
(constant).
+event-13+
(constant).
+event-14+
(constant).
+event-15+
(constant).
+event-16+
(constant).
+event-17+
(constant).
+event-18+
(constant).
+event-19+
(constant).
+event-2+
(constant).
+event-20+
(constant).
+event-21+
(constant).
+event-22+
(constant).
+event-23+
(constant).
+event-24+
(constant).
+event-25+
(constant).
+event-26+
(constant).
+event-27+
(constant).
+event-28+
(constant).
+event-29+
(constant).
+event-3+
(constant).
+event-30+
(constant).
+event-31+
(constant).
+event-32+
(constant).
+event-33+
(constant).
+event-34+
(constant).
+event-35+
(constant).
+event-36+
(constant).
+event-37+
(constant).
+event-38+
(constant).
+event-39+
(constant).
+event-4+
(constant).
+event-40+
(constant).
+event-41+
(constant).
+event-42+
(constant).
+event-43+
(constant).
+event-44+
(constant).
+event-45+
(constant).
+event-46+
(constant).
+event-47+
(constant).
+event-48+
(constant).
+event-49+
(constant).
+event-5+
(constant).
+event-50+
(constant).
+event-51+
(constant).
+event-52+
(constant).
+event-53+
(constant).
+event-54+
(constant).
+event-55+
(constant).
+event-56+
(constant).
+event-57+
(constant).
+event-58+
(constant).
+event-59+
(constant).
+event-6+
(constant).
+event-60+
(constant).
+event-61+
(constant).
+event-62+
(constant).
+event-7+
(constant).
+event-8+
(constant).
+event-9+
(constant).
+max-events+
(constant).
+no-events+
(constant).
bit->event
(function).
condition-type-t
(type).
event
(class).
event-number->event
(function).
pop-event
(macro).
pop-event-index
(macro).
receive
(generic function).
return-timeout
(function).
send
(generic function).
%receive
(function).
condition-met
(function).
define-constant
(macro).
define-event
(function).
define-event-set
(macro).
event-condition-type
(generic reader).
(setf event-condition-type)
(generic writer).
event-lock
(generic reader).
(setf event-lock)
(generic writer).
event-ready
(generic reader).
(setf event-ready)
(generic writer).
event-receive-set
(generic reader).
(setf event-receive-set)
(generic writer).
event-wait-set
(generic reader).
(setf event-wait-set)
(generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
This implementation can pass up to this many events.
Extract the first event in the set, returning it and unsetting it in the original set.
Extract the first event in the set, returning it’s difference from +event-1+. i.e. +event-1+ returns 0, unsetting +event-1+ in the original set. When set is +no-events+, the value returned is +max-events+.
Convert the event number (as in the 1 in +event-1+) to the associated event value. The valid input range for this function is from 1 to +max-events+.
Binding RETURN-TIMEOUT to the BORDEAUX-THREADS:TIMEOUT condition results in the return value :TIMEOUT when receiving an event set.
Attempt to receive an event condition specified by SET.
A CONDITION-TYPE of :ANY and :ALL are used to specify whether a
single event in the set or the complete event set is necessary to
satisfy the event condition.
The TIMEOUT parameter is used to specify whether or not the
thread will wait for the event condition to be satisfied. When
TIMEOUT is set to :NO-WAIT, the calling thread will evaluate the
pending events, returning :UNSATISFIED when the condition is not
met.
When TIMEOUT is :WAIT-FOREVER (default), the calling thread will
become blocked if the pending events do not satisfy the event
condition set. It will remain blocked until a send is performed on
the set that satisfies the event condition.
When the event condition is met, the return value will be the value
corresponding to the events in SET that were satisfied, and the
pending events that were satisfied are cleared. If the thread must
wait for the event condition to be satisfied, then a real value in
the TIMEOUT parameter is used to specify the maximum duration to
wait.
If a timeout is encountered, the BORDEAUX-THREADS:TIMEOUT condition will be raised. The RETURN-TIMEOUT restart may be used to instead cause a timeout to result in a return value of :TIMEOUT.
Send an event to an event object. If a blocked
thread’s event condition is satisfied by this event, then it
will be unblocked.
If the event condition is not satisfied and a thread is pending on
it, then the events satisfied are updated in the event object and
the thread is left pending. If a thread is not pending on the event
object, then the events are updated.
Send returns set.
The current events available for receipt
(quote fixnum)
0
(quote rt-events:condition-type-t)
rt-events:*default-condition-type*
The set used to apply the wait type to~
determine whether or not to return.
(quote fixnum)
0
(bordeaux-threads:make-lock)
(bordeaux-threads:make-condition-variable)
Jump to: | %
(
B C D E F G M P R S |
---|
Jump to: | %
(
B C D E F G M P R S |
---|
Jump to: | *
+
C L R S W |
---|
Jump to: | *
+
C L R S W |
---|
Jump to: | C E F M P R S T |
---|
Jump to: | C E F M P R S T |
---|