The laap Reference Manual

Table of Contents

The laap Reference Manual

This is the laap Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:34:57 2021 GMT+0.

1 Introduction

laap

A Common Lisp multi-threaded event loop.

From micro-benchmarks run on a random laptop (i.e. ballpark numbers to give a rough idea), a small HTTP server could handle:

• laap: ~35k requests/sec
• cl-async: ~3k requests/sec
• Golang: ~125k requests/sec
• Aerys: ~30k requests/sec
• Node.js: ~3k requests/sec

Tested on linux/sbcl x86-64 only. (But definitely open to compatibility fixes.)

What motivated the creation of this library:

• Lack of filesystem I/O support on the cl-async library.
• Lack of native Common Lisp event loop library. (To the author's knowledge.)

Getting started

(laap:with-event-loop
  (let ((socket (make-instance 'laap/socket:ipv4-tcp-socket)))
	(laap/socket:connect socket
						 (lambda (err res)
						   (when err (error err))
						   (laap/socket:send socket
											 :data (babel:string-to-octets "foo")))
											 :ip "127.0.0.1"
											 :port 80)))

This snippet creates a TCP socket to 127.0.0.1:80 and send the string foo to it.

More examples in the t/ folder.

Features

Currently, laap supports:

• Sleeping
• Most operations for TCP IPv4 sockets.
• Most filesystem I/O operations.

laap plans on supporting the following features:

• All filesystem I/O operations.
• A built-in DNS resolver.
• Support for TCP IPv4 sockets options.
• Support for UDP/IPv6/Unix sockets.

API

The API is based on callbacks. All the callbacks must accept 2 arguments: an error (possibly nil) and a result (possibly nil too). This allows for easy wrapping around the callbacks.

Core

TODO.

Sockets

TODO.

Filesystem

TODO.

Internal

TODO.

License

This library is provided under the MIT license. See LICENSE.

2 Systems

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

2.1 laap

Author

Florian Margaine <florian@margaine.com>

License

MIT

Description

A Common Lisp multi-threaded event loop.

Dependencies

• cffi
• bordeaux-threads
• uiop
• cl-ppcre
• cl-base32

Source

laap.asd (file)

Components

• core (module)
• socket (module)
• fs (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 laap/core

Parent

laap (system)

Location

core/

Components

• package.lisp (file)
• laap.lisp (file)
• cffi.lisp (file)
• timer.lisp (file)
• loop.lisp (file)
• thread-pool.lisp (file)
• condition.lisp (file)

3.2 laap/socket

Dependency

core (module)

Parent

laap (system)

Location

socket/

Components

• package.lisp (file)
• socket.lisp (file)
• cffi.lisp (file)

3.3 laap/fs

Dependency

socket (module)

Parent

laap (system)

Location

fs/

Components

• package.lisp (file)
• cffi.lisp (file)
• fs.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 laap.asd

Location

laap.asd

Systems

laap (system)

4.1.2 laap/core/package.lisp

Parent

core (module)

Location

core/package.lisp

Packages

laap

4.1.3 laap/core/laap.lisp

Dependencies

• package.lisp (file)
• loop.lisp (file)
• timer.lisp (file)
• thread-pool.lisp (file)

Parent

core (module)

Location

core/laap.lisp

Exported Definitions

• noop (function)
• with-event-loop (macro)

Internal Definitions

• *loop* (special variable)
• *thread-pool* (special variable)

4.1.4 laap/core/cffi.lisp

Dependency

package.lisp (file)

Parent

core (module)

Location

core/cffi.lisp

Exported Definitions

errno (symbol macro)

Internal Definitions

• %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)

4.1.5 laap/core/timer.lisp

Dependencies

• package.lisp (file)
• cffi.lisp (file)

Parent

core (module)

Location

core/timer.lisp

Exported Definitions

• add-timer (generic function)
• add-timer (method)
• callback (method)
• delay (function)
• direction (method)
• fd (method)
• handle-error (generic function)
• handle-error (method)
• handle-event (generic function)
• handle-event (method)
• remove-timer (generic function)
• remove-timer (method)
• spawn (function)
• timer (class)

Internal Definitions

• add-timer-in (function)
• closed (method)
• (setf closed) (method)
• timer-timer (class)

4.1.6 laap/core/loop.lisp

Dependencies

• package.lisp (file)
• cffi.lisp (file)
• timer.lisp (file)
• thread-pool.lisp (file)
• condition.lisp (file)

Parent

core (module)

Location

core/loop.lisp

Exported Definitions

*recv-buffer-length* (special variable)

Internal Definitions

• %add-event (function)
• add-event (function)
• cores-count (function)
• efd (method)
• (setf efd) (method)
• event-loop (class)
• exit-event-loop-p (function)
• find-recv-buffer-length (function)
• main-loop (function)
• start-event-loops (function)
• started (method)
• (setf started) (method)
• timers (method)
• (setf timers) (method)
• timers-lock (method)
• (setf timers-lock) (method)

4.1.7 laap/core/thread-pool.lisp

Dependencies

• package.lisp (file)
• condition.lisp (file)

Parent

core (module)

Location

core/thread-pool.lisp

Exported Definitions

• add-reporter (function)
• callback (method)
• with-blocking-thread (macro)

Internal Definitions

• %add-to-queue (function)
• *thread-should-exit* (special variable)
• action (class)
• action-queue (method)
• (setf action-queue) (method)
• action-queue-item (class)
• action-queue-lock (method)
• (setf action-queue-lock) (method)
• add-thread (function)
• add-to-action-queue (function)
• add-to-queue (function)
• blocking (method)
• (setf blocking) (method)
• blocking-action (class)
• err (method)
• event (method)
• (setf event) (method)
• event (method)
• (setf event) (method)
• event-loop-action (function)
• execute (generic function)
• execute (method)
• execute (method)
• execute (method)
• execute (method)
• getrandom (function)
• lock (method)
• (setf lock) (method)
• lock (method)
• (setf lock) (method)
• max-event-loops (method)
• (setf max-event-loops) (method)
• new-thread-action (class)
• queue (method)
• (setf queue) (method)
• quit-event-loop (function)
• reporters (method)
• (setf reporters) (method)
• reporters-lock (method)
• (setf reporters-lock) (method)
• result (method)
• (setf result) (method)
• start-thread-pool (function)
• thread (method)
• thread (method)
• thread (method)
• thread-error (class)
• thread-pool (class)
• thread-properties (class)
• threads (method)
• (setf threads) (method)
• unblocking-action (class)
• wait-from-action-queue (function)

4.1.8 laap/core/condition.lisp

Dependency

package.lisp (file)

Parent

core (module)

Location

core/condition.lisp

Exported Definitions

• epoll-error (condition)
• errno (method)
• os-error (condition)

4.1.9 laap/socket/package.lisp

Parent

socket (module)

Location

socket/package.lisp

Packages

laap/socket

4.1.10 laap/socket/socket.lisp

Dependencies

• cffi.lisp (file)
• package.lisp (file)

Parent

socket (module)

Location

socket/socket.lisp

Exported Definitions

• accept (generic function)
• accept (method)
• close (generic function)
• close (method)
• connect (generic function)
• connect (method)
• handle-error (method)
• handle-event (method)
• handle-event (method)
• handle-event (method)
• handle-event (method)
• ipv4-tcp-socket (class)
• listen (generic function)
• listen (method)
• receive (generic function)
• receive (method)
• send (generic function)
• send (method)

Internal Definitions

• data (method)
• (setf data) (method)
• end-callback (method)
• fd (method)
• socket (class)
• socket-domain (method)
• socket-protocol (method)
• socket-timer (class)
• socket-type (method)
• timer-socket-accept (class)
• timer-socket-connect (class)
• timer-socket-receive (class)
• timer-socket-send (class)

4.1.11 laap/socket/cffi.lisp

Dependency

package.lisp (file)

Parent

socket (module)

Location

socket/cffi.lisp

Internal Definitions

• %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)

4.1.12 laap/fs/package.lisp

Parent

fs (module)

Location

fs/package.lisp

Packages

laap/fs

4.1.13 laap/fs/cffi.lisp

Dependency

package.lisp (file)

Parent

fs (module)

Location

fs/cffi.lisp

Internal Definitions

• %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)

4.1.14 laap/fs/fs.lisp

Dependencies

• cffi.lisp (file)
• package.lisp (file)

Parent

fs (module)

Location

fs/fs.lisp

Exported Definitions

• close (generic function)
• close (method)
• file (class)
• link (function)
• read (generic function)
• read (method)
• readlink (function)
• rename (function)
• symlink (function)
• truncate (generic function)
• truncate (method)
• unlink (function)
• write (generic function)
• write (method)

Internal Definitions

• c-buffer-to-lisp-buffer (function)
• direction (method)
• direction (type)
• fd (method)
• (setf fd) (method)
• if-does-not-exist (method)
• (setf if-does-not-exist) (method)
• if-does-not-exist (type)
• lisp-buffer-to-c-buffer (function)
• path (method)
• (setf path) (method)

5 Packages

Packages are listed by definition order.

5.1 laap

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *recv-buffer-length* (special variable)
• add-reporter (function)
• add-timer (generic function)
• add-timer (method)
• callback (generic function)
• callback (method)
• callback (method)
• delay (function)
• direction (generic function)
• direction (method)
• epoll-error (condition)
• errno (symbol macro)
• errno (generic function)
• errno (method)
• fd (generic function)
• fd (method)
• handle-error (generic function)
• handle-error (method)
• handle-error (method)
• handle-event (generic function)
• handle-event (method)
• handle-event (method)
• handle-event (method)
• handle-event (method)
• handle-event (method)
• noop (function)
• os-error (condition)
• remove-timer (generic function)
• remove-timer (method)
• spawn (function)
• timer (class)
• with-blocking-thread (macro)
• with-event-loop (macro)

Internal Definitions

• %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 function)
• action-queue (method)
• (setf action-queue) (method)
• (setf action-queue) (generic function)
• action-queue-item (class)
• action-queue-lock (generic function)
• action-queue-lock (method)
• (setf action-queue-lock) (method)
• (setf action-queue-lock) (generic function)
• add-event (function)
• add-thread (function)
• add-timer-in (function)
• add-to-action-queue (function)
• add-to-queue (function)
• blocking (generic function)
• blocking (method)
• (setf blocking) (method)
• (setf blocking) (generic function)
• blocking-action (class)
• c-close (function)
• c-write (function)
• closed (generic function)
• closed (method)
• (setf closed) (method)
• (setf closed) (generic function)
• cores-count (function)
• efd (generic function)
• efd (method)
• (setf efd) (method)
• (setf efd) (generic function)
• epoll-create1 (function)
• epoll-ctl (function)
• epoll-event-tclass (class)
• epoll-wait (function)
• err (generic function)
• err (method)
• event (generic function)
• event (method)
• (setf event) (method)
• event (method)
• (setf event) (method)
• (setf event) (generic function)
• event-loop (class)
• event-loop-action (function)
• execute (generic function)
• execute (method)
• execute (method)
• execute (method)
• execute (method)
• exit-event-loop-p (function)
• find-recv-buffer-length (function)
• getrandom (function)
• itimerspec-tclass (class)
• lock (generic function)
• lock (method)
• (setf lock) (method)
• lock (method)
• (setf lock) (method)
• (setf lock) (generic function)
• main-loop (function)
• max-event-loops (generic function)
• max-event-loops (method)
• (setf max-event-loops) (method)
• (setf max-event-loops) (generic function)
• new-thread-action (class)
• pipe (function)
• queue (generic function)
• queue (method)
• (setf queue) (method)
• (setf queue) (generic function)
• quit-event-loop (function)
• reporters (generic function)
• reporters (method)
• (setf reporters) (method)
• (setf reporters) (generic function)
• reporters-lock (generic function)
• reporters-lock (method)
• (setf reporters-lock) (method)
• (setf reporters-lock) (generic function)
• result (generic function)
• result (method)
• (setf result) (method)
• (setf result) (generic function)
• start-event-loops (function)
• start-thread-pool (function)
• started (generic function)
• started (method)
• (setf started) (method)
• (setf started) (generic function)
• strerror (function)
• thread (generic function)
• thread (method)
• thread (method)
• thread (method)
• thread-error (class)
• thread-pool (class)
• thread-properties (class)
• threads (generic function)
• threads (method)
• (setf threads) (method)
• (setf threads) (generic function)
• timer-timer (class)
• timerfd-create (function)
• timerfd-gettime (function)
• timerfd-settime (function)
• timers (generic function)
• timers (method)
• (setf timers) (method)
• (setf timers) (generic function)
• timers-lock (generic function)
• timers-lock (method)
• (setf timers-lock) (method)
• (setf timers-lock) (generic function)
• timespec-tclass (class)
• unblocking-action (class)
• wait-from-action-queue (function)

5.2 laap/socket

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• accept (generic function)
• accept (method)
• close (generic function)
• close (method)
• connect (generic function)
• connect (method)
• ipv4-tcp-socket (class)
• listen (generic function)
• listen (method)
• receive (generic function)
• receive (method)
• send (generic function)
• send (method)

Internal Definitions

• %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 function)
• data (method)
• (setf data) (method)
• (setf data) (generic function)
• end-callback (generic function)
• end-callback (method)
• errno (symbol macro)
• fcntl (function)
• fd (generic function)
• fd (method)
• getsockopt (function)
• htons (function)
• in-addr-tclass (class)
• inet-aton (function)
• sockaddr-in-tclass (class)
• socket (class)
• socket-domain (generic function)
• socket-domain (method)
• socket-protocol (generic function)
• socket-protocol (method)
• socket-timer (class)
• socket-type (generic function)
• socket-type (method)
• strerror (function)
• timer-socket-accept (class)
• timer-socket-connect (class)
• timer-socket-receive (class)
• timer-socket-send (class)

5.3 laap/fs

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• close (generic function)
• close (method)
• file (class)
• link (function)
• read (generic function)
• read (method)
• readlink (function)
• rename (function)
• symlink (function)
• truncate (generic function)
• truncate (method)
• unlink (function)
• write (generic function)
• write (method)

Internal Definitions

• %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 function)
• direction (method)
• direction (type)
• errno (symbol macro)
• fd (generic function)
• fd (method)
• (setf fd) (method)
• (setf fd) (generic function)
• if-does-not-exist (generic function)
• if-does-not-exist (method)
• (setf if-does-not-exist) (method)
• (setf if-does-not-exist) (generic function)
• if-does-not-exist (type)
• lisp-buffer-to-c-buffer (function)
• path (generic function)
• path (method)
• (setf path) (method)
• (setf path) (generic function)
• stat-tclass (class)
• strerror (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *recv-buffer-length*

Package

laap

Source

loop.lisp (file)

6.1.2 Symbol macros

Symbol Macro: errno

Package

laap

Source

cffi.lisp (file)

Expansion

(laap::%var-accessor-errno)

6.1.3 Macros

Macro: with-blocking-thread NAME &body BODY

Package

laap

Source

thread-pool.lisp (file)

Macro: with-event-loop &body BODY

Run code in the laap event loop.

Package

laap

Source

laap.lisp (file)

6.1.4 Functions

Function: add-reporter REPORTER

Package

laap

Source

thread-pool.lisp (file)

Function: delay SECONDS CALLBACK

Run a callback in a specified amount of seconds.

Package

laap

Source

timer.lisp (file)

Function: link CALLBACK &key OLDPATH NEWPATH

Make a hard-link from newpath to oldpath.

Package

laap/fs

Source

fs.lisp (file)

Function: noop ERR RES

Package

laap

Source

laap.lisp (file)

Function: readlink CALLBACK &key PATHNAME

Readlink pathname.

Package

laap/fs

Source

fs.lisp (file)

Function: rename CALLBACK &key OLDPATH NEWPATH

Rename oldpath to newpath.

Package

laap/fs

Source

fs.lisp (file)

Function: spawn CALLBACK

Immediately run a callback.

Package

laap

Source

timer.lisp (file)

Function: symlink CALLBACK &key TARGET LINKPATH

Make a symbolic link at linkpath pointing to target.

Package

laap/fs

Source

fs.lisp (file)

Function: unlink CALLBACK &key PATHNAME

Unlink pathname.

Package

laap/fs

Source

fs.lisp (file)

6.1.5 Generic functions

Generic Function: accept SOCKET CALLBACK &key

Accept a connection from a socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: accept (SOCKET ipv4-tcp-socket) CALLBACK &key

Generic Function: add-timer TIMER

Add a timer to the event loop.

Package

laap

Source

timer.lisp (file)

Methods

Method: add-timer TIMER

Generic Function: callback OBJECT

Package

laap

Methods

Method: callback (NEW-THREAD-ACTION new-thread-action)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: callback (TIMER timer)

automatically generated reader method

Source

timer.lisp (file)

Generic Function: close SOCKET CALLBACK &key

Close the socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: close (SOCKET ipv4-tcp-socket) CALLBACK &key

Generic Function: close FILE CALLBACK

Close the backed file.

Package

laap/fs

Source

fs.lisp (file)

Methods

Method: close FILE CALLBACK

Generic Function: connect SOCKET CALLBACK &key IP PORT

Connect the socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: connect (SOCKET ipv4-tcp-socket) CALLBACK &key IP PORT

Generic Function: direction OBJECT

Package

laap

Methods

Method: direction (TIMER timer)

automatically generated reader method

Source

timer.lisp (file)

Generic Function: errno CONDITION

Package

laap

Methods

Method: errno (CONDITION os-error)

Source

condition.lisp (file)

Generic Function: fd OBJECT

Package

laap

Methods

Method: fd (TIMER timer)

automatically generated reader method

Source

timer.lisp (file)

Generic Function: handle-error TIMER ERR

Handles an error for a timer.

Package

laap

Source

timer.lisp (file)

Methods

Method: handle-error (TIMER socket-timer) ERROR

Source

socket.lisp (file)

Method: handle-error (TIMER timer-timer) ERROR

Generic Function: handle-event TIMER

Handles an event for a timer.

Package

laap

Source

timer.lisp (file)

Methods

Method: handle-event (TIMER timer-socket-accept)

Source

socket.lisp (file)

Method: handle-event (TIMER timer-socket-receive)

Source

socket.lisp (file)

Method: handle-event (TIMER timer-socket-send)

Source

socket.lisp (file)

Method: handle-event (TIMER timer-socket-connect)

Source

socket.lisp (file)

Method: handle-event (TIMER timer-timer)

Generic Function: listen SOCKET CALLBACK &key IP PORT BACKLOG

Listen on a socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: listen (SOCKET ipv4-tcp-socket) CALLBACK &key IP PORT BACKLOG

Generic Function: read FILE CALLBACK &key COUNT

Read a specified amount of bytes from a file.

Package

laap/fs

Source

fs.lisp (file)

Methods

Method: read FILE CALLBACK &key COUNT

Generic Function: receive SOCKET CALLBACK &key END

Receive data from a socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: receive (SOCKET ipv4-tcp-socket) CALLBACK &key END

Generic Function: remove-timer TIMER

Remove a timer from the event loop.

Package

laap

Source

timer.lisp (file)

Methods

Method: remove-timer TIMER

Generic Function: send SOCKET CALLBACK &key DATA

Send data over a socket.

Package

laap/socket

Source

socket.lisp (file)

Methods

Method: send (SOCKET ipv4-tcp-socket) CALLBACK &key DATA

Generic Function: truncate FILE CALLBACK &key LENGTH

Truncate a file to a specified length.

Package

laap/fs

Source

fs.lisp (file)

Methods

Method: truncate FILE CALLBACK &key LENGTH

Generic Function: write FILE CALLBACK &key DATA

Write specified data to a file.

Package

laap/fs

Source

fs.lisp (file)

Methods

Method: write FILE CALLBACK &key DATA

6.1.6 Conditions

Condition: epoll-error ()

Package

laap

Source

condition.lisp (file)

Direct superclasses

condition (condition)

Condition: os-error ()

Package

laap

Source

condition.lisp (file)

Direct superclasses

condition (condition)

Direct methods

• print-object (method)
• errno (method)

Direct slots

Slot: errno

Initargs

:errno

Readers

errno (generic function)

6.1.7 Classes

Class: file ()

An object abstracting over a file.

Package

laap/fs

Source

fs.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• if-does-not-exist (method)
• if-does-not-exist (method)
• direction (method)
• fd (method)
• fd (method)
• path (method)
• path (method)

Direct slots

Slot: path

Initargs

:path

Readers

path (generic function)

Writers

(setf path) (generic function)

Slot: fd

Readers

fd (generic function)

Writers

(setf fd) (generic function)

Slot: direction

Type

laap/fs::direction

Initargs

:direction

Readers

direction (generic function)

Slot: if-does-not-exist

Type

laap/fs::if-does-not-exist

Initargs

:if-does-not-exist

Readers

if-does-not-exist (generic function)

Writers

(setf if-does-not-exist) (generic function)

Class: ipv4-tcp-socket ()

Implementation of an IPv4 TCP socket.

Package

laap/socket

Source

socket.lisp (file)

Direct superclasses

socket (class)

Direct methods

• accept (method)
• listen (method)
• receive (method)
• send (method)
• close (method)
• connect (method)
• initialize-instance (method)

Class: timer ()

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.

Package

laap

Source

timer.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• timer-timer (class)
• socket-timer (class)

Direct methods

• closed (method)
• closed (method)
• callback (method)
• direction (method)
• fd (method)

Direct slots

Slot: fd

Initargs

:fd

Readers

fd (generic function)

Slot: direction

Initargs

:direction

Readers

direction (generic function)

Slot: callback

Initargs

:callback

Readers

callback (generic function)

Slot: closed

Readers

closed (generic function)

Writers

(setf closed) (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: +af-inet+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +clock-monotonic+

Package

laap

Source

cffi.lisp (file)

Constant: +eagain+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +ebadf+

Package

laap

Source

cffi.lisp (file)

Constant: +eexist+

Package

laap

Source

cffi.lisp (file)

Constant: +efault+

Package

laap

Source

cffi.lisp (file)

Constant: +einprogress+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +eintr+

Package

laap

Source

cffi.lisp (file)

Constant: +eintr+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +einval+

Package

laap

Source

cffi.lisp (file)

Constant: +eloop+

Package

laap

Source

cffi.lisp (file)

Constant: +enoent+

Package

laap

Source

cffi.lisp (file)

Constant: +enomem+

Package

laap

Source

cffi.lisp (file)

Constant: +enospc+

Package

laap

Source

cffi.lisp (file)

Constant: +eperm+

Package

laap

Source

cffi.lisp (file)

Constant: +epoll-cloexec+

Package

laap

Source

cffi.lisp (file)

Constant: +epoll-ctl-add+

Package

laap

Source

cffi.lisp (file)

Constant: +epoll-ctl-del+

Package

laap

Source

cffi.lisp (file)

Constant: +epoll-ctl-mod+

Package

laap

Source

cffi.lisp (file)

Constant: +epollerr+

Package

laap

Source

cffi.lisp (file)

Constant: +epollet+

Package

laap

Source

cffi.lisp (file)

Constant: +epollhup+

Package

laap

Source

cffi.lisp (file)

Constant: +epollin+

Package

laap

Source

cffi.lisp (file)

Constant: +epollin+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +epolloneshot+

Package

laap

Source

cffi.lisp (file)

Constant: +epollout+

Package

laap

Source

cffi.lisp (file)

Constant: +epollout+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +epollpri+

Package

laap

Source

cffi.lisp (file)

Constant: +ewouldblock+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +f-getfl+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +f-setfl+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +msg-nosignal+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +o-cloexec+

Package

laap

Source

cffi.lisp (file)

Constant: +o-create+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +o-nonblock+

Package

laap

Source

cffi.lisp (file)

Constant: +o-nonblock+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +o-read-only+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +o-read-write+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +o-write-only+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +path-max+

Package

laap/fs

Source

cffi.lisp (file)

Constant: +so-error+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +sock-nonblock+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +sock-stream+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +sol-socket+

Package

laap/socket

Source

cffi.lisp (file)

Constant: +tfd-cloexec+

Package

laap

Source

cffi.lisp (file)

6.2.2 Special variables

Special Variable: *loop*

Package

laap

Source

laap.lisp (file)

Special Variable: *thread-pool*

Package

laap

Source

laap.lisp (file)

Special Variable: *thread-should-exit*

Package

laap

Source

thread-pool.lisp (file)

6.2.3 Symbol macros

Symbol Macro: errno

Package

laap/socket

Source

cffi.lisp (file)

Expansion

(laap/socket::%var-accessor-errno)

Symbol Macro: errno

Package

laap/fs

Source

cffi.lisp (file)

Expansion

(laap/fs::%var-accessor-errno)

6.2.4 Functions

Function: %add-event EFD FD DIRECTION

Package

laap

Source

loop.lisp (file)

Function: %add-to-queue ACTION

Package

laap

Source

thread-pool.lisp (file)

Function: %pipe2 PIPEFDS FLAGS

Package

laap

Source

cffi.lisp (file)

Function: %var-accessor-errno ()

Function: (setf %var-accessor-errno) VALUE

Package

laap

Source

cffi.lisp (file)

Function: %var-accessor-errno ()

Function: (setf %var-accessor-errno) VALUE

Package

laap/socket

Source

cffi.lisp (file)

Function: %var-accessor-errno ()

Function: (setf %var-accessor-errno) VALUE

Package

laap/fs

Source

cffi.lisp (file)

Function: add-event EFD TIMERFD TIMER

Package

laap

Source

loop.lisp (file)

Function: add-thread FN

Package

laap

Source

thread-pool.lisp (file)

Function: add-timer-in SECONDS CALLBACK

Package

laap

Source

timer.lisp (file)

Function: add-to-action-queue ACTION VALUE

Package

laap

Source

thread-pool.lisp (file)

Function: add-to-queue ACTION

Package

laap

Source

thread-pool.lisp (file)

Function: c-accept SOCKFD ADDR ADDRLEN FLAGS

Package

laap/socket

Source

cffi.lisp (file)

Function: c-bind SOCKFD ADDR ADDRLEN

Package

laap/socket

Source

cffi.lisp (file)

Function: c-buffer-to-lisp-buffer C-BUFFER LISP-BUFFER LENGTH OFFSET

Package

laap/fs

Source

fs.lisp (file)

Function: c-close FD

Package

laap

Source

cffi.lisp (file)

Function: c-close FD

Package

laap/socket

Source

cffi.lisp (file)

Function: c-close FD

Package

laap/fs

Source

cffi.lisp (file)

Function: c-connect SOCKFD ADDR ADDRLEN

Package

laap/socket

Source

cffi.lisp (file)

Function: c-ftruncate FD LENGTH

Package

laap/fs

Source

cffi.lisp (file)

Function: c-link OLDPATH NEWPATH

Package

laap/fs

Source

cffi.lisp (file)

Function: c-listen SOCKFD BACKLOG

Package

laap/socket

Source

cffi.lisp (file)

Function: c-lstat PATHNAME STAT

Package

laap/fs

Source

cffi.lisp (file)

Function: c-open PATHNAME FLAGS

Package

laap/fs

Source

cffi.lisp (file)

Function: c-read FD BUF COUNT

Package

laap/fs

Source

cffi.lisp (file)

Function: c-readlink PATHNAME BUF BUFSIZ

Package

laap/fs

Source

cffi.lisp (file)

Function: c-recv SOCKFD BUF LEN FLAGS

Package

laap/socket

Source

cffi.lisp (file)

Function: c-rename OLDPATH NEWPATH

Package

laap/fs

Source

cffi.lisp (file)

Function: c-send SOCKFD BUF LEN FLAGS

Package

laap/socket

Source

cffi.lisp (file)

Function: c-socket DOMAIN TYPE PROTOCOL

Package

laap/socket

Source

cffi.lisp (file)

Function: c-symlink TARGET NEWPATH

Package

laap/fs

Source

cffi.lisp (file)

Function: c-unlink PATHNAME

Package

laap/fs

Source

cffi.lisp (file)

Function: c-write FD BUF COUNT

Package

laap

Source

cffi.lisp (file)

Function: c-write FD BUF COUNT

Package

laap/fs

Source

cffi.lisp (file)

Function: cores-count ()

Package

laap

Source

loop.lisp (file)

Function: epoll-create1 FLAGS

Package

laap

Source

cffi.lisp (file)

Function: epoll-ctl EPFD OP FD EVENT

Package

laap

Source

cffi.lisp (file)

Function: epoll-wait EPFD EVENTS MAXEVENTS TIMEOUT

Package

laap

Source

cffi.lisp (file)

Function: event-loop-action ()

Package

laap

Source

thread-pool.lisp (file)

Function: exit-event-loop-p ()

Package

laap

Source

loop.lisp (file)

Function: fcntl FD CMD FLAGS

Package

laap/socket

Source

cffi.lisp (file)

Function: find-recv-buffer-length ()

Package

laap

Source

loop.lisp (file)

Function: getrandom COUNT

Package

laap

Source

thread-pool.lisp (file)

Function: getsockopt SOCKFD LEVEL OPTNAME OPTVAL OPTLEN

Package

laap/socket

Source

cffi.lisp (file)

Function: htons HOSTSHORT

Package

laap/socket

Source

cffi.lisp (file)

Function: inet-aton CP INP

Package

laap/socket

Source

cffi.lisp (file)

Function: lisp-buffer-to-c-buffer LISP-BUFFER C-BUFFER LENGTH OFFSET

Package

laap/fs

Source

fs.lisp (file)

Function: main-loop EFD

Package

laap

Source

loop.lisp (file)

Function: pipe ()

Package

laap

Source

cffi.lisp (file)

Function: quit-event-loop ()

Package

laap

Source

thread-pool.lisp (file)

Function: start-event-loops ()

Package

laap

Source

loop.lisp (file)

Function: start-thread-pool ()

Package

laap

Source

thread-pool.lisp (file)

Function: strerror ERRNUM

Package

laap

Source

cffi.lisp (file)

Function: strerror ERRNUM

Package

laap/socket

Source

cffi.lisp (file)

Function: strerror ERRNUM

Package

laap/fs

Source

cffi.lisp (file)

Function: timerfd-create CLOCKID FLAGS

Package

laap

Source

cffi.lisp (file)

Function: timerfd-gettime FD CURR-VALUE

Package

laap

Source

cffi.lisp (file)

Function: timerfd-settime FD FLAGS NEW-VALUE OLD-VALUE

Package

laap

Source

cffi.lisp (file)

Function: wait-from-action-queue ACTION

Package

laap

Source

thread-pool.lisp (file)

6.2.5 Generic functions

Generic Function: action-queue OBJECT

Generic Function: (setf action-queue) NEW-VALUE OBJECT

Package

laap

Methods

Method: action-queue (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf action-queue) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: action-queue-lock OBJECT

Generic Function: (setf action-queue-lock) NEW-VALUE OBJECT

Package

laap

Methods

Method: action-queue-lock (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf action-queue-lock) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: blocking OBJECT

Generic Function: (setf blocking) NEW-VALUE OBJECT

Package

laap

Methods

Method: blocking (THREAD-PROPERTIES thread-properties)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf blocking) NEW-VALUE (THREAD-PROPERTIES thread-properties)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: closed OBJECT

Generic Function: (setf closed) NEW-VALUE OBJECT

Package

laap

Methods

Method: closed (TIMER timer)

automatically generated reader method

Source

timer.lisp (file)

Method: (setf closed) NEW-VALUE (TIMER timer)

automatically generated writer method

Source

timer.lisp (file)

Generic Function: data OBJECT

Generic Function: (setf data) NEW-VALUE OBJECT

Package

laap/socket

Methods

Method: data (TIMER-SOCKET-SEND timer-socket-send)

automatically generated reader method

Source

socket.lisp (file)

Method: (setf data) NEW-VALUE (TIMER-SOCKET-SEND timer-socket-send)

automatically generated writer method

Source

socket.lisp (file)

Generic Function: direction OBJECT

Package

laap/fs

Methods

Method: direction (FILE file)

automatically generated reader method

Source

fs.lisp (file)

Generic Function: efd OBJECT

Generic Function: (setf efd) NEW-VALUE OBJECT

Package

laap

Methods

Method: efd (EVENT-LOOP event-loop)

automatically generated reader method

Source

loop.lisp (file)

Method: (setf efd) NEW-VALUE (EVENT-LOOP event-loop)

automatically generated writer method

Source

loop.lisp (file)

Generic Function: end-callback OBJECT

Package

laap/socket

Methods

Method: end-callback (TIMER-SOCKET-RECEIVE timer-socket-receive)

automatically generated reader method

Source

socket.lisp (file)

Generic Function: err OBJECT

Package

laap

Methods

Method: err (THREAD-ERROR thread-error)

automatically generated reader method

Source

thread-pool.lisp (file)

Generic Function: event OBJECT

Generic Function: (setf event) NEW-VALUE OBJECT

Package

laap

Methods

Method: event (ACTION-QUEUE-ITEM action-queue-item)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf event) NEW-VALUE (ACTION-QUEUE-ITEM action-queue-item)

automatically generated writer method

Source

thread-pool.lisp (file)

Method: event (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf event) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: execute ACTION

Execute an action.

Package

laap

Source

thread-pool.lisp (file)

Methods

Method: execute (ACTION unblocking-action)

Method: execute (ACTION blocking-action)

Method: execute (ACTION thread-error)

Method: execute (ACTION new-thread-action)

Generic Function: fd OBJECT

Package

laap/socket

Methods

Method: fd (SOCKET socket)

automatically generated reader method

Source

socket.lisp (file)

Generic Function: fd OBJECT

Generic Function: (setf fd) NEW-VALUE OBJECT

Package

laap/fs

Methods

Method: fd (FILE file)

automatically generated reader method

Source

fs.lisp (file)

Method: (setf fd) NEW-VALUE (FILE file)

automatically generated writer method

Source

fs.lisp (file)

Generic Function: if-does-not-exist OBJECT

Generic Function: (setf if-does-not-exist) NEW-VALUE OBJECT

Package

laap/fs

Methods

Method: if-does-not-exist (FILE file)

automatically generated reader method

Source

fs.lisp (file)

Method: (setf if-does-not-exist) NEW-VALUE (FILE file)

automatically generated writer method

Source

fs.lisp (file)

Generic Function: lock OBJECT

Generic Function: (setf lock) NEW-VALUE OBJECT

Package

laap

Methods

Method: lock (ACTION-QUEUE-ITEM action-queue-item)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf lock) NEW-VALUE (ACTION-QUEUE-ITEM action-queue-item)

automatically generated writer method

Source

thread-pool.lisp (file)

Method: lock (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf lock) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: max-event-loops OBJECT

Generic Function: (setf max-event-loops) NEW-VALUE OBJECT

Package

laap

Methods

Method: max-event-loops (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf max-event-loops) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: path OBJECT

Generic Function: (setf path) NEW-VALUE OBJECT

Package

laap/fs

Methods

Method: path (FILE file)

automatically generated reader method

Source

fs.lisp (file)

Method: (setf path) NEW-VALUE (FILE file)

automatically generated writer method

Source

fs.lisp (file)

Generic Function: queue OBJECT

Generic Function: (setf queue) NEW-VALUE OBJECT

Package

laap

Methods

Method: queue (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf queue) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: reporters OBJECT

Generic Function: (setf reporters) NEW-VALUE OBJECT

Package

laap

Methods

Method: reporters (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf reporters) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: reporters-lock OBJECT

Generic Function: (setf reporters-lock) NEW-VALUE OBJECT

Package

laap

Methods

Method: reporters-lock (THREAD-POOL thread-pool)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf reporters-lock) NEW-VALUE (THREAD-POOL thread-pool)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: result OBJECT

Generic Function: (setf result) NEW-VALUE OBJECT

Package

laap

Methods

Method: result (ACTION-QUEUE-ITEM action-queue-item)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: (setf result) NEW-VALUE (ACTION-QUEUE-ITEM action-queue-item)

automatically generated writer method

Source

thread-pool.lisp (file)

Generic Function: socket-domain OBJECT

Package

laap/socket

Methods

Method: socket-domain (SOCKET socket)

automatically generated reader method

Source

socket.lisp (file)

Generic Function: socket-protocol OBJECT

Package

laap/socket

Methods

Method: socket-protocol (SOCKET socket)

automatically generated reader method

Source

socket.lisp (file)

Generic Function: socket-type OBJECT

Package

laap/socket

Methods

Method: socket-type (SOCKET socket)

automatically generated reader method

Source

socket.lisp (file)

Generic Function: started OBJECT

Generic Function: (setf started) NEW-VALUE OBJECT

Package

laap

Methods

Method: started (EVENT-LOOP event-loop)

automatically generated reader method

Source

loop.lisp (file)

Method: (setf started) NEW-VALUE (EVENT-LOOP event-loop)

automatically generated writer method

Source

loop.lisp (file)

Generic Function: thread OBJECT

Package

laap

Methods

Method: thread (UNBLOCKING-ACTION unblocking-action)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: thread (BLOCKING-ACTION blocking-action)

automatically generated reader method

Source

thread-pool.lisp (file)

Method: thread (THREAD-ERROR thread-error)

automatically generated reader method

Source

thread-pool.lisp (file)