This is the laap Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 05:25:58 2023 GMT+0.
laap/laap.asdlaap/core/package.lisplaap/core/laap.lisplaap/core/cffi.lisplaap/core/timer.lisplaap/core/loop.lisplaap/core/thread-pool.lisplaap/core/condition.lisplaap/socket/package.lisplaap/socket/socket.lisplaap/socket/cffi.lisplaap/fs/package.lisplaap/fs/cffi.lisplaap/fs/fs.lispThe main system appears first, followed by any subsystem dependency.
laapA Common Lisp multi-threaded event loop.
Florian Margaine <florian@margaine.com>
MIT
cffi (system).
bordeaux-threads (system).
uiop (system).
cl-ppcre (system).
cl-base32 (system).
Modules are listed depth-first from the system components tree.
laap/corelaap (system).
package.lisp (file).
laap.lisp (file).
cffi.lisp (file).
timer.lisp (file).
loop.lisp (file).
thread-pool.lisp (file).
condition.lisp (file).
laap/socketcore (module).
laap (system).
package.lisp (file).
socket.lisp (file).
cffi.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
laap/laap.asdlaap/core/package.lisplaap/core/laap.lisplaap/core/cffi.lisplaap/core/timer.lisplaap/core/loop.lisplaap/core/thread-pool.lisplaap/core/condition.lisplaap/socket/package.lisplaap/socket/socket.lisplaap/socket/cffi.lisplaap/fs/package.lisplaap/fs/cffi.lisplaap/fs/fs.lisplaap/core/laap.lisppackage.lisp (file).
loop.lisp (file).
timer.lisp (file).
thread-pool.lisp (file).
core (module).
noop (function).
with-event-loop (macro).
*loop* (special variable).
*thread-pool* (special variable).
laap/core/cffi.lisppackage.lisp (file).
core (module).
errno (symbol macro).
%pipe2 (function).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
+clock-monotonic+ (constant).
+ebadf+ (constant).
+eexist+ (constant).
+efault+ (constant).
+eintr+ (constant).
+einval+ (constant).
+eloop+ (constant).
+enoent+ (constant).
+enomem+ (constant).
+enospc+ (constant).
+eperm+ (constant).
+epoll-cloexec+ (constant).
+epoll-ctl-add+ (constant).
+epoll-ctl-del+ (constant).
+epoll-ctl-mod+ (constant).
+epollerr+ (constant).
+epollet+ (constant).
+epollhup+ (constant).
+epollin+ (constant).
+epolloneshot+ (constant).
+epollout+ (constant).
+epollpri+ (constant).
+o-cloexec+ (constant).
+o-nonblock+ (constant).
+tfd-cloexec+ (constant).
c-close (function).
c-write (function).
epoll-create1 (function).
epoll-ctl (function).
epoll-event-tclass (class).
epoll-wait (function).
itimerspec-tclass (class).
pipe (function).
strerror (function).
timerfd-create (function).
timerfd-gettime (function).
timerfd-settime (function).
timespec-tclass (class).
laap/core/timer.lisppackage.lisp (file).
cffi.lisp (file).
core (module).
add-timer (generic function).
callback (reader method).
delay (function).
direction (reader method).
fd (reader method).
handle-error (generic function).
handle-event (generic function).
remove-timer (generic function).
spawn (function).
timer (class).
add-timer-in (function).
closed (reader method).
(setf closed) (writer method).
timer-timer (class).
laap/core/loop.lisppackage.lisp (file).
cffi.lisp (file).
timer.lisp (file).
thread-pool.lisp (file).
condition.lisp (file).
core (module).
*recv-buffer-length* (special variable).
initialize-instance (method).
%add-event (function).
add-event (function).
cores-count (function).
efd (reader method).
(setf efd) (writer method).
event-loop (class).
exit-event-loop-p (function).
find-recv-buffer-length (function).
main-loop (function).
start-event-loops (function).
started (reader method).
(setf started) (writer method).
timers (reader method).
(setf timers) (writer method).
timers-lock (reader method).
(setf timers-lock) (writer method).
laap/core/thread-pool.lisppackage.lisp (file).
condition.lisp (file).
core (module).
add-reporter (function).
callback (reader method).
initialize-instance (method).
initialize-instance (method).
with-blocking-thread (macro).
%add-to-queue (function).
*thread-should-exit* (special variable).
action (class).
action-queue (reader method).
(setf action-queue) (writer method).
action-queue-item (class).
action-queue-lock (reader method).
(setf action-queue-lock) (writer method).
add-thread (function).
add-to-action-queue (function).
add-to-queue (function).
blocking (reader method).
(setf blocking) (writer method).
blocking-action (class).
err (reader method).
event (reader method).
event (reader method).
(setf event) (writer method).
(setf event) (writer method).
event-loop-action (function).
execute (generic function).
getrandom (function).
lock (reader method).
lock (reader method).
(setf lock) (writer method).
(setf lock) (writer method).
max-event-loops (reader method).
(setf max-event-loops) (writer method).
new-thread-action (class).
queue (reader method).
(setf queue) (writer method).
quit-event-loop (function).
reporters (reader method).
(setf reporters) (writer method).
reporters-lock (reader method).
(setf reporters-lock) (writer method).
result (reader method).
(setf result) (writer method).
start-thread-pool (function).
thread (reader method).
thread (reader method).
thread (reader method).
thread-error (class).
thread-pool (class).
thread-properties (class).
threads (reader method).
(setf threads) (writer method).
unblocking-action (class).
wait-from-action-queue (function).
laap/core/condition.lisppackage.lisp (file).
core (module).
epoll-error (condition).
errno (reader method).
os-error (condition).
print-object (method).
laap/socket/socket.lispcffi.lisp (file).
package.lisp (file).
socket (module).
accept (generic function).
close (generic function).
connect (generic function).
handle-error (method).
handle-event (method).
handle-event (method).
handle-event (method).
handle-event (method).
initialize-instance (method).
ipv4-tcp-socket (class).
listen (generic function).
receive (generic function).
send (generic function).
data (reader method).
(setf data) (writer method).
end-callback (reader method).
fd (reader method).
socket (class).
socket-domain (reader method).
socket-protocol (reader method).
socket-timer (class).
socket-type (reader method).
timer-socket-accept (class).
timer-socket-connect (class).
timer-socket-receive (class).
timer-socket-send (class).
laap/socket/cffi.lisppackage.lisp (file).
socket (module).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
+af-inet+ (constant).
+eagain+ (constant).
+einprogress+ (constant).
+epollin+ (constant).
+epollout+ (constant).
+ewouldblock+ (constant).
+f-getfl+ (constant).
+f-setfl+ (constant).
+msg-nosignal+ (constant).
+o-nonblock+ (constant).
+so-error+ (constant).
+sock-nonblock+ (constant).
+sock-stream+ (constant).
+sol-socket+ (constant).
c-accept (function).
c-bind (function).
c-close (function).
c-connect (function).
c-listen (function).
c-recv (function).
c-send (function).
c-socket (function).
errno (symbol macro).
fcntl (function).
getsockopt (function).
htons (function).
in-addr-tclass (class).
inet-aton (function).
sockaddr-in-tclass (class).
strerror (function).
laap/fs/cffi.lisppackage.lisp (file).
fs (module).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
+eintr+ (constant).
+o-create+ (constant).
+o-read-only+ (constant).
+o-read-write+ (constant).
+o-write-only+ (constant).
+path-max+ (constant).
c-close (function).
c-ftruncate (function).
c-link (function).
c-lstat (function).
c-open (function).
c-read (function).
c-readlink (function).
c-rename (function).
c-symlink (function).
c-unlink (function).
c-write (function).
errno (symbol macro).
stat-tclass (class).
strerror (function).
laap/fs/fs.lispcffi.lisp (file).
package.lisp (file).
fs (module).
c-buffer-to-lisp-buffer (function).
direction (reader method).
direction (type).
fd (reader method).
(setf fd) (writer method).
if-does-not-exist (reader method).
(setf if-does-not-exist) (writer method).
if-does-not-exist (type).
lisp-buffer-to-c-buffer (function).
path (reader method).
(setf path) (writer method).
Packages are listed by definition order.
laap/socketcommon-lisp.
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
+af-inet+ (constant).
+eagain+ (constant).
+einprogress+ (constant).
+epollin+ (constant).
+epollout+ (constant).
+ewouldblock+ (constant).
+f-getfl+ (constant).
+f-setfl+ (constant).
+msg-nosignal+ (constant).
+o-nonblock+ (constant).
+so-error+ (constant).
+sock-nonblock+ (constant).
+sock-stream+ (constant).
+sol-socket+ (constant).
c-accept (function).
c-bind (function).
c-close (function).
c-connect (function).
c-listen (function).
c-recv (function).
c-send (function).
c-socket (function).
data (generic reader).
(setf data) (generic writer).
end-callback (generic reader).
errno (symbol macro).
fcntl (function).
fd (generic reader).
getsockopt (function).
htons (function).
in-addr-tclass (class).
inet-aton (function).
sockaddr-in-tclass (class).
socket (class).
socket-domain (generic reader).
socket-protocol (generic reader).
socket-timer (class).
socket-type (generic reader).
strerror (function).
timer-socket-accept (class).
timer-socket-connect (class).
timer-socket-receive (class).
timer-socket-send (class).
laap/fscommon-lisp.
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
+eintr+ (constant).
+o-create+ (constant).
+o-read-only+ (constant).
+o-read-write+ (constant).
+o-write-only+ (constant).
+path-max+ (constant).
c-buffer-to-lisp-buffer (function).
c-close (function).
c-ftruncate (function).
c-link (function).
c-lstat (function).
c-open (function).
c-read (function).
c-readlink (function).
c-rename (function).
c-symlink (function).
c-unlink (function).
c-write (function).
direction (generic reader).
direction (type).
errno (symbol macro).
fd (generic reader).
(setf fd) (generic writer).
if-does-not-exist (generic reader).
(setf if-does-not-exist) (generic writer).
if-does-not-exist (type).
lisp-buffer-to-c-buffer (function).
path (generic reader).
(setf path) (generic writer).
stat-tclass (class).
strerror (function).
laapcommon-lisp.
*recv-buffer-length* (special variable).
add-reporter (function).
add-timer (generic function).
callback (generic reader).
delay (function).
direction (slot).
direction (slot).
direction (slot).
direction (slot).
direction (generic reader).
epoll-error (condition).
errno (symbol macro).
errno (generic reader).
fd (generic reader).
handle-error (generic function).
handle-event (generic function).
noop (function).
os-error (condition).
remove-timer (generic function).
spawn (function).
timer (class).
with-blocking-thread (macro).
with-event-loop (macro).
%add-event (function).
%add-to-queue (function).
%pipe2 (function).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
*loop* (special variable).
*thread-pool* (special variable).
*thread-should-exit* (special variable).
+clock-monotonic+ (constant).
+ebadf+ (constant).
+eexist+ (constant).
+efault+ (constant).
+eintr+ (constant).
+einval+ (constant).
+eloop+ (constant).
+enoent+ (constant).
+enomem+ (constant).
+enospc+ (constant).
+eperm+ (constant).
+epoll-cloexec+ (constant).
+epoll-ctl-add+ (constant).
+epoll-ctl-del+ (constant).
+epoll-ctl-mod+ (constant).
+epollerr+ (constant).
+epollet+ (constant).
+epollhup+ (constant).
+epollin+ (constant).
+epolloneshot+ (constant).
+epollout+ (constant).
+epollpri+ (constant).
+o-cloexec+ (constant).
+o-nonblock+ (constant).
+tfd-cloexec+ (constant).
action (class).
action-queue (generic reader).
(setf action-queue) (generic writer).
action-queue-item (class).
action-queue-lock (generic reader).
(setf action-queue-lock) (generic writer).
add-event (function).
add-thread (function).
add-timer-in (function).
add-to-action-queue (function).
add-to-queue (function).
blocking (generic reader).
(setf blocking) (generic writer).
blocking-action (class).
c-close (function).
c-write (function).
closed (generic reader).
(setf closed) (generic writer).
cores-count (function).
efd (generic reader).
(setf efd) (generic writer).
epoll-create1 (function).
epoll-ctl (function).
epoll-event-tclass (class).
epoll-wait (function).
err (generic reader).
event (generic reader).
(setf event) (generic writer).
event-loop (class).
event-loop-action (function).
execute (generic function).
exit-event-loop-p (function).
find-recv-buffer-length (function).
getrandom (function).
itimerspec-tclass (class).
lock (generic reader).
(setf lock) (generic writer).
main-loop (function).
max-event-loops (generic reader).
(setf max-event-loops) (generic writer).
new-thread-action (class).
pipe (function).
queue (generic reader).
(setf queue) (generic writer).
quit-event-loop (function).
reporters (generic reader).
(setf reporters) (generic writer).
reporters-lock (generic reader).
(setf reporters-lock) (generic writer).
result (generic reader).
(setf result) (generic writer).
start-event-loops (function).
start-thread-pool (function).
started (generic reader).
(setf started) (generic writer).
strerror (function).
thread (generic reader).
thread-error (class).
thread-pool (class).
thread-properties (class).
threads (generic reader).
(setf threads) (generic writer).
timer-timer (class).
timerfd-create (function).
timerfd-gettime (function).
timerfd-settime (function).
timers (generic reader).
(setf timers) (generic writer).
timers-lock (generic reader).
(setf timers-lock) (generic writer).
timespec-tclass (class).
unblocking-action (class).
wait-from-action-queue (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Run code in the laap event loop.
Run a callback in a specified amount of seconds.
laap.
Make a hard-link from newpath to oldpath.
Rename oldpath to newpath.
Make a symbolic link at linkpath pointing to target.
Accept a connection from a socket.
ipv4-tcp-socket) callback &key) ¶Add a timer to the event loop.
laap.
new-thread-action)) ¶automatically generated reader method
Close the socket.
ipv4-tcp-socket) callback &key) ¶Close the backed file.
Connect the socket.
ipv4-tcp-socket) callback &key ip port) ¶Handles an error for a timer.
laap.
socket-timer) error) ¶timer-timer) error) ¶Handles an event for a timer.
laap.
timer-socket-accept)) ¶timer-socket-receive)) ¶timer-socket-send)) ¶timer-socket-connect)) ¶timer-timer)) ¶Listen on a socket.
ipv4-tcp-socket) callback &key ip port backlog) ¶Read a specified amount of bytes from a file.
Receive data from a socket.
ipv4-tcp-socket) callback &key end) ¶Remove a timer from the event loop.
Send data over a socket.
ipv4-tcp-socket) callback &key data) ¶Truncate a file to a specified length.
Write specified data to a file.
ipv4-tcp-socket) &key) ¶thread-pool) &key) ¶event-loop) &key) ¶action-queue-item) &key) ¶laap.
condition.
An object abstracting over a file.
Implementation of an IPv4 TCP socket.
A timer is an object whose file descriptor is added
to epoll, used to maintain the mapping between the file descriptor
and the callback, at the minimum. Other fields can be used for
further synchronization and bookkeeping matters.
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
thread-properties)) ¶automatically generated reader method
laap.
thread-properties)) ¶automatically generated writer method
timer-socket-send)) ¶automatically generated reader method
data.
timer-socket-send)) ¶automatically generated writer method
data.
laap.
event-loop)) ¶automatically generated reader method
laap.
event-loop)) ¶automatically generated writer method
timer-socket-receive)) ¶automatically generated reader method
laap.
thread-error)) ¶automatically generated reader method
err.
laap.
action-queue-item)) ¶automatically generated reader method
thread-pool)) ¶automatically generated reader method
laap.
action-queue-item)) ¶automatically generated writer method
thread-pool)) ¶automatically generated writer method
Execute an action.
laap.
unblocking-action)) ¶blocking-action)) ¶thread-error)) ¶new-thread-action)) ¶laap.
action-queue-item)) ¶automatically generated reader method
lock.
thread-pool)) ¶automatically generated reader method
lock.
laap.
action-queue-item)) ¶automatically generated writer method
lock.
thread-pool)) ¶automatically generated writer method
lock.
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
action-queue-item)) ¶automatically generated reader method
laap.
action-queue-item)) ¶automatically generated writer method
laap.
event-loop)) ¶automatically generated reader method
laap.
event-loop)) ¶automatically generated writer method
laap.
unblocking-action)) ¶automatically generated reader method
blocking-action)) ¶automatically generated reader method
thread-error)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated reader method
laap.
thread-pool)) ¶automatically generated writer method
laap.
event-loop)) ¶automatically generated reader method
laap.
event-loop)) ¶automatically generated writer method
laap.
event-loop)) ¶automatically generated reader method
laap.
event-loop)) ¶automatically generated writer method
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
An object abstracting over a socket.
A socket-based event loop timer.
laap.
Event loop timer for the socket’s accept method.
Event loop timer for the socket’s connect method.
Event loop timer for the socket’s receive method.
:end-callback
This slot is read-only.
Event loop timer for the socket’s send method.
A POSIX timer-based timer. Used to run callbacks in a given amount of time.
| Jump to: | %
(
A B C D E F G H I L M N P Q R S T U W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N P Q R S T U W |
|---|
| Jump to: | *
+
A B C D E F I L M P Q R S T |
|---|
| Jump to: | *
+
A B C D E F I L M P Q R S T |
|---|
| Jump to: | A B C D E F I L M N O P S T U |
|---|
| Jump to: | A B C D E F I L M N O P S T U |
|---|