The cl-async Reference Manual

Table of Contents

The cl-async Reference Manual

This is the cl-async Reference Manual, version 0.6.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:03:55 2020 GMT+0.

1 Introduction

cl-async - Asynchronous operations for Common Lisp

Cl-async is a library for general purpose, non-blocking programming in Common Lisp. Cl-async uses libuv as the backend, which is a fast, stable, portable library for asynchronous IO (used as the backend library in Node.js).

The main goal is to provide an experience that makes general asynchronous programming in lisp natural, and to also provide a number of drivers on top of cl-async.

NOTE: cl-async uses the v1.x branch of libuv, so make sure to grab that version of it (not the v0.10.x branch).

Documentation

Please see the cl-async website for full documentation, examples, etc.

Quick links:

• Documentation
  • Base system
  • Timers
  • Signal handling
  • DNS
  • TCP
  • TCP stream
  • TCP SSL
  • Pollers
  • Idlers
  • Notifiers
  • Futures
  • Threading
  • Stats
  • Event callbacks and error handling
• Examples
• Benchmarks
• Implementation notes
• Drivers

Install

(ql:quickload :cl-async)

Please be aware that until cl-async v0.6.x is in quicklisp, you might want to git clone the master branch into quicklisp/local-projects/.

Tests

There is a fairly complete suite of tests in the cl-async-test package:

(ql:quickload :cl-async-test)
(cl-async-test:run-tests)
(cl-async-test:run-tests :ssl t)
(cl-async-test:run-tests :threading t)

License

As always, my code is MIT licensed. Do whatever the hell you want with it. Enjoy!

2 Systems

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

2.1 cl-async

Author

Andrew Danger Lyon <orthecreedence@gmail.com>

License

MIT

Description

Asynchronous operations for Common Lisp.

Version

0.6.1

Dependencies

• cffi
• trivial-features
• static-vectors
• cl-libuv
• cl-async-base (system)
• cl-async-util (system)
• babel
• cl-ppcre
• trivial-gray-streams
• uiop

Source

cl-async.asd (file)

Component

src (module)

2.2 cl-async-util

Author

Andrew Danger Lyon <orthecreedence@gmail.com>

License

MIT

Description

Internal utilities for cl-async.

Version

0.6.1

Dependencies

• cffi
• fast-io
• vom
• cl-libuv
• cl-ppcre
• cl-async-base (system)

Source

cl-async.asd (file)

Components

• src/util/package.lisp (file)
• src/util/helpers.lisp (file)
• src/util/foreign.lisp (file)
• src/util/error.lisp (file)

2.3 cl-async-base

Author

Andrew Danger Lyon <orthecreedence@gmail.com>

License

MIT

Description

Base system for cl-async.

Version

0.6.1

Dependencies

• cffi
• cl-libuv
• bordeaux-threads

Source

cl-async.asd (file)

Component

src/base.lisp (file)

3 Modules

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

3.1 cl-async/src

Parent

cl-async (system)

Location

src/

Components

• package.lisp (file)
• event-loop.lisp (file)
• event.lisp (file)
• dns.lisp (file)
• streamish.lisp (file)
• async-stream.lisp (file)
• socket.lisp (file)
• tcp.lisp (file)
• filesystem.lisp (file)
• pipe.lisp (file)
• signal.lisp (file)
• notify.lisp (file)
• poll.lisp (file)
• idle.lisp (file)
• process.lisp (file)
• fsevent.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 cl-async.asd

Location

cl-async.asd

Systems

• cl-async (system)
• cl-async-util (system)
• cl-async-base (system)

4.1.2 cl-async/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-async

4.1.3 cl-async/src/event-loop.lisp

Dependencies

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

Parent

src (module)

Location

src/event-loop.lisp

Exported Definitions

• add-event-loop-exit-callback (function)
• dump-event-loop-status (function)
• exit-event-loop (function)
• ref (generic function)
• start-event-loop (function)
• stats (function)
• unref (generic function)
• with-event-loop (macro)

Internal Definitions

• *event-base-registry* (special variable)
• *event-base-registry-lock* (special variable)
• *loop-close-iters* (special variable)
• check-event-loop-running (function)
• do-close-loop (function)
• handle-cleanup (generic function)
• handle-cleanup (method)
• loop-exit-walk-cb (function)
• process-event-loop-exit-callbacks (function)
• walk-cb (function)

4.1.4 cl-async/src/event.lisp

Dependencies

• event-loop.lisp (file)
• package.lisp (file)

Parent

src (module)

Location

src/event.lisp

Exported Definitions

• add-event (function)
• delay (function)
• event (class)
• event-c (method)
• (setf event-c) (method)
• event-freed (method)
• (setf event-freed) (method)
• event-freed (condition)
• event-freed-p (method)
• free-event (function)
• interval (function)
• make-event (function)
• ref (method)
• remove-event (function)
• remove-interval (function)
• unref (method)
• with-delay (macro)
• with-interval (macro)

Internal Definitions

• check-event-unfreed (function)
• event-freed-event (method)
• (setf event-freed-event) (method)
• handle-cleanup (method)
• timer-cb (function)
• timer-close-cb (function)

4.1.5 cl-async/src/dns.lisp

Dependencies

• event.lisp (file)
• package.lisp (file)

Parent

src (module)

Location

src/dns.lisp

Exported Definitions

• dns-error (condition)
• dns-lookup (function)
• reverse-dns-lookup (function)

Internal Definitions

• dns-cb (function)
• reverse-dns-cb (function)

4.1.6 cl-async/src/streamish.lisp

Dependencies

• dns.lisp (file)
• event-loop.lisp (file)
• event.lisp (file)

Parent

src (module)

Location

src/streamish.lisp

Exported Definitions

• check-streamish-open (function)
• close-streamish (generic function)
• close-streamish (method)
• socket-closed (condition)
• streamish (generic function)
• streamish (method)
• streamish (method)
• (setf streamish) (method)
• streamish (class)
• streamish-broken-pipe (condition)
• streamish-canceled (condition)
• streamish-closed (method)
• (setf streamish-closed) (method)
• streamish-closed (condition)
• streamish-closed-p (function)
• streamish-eof (condition)
• streamish-error (condition)
• streamish-info (condition)
• streamish-write (generic function)
• streamish-write (method)
• streamish-write (method)
• tcp-socket (method)
• (setf tcp-socket) (method)

Internal Definitions

• do-close-streamish (function)
• errno-event (generic function)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• event-handler (function)
• streamish-alloc-cb (function)
• streamish-c (method)
• (setf streamish-c) (method)
• streamish-close-cb (function)
• streamish-convert-data (function)
• streamish-data (method)
• (setf streamish-data) (method)
• streamish-drain-read-buffer (method)
• (setf streamish-drain-read-buffer) (method)
• streamish-read-cb (function)
• streamish-read-start (function)
• streamish-shutdown-cb (function)
• streamish-write-cb (function)
• write-to-uvstream (function)

4.1.7 cl-async/src/async-stream.lisp

Dependencies

• streamish.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/async-stream.lisp

Exported Definitions

• async-input-stream (class)
• async-io-stream (class)
• async-output-stream (class)
• async-stream (class)
• stream-socket (function)
• streamish (method)
• (setf streamish) (method)

Internal Definitions

• send-buffered-data (method)
• stream-append-bytes (method)
• stream-buffer (method)
• (setf stream-buffer) (method)
• stream-output-type (method)

4.1.8 cl-async/src/socket.lisp

Dependencies

• async-stream.lisp (file)
• streamish.lisp (file)
• async-stream.lisp (file)

Parent

src (module)

Location

src/socket.lisp

Exported Definitions

• close-socket (function)
• close-socket-server (generic function)
• close-socket-server (method)
• close-streamish (method)
• disable-socket (function)
• enable-socket (function)
• set-socket-timeouts (function)
• socket (method)
• socket (method)
• (setf socket) (method)
• socket (class)
• socket-aborted (condition)
• socket-accept-error (condition)
• socket-accept-error-listener (method)
• (setf socket-accept-error-listener) (method)
• socket-address-in-use (condition)
• socket-c (method)
• (setf socket-c) (method)
• socket-closed (method)
• (setf socket-closed) (method)
• socket-closed-p (function)
• socket-data (method)
• (setf socket-data) (method)
• socket-eof (condition)
• socket-error (condition)
• socket-info (condition)
• socket-refused (condition)
• socket-reset (condition)
• socket-timeout (condition)
• streamish-write (method)
• tcp-accept-error (condition)
• tcp-eof (condition)
• tcp-error (condition)
• tcp-info (condition)
• tcp-refused (condition)
• tcp-reset (condition)
• tcp-timeout (condition)
• write-socket-data (function)

Internal Definitions

• check-socket-open (function)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• handle-cleanup (method)
• init-client-socket (function)
• init-incoming-socket (function)
• make-socket-handle (generic function)
• server-socket-class (generic function)
• socket-accept-cb (function)
• socket-accept-error-server (method)
• (setf socket-accept-error-server) (method)
• socket-address (method)
• (setf socket-address) (method)
• socket-buffer (method)
• (setf socket-buffer) (method)
• socket-buffering-p (method)
• (setf socket-buffering-p) (method)
• socket-connect-cb (function)
• socket-connected (method)
• (setf socket-connected) (method)
• socket-drain-read-buffer (method)
• (setf socket-drain-read-buffer) (method)
• socket-server (function)
• socket-server (class)
• socket-server-bind (generic function)
• socket-server-c (method)
• (setf socket-server-c) (method)
• socket-server-closed (method)
• (setf socket-server-closed) (method)
• socket-server-stream (method)
• (setf socket-server-stream) (method)
• write-pending-socket-data (generic function)
• write-pending-socket-data (method)

4.1.9 cl-async/src/tcp.lisp

Dependencies

• socket.lisp (file)
• dns.lisp (file)
• socket.lisp (file)

Parent

src (module)

Location

src/tcp.lisp

Exported Definitions

• close-streamish (method)
• close-tcp-server (function)
• connect-tcp-socket (function)
• tcp-connect (function)
• tcp-server (function)
• tcp-server (class)
• tcp-server-bind-error (condition)
• tcp-socket (class)

Internal Definitions

• handle-cleanup (method)
• make-socket-handle (method)
• server-socket-class (method)
• socket-direction (method)
• (setf socket-direction) (method)
• socket-server-bind (method)
• tcp-connect-new (function)
• tcp-mixin (class)
• tcp-server-bind-error-addr (method)
• (setf tcp-server-bind-error-addr) (method)
• tcp-server-bind-error-port (method)
• (setf tcp-server-bind-error-port) (method)
• tcp-server-closed (function)
• tcp-server-new (function)

4.1.10 cl-async/src/filesystem.lisp

Dependencies

• tcp.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/filesystem.lisp

Exported Definitions

• filesystem-eacces (condition)
• filesystem-enoent (condition)
• filesystem-eperm (condition)
• filesystem-error (condition)
• mkdtemp (function)

Internal Definitions

• errno-event (method)
• errno-event (method)
• errno-event (method)
• fs-cb (function)

4.1.11 cl-async/src/pipe.lisp

Dependencies

• filesystem.lisp (file)
• socket.lisp (file)
• filesystem.lisp (file)

Parent

src (module)

Location

src/pipe.lisp

Exported Definitions

• pipe-connect (function)
• pipe-server (function)
• pipe-server (class)

Internal Definitions

• %pipe-connect (function)
• handle-cleanup (method)
• make-socket-handle (method)
• pipe (class)
• pipe-mixin (class)
• server-socket-class (method)
• socket-server-bind (method)

4.1.12 cl-async/src/signal.lisp

Dependencies

• pipe.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/signal.lisp

Exported Definitions

• +sigabrt+ (constant)
• +sigalrm+ (constant)
• +sigbus+ (constant)
• +sigchld+ (constant)
• +sigcont+ (constant)
• +sigemt+ (constant)
• +sigfpe+ (constant)
• +sighup+ (constant)
• +sigill+ (constant)
• +siginfo+ (constant)
• +sigint+ (constant)
• +sigio+ (constant)
• +sigkill+ (constant)
• +sigpipe+ (constant)
• +sigprof+ (constant)
• +sigquit+ (constant)
• +sigsegv+ (constant)
• +sigstop+ (constant)
• +sigsys+ (constant)
• +sigterm+ (constant)
• +sigtrap+ (constant)
• +sigtstp+ (constant)
• +sigttin+ (constant)
• +sigttou+ (constant)
• +sigurg+ (constant)
• +sigusr1+ (constant)
• +sigusr2+ (constant)
• +sigvtalrm+ (constant)
• +sigwinch+ (constant)
• +sigxcpu+ (constant)
• +sigxfsz+ (constant)
• clear-signal-handlers (function)
• free-signal-handler (function)
• signal-handler (function)

Internal Definitions

• lisp-signal-cb (function)
• set-lisp-signal-handler (function)
• signal-cb (function)
• signal-close-cb (function)
• signal-pointer (function)

4.1.13 cl-async/src/notify.lisp

Dependencies

• signal.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/notify.lisp

Exported Definitions

• free-notifier (function)
• make-notifier (function)
• notifier (class)
• notifier-freed-p (method)
• ref (method)
• trigger-notifier (function)
• unref (method)

Internal Definitions

• async-cb (function)
• async-close-cb (function)
• check-notifier-unfreed (function)
• handle-cleanup (method)
• notifier-c (method)
• (setf notifier-c) (method)
• notifier-freed (method)
• (setf notifier-freed) (method)
• notifier-freed (condition)
• notifier-freed-notifier (method)
• (setf notifier-freed-notifier) (method)
• notifier-single-shot (method)
• (setf notifier-single-shot) (method)
• notifier-single-shot-p (method)

4.1.14 cl-async/src/poll.lisp

Dependencies

• notify.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/poll.lisp

Exported Definitions

• free-poller (function)
• poll (function)
• poller (class)
• poller-freed-p (method)

Internal Definitions

• poll-cb (function)
• poll-close-cb (function)
• poller-c (method)
• (setf poller-c) (method)
• poller-freed (method)
• (setf poller-freed) (method)

4.1.15 cl-async/src/idle.lisp

Dependencies

• poll.lisp (file)
• package.lisp (file)

Parent

src (module)

Location

src/idle.lisp

Exported Definitions

• free-idler (function)
• idle (function)
• idler (class)
• idler-freed-p (method)

Internal Definitions

• idle-cb (function)
• idle-close-cb (function)
• idler-c (method)
• (setf idler-c) (method)
• idler-freed (method)
• (setf idler-freed) (method)

4.1.16 cl-async/src/process.lisp

Dependencies

• idle.lisp (file)
• pipe.lisp (file)

Parent

src (module)

Location

src/process.lisp

Exported Definitions

• process-error-output (method)
• (setf process-error-output) (method)
• process-input (method)
• (setf process-input) (method)
• process-kill (function)
• process-output (method)
• (setf process-output) (method)
• spawn (function)

Internal Definitions

• handle-cleanup (method)
• init-stdio-container (function)
• process (class)
• process-c (method)
• (setf process-c) (method)
• process-close (function)
• process-close-cb (function)
• process-exit-cb (function)

4.1.17 cl-async/src/fsevent.lisp

Dependencies

• process.lisp (file)
• streamish.lisp (file)

Parent

src (module)

Location

src/fsevent.lisp

Exported Definitions

• fs-monitor-close (function)
• fs-unwatch (function)
• fs-watch (function)

Internal Definitions

• %fs-monitor-close (function)
• fs-event-callback (function)
• fs-monitor (class)
• fs-monitor-c (method)
• (setf fs-monitor-c) (method)
• fs-monitor-close-cb (function)
• handle-cleanup (method)

4.1.18 cl-async-util/src/util/package.lisp

Parent

cl-async-util (system)

Location

src/util/package.lisp

Packages

cl-async-util

4.1.19 cl-async-util/src/util/helpers.lisp

Dependency

src/util/package.lisp (file)

Parent

cl-async-util (system)

Location

src/util/helpers.lisp

Exported Definitions

• *ipv4-scanner* (special variable)
• *ipv6-scanner* (special variable)
• append-array (function)
• attach-data-to-pointer (function)
• buffer-output (function)
• bytes (function)
• bytes-or-string (type)
• callback (type)
• clear-callbacks (function)
• clear-pointer-data (function)
• create-data-pointer (function)
• define-condition-alias (macro)
• deref-data-from-pointer (function)
• do-chunk-data (function)
• free-pointer-data (function)
• get-callbacks (function)
• ip-address-p (function)
• ipv4-address-p (function)
• ipv6-address-p (function)
• make-buffer (function)
• make-pointer-eql-able (function)
• octet (type)
• octet-vector (type)
• save-callbacks (function)
• with-lock (macro)
• write-to-buffer (function)

4.1.20 cl-async-util/src/util/foreign.lisp

Dependency

src/util/helpers.lisp (file)

Parent

cl-async-util (system)

Location

src/util/foreign.lisp

Exported Definitions

• +af-inet+ (constant)
• +af-inet6+ (constant)
• +af-unix+ (constant)
• +af-unspec+ (constant)
• addrinfo-to-string (function)
• define-c-callback (macro)
• error-str (function)
• fd-connected-p (function)
• ip-str-to-sockaddr (function)
• set-socket-nonblocking (function)
• with-foreign-object* (macro)
• with-ip-to-sockaddr (macro)

4.1.21 cl-async-util/src/util/error.lisp

Dependency

src/util/foreign.lisp (file)

Parent

cl-async-util (system)

Location

src/util/error.lisp

Exported Definitions

• *passthrough-errors* (special variable)
• call-with-callback-restarts (function)
• catch-app-errors (macro)
• handle-error (generic function)
• handle-error (method)
• passthrough-error-p (function)
• run-event-cb (function)

Internal Definitions

*evcb-err* (special variable)

4.1.22 cl-async-base/src/base.lisp

Parent

cl-async-base (system)

Location

src/base.lisp

Packages

cl-async-base

Exported Definitions

• *buffer-size* (special variable)
• *buffer-writes* (special variable)
• *data-registry* (special variable)
• *enable-threading* (special variable)
• *event-base* (special variable)
• *event-base-next-id* (special variable)
• *function-registry* (special variable)
• *input-buffer* (special variable)
• *output-buffer* (special variable)
• *safe-sldb-quit-restart* (special variable)
• event-base (class)
• event-base-c (method)
• (setf event-base-c) (method)
• event-base-catch-app-errors (method)
• (setf event-base-catch-app-errors) (method)
• event-base-data-registry (method)
• (setf event-base-data-registry) (method)
• event-base-dns-base (method)
• (setf event-base-dns-base) (method)
• event-base-dns-ref-count (method)
• (setf event-base-dns-ref-count) (method)
• event-base-exit-functions (method)
• (setf event-base-exit-functions) (method)
• event-base-function-registry (method)
• (setf event-base-function-registry) (method)
• event-base-id (method)
• (setf event-base-id) (method)
• event-base-lock (method)
• (setf event-base-lock) (method)
• event-base-num-connections-in (method)
• (setf event-base-num-connections-in) (method)
• event-base-num-connections-out (method)
• (setf event-base-num-connections-out) (method)
• event-base-send-errors-to-eventcb (method)
• (setf event-base-send-errors-to-eventcb) (method)
• event-base-signal-handlers (method)
• (setf event-base-signal-handlers) (method)
• event-errcode (method)
• event-errmsg (method)
• event-error (condition)
• event-info (condition)

5 Packages

Packages are listed by definition order.

5.1 cl-async

Source

package.lisp (file)

Nickname

as

Use List

• trivial-gray-streams
• cl-async-util
• cl-async-base
• common-lisp

Exported Definitions

• +sigabrt+ (constant)
• +sigalrm+ (constant)
• +sigbus+ (constant)
• +sigchld+ (constant)
• +sigcont+ (constant)
• +sigemt+ (constant)
• +sigfpe+ (constant)
• +sighup+ (constant)
• +sigill+ (constant)
• +siginfo+ (constant)
• +sigint+ (constant)
• +sigio+ (constant)
• +sigkill+ (constant)
• +sigpipe+ (constant)
• +sigprof+ (constant)
• +sigquit+ (constant)
• +sigsegv+ (constant)
• +sigstop+ (constant)
• +sigsys+ (constant)
• +sigterm+ (constant)
• +sigtrap+ (constant)
• +sigtstp+ (constant)
• +sigttin+ (constant)
• +sigttou+ (constant)
• +sigurg+ (constant)
• +sigusr1+ (constant)
• +sigusr2+ (constant)
• +sigvtalrm+ (constant)
• +sigwinch+ (constant)
• +sigxcpu+ (constant)
• +sigxfsz+ (constant)
• add-event (function)
• add-event-loop-exit-callback (function)
• async-input-stream (class)
• async-io-stream (class)
• async-output-stream (class)
• async-stream (class)
• check-streamish-open (function)
• clear-signal-handlers (function)
• close-socket (function)
• close-socket-server (generic function)
• close-socket-server (method)
• close-streamish (generic function)
• close-streamish (method)
• close-streamish (method)
• close-streamish (method)
• close-tcp-server (function)
• connect-tcp-socket (function)
• delay (function)
• disable-socket (function)
• dns-error (condition)
• dns-lookup (function)
• dump-event-loop-status (function)
• enable-socket (function)
• event (class)
• event-c (generic function)
• event-c (method)
• (setf event-c) (method)
• (setf event-c) (generic function)
• event-freed (generic function)
• event-freed (method)
• (setf event-freed) (method)
• (setf event-freed) (generic function)
• event-freed (condition)
• event-freed-p (generic function)
• event-freed-p (method)
• exit-event-loop (function)
• filesystem-eacces (condition)
• filesystem-enoent (condition)
• filesystem-eperm (condition)
• filesystem-error (condition)
• free-event (function)
• free-idler (function)
• free-notifier (function)
• free-poller (function)
• free-signal-handler (function)
• fs-monitor-close (function)
• fs-unwatch (function)
• fs-watch (function)
• idle (function)
• idler (class)
• idler-freed-p (generic function)
• idler-freed-p (method)
• interval (function)
• make-event (function)
• make-notifier (function)
• mkdtemp (function)
• notifier (class)
• notifier-freed-p (generic function)
• notifier-freed-p (method)
• pipe-connect (function)
• pipe-server (function)
• pipe-server (class)
• poll (function)
• poller (class)
• poller-freed-p (generic function)
• poller-freed-p (method)
• process-error-output (generic function)
• process-error-output (method)
• (setf process-error-output) (method)
• (setf process-error-output) (generic function)
• process-input (generic function)
• process-input (method)
• (setf process-input) (method)
• (setf process-input) (generic function)
• process-kill (function)
• process-output (generic function)
• process-output (method)
• (setf process-output) (method)
• (setf process-output) (generic function)
• ref (generic function)
• ref (method)
• ref (method)
• remove-event (function)
• remove-interval (function)
• reverse-dns-lookup (function)
• set-socket-timeouts (function)
• signal-handler (function)
• socket (generic function)
• socket (method)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• socket (class)
• socket-aborted (condition)
• socket-accept-error (condition)
• socket-accept-error-listener (generic function)
• socket-accept-error-listener (method)
• (setf socket-accept-error-listener) (method)
• (setf socket-accept-error-listener) (generic function)
• socket-address-in-use (condition)
• socket-c (generic function)
• socket-c (method)
• (setf socket-c) (method)
• (setf socket-c) (generic function)
• socket-closed (generic function)
• socket-closed (method)
• (setf socket-closed) (method)
• (setf socket-closed) (generic function)
• socket-closed (condition)
• socket-closed-p (function)
• socket-data (generic function)
• socket-data (method)
• (setf socket-data) (method)
• (setf socket-data) (generic function)
• socket-eof (condition)
• socket-error (condition)
• socket-info (condition)
• socket-refused (condition)
• socket-reset (condition)
• socket-timeout (condition)
• spawn (function)
• start-event-loop (function)
• stats (function)
• stream-socket (function)
• streamish (generic function)
• streamish (method)
• streamish (method)
• streamish (method)
• (setf streamish) (generic function)
• (setf streamish) (method)
• (setf streamish) (method)
• streamish (class)
• streamish-broken-pipe (condition)
• streamish-canceled (condition)
• streamish-closed (generic function)
• streamish-closed (method)
• (setf streamish-closed) (method)
• (setf streamish-closed) (generic function)
• streamish-closed (condition)
• streamish-closed-p (function)
• streamish-eof (condition)
• streamish-error (condition)
• streamish-info (condition)
• streamish-write (generic function)
• streamish-write (method)
• streamish-write (method)
• streamish-write (method)
• tcp-accept-error (condition)
• tcp-connect (function)
• tcp-eof (condition)
• tcp-error (condition)
• tcp-info (condition)
• tcp-refused (condition)
• tcp-reset (condition)
• tcp-server (function)
• tcp-server (class)
• tcp-server-bind-error (condition)
• tcp-socket (generic function)
• tcp-socket (method)
• (setf tcp-socket) (method)
• (setf tcp-socket) (generic function)
• tcp-socket (class)
• tcp-timeout (condition)
• trigger-notifier (function)
• unref (generic function)
• unref (method)
• unref (method)
• with-delay (macro)
• with-event-loop (macro)
• with-interval (macro)
• write-socket-data (function)

Internal Definitions

• %fs-monitor-close (function)
• %pipe-connect (function)
• *event-base-registry* (special variable)
• *event-base-registry-lock* (special variable)
• *loop-close-iters* (special variable)
• async-cb (function)
• async-close-cb (function)
• check-event-loop-running (function)
• check-event-unfreed (function)
• check-notifier-unfreed (function)
• check-socket-open (function)
• dns-cb (function)
• do-close-loop (function)
• do-close-streamish (function)
• errno-event (generic function)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• errno-event (method)
• event-freed-event (generic function)
• event-freed-event (method)
• (setf event-freed-event) (method)
• (setf event-freed-event) (generic function)
• event-handler (function)
• fs-cb (function)
• fs-event-callback (function)
• fs-monitor (class)
• fs-monitor-c (generic function)
• fs-monitor-c (method)
• (setf fs-monitor-c) (method)
• (setf fs-monitor-c) (generic function)
• fs-monitor-close-cb (function)
• handle-cleanup (generic function)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• handle-cleanup (method)
• idle-cb (function)
• idle-close-cb (function)
• idler-c (generic function)
• idler-c (method)
• (setf idler-c) (method)
• (setf idler-c) (generic function)
• idler-freed (generic function)
• idler-freed (method)
• (setf idler-freed) (method)
• (setf idler-freed) (generic function)
• init-client-socket (function)
• init-incoming-socket (function)
• init-stdio-container (function)
• lisp-signal-cb (function)
• loop-exit-walk-cb (function)
• make-socket-handle (generic function)
• make-socket-handle (method)
• make-socket-handle (method)
• notifier-c (generic function)
• notifier-c (method)
• (setf notifier-c) (method)
• (setf notifier-c) (generic function)
• notifier-freed (generic function)
• notifier-freed (method)
• (setf notifier-freed) (method)
• (setf notifier-freed) (generic function)
• notifier-freed (condition)
• notifier-freed-notifier (generic function)
• notifier-freed-notifier (method)
• (setf notifier-freed-notifier) (method)
• (setf notifier-freed-notifier) (generic function)
• notifier-single-shot (generic function)
• notifier-single-shot (method)
• (setf notifier-single-shot) (method)
• (setf notifier-single-shot) (generic function)
• notifier-single-shot-p (generic function)
• notifier-single-shot-p (method)
• pipe (class)
• pipe-mixin (class)
• poll-cb (function)
• poll-close-cb (function)
• poller-c (generic function)
• poller-c (method)
• (setf poller-c) (method)
• (setf poller-c) (generic function)
• poller-freed (generic function)
• poller-freed (method)
• (setf poller-freed) (method)
• (setf poller-freed) (generic function)
• process (class)
• process-c (generic function)
• process-c (method)
• (setf process-c) (method)
• (setf process-c) (generic function)
• process-close (function)
• process-close-cb (function)
• process-event-loop-exit-callbacks (function)
• process-exit-cb (function)
• reverse-dns-cb (function)
• send-buffered-data (generic function)
• send-buffered-data (method)
• server-socket-class (generic function)
• server-socket-class (method)
• server-socket-class (method)
• set-lisp-signal-handler (function)
• signal-cb (function)
• signal-close-cb (function)
• signal-pointer (function)
• socket-accept-cb (function)
• socket-accept-error-server (generic function)
• socket-accept-error-server (method)
• (setf socket-accept-error-server) (method)
• (setf socket-accept-error-server) (generic function)
• socket-address (generic function)
• socket-address (method)
• (setf socket-address) (method)
• (setf socket-address) (generic function)
• socket-buffer (generic function)
• socket-buffer (method)
• (setf socket-buffer) (method)
• (setf socket-buffer) (generic function)
• socket-buffering-p (generic function)
• socket-buffering-p (method)
• (setf socket-buffering-p) (method)
• (setf socket-buffering-p) (generic function)
• socket-connect-cb (function)
• socket-connected (generic function)
• socket-connected (method)
• (setf socket-connected) (method)
• (setf socket-connected) (generic function)
• socket-direction (generic function)
• socket-direction (method)
• (setf socket-direction) (method)
• (setf socket-direction) (generic function)
• socket-drain-read-buffer (generic function)
• socket-drain-read-buffer (method)
• (setf socket-drain-read-buffer) (method)
• (setf socket-drain-read-buffer) (generic function)
• socket-server (function)
• socket-server (class)
• socket-server-bind (generic function)
• socket-server-bind (method)
• socket-server-bind (method)
• socket-server-c (generic function)
• socket-server-c (method)
• (setf socket-server-c) (method)
• (setf socket-server-c) (generic function)
• socket-server-closed (generic function)
• socket-server-closed (method)
• (setf socket-server-closed) (method)
• (setf socket-server-closed) (generic function)
• socket-server-stream (generic function)
• socket-server-stream (method)
• (setf socket-server-stream) (method)
• (setf socket-server-stream) (generic function)
• stream-append-bytes (generic function)
• stream-append-bytes (method)
• stream-buffer (generic function)
• stream-buffer (method)
• (setf stream-buffer) (method)
• (setf stream-buffer) (generic function)
• stream-output-type (generic function)
• stream-output-type (method)
• streamish-alloc-cb (function)
• streamish-c (generic function)
• streamish-c (method)
• (setf streamish-c) (method)
• (setf streamish-c) (generic function)
• streamish-close-cb (function)
• streamish-convert-data (function)
• streamish-data (generic function)
• streamish-data (method)
• (setf streamish-data) (method)
• (setf streamish-data) (generic function)
• streamish-drain-read-buffer (generic function)
• streamish-drain-read-buffer (method)
• (setf streamish-drain-read-buffer) (method)
• (setf streamish-drain-read-buffer) (generic function)
• streamish-read-cb (function)
• streamish-read-start (function)
• streamish-shutdown-cb (function)
• streamish-write-cb (function)
• tcp-connect-new (function)
• tcp-mixin (class)
• tcp-server-bind-error-addr (generic function)
• tcp-server-bind-error-addr (method)
• (setf tcp-server-bind-error-addr) (method)
• (setf tcp-server-bind-error-addr) (generic function)
• tcp-server-bind-error-port (generic function)
• tcp-server-bind-error-port (method)
• (setf tcp-server-bind-error-port) (method)
• (setf tcp-server-bind-error-port) (generic function)
• tcp-server-closed (function)
• tcp-server-new (function)
• timer-cb (function)
• timer-close-cb (function)
• walk-cb (function)
• write-pending-socket-data (generic function)
• write-pending-socket-data (method)
• write-to-uvstream (function)

5.2 cl-async-util

Source

src/util/package.lisp (file)

Use List

• cl-async-base
• common-lisp

Used By List

cl-async

Exported Definitions

• *ipv4-scanner* (special variable)
• *ipv6-scanner* (special variable)
• *passthrough-errors* (special variable)
• +af-inet+ (constant)
• +af-inet6+ (constant)
• +af-unix+ (constant)
• +af-unspec+ (constant)
• addrinfo-to-string (function)
• append-array (function)
• attach-data-to-pointer (function)
• buffer-output (function)
• bytes (function)
• bytes-or-string (type)
• call-with-callback-restarts (function)
• callback (type)
• catch-app-errors (macro)
• clear-callbacks (function)
• clear-pointer-data (function)
• create-data-pointer (function)
• define-c-callback (macro)
• define-condition-alias (macro)
• deref-data-from-pointer (function)
• do-chunk-data (function)
• error-str (function)
• fd-connected-p (function)
• free-pointer-data (function)
• get-callbacks (function)
• handle-error (generic function)
• handle-error (method)
• ip-address-p (function)
• ip-str-to-sockaddr (function)
• ipv4-address-p (function)
• ipv6-address-p (function)
• make-buffer (function)
• make-pointer-eql-able (function)
• octet (type)
• octet-vector (type)
• passthrough-error-p (function)
• run-event-cb (function)
• save-callbacks (function)
• set-socket-nonblocking (function)
• with-foreign-object* (macro)
• with-ip-to-sockaddr (macro)
• with-lock (macro)
• write-to-buffer (function)

Internal Definitions

*evcb-err* (special variable)

5.3 cl-async-base

Source

src/base.lisp (file)

Use List

common-lisp

Used By List

• cl-async
• cl-async-util

Exported Definitions

• *buffer-size* (special variable)
• *buffer-writes* (special variable)
• *data-registry* (special variable)
• *enable-threading* (special variable)
• *event-base* (special variable)
• *event-base-next-id* (special variable)
• *function-registry* (special variable)
• *input-buffer* (special variable)
• *output-buffer* (special variable)
• *safe-sldb-quit-restart* (special variable)
• event-base (class)
• event-base-c (generic function)
• event-base-c (method)
• (setf event-base-c) (method)
• (setf event-base-c) (generic function)
• event-base-catch-app-errors (generic function)
• event-base-catch-app-errors (method)
• (setf event-base-catch-app-errors) (method)
• (setf event-base-catch-app-errors) (generic function)
• event-base-data-registry (generic function)
• event-base-data-registry (method)
• (setf event-base-data-registry) (method)
• (setf event-base-data-registry) (generic function)
• event-base-dns-base (generic function)
• event-base-dns-base (method)
• (setf event-base-dns-base) (method)
• (setf event-base-dns-base) (generic function)
• event-base-dns-ref-count (generic function)
• event-base-dns-ref-count (method)
• (setf event-base-dns-ref-count) (method)
• (setf event-base-dns-ref-count) (generic function)
• event-base-exit-functions (generic function)
• event-base-exit-functions (method)
• (setf event-base-exit-functions) (method)
• (setf event-base-exit-functions) (generic function)
• event-base-function-registry (generic function)
• event-base-function-registry (method)
• (setf event-base-function-registry) (method)
• (setf event-base-function-registry) (generic function)
• event-base-id (generic function)
• event-base-id (method)
• (setf event-base-id) (method)
• (setf event-base-id) (generic function)
• event-base-lock (generic function)
• event-base-lock (method)
• (setf event-base-lock) (method)
• (setf event-base-lock) (generic function)
• event-base-num-connections-in (generic function)
• event-base-num-connections-in (method)
• (setf event-base-num-connections-in) (method)
• (setf event-base-num-connections-in) (generic function)
• event-base-num-connections-out (generic function)
• event-base-num-connections-out (method)
• (setf event-base-num-connections-out) (method)
• (setf event-base-num-connections-out) (generic function)
• event-base-send-errors-to-eventcb (generic function)
• event-base-send-errors-to-eventcb (method)
• (setf event-base-send-errors-to-eventcb) (method)
• (setf event-base-send-errors-to-eventcb) (generic function)
• event-base-signal-handlers (generic function)
• event-base-signal-handlers (method)
• (setf event-base-signal-handlers) (method)
• (setf event-base-signal-handlers) (generic function)
• event-errcode (generic function)
• event-errcode (method)
• event-errmsg (generic function)
• event-errmsg (method)
• event-error (condition)
• event-info (condition)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +af-inet+

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Constant: +af-inet6+

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Constant: +af-unix+

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Constant: +af-unspec+

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Constant: +sigabrt+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigalrm+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigbus+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigchld+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigcont+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigemt+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigfpe+

Package

cl-async

Source

signal.lisp (file)

Constant: +sighup+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigill+

Package

cl-async

Source

signal.lisp (file)

Constant: +siginfo+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigint+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigio+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigkill+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigpipe+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigprof+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigquit+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigsegv+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigstop+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigsys+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigterm+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigtrap+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigtstp+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigttin+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigttou+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigurg+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigusr1+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigusr2+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigvtalrm+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigwinch+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigxcpu+

Package

cl-async

Source

signal.lisp (file)

Constant: +sigxfsz+

Package

cl-async

Source

signal.lisp (file)

6.1.2 Special variables

Special Variable: *buffer-size*

The amount of data we’ll pull from the evbuffers when doing reading/writing.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *buffer-writes*

If T, will buffer writes on the socket until the next loop. This is mainly to cut down on calls to uv_write, which is fairly slow.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *data-registry*

A hash table holding C pointer -> lisp data mappings.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *enable-threading*

If true, various pieces of the cl-async internals will lock their restecpive structures before operating to ensure thread safety.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *event-base*

THE event base object used to process all async operations.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *event-base-next-id*

The numeric identifier assigned to each new event base.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *function-registry*

A hash table holding C pointer -> lisp function(s) mappings.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *input-buffer*

A buffer that lives in both C and lisp worlds (static-vector) that lets us read from sockets.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *ipv4-scanner*

Scanner that detects if a string is an IPV4 address.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Special Variable: *ipv6-scanner*

Scanner that detects if a string is an IPV6 address.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Special Variable: *output-buffer*

A buffer that lives in both C and lisp worlds (static-vector) that lets us write to sockets.

Package

cl-async-base

Source

src/base.lisp (file)

Special Variable: *passthrough-errors*

Package

cl-async-util

Source

src/util/error.lisp (file)

Special Variable: *safe-sldb-quit-restart*

If true, provides a safe default for SLIME debugger quit restart (ABORT-CALLBACK). This restart causes the callback to be aborted without quitting the event loop. If false, the default restart is set to EXIT-EVENT-LOOP.

Package

cl-async-base

Source

src/base.lisp (file)

6.1.3 Macros

Macro: catch-app-errors EVENT-CB &body BODY

Handle error conditions by directing them to the specified event callback or default event handler of the current event loop, if catching app errors is enabled for the current event loop via EVENT-BASE-CATCH-APP-ERRORS, otherwise just evaluate the BODY.

If event-cbs are called via run-event-cb, make sure the event-cb is NOT double-called with the same condition twice.

Package

cl-async-util

Source

src/util/error.lisp (file)

Macro: define-c-callback NAME RETURN-VAL (&rest ARGS) &body BODY

Define a top-level function with the given and also define a C callback that calls the function directly. The idea is that CFFI callbacks aren’t directly callable/debuggable, but it’s obnoxious to have to define and callback *and* a function right next to each other.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Macro: define-condition-alias ALIAS NAME

Define an alias for the specified condition.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Macro: with-delay (&optional SECONDS) &body BODY

Nicer syntax for delay function.

Package

cl-async

Source

event.lisp (file)

Macro: with-event-loop (&key CATCH-APP-ERRORS SEND-ERRORS-TO-EVENTCB) &body BODY

Makes starting an event loop a tad less annoying. I really couldn’t take typing out ‘(start-event-loop (lambda () ...) ...) every time. Example:

(with-event-loop (:catch-app-errors t) (do-something-one-does-when-an-event-loop-is-running))

See how nice that is?

Package

cl-async

Source

event-loop.lisp (file)

Macro: with-foreign-object* (VAR TYPE &key ZERO INITIAL) BINDINGS &body BODY

Convenience macro, makes creation and initialization of CFFI types easier. Emphasis on initialization.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Macro: with-interval (SECONDS) &body BODY

Nicer syntax for interval function.

Package

cl-async

Source

event.lisp (file)

Macro: with-ip-to-sockaddr ((BIND) ADDRESS PORT) &body BODY

Wraps around ipv4-str-to-sockaddr. Converts a string address and port and creates a sockaddr-in object, runs the body with it bound, and frees it.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Macro: with-lock &body BODY

If threading is enabled, locks the current event loop before processing body and releases the lock after body is finished.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

6.1.4 Functions

Function: add-event EVENT &key TIMEOUT ACTIVATE

Add an event to its specified event loop (make it pending). If given a :timeout (in seconds) the event will fire after that amount of time, unless it’s removed or freed.

Package

cl-async

Source

event.lisp (file)

Function: add-event-loop-exit-callback FN

Add a function to be run when the event loop exits.

Package

cl-async

Source

event-loop.lisp (file)

Function: addrinfo-to-string ADDRINFO

Given a (horrible) addrinfo C object pointer, grab either an IP4 or IP6 address and return is as a string.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Function: append-array ARR1 ARR2

Create an array, made up of arr1 followed by arr2.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: attach-data-to-pointer POINTER DATA

Attach a lisp object to a foreign pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: buffer-output BUFFER

Grab the output from a buffer created with (make-buffer).

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: bytes VECTOR

Convert any vector/string into a byte array. Useful for sending direct byte data into write-socket-data.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: call-with-callback-restarts THUNK &key CONTINUE-FN ABORT-RESTART-DESCRIPTION

Call thunk with restarts that make it possible to ignore the callback in case of an error or safely terminate the event loop.

If SWANK is active, set SLDB’s quit restart to ABORT-CALLBACK restart if *safe-sldb-quit-restart* is true or EXIT-EVENT-LOOP otherwise.

Package

cl-async-util

Source

src/util/error.lisp (file)

Function: check-streamish-open STREAMISH

Throw a streamish-closed condition if given a streamish that’s closed.

Package

cl-async

Source

streamish.lisp (file)

Function: clear-callbacks POINTER

Clear out all callbacks for the given pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: clear-pointer-data POINTER

Clear the data attached to a CFFI pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: clear-signal-handlers ()

Clear all bound signal handlers. Great for cleaning up when exiting an app.

Package

cl-async

Source

signal.lisp (file)

Function: close-socket SOCKET &key FORCE

Free a socket (uvstream) and clear out all associated data. Same as close-streamish.

Package

cl-async

Source

socket.lisp (file)

Function: close-tcp-server SERVER

Package

cl-async

Source

tcp.lisp (file)

Function: connect-tcp-socket SOCKET/STREAM HOST PORT &key EVENT-CB

Connect a tcp socket initialized with init-client-socket.

Package

cl-async

Source

tcp.lisp (file)

Function: create-data-pointer ()

Creates a pointer in C land that can be used to attach data/callbacks to. Note that this must be freed via clear-pointer-data.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: delay CALLBACK &key TIME EVENT-CB

Run a function, asynchronously, after the specified amount of seconds. An event loop must be running for this to work.

If time is nil, callback is still called asynchronously, but is queued in the event loop with no delay.

Package

cl-async

Source

event.lisp (file)

Function: deref-data-from-pointer POINTER

Grab data attached to a CFFI pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: disable-socket SOCKET &key READ WRITE

Disable read/write monitoring on a socket. If :read or :write are nil, they are not enabled, but rather just not disabled.

Package

cl-async

Source

socket.lisp (file)

Function: dns-lookup HOST RESOLVE-CB &key EVENT-CB FAMILY

Asynchronously lookup a DNS address. Note that if an IP address is passed, the lookup happens synchronously. If a lookup is synchronous (and instant) this returns T, otherwise nil (lookup happening in background). Either way the resolve-cb is called with the lookup info (so always assume this is async).

Package

cl-async

Source

dns.lisp (file)

Function: do-chunk-data DATA BUFFER WRITE-CB &key START END NEW-BUFFER

Util function that splits data into the (length buffer) chunks and calls write-cb for each chunk.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: dump-event-loop-status ()

Return the status of the event loop. Really a debug function more than anything else.

Package

cl-async

Source

event-loop.lisp (file)

Function: enable-socket SOCKET &key READ WRITE

Enable read/write monitoring on a socket. If :read or :write are nil, they are not disabled, but rather just not enabled.

Package

cl-async

Source

socket.lisp (file)

Function: error-str UV-ERRNO

Given a libuv error number, return the error string.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Function: exit-event-loop ()

Exit the event loop if running.

Package

cl-async

Source

event-loop.lisp (file)

Function: fd-connected-p FD

Check if an FD is connected.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Function: free-event EVENT

Free a cl-async event object and any resources it uses.

Package

cl-async

Source

event.lisp (file)

Function: free-idler IDLER

Stop and free an idler.

Package

cl-async

Source

idle.lisp (file)

Function: free-notifier NOTIFIER

Free a cl-async notifier object and any resources it uses.

Package

cl-async

Source

notify.lisp (file)

Function: free-pointer-data POINTER &key PRESERVE-POINTER

Clears out all data attached to a foreign pointer, and frees the pointer (unless :preserve-pointer is t).

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: free-poller POLLER

Stop and free a poller.

Package

cl-async

Source

poll.lisp (file)

Function: free-signal-handler SIGNO

Clear a signal handler and unbind it.

Package

cl-async

Source

signal.lisp (file)

Function: fs-monitor-close FS-MONITOR

Package

cl-async

Source

fsevent.lisp (file)

Function: fs-unwatch FS-MONITOR

Package

cl-async

Source

fsevent.lisp (file)

Function: fs-watch PATH CALLBACK &key EVENT-CB

Package

cl-async

Source

fsevent.lisp (file)

Function: get-callbacks POINTER

Get all callbacks for the given pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: idle CALLBACK &key EVENT-CB

Calls ‘callback‘ once per event loop.

Package

cl-async

Source

idle.lisp (file)

Function: interval CALLBACK &key TIME EVENT-CB

Run a function, asynchronously, every ‘time‘ seconds. This function returns a function which, when called, cancels the interval.

Package

cl-async

Source

event.lisp (file)

Function: ip-address-p ADDR

Determine if the given host is an IP or a hostname.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: ip-str-to-sockaddr ADDRESS PORT

Convert a string IP address and port into a sockaddr-in struct. Must be freed by the app!

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Function: ipv4-address-p ADDR

Determine if the given host is an IPV4 addr or a hostname.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: ipv6-address-p ADDR

Determine if the given host is an IPV6 addr or a hostname.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: make-buffer &optional DATA

Create an octet buffer, optoinally filled with the given data.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: make-event CALLBACK &key EVENT-CB

Make an arbitrary event, and add it to the event loop. It *must* be triggered by (add-event <the event> :activate t) or it will sit, idle, for 100 years. Or you can remove/free it instead.

This is useful for triggering arbitrary events, and can even be triggered from a thread outside the libuv loop.

Package

cl-async

Source

event.lisp (file)

Function: make-notifier CALLBACK &key EVENT-CB SINGLE-SHOT

Makes a notifier, an object that can trigger a callback from a thread other than the event loop thread. If single-shot is true (the default), free the notifier after it’s triggered.

Package

cl-async

Source

notify.lisp (file)

Function: make-pointer-eql-able POINTER

Abstraction to make a CFFI pointer #’eql to itself. Does its best to be the most performant for the current implementation.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: mkdtemp TEMPLATE CB &key EVENT-CB

Package

cl-async

Source

filesystem.lisp (file)

Function: passthrough-error-p E

Return true if the specified error condition should not be intercepted by cl-async error handling mechanism.

Package

cl-async-util

Source

src/util/error.lisp (file)

Function: pipe-connect NAME READ-CB &key DATA STREAM EVENT-CB CONNECT-CB WRITE-CB READ-TIMEOUT WRITE-TIMEOUT DONT-DRAIN-READ-BUFFER

Open a pipe connection asynchronously. Optionally send data out once connected via the :data keyword (can be a string or byte array).

Package

cl-async

Source

pipe.lisp (file)

Function: pipe-server NAME READ-CB &key EVENT-CB CONNECT-CB BACKLOG STREAM FD

Start a pipe listener on the current event loop. Returns a tcp-server class which can be closed with close-tcp-server

Package

cl-async

Source

pipe.lisp (file)

Function: poll FD POLL-CB &key EVENT-CB POLL-FOR SOCKET

Poll an OS FD. If the FD is a socket, :socket t must be passed.

Package

cl-async

Source

poll.lisp (file)

Function: process-kill PROCESS SIGNAL &key EVENT-CB

If PROCESS is active, send the specified signal (an integer) to it and return true. If PROCESS is not active or an error occurs (and EVENT-CB doesn’t
signal an error), return false. If EVENT-CB is specified, use it
to handle errors, otherwise signal them via ERROR.

Package

cl-async

Source

process.lisp (file)

Function: remove-event EVENT

Remove a pending event from the event loop.

Package

cl-async

Source

event.lisp (file)

Function: remove-interval INTERVAL-FN

Stops an interval from looping.

Package

cl-async

Source

event.lisp (file)

Function: reverse-dns-lookup IP RESOLVE-CB &key EVENT-CB

Perform reverse DNS lookup on IP specifier as string. Call RESOLVE-CB with resolved HOST and SERVICE as strings. The callback is called once with one host, even if multiple hosts match the query.

Package

cl-async

Source

dns.lisp (file)

Function: run-event-cb EVENT-CB &rest ARGS

When used in the dynamic context of catch-app-errors, wraps the calling of an event-cb with args such that errors are caught and saved, ensuring that an event-cb isn’t called twice with the same condition. When used outside the dynamic context of catch-app-errors, just invokes event-cb with args.

Package

cl-async-util

Source

src/util/error.lisp (file)

Function: save-callbacks POINTER CALLBACKS

Save a set of callbacks, keyed by the given pointer.

Package

cl-async-util

Source

src/util/helpers.lisp (file)

Function: set-socket-nonblocking FD

Sets an FD into non-blocking mode.

Package

cl-async-util

Source

src/util/foreign.lisp (file)

Function: set-socket-timeouts SOCKET READ-SEC WRITE-SEC &key SOCKET-IS-UVSTREAM

Set the read/write timeouts on a socket.

Package

cl-async

Source

socket.lisp (file)

Function: signal-handler SIGNO SIGNAL-CB &key EVENT-CB

Setup a one-time signal handler for the given signo. This also sets up a lisp signal handler, so if a signal comes through while lisp is running instead of the event loop, it will run the same callback. All signal handlers are restored on event loop exit.

Package

cl-async

Source

signal.lisp (file)

Function: socket-closed-p SOCKET

Return whether a socket is closed or not. Same as streamish-closed-p.

Package

cl-async

Source

socket.lisp (file)

Function: spawn PATH ARGS &key EXIT-CB EVENT-CB INPUT OUTPUT ERROR-OUTPUT ENV WORKING-DIRECTORY

Run the program specified by PATH with specified ARGS.
ARGS don’t include the executable path (argv[0]). Return process object and pipes or streams for input, output and error output file descriptors of the child process (NIL for file descriptors that
aren’t redirected via :PIPE or :STREAM, see below).

EXIT-CB specifies the callback that should be called when the
program terminates. It should be a function taking three arguments: process object, exit status and signal number that caused program termination (0 if the program wasn’t terminated by signal).

EVENT-CB specifies error handler to be used.

INPUT, OUTPUT and ERROR-OUTPUT specify process input/output/error redirection. For each of these, the following values are
supported:

:IGNORE the corresponding file descriptor isn’t used
:INHERIT inherit file descriptor from this process
(:PIPE [:READ-CB ...] ...) use pipe-based redirection of the corresponding file descriptor (see PIPE-CONNECT for the set
of supported keyword arguments).
(:STREAM [:READ-CB ...] ...) same as PIPE, but uses async
stream instead of a pipe.

ENV is an alist of (VAR . VALUE) pairs specifying the environment variables of the spawned process. Note that both VAR and VALUE must be strings.

WORKING-DIRECTORY specifies the current working directory of the spawned program. Defaults to the current working directory of its parent process (viz. the process SPAWN is called from).

Package

cl-async

Source

process.lisp (file)

Function: start-event-loop START-FN &key CATCH-APP-ERRORS SEND-ERRORS-TO-EVENTCB

Simple wrapper function that starts an event loop which runs the given callback, most likely to init your server/client.

Package

cl-async

Source

event-loop.lisp (file)

Function: stats ()

Return statistics about the current event loop.

Package

cl-async

Source

event-loop.lisp (file)

Function: stream-socket STREAM

Package

cl-async

Source

async-stream.lisp (file)

Function: streamish-closed-p STREAMISH

Return whether a streamish is closed or not.

Package

cl-async

Source

streamish.lisp (file)

Function: tcp-connect HOST PORT READ-CB &rest ARGS

Open a TCP connection asynchronously. Optionally send data out once connected via the :data keyword (can be a string or byte array).

Package

cl-async

Source

tcp.lisp (file)

Function: tcp-server BIND-ADDRESS PORT READ-CB &rest ARGS

Open a TCP connection asynchronously. Optionally send data out once connected via the :data keyword (can be a string or byte array).

Package

cl-async

Source

tcp.lisp (file)

Function: trigger-notifier NOTIFIER

Fires the callback attached to a notifier. Can be called from any thread.

Package

cl-async

Source

notify.lisp (file)

Function: write-socket-data SOCKET DATA &rest ARGS &key &allow-other-keys

An compatibility alias for STREAMISH-WRITE.

Package

cl-async

Source

socket.lisp (file)

Function: write-to-buffer SEQ BUFFER &optional START END

Write data to a buffer created with (make-buffer).

Package

cl-async-util

Source

src/util/helpers.lisp (file)

6.1.5 Generic functions

Generic Function: close-socket-server SOCKET

Closes a socket server. If already closed, does nothing.

Package

cl-async

Source

socket.lisp (file)

Methods

Method: close-socket-server (SOCKET-SERVER socket-server)

Generic Function: close-streamish STREAMISH &key FORCE &allow-other-keys

Free a streamish (uvstream) and clear out all associated data.

Package

cl-async

Source

streamish.lisp (file)

Methods

Method: close-streamish (SOCKET tcp-socket) &key &allow-other-keys after

Source

tcp.lisp (file)

Method: close-streamish (SOCKET socket) &key FORCE &allow-other-keys

Source

socket.lisp (file)

Method: close-streamish (STREAMISH streamish) &key FORCE

Close and free a streamish and all of it’s underlying structures.

Generic Function: event-base-c OBJECT

Generic Function: (setf event-base-c) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-c (EVENT-BASE event-base)

Method: (setf event-base-c) NEW-VALUE (EVENT-BASE event-base)

Holds the C object pointing to the underlying event loop object.

Source

src/base.lisp (file)

Generic Function: event-base-catch-app-errors OBJECT

Generic Function: (setf event-base-catch-app-errors) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-catch-app-errors (EVENT-BASE event-base)

Method: (setf event-base-catch-app-errors) NEW-VALUE (EVENT-BASE event-base)

If t (or a function) will trap all errors produced in the event loop and process them internally

Source

src/base.lisp (file)

Generic Function: event-base-data-registry OBJECT

Generic Function: (setf event-base-data-registry) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-data-registry (EVENT-BASE event-base)

Method: (setf event-base-data-registry) NEW-VALUE (EVENT-BASE event-base)

Holds all callback data attached to this event loop.

Source

src/base.lisp (file)

Generic Function: event-base-dns-base OBJECT

Generic Function: (setf event-base-dns-base) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-dns-base (EVENT-BASE event-base)

Method: (setf event-base-dns-base) NEW-VALUE (EVENT-BASE event-base)

Holds the DNS base object used for DNS lookups.

Source

src/base.lisp (file)

Generic Function: event-base-dns-ref-count OBJECT

Generic Function: (setf event-base-dns-ref-count) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-dns-ref-count (EVENT-BASE event-base)

Method: (setf event-base-dns-ref-count) NEW-VALUE (EVENT-BASE event-base)

Tracks how many open requests are pending on the dns base.

Source

src/base.lisp (file)

Generic Function: event-base-exit-functions OBJECT

Generic Function: (setf event-base-exit-functions) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-exit-functions (EVENT-BASE event-base)

Method: (setf event-base-exit-functions) NEW-VALUE (EVENT-BASE event-base)

Holds functions to be run when the event loop exist (cleanly or otherwise).

Source

src/base.lisp (file)

Generic Function: event-base-function-registry OBJECT

Generic Function: (setf event-base-function-registry) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-function-registry (EVENT-BASE event-base)

Method: (setf event-base-function-registry) NEW-VALUE (EVENT-BASE event-base)

Holds all callbacks attached to this event loop.

Source

src/base.lisp (file)

Generic Function: event-base-id OBJECT

Generic Function: (setf event-base-id) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-id (EVENT-BASE event-base)

Method: (setf event-base-id) NEW-VALUE (EVENT-BASE event-base)

Holds this event loop’s numeric id.

Source

src/base.lisp (file)

Generic Function: event-base-lock OBJECT

Generic Function: (setf event-base-lock) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-lock (EVENT-BASE event-base)

Method: (setf event-base-lock) NEW-VALUE (EVENT-BASE event-base)

Holds *the* lock for this event base.

Source

src/base.lisp (file)

Generic Function: event-base-num-connections-in OBJECT

Generic Function: (setf event-base-num-connections-in) NEW-VALUE OBJECT

Package

cl-async-base

Methods

Method: event-base-num-connections-in (EVENT-BASE event-base)

automatically generated reader method

Source

src/base.lisp (file)

Method: (setf event-base-num-connections-in) NEW-VALUE (EVENT-BASE event-base)

automatically generated writer method

Source

src/base.lisp (file)