The cl-async Reference Manual

This is the cl-async Reference Manual, version 0.6.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:43:21 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-async

Asynchronous operations for Common Lisp.

Author

Andrew Danger Lyon <>

License

MIT

Version

0.6.1

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

cl-async.asd.

Child Component

src (module).


2.2 cl-async-base

Base system for cl-async.

Author

Andrew Danger Lyon <>

License

MIT

Version

0.6.1

Dependencies
  • cffi (system).
  • cl-libuv (system).
  • bordeaux-threads (system).
Source

cl-async.asd.

Child Component

src/base.lisp (file).


2.3 cl-async-util

Internal utilities for cl-async.

Author

Andrew Danger Lyon <>

License

MIT

Version

0.6.1

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

cl-async.asd.

Child Components

3 Modules

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


3.1 cl-async/src

Source

cl-async.asd.

Parent Component

cl-async (system).

Child Components

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/cl-async.asd

Source

cl-async.asd.

Parent Component

cl-async (system).

ASDF Systems

4.1.2 cl-async/src/package.lisp

Source

cl-async.asd.

Parent Component

src (module).

Packages

cl-async.


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

Dependency

package.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 cl-async/src/event.lisp

Dependency

package.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-async/src/dns.lisp

Dependencies
Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 cl-async/src/streamish.lisp

Dependencies
Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

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

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.8 cl-async/src/socket.lisp

Dependencies
Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.9 cl-async/src/tcp.lisp

Dependencies
Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.10 cl-async/src/filesystem.lisp

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.11 cl-async/src/pipe.lisp

Dependencies
Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.12 cl-async/src/signal.lisp

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.13 cl-async/src/notify.lisp

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.14 cl-async/src/poll.lisp

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.15 cl-async/src/idle.lisp

Dependency

package.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.16 cl-async/src/process.lisp

Dependency

pipe.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.17 cl-async/src/fsevent.lisp

Dependency

streamish.lisp (file).

Source

cl-async.asd.

Parent Component

src (module).

Public Interface
Internals

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

Source

cl-async.asd.

Parent Component

cl-async-base (system).

Packages

cl-async-base.

Public Interface

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

Source

cl-async.asd.

Parent Component

cl-async-util (system).

Packages

cl-async-util.


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

Dependency

src/util/package.lisp (file).

Source

cl-async.asd.

Parent Component

cl-async-util (system).

Public Interface

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

Dependency

src/util/helpers.lisp (file).

Source

cl-async.asd.

Parent Component

cl-async-util (system).

Public Interface

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

Dependency

src/util/foreign.lisp (file).

Source

cl-async.asd.

Parent Component

cl-async-util (system).

Public Interface
Internals

*evcb-err* (special variable).


5 Packages

Packages are listed by definition order.


5.1 cl-async-base

Source

src/base.lisp.

Use List

common-lisp.

Used By List
Public Interface

5.2 cl-async-util

Source

src/util/package.lisp.

Use List
Used By List

cl-async.

Public Interface
Internals

*evcb-err* (special variable).


5.3 cl-async

Source

package.lisp.

Nickname

as

Use List
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Constants

Constant: +af-inet+
Package

cl-async-util.

Source

src/util/foreign.lisp.

Constant: +af-inet6+
Package

cl-async-util.

Source

src/util/foreign.lisp.

Constant: +af-unix+
Package

cl-async-util.

Source

src/util/foreign.lisp.

Constant: +af-unspec+
Package

cl-async-util.

Source

src/util/foreign.lisp.

Constant: +sigabrt+
Package

cl-async.

Source

signal.lisp.

Constant: +sigalrm+
Package

cl-async.

Source

signal.lisp.

Constant: +sigbus+
Package

cl-async.

Source

signal.lisp.

Constant: +sigchld+
Package

cl-async.

Source

signal.lisp.

Constant: +sigcont+
Package

cl-async.

Source

signal.lisp.

Constant: +sigemt+
Package

cl-async.

Source

signal.lisp.

Constant: +sigfpe+
Package

cl-async.

Source

signal.lisp.

Constant: +sighup+
Package

cl-async.

Source

signal.lisp.

Constant: +sigill+
Package

cl-async.

Source

signal.lisp.

Constant: +siginfo+
Package

cl-async.

Source

signal.lisp.

Constant: +sigint+
Package

cl-async.

Source

signal.lisp.

Constant: +sigio+
Package

cl-async.

Source

signal.lisp.

Constant: +sigkill+
Package

cl-async.

Source

signal.lisp.

Constant: +sigpipe+
Package

cl-async.

Source

signal.lisp.

Constant: +sigprof+
Package

cl-async.

Source

signal.lisp.

Constant: +sigquit+
Package

cl-async.

Source

signal.lisp.

Constant: +sigsegv+
Package

cl-async.

Source

signal.lisp.

Constant: +sigstop+
Package

cl-async.

Source

signal.lisp.

Constant: +sigsys+
Package

cl-async.

Source

signal.lisp.

Constant: +sigterm+
Package

cl-async.

Source

signal.lisp.

Constant: +sigtrap+
Package

cl-async.

Source

signal.lisp.

Constant: +sigtstp+
Package

cl-async.

Source

signal.lisp.

Constant: +sigttin+
Package

cl-async.

Source

signal.lisp.

Constant: +sigttou+
Package

cl-async.

Source

signal.lisp.

Constant: +sigurg+
Package

cl-async.

Source

signal.lisp.

Constant: +sigusr1+
Package

cl-async.

Source

signal.lisp.

Constant: +sigusr2+
Package

cl-async.

Source

signal.lisp.

Constant: +sigvtalrm+
Package

cl-async.

Source

signal.lisp.

Constant: +sigwinch+
Package

cl-async.

Source

signal.lisp.

Constant: +sigxcpu+
Package

cl-async.

Source

signal.lisp.

Constant: +sigxfsz+
Package

cl-async.

Source

signal.lisp.


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.

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.

Special Variable: *data-registry*

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

Package

cl-async-base.

Source

src/base.lisp.

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.

Special Variable: *event-base*

THE event base object used to process all async operations.

Package

cl-async-base.

Source

src/base.lisp.

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

The numeric identifier assigned to each new event base.

Package

cl-async-base.

Source

src/base.lisp.

Special Variable: *function-registry*

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

Package

cl-async-base.

Source

src/base.lisp.

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.

Special Variable: *ipv4-scanner*

Scanner that detects if a string is an IPV4 address.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Special Variable: *ipv6-scanner*

Scanner that detects if a string is an IPV6 address.

Package

cl-async-util.

Source

src/util/helpers.lisp.

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.

Special Variable: *passthrough-errors*
Package

cl-async-util.

Source

src/util/error.lisp.

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.


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.

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.

Macro: define-condition-alias (alias name)

Define an alias for the specified condition.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Macro: with-delay ((&optional seconds) &body body)

Nicer syntax for delay function.

Package

cl-async.

Source

event.lisp.

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.

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.

Macro: with-interval ((seconds) &body body)

Nicer syntax for interval function.

Package

cl-async.

Source

event.lisp.

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.

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.


6.1.4 Ordinary 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.

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.

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.

Function: append-array (arr1 arr2)

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

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: attach-data-to-pointer (pointer data)

Attach a lisp object to a foreign pointer.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: buffer-output (buffer)

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

Package

cl-async-util.

Source

src/util/helpers.lisp.

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.

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.

Function: check-streamish-open (streamish)

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

Package

cl-async.

Source

streamish.lisp.

Function: clear-callbacks (pointer)

Clear out all callbacks for the given pointer.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: clear-pointer-data (pointer)

Clear the data attached to a CFFI pointer.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: clear-signal-handlers ()

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

Package

cl-async.

Source

signal.lisp.

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.

Function: close-tcp-server (server)
Package

cl-async.

Source

tcp.lisp.

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.

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.

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.

Function: deref-data-from-pointer (pointer)

Grab data attached to a CFFI pointer.

Package

cl-async-util.

Source

src/util/helpers.lisp.

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.

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.

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.

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.

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.

Function: error-str (uv-errno)

Given a libuv error number, return the error string.

Package

cl-async-util.

Source

src/util/foreign.lisp.

Function: exit-event-loop ()

Exit the event loop if running.

Package

cl-async.

Source

event-loop.lisp.

Function: fd-connected-p (fd)

Check if an FD is connected.

Package

cl-async-util.

Source

src/util/foreign.lisp.

Function: free-event (event)

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

Package

cl-async.

Source

event.lisp.

Function: free-idler (idler)

Stop and free an idler.

Package

cl-async.

Source

idle.lisp.

Function: free-notifier (notifier)

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

Package

cl-async.

Source

notify.lisp.

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.

Function: free-poller (poller)

Stop and free a poller.

Package

cl-async.

Source

poll.lisp.

Function: free-signal-handler (signo)

Clear a signal handler and unbind it.

Package

cl-async.

Source

signal.lisp.

Function: fs-monitor-close (fs-monitor)
Package

cl-async.

Source

fsevent.lisp.

Function: fs-unwatch (fs-monitor)
Package

cl-async.

Source

fsevent.lisp.

Function: fs-watch (path callback &key event-cb)
Package

cl-async.

Source

fsevent.lisp.

Function: get-callbacks (pointer)

Get all callbacks for the given pointer.

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: idle (callback &key event-cb)

Calls ‘callback‘ once per event loop.

Package

cl-async.

Source

idle.lisp.

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.

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.

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.

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.

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.

Function: make-buffer (&optional data)

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

Package

cl-async-util.

Source

src/util/helpers.lisp.

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.

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.

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.

Function: mkdtemp (template cb &key event-cb)
Package

cl-async.

Source

filesystem.lisp.

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.

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.

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.

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.

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.

Function: remove-event (event)

Remove a pending event from the event loop.

Package

cl-async.

Source

event.lisp.

Function: remove-interval (interval-fn)

Stops an interval from looping.

Package

cl-async.

Source

event.lisp.

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.

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.

Function: save-callbacks (pointer callbacks)

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

Package

cl-async-util.

Source

src/util/helpers.lisp.

Function: set-socket-nonblocking (fd)

Sets an FD into non-blocking mode.

Package

cl-async-util.

Source

src/util/foreign.lisp.

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.

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.

Function: socket-closed-p (socket)

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

Package

cl-async.

Source

socket.lisp.

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.

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.

Function: stats ()

Return statistics about the current event loop.

Package

cl-async.

Source

event-loop.lisp.

Function: stream-socket (stream)
Package

cl-async.

Source

async-stream.lisp.

Function: streamish-closed-p (streamish)

Return whether a streamish is closed or not.

Package

cl-async.

Source

streamish.lisp.

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.

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.

Function: trigger-notifier (notifier)

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

Package

cl-async.

Source

notify.lisp.

Function: write-socket-data (socket data &rest args &key &allow-other-keys)

An compatibility alias for STREAMISH-WRITE.

Package

cl-async.

Source

socket.lisp.

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.


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.

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.

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

tcp.lisp.

Method: close-streamish ((socket socket) &key force &allow-other-keys)
Source

socket.lisp.

Method: close-streamish ((streamish streamish) &key force)

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

Generic Reader: event-base-c (object)
Generic Writer: (setf event-base-c) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-c ((event-base event-base))
Writer Method: (setf event-base-c) ((event-base event-base))

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

Source

src/base.lisp.

Target Slot

c.

Generic Reader: event-base-catch-app-errors (object)
Generic Writer: (setf event-base-catch-app-errors) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-catch-app-errors ((event-base event-base))
Writer Method: (setf event-base-catch-app-errors) ((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.

Target Slot

catch-app-errors.

Generic Reader: event-base-data-registry (object)
Generic Writer: (setf event-base-data-registry) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-data-registry ((event-base event-base))
Writer Method: (setf event-base-data-registry) ((event-base event-base))

Holds all callback data attached to this event loop.

Source

src/base.lisp.

Target Slot

data-registry.

Generic Reader: event-base-dns-base (object)
Generic Writer: (setf event-base-dns-base) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-dns-base ((event-base event-base))
Writer Method: (setf event-base-dns-base) ((event-base event-base))

Holds the DNS base object used for DNS lookups.

Source

src/base.lisp.

Target Slot

dns-base.

Generic Reader: event-base-dns-ref-count (object)
Generic Writer: (setf event-base-dns-ref-count) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-dns-ref-count ((event-base event-base))
Writer Method: (setf event-base-dns-ref-count) ((event-base event-base))

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

Source

src/base.lisp.

Target Slot

dns-ref-count.

Generic Reader: event-base-exit-functions (object)
Generic Writer: (setf event-base-exit-functions) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-exit-functions ((event-base event-base))
Writer Method: (setf event-base-exit-functions) ((event-base event-base))

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

Source

src/base.lisp.

Target Slot

exit-functions.

Generic Reader: event-base-function-registry (object)
Generic Writer: (setf event-base-function-registry) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-function-registry ((event-base event-base))
Writer Method: (setf event-base-function-registry) ((event-base event-base))

Holds all callbacks attached to this event loop.

Source

src/base.lisp.

Target Slot

function-registry.

Generic Reader: event-base-id (object)
Generic Writer: (setf event-base-id) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-id ((event-base event-base))
Writer Method: (setf event-base-id) ((event-base event-base))

Holds this event loop’s numeric id.

Source

src/base.lisp.

Target Slot

id.

Generic Reader: event-base-lock (object)
Generic Writer: (setf event-base-lock) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-lock ((event-base event-base))
Writer Method: (setf event-base-lock) ((event-base event-base))

Holds *the* lock for this event base.

Source

src/base.lisp.

Target Slot

lock.

Generic Reader: event-base-num-connections-in (object)
Package

cl-async-base.

Methods
Reader Method: event-base-num-connections-in ((event-base event-base))

automatically generated reader method

Source

src/base.lisp.

Target Slot

num-connections-in.

Generic Writer: (setf event-base-num-connections-in) (object)
Package

cl-async-base.

Methods
Writer Method: (setf event-base-num-connections-in) ((event-base event-base))

automatically generated writer method

Source

src/base.lisp.

Target Slot

num-connections-in.

Generic Reader: event-base-num-connections-out (object)
Package

cl-async-base.

Methods
Reader Method: event-base-num-connections-out ((event-base event-base))

automatically generated reader method

Source

src/base.lisp.

Target Slot

num-connections-out.

Generic Writer: (setf event-base-num-connections-out) (object)
Package

cl-async-base.

Methods
Writer Method: (setf event-base-num-connections-out) ((event-base event-base))

automatically generated writer method

Source

src/base.lisp.

Target Slot

num-connections-out.

Generic Reader: event-base-send-errors-to-eventcb (object)
Generic Writer: (setf event-base-send-errors-to-eventcb) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-send-errors-to-eventcb ((event-base event-base))
Writer Method: (setf event-base-send-errors-to-eventcb) ((event-base event-base))

If t, will send caught errors to the event-cb instead of handle-error

Source

src/base.lisp.

Target Slot

send-errors-to-eventcb.

Generic Reader: event-base-signal-handlers (object)
Generic Writer: (setf event-base-signal-handlers) (object)
Package

cl-async-base.

Methods
Reader Method: event-base-signal-handlers ((event-base event-base))
Writer Method: (setf event-base-signal-handlers) ((event-base event-base))

Holds all signal handlers.

Source

src/base.lisp.

Target Slot

signal-handlers.

Generic Reader: event-c (object)
Package

cl-async.

Methods
Reader Method: event-c ((event event))

automatically generated reader method

Source

event.lisp.

Target Slot

c.

Generic Writer: (setf event-c) (object)
Package

cl-async.

Methods
Writer Method: (setf event-c) ((event event))

automatically generated writer method

Source

event.lisp.

Target Slot

c.

Generic Reader: event-errcode (condition)
Package

cl-async-base.

Methods
Reader Method: event-errcode ((condition event-error))
Source

src/base.lisp.

Target Slot

code.

Generic Reader: event-errmsg (condition)
Package

cl-async-base.

Methods
Reader Method: event-errmsg ((condition event-error))
Source

src/base.lisp.

Target Slot

msg.

Generic Reader: event-freed (object)
Package

cl-async.

Methods
Reader Method: event-freed ((event event))

automatically generated reader method

Source

event.lisp.

Target Slot

freed.

Generic Writer: (setf event-freed) (object)
Package

cl-async.

Methods
Writer Method: (setf event-freed) ((event event))

automatically generated writer method

Source

event.lisp.

Target Slot

freed.

Generic Reader: event-freed-p (object)
Package

cl-async.

Methods
Reader Method: event-freed-p ((event event))

automatically generated reader method

Source

event.lisp.

Target Slot

freed.

Generic Function: handle-error (error)

Default error handler responsible for handling uncaught errors.

Package

cl-async-util.

Source

src/util/error.lisp.

Methods
Method: handle-error (error)
Generic Reader: idler-freed-p (object)
Package

cl-async.

Methods
Reader Method: idler-freed-p ((idler idler))

automatically generated reader method

Source

idle.lisp.

Target Slot

freed.

Generic Reader: notifier-freed-p (object)
Package

cl-async.

Methods
Reader Method: notifier-freed-p ((notifier notifier))

automatically generated reader method

Source

notify.lisp.

Target Slot

freed.

Generic Reader: poller-freed-p (object)
Package

cl-async.

Methods
Reader Method: poller-freed-p ((poller poller))

automatically generated reader method

Source

poll.lisp.

Target Slot

freed.

Generic Reader: process-error-output (object)
Package

cl-async.

Methods
Reader Method: process-error-output ((process process))

automatically generated reader method

Source

process.lisp.

Target Slot

error-output.

Generic Writer: (setf process-error-output) (object)
Package

cl-async.

Methods
Writer Method: (setf process-error-output) ((process process))

automatically generated writer method

Source

process.lisp.

Target Slot

error-output.

Generic Reader: process-input (object)
Package

cl-async.

Methods
Reader Method: process-input ((process process))

automatically generated reader method

Source

process.lisp.

Target Slot

input.

Generic Writer: (setf process-input) (object)
Package

cl-async.

Methods
Writer Method: (setf process-input) ((process process))

automatically generated writer method

Source

process.lisp.

Target Slot

input.

Generic Reader: process-output (object)
Package

cl-async.

Methods
Reader Method: process-output ((process process))

automatically generated reader method

Source

process.lisp.

Target Slot

output.

Generic Writer: (setf process-output) (object)
Package

cl-async.

Methods
Writer Method: (setf process-output) ((process process))

automatically generated writer method

Source

process.lisp.

Target Slot

output.

Generic Function: ref (handle)

Reference a libuv handle object (uv_ref)

Package

cl-async.

Source

event-loop.lisp.

Methods
Method: ref ((handle notifier))
Source

notify.lisp.

Method: ref ((handle event))
Source

event.lisp.

Generic Function: socket (condition)
Package

cl-async.

Methods
Method: socket (thing)
Source

socket.lisp.

Reader Method: socket ((condition socket-info))
Source

socket.lisp.

Target Slot

streamish.

Generic Writer: (setf socket) (condition)
Package

cl-async.

Methods
Writer Method: (setf socket) ((condition socket-info))
Source

socket.lisp.

Target Slot

streamish.

Generic Reader: socket-accept-error-listener (condition)
Generic Writer: (setf socket-accept-error-listener) (condition)
Package

cl-async.

Methods
Reader Method: socket-accept-error-listener ((condition socket-accept-error))
Writer Method: (setf socket-accept-error-listener) ((condition socket-accept-error))
Source

socket.lisp.

Target Slot

listener.

Generic Reader: socket-c (object)
Package

cl-async.

Methods
Reader Method: socket-c ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

c.

Generic Writer: (setf socket-c) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-c) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

c.

Generic Reader: socket-closed (object)
Package

cl-async.

Methods
Reader Method: socket-closed ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

closed.

Generic Writer: (setf socket-closed) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-closed) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

closed.

Generic Reader: socket-data (object)
Package

cl-async.

Methods
Reader Method: socket-data ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

data.

Generic Writer: (setf socket-data) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-data) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

data.

Generic Function: streamish (thing)

Returned associated streamish for THING or THING itself if THING is a streamish.

Package

cl-async.

Source

streamish.lisp.

Methods
Reader Method: streamish ((async-stream async-stream))

automatically generated reader method

Source

async-stream.lisp.

Target Slot

streamish.

Method: streamish ((streamish streamish))
Reader Method: streamish ((condition streamish-info))
Target Slot

streamish.

Generic Writer: (setf streamish) (condition)
Package

cl-async.

Methods
Writer Method: (setf streamish) ((async-stream async-stream))

automatically generated writer method

Source

async-stream.lisp.

Target Slot

streamish.

Writer Method: (setf streamish) ((condition streamish-info))
Source

streamish.lisp.

Target Slot

streamish.

Generic Reader: streamish-closed (object)
Package

cl-async.

Methods
Reader Method: streamish-closed ((streamish streamish))

automatically generated reader method

Source

streamish.lisp.

Target Slot

closed.

Generic Writer: (setf streamish-closed) (object)
Package

cl-async.

Methods
Writer Method: (setf streamish-closed) ((streamish streamish))

automatically generated writer method

Source

streamish.lisp.

Target Slot

closed.

Generic Function: streamish-write (streamish data &key start end force read-cb write-cb event-cb &allow-other-keys)

Write data into a streamish. Allows specifying read/write/event
callbacks. Any callback left nil will use that current callback from the streamish (so they only override when specified, otherwise keep the current callback).

Note that libuv doesn’t buffer output for non-connected sockets, so we have to do it ourselves by checking if the socket is connected and buffering accordingly.

Package

cl-async.

Source

streamish.lisp.

Methods
Method: streamish-write ((socket socket) data &key start end force &allow-other-keys)
Source

socket.lisp.

Method: streamish-write :around ((streamish streamish) data &key read-cb write-cb event-cb &allow-other-keys)
Method: streamish-write ((streamish streamish) data &key start end &allow-other-keys)
Generic Reader: tcp-socket (condition)
Generic Writer: (setf tcp-socket) (condition)
Package

cl-async.

Methods
Reader Method: tcp-socket ((condition streamish-info))
Writer Method: (setf tcp-socket) ((condition streamish-info))
Source

streamish.lisp.

Target Slot

streamish.

Generic Function: unref (handle)

Unreference a libuv handle object (uv_unref)

Package

cl-async.

Source

event-loop.lisp.

Methods
Method: unref ((handle notifier))
Source

notify.lisp.

Method: unref ((handle event))
Source

event.lisp.


6.1.6 Standalone methods

Method: close ((stream async-stream) &key abort)

Close the stream. If aborting, attempt to clear out remaining data in the buffers before closing (is this really needed?)

Source

async-stream.lisp.

Method: initialize-instance :after ((socket socket) &key &allow-other-keys)
Source

socket.lisp.

Method: initialize-instance :after ((socket tcp-socket) &key direction &allow-other-keys)
Source

tcp.lisp.

Method: initialize-instance :after ((process process) &key exit-cb event-cb &allow-other-keys)
Source

process.lisp.

Method: initialize-instance :after ((server socket-server) &key &allow-other-keys)
Source

socket.lisp.

Method: initialize-instance :after ((fs-monitor fs-monitor) &key &allow-other-keys)
Source

fsevent.lisp.

Method: open-stream-p ((stream async-stream))

Test the underlying streamish to see if this stream is open.

Source

async-stream.lisp.

Method: stream-clear-input ((stream async-input-stream))

Attempt to clear the input buffer of an input stream.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-clear-output ((stream async-output-stream))

Attempt to clear the output buffer of an output stream.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-element-type ((stream async-stream))

This is always a binary stream.

Source

async-stream.lisp.

Method: stream-finish-output ((stream async-output-stream))

Really, since we’re async, same as force-output.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-force-output ((stream async-output-stream))

Force an output stream to send its data to the underlying fd.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-read-byte ((stream async-input-stream))

Read one byte from the underlying streamish.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-read-sequence ((stream async-input-stream) sequence start end &key)

Attempt to read a sequence of bytes from the underlying streamish.

Package

trivial-gray-streams.

Source

async-stream.lisp.

Method: stream-write-byte ((stream async-output-stream) byte)

Write one byte to the underlying streamish.

Package

sb-gray.

Source

async-stream.lisp.

Method: stream-write-sequence ((stream async-output-stream) sequence start end &key)

Write a sequence of bytes to the underlying streamish.

Package

trivial-gray-streams.

Source

async-stream.lisp.


6.1.7 Conditions

Condition: dns-error

Passed to a failure callback when a DNS error occurs on a connection.

Package

cl-async.

Source

dns.lisp.

Direct superclasses

event-error.

Condition: event-error

Describes a general error event.

Package

cl-async-base.

Source

src/base.lisp.

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: code
Initform

(quote 0)

Initargs

:code

Readers

event-errcode.

Writers

This slot is read-only.

Slot: msg
Initform

(quote nil)

Initargs

:msg

Readers

event-errmsg.

Writers

This slot is read-only.

Condition: event-freed

Thrown when a freed event is operated on.

Package

cl-async.

Source

event.lisp.

Direct superclasses

event-error.

Direct methods
Direct slots
Slot: event
Initform

(quote nil)

Initargs

:event

Readers

event-freed-event.

Writers

(setf event-freed-event).

Condition: event-info

Describes the base event for any action in cl-async.

Package

cl-async-base.

Source

src/base.lisp.

Direct superclasses

condition.

Direct subclasses
Condition: filesystem-eacces

Error: access denied

Package

cl-async.

Source

filesystem.lisp.

Direct superclasses

filesystem-error.

Condition: filesystem-enoent

Error: no such file or directory

Package

cl-async.

Source

filesystem.lisp.

Direct superclasses

filesystem-error.

Condition: filesystem-eperm

Error: permission denied

Package

cl-async.

Source

filesystem.lisp.

Direct superclasses

filesystem-error.

Condition: filesystem-error

Base class for filesystem conditions

Package

cl-async.

Source

filesystem.lisp.

Direct superclasses

event-error.

Direct subclasses
Condition: socket-aborted

Connection aborted.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Condition: socket-accept-error

Passed to a server’s event-cb when there’s an error accepting a connection.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Direct subclasses

tcp-accept-error.

Direct methods
Direct slots
Slot: listener
Initform

(quote (cffi-sys:null-pointer))

Initargs

:listener

Readers

socket-accept-error-listener.

Writers

(setf socket-accept-error-listener).

Slot: server
Initform

(quote nil)

Initargs

:server

Readers

socket-accept-error-server.

Writers

(setf socket-accept-error-server).

Condition: socket-address-in-use

Address is already in use.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Condition: socket-closed
Package

cl-async.

Source

socket.lisp.

Direct superclasses

streamish-closed.

Condition: socket-eof

Peer closes a socket connection.

Package

cl-async.

Source

socket.lisp.

Direct superclasses
Direct subclasses

tcp-eof.

Condition: socket-error

Describes a general socket connection error.

Package

cl-async.

Source

socket.lisp.

Direct superclasses
Direct subclasses
Condition: socket-info

Base socket condition. Holds the socket object.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

streamish-info.

Direct subclasses
Direct methods
Direct slots
Slot: streamish
Initform

(quote nil)

Initargs

:streamish, :socket

Readers

socket.

Writers

(setf socket).

Condition: socket-refused

Connection refused.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Direct subclasses

tcp-refused.

Condition: socket-reset

Connection reset.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Direct subclasses

tcp-reset.

Condition: socket-timeout

Socket connection timed out.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

socket-error.

Direct subclasses

tcp-timeout.

Condition: streamish-broken-pipe

Broken pipe.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

streamish-error.

Condition: streamish-canceled

Operation canceled.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

streamish-error.

Condition: streamish-closed

Thrown when a closed streamish is being operated on.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

streamish-error.

Direct subclasses

socket-closed.

Condition: streamish-enoent

Passed to an event callback on Error: no such file or directory.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

streamish-error.

Condition: streamish-eof

Passed to an event callback when stream EOF is reached.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

streamish-info.

Direct subclasses

socket-eof.

Condition: streamish-error

Describes a general streamish error.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses
Direct subclasses
Condition: streamish-info

Base streamish condition. Holds the streamish object.

Package

cl-async.

Source

streamish.lisp.

Direct superclasses

event-info.

Direct subclasses
Direct methods
Direct slots
Slot: streamish
Initform

(quote nil)

Initargs

:streamish, :socket

Readers
Writers
Condition: tcp-accept-error
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-accept-error.

Condition: tcp-eof
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-eof.

Condition: tcp-error
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-error.

Condition: tcp-info
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-info.

Condition: tcp-refused
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-refused.

Condition: tcp-reset
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-reset.

Condition: tcp-server-bind-error

Thrown when a server fails to bind (generally, the port is already in use).

Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-error.

Direct methods
Direct slots
Slot: addr
Initform

(quote nil)

Initargs

:addr

Readers

tcp-server-bind-error-addr.

Writers

(setf tcp-server-bind-error-addr).

Slot: port
Initform

(quote nil)

Initargs

:port

Readers

tcp-server-bind-error-port.

Writers

(setf tcp-server-bind-error-port).

Condition: tcp-timeout
Package

cl-async.

Source

tcp.lisp.

Direct superclasses

socket-timeout.


6.1.8 Classes

Class: async-input-stream

Async input stream.

Package

cl-async.

Source

async-stream.lisp.

Direct superclasses
Direct subclasses

async-io-stream.

Direct methods
Class: async-io-stream

Async stream for both input and output.

Package

cl-async.

Source

async-stream.lisp.

Direct superclasses
Class: async-output-stream

Async output stream.

Package

cl-async.

Source

async-stream.lisp.

Direct superclasses
Direct subclasses

async-io-stream.

Direct methods
Class: async-stream

The underlying class for async streams. Wraps a streamish.

Package

cl-async.

Source

async-stream.lisp.

Direct superclasses

trivial-gray-stream-mixin.

Direct subclasses
Direct methods
Direct slots
Slot: streamish
Initargs

:socket, :streamish

Readers

streamish.

Writers

(setf streamish).

Slot: buffer
Initform

(cl-async-util:make-buffer)

Readers

stream-buffer.

Writers

(setf stream-buffer).

Class: event

Wraps a C libuv event object.

Package

cl-async.

Source

event.lisp.

Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

event-c.

Writers

(setf event-c).

Slot: freed
Readers
Writers

(setf event-freed).

Class: event-base

A class that holds an event loop and all of the state that it manages.

One object to rule them all, one object to find them.
One object to bring them in and in the darkness bind them.

Package

cl-async-base.

Source

src/base.lisp.

Direct methods
Direct slots
Slot: c

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

Initargs

:c

Readers

event-base-c.

Writers

(setf event-base-c).

Slot: id

Holds this event loop’s numeric id.

Initargs

:id

Readers

event-base-id.

Writers

(setf event-base-id).

Slot: function-registry

Holds all callbacks attached to this event loop.

Initform

(make-hash-table :test (function eql))

Initargs

:function-registry

Readers

event-base-function-registry.

Writers

(setf event-base-function-registry).

Slot: data-registry

Holds all callback data attached to this event loop.

Initform

(make-hash-table :test (function eql))

Initargs

:data-registry

Readers

event-base-data-registry.

Writers

(setf event-base-data-registry).

Slot: exit-functions

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

Initargs

:exit-functions

Readers

event-base-exit-functions.

Writers

(setf event-base-exit-functions).

Slot: signal-handlers

Holds all signal handlers.

Initargs

:signal-handlers

Readers

event-base-signal-handlers.

Writers

(setf event-base-signal-handlers).

Slot: dns-base

Holds the DNS base object used for DNS lookups.

Initargs

:dns-base

Readers

event-base-dns-base.

Writers

(setf event-base-dns-base).

Slot: dns-ref-count

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

Initform

0

Initargs

:dns-ref-count

Readers

event-base-dns-ref-count.

Writers

(setf event-base-dns-ref-count).

Slot: catch-app-errors

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

Initargs

:catch-app-errors

Readers

event-base-catch-app-errors.

Writers

(setf event-base-catch-app-errors).

Slot: send-errors-to-eventcb

If t, will send caught errors to the event-cb instead of handle-error

Initargs

:send-errors-to-eventcb

Readers

event-base-send-errors-to-eventcb.

Writers

(setf event-base-send-errors-to-eventcb).

Slot: lock

Holds *the* lock for this event base.

Initform

(bordeaux-threads:make-lock)

Initargs

:lock

Readers

event-base-lock.

Writers

(setf event-base-lock).

Slot: num-connections-in
Initform

0

Readers

event-base-num-connections-in.

Writers

(setf event-base-num-connections-in).

Slot: num-connections-out
Initform

0

Readers

event-base-num-connections-out.

Writers

(setf event-base-num-connections-out).

Class: idler

Wraps a libuv idle handle.

Package

cl-async.

Source

idle.lisp.

Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

idler-c.

Writers

(setf idler-c).

Slot: freed
Readers
Writers

(setf idler-freed).

Class: notifier

Wraps a threading-enabled notifier.

Package

cl-async.

Source

notify.lisp.

Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

notifier-c.

Writers

(setf notifier-c).

Slot: freed
Readers
Writers

(setf notifier-freed).

Slot: single-shot
Initform

t

Initargs

:single-shot

Readers
Writers

(setf notifier-single-shot).

Class: pipe-server
Package

cl-async.

Source

pipe.lisp.

Direct superclasses
Direct methods
Class: poller

Wraps a polling handle.

Package

cl-async.

Source

poll.lisp.

Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

poller-c.

Writers

(setf poller-c).

Slot: freed
Readers
Writers

(setf poller-freed).

Class: socket

Wraps around a socket.

Package

cl-async.

Source

socket.lisp.

Direct superclasses

streamish.

Direct subclasses
Direct methods
Direct slots
Slot: c
Readers

socket-c.

Writers

(setf socket-c).

Slot: data
Readers

socket-data.

Writers

(setf socket-data).

Slot: address
Readers

socket-address.

Writers

(setf socket-address).

Slot: closed
Readers

socket-closed.

Writers

(setf socket-closed).

Slot: buffer

Holds data sent on the socket that hasn’t been sent yet.

Initform

(cl-async-util:make-buffer)

Initargs

:buffer

Readers

socket-buffer.

Writers

(setf socket-buffer).

Slot: bufferingp

Lets us know if the socket is currently buffering output.

Readers

socket-buffering-p.

Writers

(setf socket-buffering-p).

Slot: connected
Initargs

:connected

Readers

socket-connected.

Writers

(setf socket-connected).

Slot: drain-read-buffer
Readers

socket-drain-read-buffer.

Writers

(setf socket-drain-read-buffer).

Class: streamish

Wraps around a streamish.

Package

cl-async.

Source

streamish.lisp.

Direct subclasses

socket.

Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

streamish-c.

Writers

(setf streamish-c).

Slot: data

Used to store arbitrary (app-defined) data with a streamish.

Initargs

cl-async::data

Readers

streamish-data.

Writers

(setf streamish-data).

Slot: closed
Initargs

:closed

Readers

streamish-closed.

Writers

(setf streamish-closed).

Slot: drain-read-buffer
Initform

t

Initargs

:drain-read-buffer

Readers

streamish-drain-read-buffer.

Writers

(setf streamish-drain-read-buffer).

Class: tcp-server
Package

cl-async.

Source

tcp.lisp.

Direct superclasses
Direct methods
Class: tcp-socket
Package

cl-async.

Source

tcp.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: direction
Initform

:out

Initargs

:direction

Readers

socket-direction.

Writers

(setf socket-direction).


6.1.9 Types

Type: bytes-or-string ()
Package

cl-async-util.

Source

src/util/helpers.lisp.

Type: callback ()
Package

cl-async-util.

Source

src/util/helpers.lisp.

Type: octet ()
Package

cl-async-util.

Source

src/util/helpers.lisp.

Type: octet-vector ()
Package

cl-async-util.

Source

src/util/helpers.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *evcb-err*
Package

cl-async-util.

Source

src/util/error.lisp.

Special Variable: *event-base-registry*

Holds ID -> event-base lookups for every active event loop. Mainly used when grabbing the threading context for a particular event loop.

Package

cl-async.

Source

event-loop.lisp.

Special Variable: *event-base-registry-lock*

Locks the event-base registry.

Package

cl-async.

Source

event-loop.lisp.

Special Variable: *loop-close-iters*

Maximum number of event loop cleanup iterations

Package

cl-async.

Source

event-loop.lisp.


6.2.2 Ordinary functions

Function: %fs-monitor-close (handle)
Package

cl-async.

Source

fsevent.lisp.

Function: %pipe-connect (socket/stream name)

Connect a pipe initialized with init-client-socket.

Package

cl-async.

Source

pipe.lisp.

Function: async-cb (async-c)

Called when an async notifier is triggered.

Package

cl-async.

Source

notify.lisp.

Function: async-close-cb (async-c)

Called when an async handle is closed.

Package

cl-async.

Source

notify.lisp.

Function: check-event-loop-running ()
Package

cl-async.

Source

event-loop.lisp.

Function: check-event-unfreed (event)

Checks that an event being operated on is not freed.

Package

cl-async.

Source

event.lisp.

Function: check-notifier-unfreed (notifier)

Checks that an notifier being operated on is not freed.

Package

cl-async.

Source

notify.lisp.

Function: check-socket-open (socket)

Compatibility alias for CHECK-STREAMISH-OPEN.

Package

cl-async.

Source

socket.lisp.

Function: dns-cb (req status addrinfo)

Callback for DNS lookups.

Package

cl-async.

Source

dns.lisp.

Function: do-close-loop (evloop)

Close an event loop by looping over its open handles, closing them, rinsing and repeating until uv-loop-close returns 0, but at most *LOOP-CLOSE-ITERS* times.

Package

cl-async.

Source

event-loop.lisp.

Function: do-close-streamish (uvstream &key force)

Close an UV stream.

Package

cl-async.

Source

streamish.lisp.

Function: event-handler (error event-cb &key streamish throw)

Called when an event (error, mainly) occurs.

Package

cl-async.

Source

streamish.lisp.

Function: fs-cb (req)
Package

cl-async.

Source

filesystem.lisp.

Function: fs-event-callback (handle path events status)
Package

cl-async.

Source

fsevent.lisp.

Function: fs-monitor-close-cb (handle)

Called when a fs-monitor closes.

Package

cl-async.

Source

fsevent.lisp.

Function: idle-cb (handle)

Called when an idle handler fires.

Package

cl-async.

Source

idle.lisp.

Function: idle-close-cb (idle-c)

Called when an idler closes.

Package

cl-async.

Source

idle.lisp.

Function: init-client-socket (socket-class &key read-cb event-cb data stream connect-cb write-cb direction read-timeout write-timeout dont-drain-read-buffer)

Initialize an async socket, but do not connect it.

Package

cl-async.

Source

socket.lisp.

Function: init-incoming-socket (server status)

Called by the socket-accept-cb when an incoming connection is detected. Sets up a socket between the client and the server along with any callbacks the server has attached to it. Returns the cl-async socket object created.

Package

cl-async.

Source

socket.lisp.

Function: init-stdio-container (container out-p type fd pipe-args)
Package

cl-async.

Source

process.lisp.

Function: lisp-signal-cb (signo)

Generic callback for lisp signal handling.

Package

cl-async.

Source

signal.lisp.

Function: loop-exit-walk-cb (handle arg)

Called when we want to close the loop AND IT WONT CLOSE. So we walk each handle and close them.

Package

cl-async.

Source

event-loop.lisp.

Function: poll-cb (poll-c status events)

Called when something happens on a polled FD.

Package

cl-async.

Source

poll.lisp.

Function: poll-close-cb (poll-c)

Called when a poller closes.

Package

cl-async.

Source

poll.lisp.

Function: process-close (process-handle)
Package

cl-async.

Source

process.lisp.

Function: process-close-cb (process-handle)

Called when a process closes.

Package

cl-async.

Source

process.lisp.

Function: process-event-loop-exit-callbacks ()

run and clear out all event loop exit functions.

Package

cl-async.

Source

event-loop.lisp.

Function: process-exit-cb (process-handle exit-status term-signal)
Package

cl-async.

Source

process.lisp.

Function: reverse-dns-cb (req status hostname service)

Callback for reverse DNS lookups.

Package

cl-async.

Source

dns.lisp.

Function: set-lisp-signal-handler (signo fn)

Replace the current handler for the signal number under signo, and return a pointer to the handler that is being replaced.

Package

cl-async.

Source

signal.lisp.

Function: signal-cb (watcher signo)

All signals come through here.

Package

cl-async.

Source

signal.lisp.

Function: signal-close-cb (watcher)

Called when a signal handler closes.

Package

cl-async.

Source

signal.lisp.

Function: signal-pointer (signo)

Creates a pointer from a signal number. Not that this doesn’t need to be freed since we’re not allocating anything...just creating a pointer object with a specific address (which can be GCed).

Package

cl-async.

Source

signal.lisp.

Function: socket-accept-cb (server status)

Called by a listener when an incoming connection is detected. Thin wrapper around init-incoming-socket, which does all the setting up of callbacks and pointers and so forth.

Package

cl-async.

Source

socket.lisp.

Function: socket-connect-cb (req status)

Called when an outgoing socket connects.

Package

cl-async.

Source

socket.lisp.

Function: socket-server (server-class address read-cb &key event-cb connect-cb backlog stream fd)

Start a socket listener on the current event loop. Returns a socket-server instance which can be closed with close-socket-server

Package

cl-async.

Source

socket.lisp.

Function: streamish-alloc-cb (handle size buf)

Called when we want to allocate data to be filled for stream reading.

Package

cl-async.

Source

streamish.lisp.

Function: streamish-close-cb (uvstream)

Called when a streamish closes.

Package

cl-async.

Source

streamish.lisp.

Function: streamish-convert-data (data)
Package

cl-async.

Source

streamish.lisp.

Function: streamish-read-cb (uvstream nread buf)

Called when a stream has been read into a buffer returned by alloc-cb.

Package

cl-async.

Source

streamish.lisp.

Function: streamish-read-start (streamish)

Start reading on the socket, return true on success. Invoke streamish’ event handler callback on error, returning NIL.

Package

cl-async.

Source

streamish.lisp.

Function: streamish-shutdown-cb (req status)

Called when a streamish shuts down.

Package

cl-async.

Source

streamish.lisp.

Function: streamish-write-cb (req status)

Called when data is finished being written to a streamish.

Package

cl-async.

Source

streamish.lisp.

Function: tcp-connect-new (host port read-cb &key data stream event-cb connect-cb write-cb read-timeout write-timeout dont-drain-read-buffer)

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.

Function: tcp-server-closed (server)
Package

cl-async.

Source

tcp.lisp.

Function: tcp-server-new (bind-address port read-cb &key event-cb connect-cb backlog stream fd)

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

Package

cl-async.

Source

tcp.lisp.

Function: timer-cb (timer-c)

Callback used by the async timer system to find and run user-specified callbacks on timer events.

Package

cl-async.

Source

event.lisp.

Function: timer-close-cb (timer-c)

Called when a timer closes.

Package

cl-async.

Source

event.lisp.

Function: walk-cb (handle arg)

Called when we’re walking the loop.

Package

cl-async.

Source

event-loop.lisp.

Function: write-to-uvstream (uvstream data &key start end)

Util function to write data directly to a uv stream object.

Package

cl-async.

Source

streamish.lisp.


6.2.3 Generic functions

Generic Function: errno-event (streamish errno)

Make an event based on errno and streamish.

Package

cl-async.

Source

streamish.lisp.

Methods
Method: errno-event (streamish (errno (eql -1)))
Source

filesystem.lisp.

Method: errno-event (streamish (errno (eql -13)))
Source

filesystem.lisp.

Method: errno-event (streamish (errno (eql -2)))
Source

filesystem.lisp.

Method: errno-event (socket (errno (eql -98)))
Source

socket.lisp.

Method: errno-event ((socket socket) (errno (eql -103)))
Source

socket.lisp.

Method: errno-event ((socket socket) (errno (eql -111)))
Source

socket.lisp.

Method: errno-event ((socket socket) (errno (eql -4095)))
Source

socket.lisp.

Method: errno-event ((socket socket) (errno (eql -104)))
Source

socket.lisp.

Method: errno-event ((socket socket) (errno (eql -110)))
Source

socket.lisp.

Method: errno-event (streamish (errno (eql -3007)))
Source

dns.lisp.

Method: errno-event ((streamish streamish) (errno (eql -125)))
Method: errno-event ((streamish streamish) (errno (eql -32)))
Method: errno-event ((streamish streamish) (errno (eql -4095)))
Method: errno-event ((streamish streamish) (errno (eql -2)))
Method: errno-event ((streamish streamish) errno)
Method: errno-event (streamish (errno (eql -14)))
Method: errno-event (streamish (errno (eql -3008)))
Method: errno-event (streamish errno)
Generic Reader: event-freed-event (condition)
Generic Writer: (setf event-freed-event) (condition)
Package

cl-async.

Methods
Reader Method: event-freed-event ((condition event-freed))
Writer Method: (setf event-freed-event) ((condition event-freed))
Source

event.lisp.

Target Slot

event.

Generic Reader: fs-monitor-c (object)
Package

cl-async.

Methods
Reader Method: fs-monitor-c ((fs-monitor fs-monitor))

automatically generated reader method

Source

fsevent.lisp.

Target Slot

c.

Generic Writer: (setf fs-monitor-c) (object)
Package

cl-async.

Methods
Writer Method: (setf fs-monitor-c) ((fs-monitor fs-monitor))

automatically generated writer method

Source

fsevent.lisp.

Target Slot

c.

Generic Function: handle-cleanup (handle-type handle)

Perform cleanup for a libuv handle

Package

cl-async.

Source

event-loop.lisp.

Methods
Method: handle-cleanup ((handle-type (eql :fs-event)) handle)
Source

fsevent.lisp.

Method: handle-cleanup ((handle-type (eql :process)) handle)
Source

process.lisp.

Method: handle-cleanup ((handle-type (eql :async)) handle)
Source

notify.lisp.

Method: handle-cleanup ((handle-type (eql :named-pipe)) handle)
Source

pipe.lisp.

Method: handle-cleanup ((handle-type (eql :tcp)) handle)
Source

tcp.lisp.

Method: handle-cleanup ((handle-type (eql :async-socket)) handle)
Source

socket.lisp.

Method: handle-cleanup ((handle-type (eql :timer)) handle)
Source

event.lisp.

Method: handle-cleanup (handle-type handle)
Generic Reader: idler-c (object)
Package

cl-async.

Methods
Reader Method: idler-c ((idler idler))

automatically generated reader method

Source

idle.lisp.

Target Slot

c.

Generic Writer: (setf idler-c) (object)
Package

cl-async.

Methods
Writer Method: (setf idler-c) ((idler idler))

automatically generated writer method

Source

idle.lisp.

Target Slot

c.

Generic Reader: idler-freed (object)
Package

cl-async.

Methods
Reader Method: idler-freed ((idler idler))

automatically generated reader method

Source

idle.lisp.

Target Slot

freed.

Generic Writer: (setf idler-freed) (object)
Package

cl-async.

Methods
Writer Method: (setf idler-freed) ((idler idler))

automatically generated writer method

Source

idle.lisp.

Target Slot

freed.

Generic Function: make-socket-handle (socket-or-server)

Create an underlying stream handle for socket connection

Package

cl-async.

Source

socket.lisp.

Methods
Method: make-socket-handle ((socket-or-server pipe-mixin))
Source

pipe.lisp.

Method: make-socket-handle ((socket-or-server tcp-mixin))
Source

tcp.lisp.

Generic Reader: notifier-c (object)
Package

cl-async.

Methods
Reader Method: notifier-c ((notifier notifier))

automatically generated reader method

Source

notify.lisp.

Target Slot

c.

Generic Writer: (setf notifier-c) (object)
Package

cl-async.

Methods
Writer Method: (setf notifier-c) ((notifier notifier))

automatically generated writer method

Source

notify.lisp.

Target Slot

c.

Generic Reader: notifier-freed (object)
Package

cl-async.

Methods
Reader Method: notifier-freed ((notifier notifier))

automatically generated reader method

Source

notify.lisp.

Target Slot

freed.

Generic Writer: (setf notifier-freed) (object)
Package

cl-async.

Methods
Writer Method: (setf notifier-freed) ((notifier notifier))

automatically generated writer method

Source

notify.lisp.

Target Slot

freed.

Generic Reader: notifier-freed-notifier (condition)
Generic Writer: (setf notifier-freed-notifier) (condition)
Package

cl-async.

Methods
Reader Method: notifier-freed-notifier ((condition notifier-freed))
Writer Method: (setf notifier-freed-notifier) ((condition notifier-freed))
Source

notify.lisp.

Target Slot

notifier.

Generic Reader: notifier-single-shot (object)
Package

cl-async.

Methods
Reader Method: notifier-single-shot ((notifier notifier))

automatically generated reader method

Source

notify.lisp.

Target Slot

single-shot.

Generic Writer: (setf notifier-single-shot) (object)
Package

cl-async.

Methods
Writer Method: (setf notifier-single-shot) ((notifier notifier))

automatically generated writer method

Source

notify.lisp.

Target Slot

single-shot.

Generic Reader: notifier-single-shot-p (object)
Package

cl-async.

Methods
Reader Method: notifier-single-shot-p ((notifier notifier))

automatically generated reader method

Source

notify.lisp.

Target Slot

single-shot.

Generic Reader: poller-c (object)
Package

cl-async.

Methods
Reader Method: poller-c ((poller poller))

automatically generated reader method

Source

poll.lisp.

Target Slot

c.

Generic Writer: (setf poller-c) (object)
Package

cl-async.

Methods
Writer Method: (setf poller-c) ((poller poller))

automatically generated writer method

Source

poll.lisp.

Target Slot

c.

Generic Reader: poller-freed (object)
Package

cl-async.

Methods
Reader Method: poller-freed ((poller poller))

automatically generated reader method

Source

poll.lisp.

Target Slot

freed.

Generic Writer: (setf poller-freed) (object)
Package

cl-async.

Methods
Writer Method: (setf poller-freed) ((poller poller))

automatically generated writer method

Source

poll.lisp.

Target Slot

freed.

Generic Reader: process-c (object)
Package

cl-async.

Methods
Reader Method: process-c ((process process))

automatically generated reader method

Source

process.lisp.

Target Slot

c.

Generic Writer: (setf process-c) (object)
Package

cl-async.

Methods
Writer Method: (setf process-c) ((process process))

automatically generated writer method

Source

process.lisp.

Target Slot

c.

Generic Function: send-buffered-data (stream)
Package

cl-async.

Methods
Method: send-buffered-data ((stream async-output-stream))

Take data we’ve buffered between initial sending and actual streamish and send it out.

Source

async-stream.lisp.

Generic Function: server-socket-class (server)

Return socket class for connections accepted by SERVER

Package

cl-async.

Source

socket.lisp.

Methods
Method: server-socket-class ((server pipe-server))
Source

pipe.lisp.

Method: server-socket-class ((server tcp-server))
Source

tcp.lisp.

Generic Reader: socket-accept-error-server (condition)
Generic Writer: (setf socket-accept-error-server) (condition)
Package

cl-async.

Methods
Reader Method: socket-accept-error-server ((condition socket-accept-error))
Writer Method: (setf socket-accept-error-server) ((condition socket-accept-error))
Source

socket.lisp.

Target Slot

server.

Generic Reader: socket-address (object)
Package

cl-async.

Methods
Reader Method: socket-address ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

address.

Generic Writer: (setf socket-address) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-address) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

address.

Generic Reader: socket-buffer (object)
Generic Writer: (setf socket-buffer) (object)
Package

cl-async.

Methods
Reader Method: socket-buffer ((socket socket))
Writer Method: (setf socket-buffer) ((socket socket))

Holds data sent on the socket that hasn’t been sent yet.

Source

socket.lisp.

Target Slot

buffer.

Generic Reader: socket-buffering-p (object)
Generic Writer: (setf socket-buffering-p) (object)
Package

cl-async.

Methods
Reader Method: socket-buffering-p ((socket socket))
Writer Method: (setf socket-buffering-p) ((socket socket))

Lets us know if the socket is currently buffering output.

Source

socket.lisp.

Target Slot

bufferingp.

Generic Reader: socket-connected (object)
Package

cl-async.

Methods
Reader Method: socket-connected ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

connected.

Generic Writer: (setf socket-connected) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-connected) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

connected.

Generic Reader: socket-direction (object)
Package

cl-async.

Methods
Reader Method: socket-direction ((tcp-socket tcp-socket))

automatically generated reader method

Source

tcp.lisp.

Target Slot

direction.

Generic Writer: (setf socket-direction) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-direction) ((tcp-socket tcp-socket))

automatically generated writer method

Source

tcp.lisp.

Target Slot

direction.

Generic Reader: socket-drain-read-buffer (object)
Package

cl-async.

Methods
Reader Method: socket-drain-read-buffer ((socket socket))

automatically generated reader method

Source

socket.lisp.

Target Slot

drain-read-buffer.

Generic Writer: (setf socket-drain-read-buffer) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-drain-read-buffer) ((socket socket))

automatically generated writer method

Source

socket.lisp.

Target Slot

drain-read-buffer.

Generic Function: socket-server-bind (server address fd)

Bind socket server to the specified address, return libuv errno. Specify FD to bind the server to an existing file descriptor.

Package

cl-async.

Source

socket.lisp.

Methods
Method: socket-server-bind ((server pipe-server) address fd)
Source

pipe.lisp.

Method: socket-server-bind ((server tcp-server) address fd)
Source

tcp.lisp.

Generic Reader: socket-server-c (object)
Package

cl-async.

Methods
Reader Method: socket-server-c ((socket-server socket-server))

automatically generated reader method

Source

socket.lisp.

Target Slot

c.

Generic Writer: (setf socket-server-c) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-server-c) ((socket-server socket-server))

automatically generated writer method

Source

socket.lisp.

Target Slot

c.

Generic Reader: socket-server-closed (object)
Package

cl-async.

Methods
Reader Method: socket-server-closed ((socket-server socket-server))

automatically generated reader method

Source

socket.lisp.

Target Slot

closed.

Generic Writer: (setf socket-server-closed) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-server-closed) ((socket-server socket-server))

automatically generated writer method

Source

socket.lisp.

Target Slot

closed.

Generic Reader: socket-server-stream (object)
Package

cl-async.

Methods
Reader Method: socket-server-stream ((socket-server socket-server))

automatically generated reader method

Source

socket.lisp.

Target Slot

stream.

Generic Writer: (setf socket-server-stream) (object)
Package

cl-async.

Methods
Writer Method: (setf socket-server-stream) ((socket-server socket-server))

automatically generated writer method

Source

socket.lisp.

Target Slot

stream.

Generic Function: stream-append-bytes (stream bytes)
Package

cl-async.

Methods
Method: stream-append-bytes ((stream async-stream) bytes)

Append some data to a stream’s underlying buffer.

Source

async-stream.lisp.

Generic Reader: stream-buffer (object)
Package

cl-async.

Methods
Reader Method: stream-buffer ((async-stream async-stream))

automatically generated reader method

Source

async-stream.lisp.

Target Slot

buffer.

Generic Writer: (setf stream-buffer) (object)
Package

cl-async.

Methods
Writer Method: (setf stream-buffer) ((async-stream async-stream))

automatically generated writer method

Source

async-stream.lisp.

Target Slot

buffer.

Generic Function: stream-output-type (stream)
Package

cl-async.

Methods
Method: stream-output-type ((stream async-stream))

This is always a binary stream.

Source

async-stream.lisp.

Generic Reader: streamish-c (object)
Package

cl-async.

Methods
Reader Method: streamish-c ((streamish streamish))

automatically generated reader method

Source

streamish.lisp.

Target Slot

c.

Generic Writer: (setf streamish-c) (object)
Package

cl-async.

Methods
Writer Method: (setf streamish-c) ((streamish streamish))

automatically generated writer method

Source

streamish.lisp.

Target Slot

c.

Generic Reader: streamish-data (object)
Generic Writer: (setf streamish-data) (object)
Package

cl-async.

Methods
Reader Method: streamish-data ((streamish streamish))
Writer Method: (setf streamish-data) ((streamish streamish))

Used to store arbitrary (app-defined) data with a streamish.

Source

streamish.lisp.

Target Slot

data.

Generic Reader: streamish-drain-read-buffer (object)
Package

cl-async.

Methods
Reader Method: streamish-drain-read-buffer ((streamish streamish))

automatically generated reader method

Source

streamish.lisp.

Target Slot

drain-read-buffer.

Generic Writer: (setf streamish-drain-read-buffer) (object)
Package

cl-async.

Methods
Writer Method: (setf streamish-drain-read-buffer) ((streamish streamish))

automatically generated writer method

Source

streamish.lisp.

Target Slot

drain-read-buffer.

Generic Reader: tcp-server-bind-error-addr (condition)
Generic Writer: (setf tcp-server-bind-error-addr) (condition)
Package

cl-async.

Methods
Reader Method: tcp-server-bind-error-addr ((condition tcp-server-bind-error))
Writer Method: (setf tcp-server-bind-error-addr) ((condition tcp-server-bind-error))
Source

tcp.lisp.

Target Slot

addr.

Generic Reader: tcp-server-bind-error-port (condition)
Generic Writer: (setf tcp-server-bind-error-port) (condition)
Package

cl-async.

Methods
Reader Method: tcp-server-bind-error-port ((condition tcp-server-bind-error))
Writer Method: (setf tcp-server-bind-error-port) ((condition tcp-server-bind-error))
Source

tcp.lisp.

Target Slot

port.

Generic Function: write-pending-socket-data (socket)

Write any pending data on the given socket to its underlying stream.

Package

cl-async.

Source

socket.lisp.

Methods
Method: write-pending-socket-data ((socket socket))

6.2.4 Conditions

Condition: notifier-freed

Thrown when a freed notifier is operated on.

Package

cl-async.

Source

notify.lisp.

Direct superclasses

event-error.

Direct methods
Direct slots
Slot: notifier
Initform

(quote nil)

Initargs

:notifier

Readers

notifier-freed-notifier.

Writers

(setf notifier-freed-notifier).


6.2.5 Classes

Class: fs-monitor
Package

cl-async.

Source

fsevent.lisp.

Direct methods
Direct slots
Slot: c
Readers

fs-monitor-c.

Writers

(setf fs-monitor-c).

Class: pipe
Package

cl-async.

Source

pipe.lisp.

Direct superclasses
Class: pipe-mixin
Package

cl-async.

Source

pipe.lisp.

Direct subclasses
Direct methods

make-socket-handle.

Class: process
Package

cl-async.

Source

process.lisp.

Direct methods
Direct slots
Slot: c
Initargs

:c

Readers

process-c.

Writers

(setf process-c).

Slot: input
Initargs

:input

Readers

process-input.

Writers

(setf process-input).

Slot: output
Initargs

:output

Readers

process-output.

Writers

(setf process-output).

Slot: error-output
Initargs

:error-output

Readers

process-error-output.

Writers

(setf process-error-output).

Class: socket-server

Wraps around a connection listener.

Package

cl-async.

Source

socket.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: c
Initform

(cffi-sys:null-pointer)

Initargs

:c

Readers

socket-server-c.

Writers

(setf socket-server-c).

Slot: closed
Initargs

:closed

Readers

socket-server-closed.

Writers

(setf socket-server-closed).

Slot: stream
Package

common-lisp.

Initargs

:stream

Readers

socket-server-stream.

Writers

(setf socket-server-stream).

Class: tcp-mixin
Package

cl-async.

Source

tcp.lisp.

Direct subclasses
Direct methods

make-socket-handle.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S   T   U   W  
Index Entry  Section

%
%fs-monitor-close: Private ordinary functions
%pipe-connect: Private ordinary functions

(
(setf event-base-c): Public generic functions
(setf event-base-c): Public generic functions
(setf event-base-catch-app-errors): Public generic functions
(setf event-base-catch-app-errors): Public generic functions
(setf event-base-data-registry): Public generic functions
(setf event-base-data-registry): Public generic functions
(setf event-base-dns-base): Public generic functions
(setf event-base-dns-base): Public generic functions
(setf event-base-dns-ref-count): Public generic functions
(setf event-base-dns-ref-count): Public generic functions
(setf event-base-exit-functions): Public generic functions
(setf event-base-exit-functions): Public generic functions
(setf event-base-function-registry): Public generic functions
(setf event-base-function-registry): Public generic functions
(setf event-base-id): Public generic functions
(setf event-base-id): Public generic functions
(setf event-base-lock): Public generic functions
(setf event-base-lock): Public generic functions
(setf event-base-num-connections-in): Public generic functions
(setf event-base-num-connections-in): Public generic functions
(setf event-base-num-connections-out): Public generic functions
(setf event-base-num-connections-out): Public generic functions
(setf event-base-send-errors-to-eventcb): Public generic functions
(setf event-base-send-errors-to-eventcb): Public generic functions
(setf event-base-signal-handlers): Public generic functions
(setf event-base-signal-handlers): Public generic functions
(setf event-c): Public generic functions
(setf event-c): Public generic functions
(setf event-freed): Public generic functions
(setf event-freed): Public generic functions
(setf event-freed-event): Private generic functions
(setf event-freed-event): Private generic functions
(setf fs-monitor-c): Private generic functions
(setf fs-monitor-c): Private generic functions
(setf idler-c): Private generic functions
(setf idler-c): Private generic functions
(setf idler-freed): Private generic functions
(setf idler-freed): Private generic functions
(setf notifier-c): Private generic functions
(setf notifier-c): Private generic functions
(setf notifier-freed): Private generic functions
(setf notifier-freed): Private generic functions
(setf notifier-freed-notifier): Private generic functions
(setf notifier-freed-notifier): Private generic functions
(setf notifier-single-shot): Private generic functions
(setf notifier-single-shot): Private generic functions
(setf poller-c): Private generic functions
(setf poller-c): Private generic functions
(setf poller-freed): Private generic functions
(setf poller-freed): Private generic functions
(setf process-c): Private generic functions
(setf process-c): Private generic functions
(setf process-error-output): Public generic functions
(setf process-error-output): Public generic functions
(setf process-input): Public generic functions
(setf process-input): Public generic functions
(setf process-output): Public generic functions
(setf process-output): Public generic functions
(setf socket): Public generic functions
(setf socket): Public generic functions
(setf socket-accept-error-listener): Public generic functions
(setf socket-accept-error-listener): Public generic functions
(setf socket-accept-error-server): Private generic functions
(setf socket-accept-error-server): Private generic functions
(setf socket-address): Private generic functions
(setf socket-address): Private generic functions
(setf socket-buffer): Private generic functions
(setf socket-buffer): Private generic functions
(setf socket-buffering-p): Private generic functions
(setf socket-buffering-p): Private generic functions
(setf socket-c): Public generic functions
(setf socket-c): Public generic functions
(setf socket-closed): Public generic functions
(setf socket-closed): Public generic functions
(setf socket-connected): Private generic functions
(setf socket-connected): Private generic functions
(setf socket-data): Public generic functions
(setf socket-data): Public generic functions
(setf socket-direction): Private generic functions
(setf socket-direction): Private generic functions
(setf socket-drain-read-buffer): Private generic functions
(setf socket-drain-read-buffer): Private generic functions
(setf socket-server-c): Private generic functions
(setf socket-server-c): Private generic functions
(setf socket-server-closed): Private generic functions
(setf socket-server-closed): Private generic functions
(setf socket-server-stream): Private generic functions
(setf socket-server-stream): Private generic functions
(setf stream-buffer): Private generic functions
(setf stream-buffer): Private generic functions
(setf streamish): Public generic functions
(setf streamish): Public generic functions
(setf streamish): Public generic functions
(setf streamish-c): Private generic functions
(setf streamish-c): Private generic functions
(setf streamish-closed): Public generic functions
(setf streamish-closed): Public generic functions
(setf streamish-data): Private generic functions
(setf streamish-data): Private generic functions
(setf streamish-drain-read-buffer): Private generic functions
(setf streamish-drain-read-buffer): Private generic functions
(setf tcp-server-bind-error-addr): Private generic functions
(setf tcp-server-bind-error-addr): Private generic functions
(setf tcp-server-bind-error-port): Private generic functions
(setf tcp-server-bind-error-port): Private generic functions
(setf tcp-socket): Public generic functions
(setf tcp-socket): Public generic functions

A
add-event: Public ordinary functions
add-event-loop-exit-callback: Public ordinary functions
addrinfo-to-string: Public ordinary functions
append-array: Public ordinary functions
async-cb: Private ordinary functions
async-close-cb: Private ordinary functions
attach-data-to-pointer: Public ordinary functions

B
buffer-output: Public ordinary functions
bytes: Public ordinary functions

C
call-with-callback-restarts: Public ordinary functions
catch-app-errors: Public macros
check-event-loop-running: Private ordinary functions
check-event-unfreed: Private ordinary functions
check-notifier-unfreed: Private ordinary functions
check-socket-open: Private ordinary functions
check-streamish-open: Public ordinary functions
clear-callbacks: Public ordinary functions
clear-pointer-data: Public ordinary functions
clear-signal-handlers: Public ordinary functions
close: Public standalone methods
close-socket: Public ordinary functions
close-socket-server: Public generic functions
close-socket-server: Public generic functions
close-streamish: Public generic functions
close-streamish: Public generic functions
close-streamish: Public generic functions
close-streamish: Public generic functions
close-tcp-server: Public ordinary functions
connect-tcp-socket: Public ordinary functions
create-data-pointer: Public ordinary functions

D
define-c-callback: Public macros
define-condition-alias: Public macros
delay: Public ordinary functions
deref-data-from-pointer: Public ordinary functions
disable-socket: Public ordinary functions
dns-cb: Private ordinary functions
dns-lookup: Public ordinary functions
do-chunk-data: Public ordinary functions
do-close-loop: Private ordinary functions
do-close-streamish: Private ordinary functions
dump-event-loop-status: Public ordinary functions

E
enable-socket: Public ordinary functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
errno-event: Private generic functions
error-str: Public ordinary functions
event-base-c: Public generic functions
event-base-c: Public generic functions
event-base-catch-app-errors: Public generic functions
event-base-catch-app-errors: Public generic functions
event-base-data-registry: Public generic functions
event-base-data-registry: Public generic functions
event-base-dns-base: Public generic functions
event-base-dns-base: Public generic functions
event-base-dns-ref-count: Public generic functions
event-base-dns-ref-count: Public generic functions
event-base-exit-functions: Public generic functions
event-base-exit-functions: Public generic functions
event-base-function-registry: Public generic functions
event-base-function-registry: Public generic functions
event-base-id: Public generic functions
event-base-id: Public generic functions
event-base-lock: Public generic functions
event-base-lock: Public generic functions
event-base-num-connections-in: Public generic functions
event-base-num-connections-in: Public generic functions
event-base-num-connections-out: Public generic functions
event-base-num-connections-out: Public generic functions
event-base-send-errors-to-eventcb: Public generic functions
event-base-send-errors-to-eventcb: Public generic functions
event-base-signal-handlers: Public generic functions
event-base-signal-handlers: Public generic functions
event-c: Public generic functions
event-c: Public generic functions
event-errcode: Public generic functions
event-errcode: Public generic functions
event-errmsg: Public generic functions
event-errmsg: Public generic functions
event-freed: Public generic functions
event-freed: Public generic functions
event-freed-event: Private generic functions
event-freed-event: Private generic functions
event-freed-p: Public generic functions
event-freed-p: Public generic functions
event-handler: Private ordinary functions
exit-event-loop: Public ordinary functions

F
fd-connected-p: Public ordinary functions
free-event: Public ordinary functions
free-idler: Public ordinary functions
free-notifier: Public ordinary functions
free-pointer-data: Public ordinary functions
free-poller: Public ordinary functions
free-signal-handler: Public ordinary functions
fs-cb: Private ordinary functions
fs-event-callback: Private ordinary functions
fs-monitor-c: Private generic functions
fs-monitor-c: Private generic functions
fs-monitor-close: Public ordinary functions
fs-monitor-close-cb: Private ordinary functions
fs-unwatch: Public ordinary functions
fs-watch: Public ordinary functions
Function, %fs-monitor-close: Private ordinary functions
Function, %pipe-connect: Private ordinary functions
Function, add-event: Public ordinary functions
Function, add-event-loop-exit-callback: Public ordinary functions
Function, addrinfo-to-string: Public ordinary functions
Function, append-array: Public ordinary functions
Function, async-cb: Private ordinary functions
Function, async-close-cb: Private ordinary functions
Function, attach-data-to-pointer: Public ordinary functions
Function, buffer-output: Public ordinary functions
Function, bytes: Public ordinary functions
Function, call-with-callback-restarts: Public ordinary functions
Function, check-event-loop-running: Private ordinary functions
Function, check-event-unfreed: Private ordinary functions
Function, check-notifier-unfreed: Private ordinary functions
Function, check-socket-open: Private ordinary functions
Function, check-streamish-open: Public ordinary functions
Function, clear-callbacks: Public ordinary functions
Function, clear-pointer-data: Public ordinary functions
Function, clear-signal-handlers: Public ordinary functions
Function, close-socket: Public ordinary functions
Function, close-tcp-server: Public ordinary functions
Function, connect-tcp-socket: Public ordinary functions
Function, create-data-pointer: Public ordinary functions
Function, delay: Public ordinary functions
Function, deref-data-from-pointer: Public ordinary functions
Function, disable-socket: Public ordinary functions
Function, dns-cb: Private ordinary functions
Function, dns-lookup: Public ordinary functions
Function, do-chunk-data: Public ordinary functions
Function, do-close-loop: Private ordinary functions
Function, do-close-streamish: Private ordinary functions
Function, dump-event-loop-status: Public ordinary functions
Function, enable-socket: Public ordinary functions
Function, error-str: Public ordinary functions
Function, event-handler: Private ordinary functions
Function, exit-event-loop: Public ordinary functions
Function, fd-connected-p: Public ordinary functions
Function, free-event: Public ordinary functions
Function, free-idler: Public ordinary functions
Function, free-notifier: Public ordinary functions
Function, free-pointer-data: Public ordinary functions
Function, free-poller: Public ordinary functions
Function, free-signal-handler: Public ordinary functions
Function, fs-cb: Private ordinary functions
Function, fs-event-callback: Private ordinary functions
Function, fs-monitor-close: Public ordinary functions
Function, fs-monitor-close-cb: Private ordinary functions
Function, fs-unwatch: Public ordinary functions
Function, fs-watch: Public ordinary functions
Function, get-callbacks: Public ordinary functions
Function, idle: Public ordinary functions
Function, idle-cb: Private ordinary functions
Function, idle-close-cb: Private ordinary functions
Function, init-client-socket: Private ordinary functions
Function, init-incoming-socket: Private ordinary functions
Function, init-stdio-container: Private ordinary functions
Function, interval: Public ordinary functions
Function, ip-address-p: Public ordinary functions
Function, ip-str-to-sockaddr: Public ordinary functions
Function, ipv4-address-p: Public ordinary functions
Function, ipv6-address-p: Public ordinary functions
Function, lisp-signal-cb: Private ordinary functions
Function, loop-exit-walk-cb: Private ordinary functions
Function, make-buffer: Public ordinary functions
Function, make-event: Public ordinary functions
Function, make-notifier: Public ordinary functions
Function, make-pointer-eql-able: Public ordinary functions
Function, mkdtemp: Public ordinary functions
Function, passthrough-error-p: Public ordinary functions
Function, pipe-connect: Public ordinary functions
Function, pipe-server: Public ordinary functions
Function, poll: Public ordinary functions
Function, poll-cb: Private ordinary functions
Function, poll-close-cb: Private ordinary functions
Function, process-close: Private ordinary functions
Function, process-close-cb: Private ordinary functions
Function, process-event-loop-exit-callbacks: Private ordinary functions
Function, process-exit-cb: Private ordinary functions
Function, process-kill: Public ordinary functions
Function, remove-event: Public ordinary functions
Function, remove-interval: Public ordinary functions
Function, reverse-dns-cb: Private ordinary functions
Function, reverse-dns-lookup: Public ordinary functions
Function, run-event-cb: Public ordinary functions
Function, save-callbacks: Public ordinary functions
Function, set-lisp-signal-handler: Private ordinary functions
Function, set-socket-nonblocking: Public ordinary functions
Function, set-socket-timeouts: Public ordinary functions
Function, signal-cb: Private ordinary functions
Function, signal-close-cb: Private ordinary functions
Function, signal-handler: Public ordinary functions
Function, signal-pointer: Private ordinary functions
Function, socket-accept-cb: Private ordinary functions
Function, socket-closed-p: Public ordinary functions
Function, socket-connect-cb: Private ordinary functions
Function, socket-server: Private ordinary functions
Function, spawn: Public ordinary functions
Function, start-event-loop: Public ordinary functions
Function, stats: Public ordinary functions
Function, stream-socket: Public ordinary functions
Function, streamish-alloc-cb: Private ordinary functions
Function, streamish-close-cb: Private ordinary functions
Function, streamish-closed-p: Public ordinary functions
Function, streamish-convert-data: Private ordinary functions
Function, streamish-read-cb: Private ordinary functions
Function, streamish-read-start: Private ordinary functions
Function, streamish-shutdown-cb: Private ordinary functions
Function, streamish-write-cb: Private ordinary functions
Function, tcp-connect: Public ordinary functions
Function, tcp-connect-new: Private ordinary functions
Function, tcp-server: Public ordinary functions
Function, tcp-server-closed: Private ordinary functions
Function, tcp-server-new: Private ordinary functions
Function, timer-cb: Private ordinary functions
Function, timer-close-cb: Private ordinary functions
Function, trigger-notifier: Public ordinary functions
Function, walk-cb: Private ordinary functions
Function, write-socket-data: Public ordinary functions
Function, write-to-buffer: Public ordinary functions
Function, write-to-uvstream: Private ordinary functions

G
Generic Function, (setf event-base-c): Public generic functions
Generic Function, (setf event-base-catch-app-errors): Public generic functions
Generic Function, (setf event-base-data-registry): Public generic functions
Generic Function, (setf event-base-dns-base): Public generic functions
Generic Function, (setf event-base-dns-ref-count): Public generic functions
Generic Function, (setf event-base-exit-functions): Public generic functions
Generic Function, (setf event-base-function-registry): Public generic functions
Generic Function, (setf event-base-id): Public generic functions
Generic Function, (setf event-base-lock): Public generic functions
Generic Function, (setf event-base-num-connections-in): Public generic functions
Generic Function, (setf event-base-num-connections-out): Public generic functions
Generic Function, (setf event-base-send-errors-to-eventcb): Public generic functions
Generic Function, (setf event-base-signal-handlers): Public generic functions
Generic Function, (setf event-c): Public generic functions
Generic Function, (setf event-freed): Public generic functions
Generic Function, (setf event-freed-event): Private generic functions
Generic Function, (setf fs-monitor-c): Private generic functions
Generic Function, (setf idler-c): Private generic functions
Generic Function, (setf idler-freed): Private generic functions
Generic Function, (setf notifier-c): Private generic functions
Generic Function, (setf notifier-freed): Private generic functions
Generic Function, (setf notifier-freed-notifier): Private generic functions
Generic Function, (setf notifier-single-shot): Private generic functions
Generic Function, (setf poller-c): Private generic functions
Generic Function, (setf poller-freed): Private generic functions
Generic Function, (setf process-c): Private generic functions
Generic Function, (setf process-error-output): Public generic functions
Generic Function, (setf process-input): Public generic functions
Generic Function, (setf process-output): Public generic functions
Generic Function, (setf socket): Public generic functions
Generic Function, (setf socket-accept-error-listener): Public generic functions
Generic Function, (setf socket-accept-error-server): Private generic functions
Generic Function, (setf socket-address): Private generic functions
Generic Function, (setf socket-buffer): Private generic functions
Generic Function, (setf socket-buffering-p): Private generic functions
Generic Function, (setf socket-c): Public generic functions
Generic Function, (setf socket-closed): Public generic functions
Generic Function, (setf socket-connected): Private generic functions
Generic Function, (setf socket-data): Public generic functions
Generic Function, (setf socket-direction): Private generic functions
Generic Function, (setf socket-drain-read-buffer): Private generic functions
Generic Function, (setf socket-server-c): Private generic functions
Generic Function, (setf socket-server-closed): Private generic functions
Generic Function, (setf socket-server-stream): Private generic functions
Generic Function, (setf stream-buffer): Private generic functions
Generic Function, (setf streamish): Public generic functions
Generic Function, (setf streamish-c): Private generic functions
Generic Function, (setf streamish-closed): Public generic functions
Generic Function, (setf streamish-data): Private generic functions
Generic Function, (setf streamish-drain-read-buffer): Private generic functions
Generic Function, (setf tcp-server-bind-error-addr): Private generic functions
Generic Function, (setf tcp-server-bind-error-port): Private generic functions
Generic Function, (setf tcp-socket): Public generic functions
Generic Function, close-socket-server: Public generic functions
Generic Function, close-streamish: Public generic functions
Generic Function, errno-event: Private generic functions
Generic Function, event-base-c: Public generic functions
Generic Function, event-base-catch-app-errors: Public generic functions
Generic Function, event-base-data-registry: Public generic functions
Generic Function, event-base-dns-base: Public generic functions
Generic Function, event-base-dns-ref-count: Public generic functions
Generic Function, event-base-exit-functions: Public generic functions
Generic Function, event-base-function-registry: Public generic functions
Generic Function, event-base-id: Public generic functions
Generic Function, event-base-lock: Public generic functions
Generic Function, event-base-num-connections-in: Public generic functions
Generic Function, event-base-num-connections-out: Public generic functions
Generic Function, event-base-send-errors-to-eventcb: Public generic functions
Generic Function, event-base-signal-handlers: Public generic functions
Generic Function, event-c: Public generic functions
Generic Function, event-errcode: Public generic functions
Generic Function, event-errmsg: Public generic functions
Generic Function, event-freed: Public generic functions
Generic Function, event-freed-event: Private generic functions
Generic Function, event-freed-p: Public generic functions
Generic Function, fs-monitor-c: Private generic functions
Generic Function, handle-cleanup: Private generic functions
Generic Function, handle-error: Public generic functions
Generic Function, idler-c: Private generic functions
Generic Function, idler-freed: Private generic functions
Generic Function, idler-freed-p: Public generic functions
Generic Function, make-socket-handle: Private generic functions
Generic Function, notifier-c: Private generic functions
Generic Function, notifier-freed: Private generic functions
Generic Function, notifier-freed-notifier: Private generic functions
Generic Function, notifier-freed-p: Public generic functions
Generic Function, notifier-single-shot: Private generic functions
Generic Function, notifier-single-shot-p: Private generic functions
Generic Function, poller-c: Private generic functions
Generic Function, poller-freed: Private generic functions
Generic Function, poller-freed-p: Public generic functions
Generic Function, process-c: Private generic functions
Generic Function, process-error-output: Public generic functions
Generic Function, process-input: Public generic functions
Generic Function, process-output: Public generic functions
Generic Function, ref: Public generic functions
Generic Function, send-buffered-data: Private generic functions
Generic Function, server-socket-class: Private generic functions
Generic Function, socket: Public generic functions
Generic Function, socket-accept-error-listener: Public generic functions
Generic Function, socket-accept-error-server: Private generic functions
Generic Function, socket-address: Private generic functions
Generic Function, socket-buffer: Private generic functions
Generic Function, socket-buffering-p: Private generic functions
Generic Function, socket-c: Public generic functions
Generic Function, socket-closed: Public generic functions
Generic Function, socket-connected: Private generic functions
Generic Function, socket-data: Public generic functions
Generic Function, socket-direction: Private generic functions
Generic Function, socket-drain-read-buffer: Private generic functions
Generic Function, socket-server-bind: Private generic functions
Generic Function, socket-server-c: Private generic functions
Generic Function, socket-server-closed: Private generic functions
Generic Function, socket-server-stream: Private generic functions
Generic Function, stream-append-bytes: Private generic functions
Generic Function, stream-buffer: Private generic functions
Generic Function, stream-output-type: Private generic functions
Generic Function, streamish: Public generic functions
Generic Function, streamish-c: Private generic functions
Generic Function, streamish-closed: Public generic functions
Generic Function, streamish-data: Private generic functions
Generic Function, streamish-drain-read-buffer: Private generic functions
Generic Function, streamish-write: Public generic functions
Generic Function, tcp-server-bind-error-addr: Private generic functions
Generic Function, tcp-server-bind-error-port: Private generic functions
Generic Function, tcp-socket: Public generic functions
Generic Function, unref: Public generic functions
Generic Function, write-pending-socket-data: Private generic functions
get-callbacks: Public ordinary functions

H
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-cleanup: Private generic functions
handle-error: Public generic functions
handle-error: Public generic functions

I
idle: Public ordinary functions
idle-cb: Private ordinary functions
idle-close-cb: Private ordinary functions
idler-c: Private generic functions
idler-c: Private generic functions
idler-freed: Private generic functions
idler-freed: Private generic functions
idler-freed-p: Public generic functions
idler-freed-p: Public generic functions
init-client-socket: Private ordinary functions
init-incoming-socket: Private ordinary functions
init-stdio-container: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
interval: Public ordinary functions
ip-address-p: Public ordinary functions
ip-str-to-sockaddr: Public ordinary functions
ipv4-address-p: Public ordinary functions
ipv6-address-p: Public ordinary functions

L
lisp-signal-cb: Private ordinary functions
loop-exit-walk-cb: Private ordinary functions

M
Macro, catch-app-errors: Public macros
Macro, define-c-callback: Public macros
Macro, define-condition-alias: Public macros
Macro, with-delay: Public macros
Macro, with-event-loop: Public macros
Macro, with-foreign-object*: Public macros
Macro, with-interval: Public macros
Macro, with-ip-to-sockaddr: Public macros
Macro, with-lock: Public macros
make-buffer: Public ordinary functions
make-event: Public ordinary functions
make-notifier: Public ordinary functions
make-pointer-eql-able: Public ordinary functions
make-socket-handle: Private generic functions
make-socket-handle: Private generic functions
make-socket-handle: Private generic functions
Method, (setf event-base-c): Public generic functions
Method, (setf event-base-catch-app-errors): Public generic functions
Method, (setf event-base-data-registry): Public generic functions
Method, (setf event-base-dns-base): Public generic functions
Method, (setf event-base-dns-ref-count): Public generic functions
Method, (setf event-base-exit-functions): Public generic functions
Method, (setf event-base-function-registry): Public generic functions
Method, (setf event-base-id): Public generic functions
Method, (setf event-base-lock): Public generic functions
Method, (setf event-base-num-connections-in): Public generic functions
Method, (setf event-base-num-connections-out): Public generic functions
Method, (setf event-base-send-errors-to-eventcb): Public generic functions
Method, (setf event-base-signal-handlers): Public generic functions
Method, (setf event-c): Public generic functions
Method, (setf event-freed): Public generic functions
Method, (setf event-freed-event): Private generic functions
Method, (setf fs-monitor-c): Private generic functions
Method, (setf idler-c): Private generic functions
Method, (setf idler-freed): Private generic functions
Method, (setf notifier-c): Private generic functions
Method, (setf notifier-freed): Private generic functions
Method, (setf notifier-freed-notifier): Private generic functions
Method, (setf notifier-single-shot): Private generic functions
Method, (setf poller-c): Private generic functions
Method, (setf poller-freed): Private generic functions
Method, (setf process-c): Private generic functions
Method, (setf process-error-output): Public generic functions
Method, (setf process-input): Public generic functions
Method, (setf process-output): Public generic functions
Method, (setf socket): Public generic functions
Method, (setf socket-accept-error-listener): Public generic functions
Method, (setf socket-accept-error-server): Private generic functions
Method, (setf socket-address): Private generic functions
Method, (setf socket-buffer): Private generic functions
Method, (setf socket-buffering-p): Private generic functions
Method, (setf socket-c): Public generic functions
Method, (setf socket-closed): Public generic functions
Method, (setf socket-connected): Private generic functions
Method, (setf socket-data): Public generic functions
Method, (setf socket-direction): Private generic functions
Method, (setf socket-drain-read-buffer): Private generic functions
Method, (setf socket-server-c): Private generic functions
Method, (setf socket-server-closed): Private generic functions
Method, (setf socket-server-stream): Private generic functions
Method, (setf stream-buffer): Private generic functions
Method, (setf streamish): Public generic functions
Method, (setf streamish): Public generic functions
Method, (setf streamish-c): Private generic functions
Method, (setf streamish-closed): Public generic functions
Method, (setf streamish-data): Private generic functions
Method, (setf streamish-drain-read-buffer): Private generic functions
Method, (setf tcp-server-bind-error-addr): Private generic functions
Method, (setf tcp-server-bind-error-port): Private generic functions
Method, (setf tcp-socket): Public generic functions
Method, close: Public standalone methods
Method, close-socket-server: Public generic functions
Method, close-streamish: Public generic functions
Method, close-streamish: Public generic functions
Method, close-streamish: Public generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, errno-event: Private generic functions
Method, event-base-c: Public generic functions
Method, event-base-catch-app-errors: Public generic functions
Method, event-base-data-registry: Public generic functions
Method, event-base-dns-base: Public generic functions
Method, event-base-dns-ref-count: Public generic functions
Method, event-base-exit-functions: Public generic functions
Method, event-base-function-registry: Public generic functions
Method, event-base-id: Public generic functions
Method, event-base-lock: Public generic functions
Method, event-base-num-connections-in: Public generic functions
Method, event-base-num-connections-out: Public generic functions
Method, event-base-send-errors-to-eventcb: Public generic functions
Method, event-base-signal-handlers: Public generic functions
Method, event-c: Public generic functions
Method, event-errcode: Public generic functions
Method, event-errmsg: Public generic functions
Method, event-freed: Public generic functions
Method, event-freed-event: Private generic functions
Method, event-freed-p: Public generic functions
Method, fs-monitor-c: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-cleanup: Private generic functions
Method, handle-error: Public generic functions
Method, idler-c: Private generic functions
Method, idler-freed: Private generic functions
Method, idler-freed-p: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, make-socket-handle: Private generic functions
Method, make-socket-handle: Private generic functions
Method, notifier-c: Private generic functions
Method, notifier-freed: Private generic functions
Method, notifier-freed-notifier: Private generic functions
Method, notifier-freed-p: Public generic functions
Method, notifier-single-shot: Private generic functions
Method, notifier-single-shot-p: Private generic functions
Method, open-stream-p: Public standalone methods
Method, poller-c: Private generic functions
Method, poller-freed: Private generic functions
Method, poller-freed-p: Public generic functions
Method, process-c: Private generic functions
Method, process-error-output: Public generic functions
Method, process-input: Public generic functions
Method, process-output: Public generic functions
Method, ref: Public generic functions
Method, ref: Public generic functions
Method, send-buffered-data: Private generic functions
Method, server-socket-class: Private generic functions
Method, server-socket-class: Private generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket-accept-error-listener: Public generic functions
Method, socket-accept-error-server: Private generic functions
Method, socket-address: Private generic functions
Method, socket-buffer: Private generic functions
Method, socket-buffering-p: Private generic functions
Method, socket-c: Public generic functions
Method, socket-closed: Public generic functions
Method, socket-connected: Private generic functions
Method, socket-data: Public generic functions
Method, socket-direction: Private generic functions
Method, socket-drain-read-buffer: Private generic functions
Method, socket-server-bind: Private generic functions
Method, socket-server-bind: Private generic functions
Method, socket-server-c: Private generic functions
Method, socket-server-closed: Private generic functions
Method, socket-server-stream: Private generic functions
Method, stream-append-bytes: Private generic functions
Method, stream-buffer: Private generic functions
Method, stream-clear-input: Public standalone methods
Method, stream-clear-output: Public standalone methods
Method, stream-element-type: Public standalone methods
Method, stream-finish-output: Public standalone methods
Method, stream-force-output: Public standalone methods
Method, stream-output-type: Private generic functions
Method, stream-read-byte: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-write-byte: Public standalone methods
Method, stream-write-sequence: Public standalone methods
Method, streamish: Public generic functions
Method, streamish: Public generic functions
Method, streamish: Public generic functions
Method, streamish-c: Private generic functions
Method, streamish-closed: Public generic functions
Method, streamish-data: Private generic functions
Method, streamish-drain-read-buffer: Private generic functions
Method, streamish-write: Public generic functions
Method, streamish-write: Public generic functions
Method, streamish-write: Public generic functions
Method, tcp-server-bind-error-addr: Private generic functions
Method, tcp-server-bind-error-port: Private generic functions
Method, tcp-socket: Public generic functions
Method, unref: Public generic functions
Method, unref: Public generic functions
Method, write-pending-socket-data: Private generic functions
mkdtemp: Public ordinary functions

N
notifier-c: Private generic functions
notifier-c: Private generic functions
notifier-freed: Private generic functions
notifier-freed: Private generic functions
notifier-freed-notifier: Private generic functions
notifier-freed-notifier: Private generic functions
notifier-freed-p: Public generic functions
notifier-freed-p: Public generic functions
notifier-single-shot: Private generic functions
notifier-single-shot: Private generic functions
notifier-single-shot-p: Private generic functions
notifier-single-shot-p: Private generic functions

O
open-stream-p: Public standalone methods

P
passthrough-error-p: Public ordinary functions
pipe-connect: Public ordinary functions
pipe-server: Public ordinary functions
poll: Public ordinary functions
poll-cb: Private ordinary functions
poll-close-cb: Private ordinary functions
poller-c: Private generic functions
poller-c: Private generic functions
poller-freed: Private generic functions
poller-freed: Private generic functions
poller-freed-p: Public generic functions
poller-freed-p: Public generic functions
process-c: Private generic functions
process-c: Private generic functions
process-close: Private ordinary functions
process-close-cb: Private ordinary functions
process-error-output: Public generic functions
process-error-output: Public generic functions
process-event-loop-exit-callbacks: Private ordinary functions
process-exit-cb: Private ordinary functions
process-input: Public generic functions
process-input: Public generic functions
process-kill: Public ordinary functions
process-output: Public generic functions
process-output: Public generic functions

R
ref: Public generic functions
ref: Public generic functions
ref: Public generic functions
remove-event: Public ordinary functions
remove-interval: Public ordinary functions
reverse-dns-cb: Private ordinary functions
reverse-dns-lookup: Public ordinary functions
run-event-cb: Public ordinary functions

S
save-callbacks: Public ordinary functions
send-buffered-data: Private generic functions
send-buffered-data: Private generic functions
server-socket-class: Private generic functions
server-socket-class: Private generic functions
server-socket-class: Private generic functions
set-lisp-signal-handler: Private ordinary functions
set-socket-nonblocking: Public ordinary functions
set-socket-timeouts: Public ordinary functions
signal-cb: Private ordinary functions
signal-close-cb: Private ordinary functions
signal-handler: Public ordinary functions
signal-pointer: Private ordinary functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket-accept-cb: Private ordinary functions
socket-accept-error-listener: Public generic functions
socket-accept-error-listener: Public generic functions
socket-accept-error-server: Private generic functions
socket-accept-error-server: Private generic functions
socket-address: Private generic functions
socket-address: Private generic functions
socket-buffer: Private generic functions
socket-buffer: Private generic functions
socket-buffering-p: Private generic functions
socket-buffering-p: Private generic functions
socket-c: Public generic functions
socket-c: Public generic functions
socket-closed: Public generic functions
socket-closed: Public generic functions
socket-closed-p: Public ordinary functions
socket-connect-cb: Private ordinary functions
socket-connected: Private generic functions
socket-connected: Private generic functions
socket-data: Public generic functions
socket-data: Public generic functions
socket-direction: Private generic functions
socket-direction: Private generic functions
socket-drain-read-buffer: Private generic functions
socket-drain-read-buffer: Private generic functions
socket-server: Private ordinary functions
socket-server-bind: Private generic functions
socket-server-bind: Private generic functions
socket-server-bind: Private generic functions
socket-server-c: Private generic functions
socket-server-c: Private generic functions
socket-server-closed: Private generic functions
socket-server-closed: Private generic functions
socket-server-stream: Private generic functions
socket-server-stream: Private generic functions
spawn: Public ordinary functions
start-event-loop: Public ordinary functions
stats: Public ordinary functions
stream-append-bytes: Private generic functions
stream-append-bytes: Private generic functions
stream-buffer: Private generic functions
stream-buffer: Private generic functions
stream-clear-input: Public standalone methods
stream-clear-output: Public standalone methods
stream-element-type: Public standalone methods
stream-finish-output: Public standalone methods
stream-force-output: Public standalone methods
stream-output-type: Private generic functions
stream-output-type: Private generic functions
stream-read-byte: Public standalone methods
stream-read-sequence: Public standalone methods
stream-socket: Public ordinary functions
stream-write-byte: Public standalone methods
stream-write-sequence: Public standalone methods
streamish: Public generic functions
streamish: Public generic functions
streamish: Public generic functions
streamish: Public generic functions
streamish-alloc-cb: Private ordinary functions
streamish-c: Private generic functions
streamish-c: Private generic functions
streamish-close-cb: Private ordinary functions
streamish-closed: Public generic functions
streamish-closed: Public generic functions
streamish-closed-p: Public ordinary functions
streamish-convert-data: Private ordinary functions
streamish-data: Private generic functions
streamish-data: Private generic functions
streamish-drain-read-buffer: Private generic functions
streamish-drain-read-buffer: Private generic functions
streamish-read-cb: Private ordinary functions
streamish-read-start: Private ordinary functions
streamish-shutdown-cb: Private ordinary functions
streamish-write: Public generic functions
streamish-write: Public generic functions
streamish-write: Public generic functions
streamish-write: Public generic functions
streamish-write-cb: Private ordinary functions

T
tcp-connect: Public ordinary functions
tcp-connect-new: Private ordinary functions
tcp-server: Public ordinary functions
tcp-server-bind-error-addr: Private generic functions
tcp-server-bind-error-addr: Private generic functions
tcp-server-bind-error-port: Private generic functions
tcp-server-bind-error-port: Private generic functions
tcp-server-closed: Private ordinary functions
tcp-server-new: Private ordinary functions
tcp-socket: Public generic functions
tcp-socket: Public generic functions
timer-cb: Private ordinary functions
timer-close-cb: Private ordinary functions
trigger-notifier: Public ordinary functions

U
unref: Public generic functions
unref: Public generic functions
unref: Public generic functions

W
walk-cb: Private ordinary functions
with-delay: Public macros
with-event-loop: Public macros
with-foreign-object*: Public macros
with-interval: Public macros
with-ip-to-sockaddr: Public macros
with-lock: Public macros
write-pending-socket-data: Private generic functions
write-pending-socket-data: Private generic functions
write-socket-data: Public ordinary functions
write-to-buffer: Public ordinary functions
write-to-uvstream: Private ordinary functions


A.3 Variables

Jump to:   *   +  
A   B   C   D   E   F   I   L   M   N   O   P   S  
Index Entry  Section

*
*buffer-size*: Public special variables
*buffer-writes*: Public special variables
*data-registry*: Public special variables
*enable-threading*: Public special variables
*evcb-err*: Private special variables
*event-base*: Public special variables
*event-base-next-id*: Public special variables
*event-base-registry*: Private special variables
*event-base-registry-lock*: Private special variables
*function-registry*: Public special variables
*input-buffer*: Public special variables
*ipv4-scanner*: Public special variables
*ipv6-scanner*: Public special variables
*loop-close-iters*: Private special variables
*output-buffer*: Public special variables
*passthrough-errors*: Public special variables
*safe-sldb-quit-restart*: Public special variables

+
+af-inet+: Public constants
+af-inet6+: Public constants
+af-unix+: Public constants
+af-unspec+: Public constants
+sigabrt+: Public constants
+sigalrm+: Public constants
+sigbus+: Public constants
+sigchld+: Public constants
+sigcont+: Public constants
+sigemt+: Public constants
+sigfpe+: Public constants
+sighup+: Public constants
+sigill+: Public constants
+siginfo+: Public constants
+sigint+: Public constants
+sigio+: Public constants
+sigkill+: Public constants
+sigpipe+: Public constants
+sigprof+: Public constants
+sigquit+: Public constants
+sigsegv+: Public constants
+sigstop+: Public constants
+sigsys+: Public constants
+sigterm+: Public constants
+sigtrap+: Public constants
+sigtstp+: Public constants
+sigttin+: Public constants
+sigttou+: Public constants
+sigurg+: Public constants
+sigusr1+: Public constants
+sigusr2+: Public constants
+sigvtalrm+: Public constants
+sigwinch+: Public constants
+sigxcpu+: Public constants
+sigxfsz+: Public constants

A
addr: Public conditions
address: Public classes

B
buffer: Public classes
buffer: Public classes
bufferingp: Public classes

C
c: Public classes
c: Public classes
c: Public classes
c: Public classes
c: Public classes
c: Public classes
c: Public classes
c: Private classes
c: Private classes
c: Private classes
catch-app-errors: Public classes
closed: Public classes
closed: Public classes
closed: Private classes
code: Public conditions
connected: Public classes
Constant, +af-inet+: Public constants
Constant, +af-inet6+: Public constants
Constant, +af-unix+: Public constants
Constant, +af-unspec+: Public constants
Constant, +sigabrt+: Public constants
Constant, +sigalrm+: Public constants
Constant, +sigbus+: Public constants
Constant, +sigchld+: Public constants
Constant, +sigcont+: Public constants
Constant, +sigemt+: Public constants
Constant, +sigfpe+: Public constants
Constant, +sighup+: Public constants
Constant, +sigill+: Public constants
Constant, +siginfo+: Public constants
Constant, +sigint+: Public constants
Constant, +sigio+: Public constants
Constant, +sigkill+: Public constants
Constant, +sigpipe+: Public constants
Constant, +sigprof+: Public constants
Constant, +sigquit+: Public constants
Constant, +sigsegv+: Public constants
Constant, +sigstop+: Public constants
Constant, +sigsys+: Public constants
Constant, +sigterm+: Public constants
Constant, +sigtrap+: Public constants
Constant, +sigtstp+: Public constants
Constant, +sigttin+: Public constants
Constant, +sigttou+: Public constants
Constant, +sigurg+: Public constants
Constant, +sigusr1+: Public constants
Constant, +sigusr2+: Public constants
Constant, +sigvtalrm+: Public constants
Constant, +sigwinch+: Public constants
Constant, +sigxcpu+: Public constants
Constant, +sigxfsz+: Public constants

D
data: Public classes
data: Public classes
data-registry: Public classes
direction: Public classes
dns-base: Public classes
dns-ref-count: Public classes
drain-read-buffer: Public classes
drain-read-buffer: Public classes

E
error-output: Private classes
event: Public conditions
exit-functions: Public classes

F
freed: Public classes
freed: Public classes
freed: Public classes
freed: Public classes
function-registry: Public classes

I
id: Public classes
input: Private classes

L
listener: Public conditions
lock: Public classes

M
msg: Public conditions

N
notifier: Private conditions
num-connections-in: Public classes
num-connections-out: Public classes

O
output: Private classes

P
port: Public conditions

S
send-errors-to-eventcb: Public classes
server: Public conditions
signal-handlers: Public classes
single-shot: Public classes
Slot, addr: Public conditions
Slot, address: Public classes
Slot, buffer: Public classes
Slot, buffer: Public classes
Slot, bufferingp: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Public classes
Slot, c: Private classes
Slot, c: Private classes
Slot, c: Private classes
Slot, catch-app-errors: Public classes
Slot, closed: Public classes
Slot, closed: Public classes
Slot, closed: Private classes
Slot, code: Public conditions
Slot, connected: Public classes
Slot, data: Public classes
Slot, data: Public classes
Slot, data-registry: Public classes
Slot, direction: Public classes
Slot, dns-base: Public classes
Slot, dns-ref-count: Public classes
Slot, drain-read-buffer: Public classes
Slot, drain-read-buffer: Public classes
Slot, error-output: Private classes
Slot, event: Public conditions
Slot, exit-functions: Public classes
Slot, freed: Public classes
Slot, freed: Public classes
Slot, freed: Public classes
Slot, freed: Public classes
Slot, function-registry: Public classes
Slot, id: Public classes
Slot, input: Private classes
Slot, listener: Public conditions
Slot, lock: Public classes
Slot, msg: Public conditions
Slot, notifier: Private conditions
Slot, num-connections-in: Public classes
Slot, num-connections-out: Public classes
Slot, output: Private classes
Slot, port: Public conditions
Slot, send-errors-to-eventcb: Public classes
Slot, server: Public conditions
Slot, signal-handlers: Public classes
Slot, single-shot: Public classes
Slot, stream: Private classes
Slot, streamish: Public conditions
Slot, streamish: Public conditions
Slot, streamish: Public classes
Special Variable, *buffer-size*: Public special variables
Special Variable, *buffer-writes*: Public special variables
Special Variable, *data-registry*: Public special variables
Special Variable, *enable-threading*: Public special variables
Special Variable, *evcb-err*: Private special variables
Special Variable, *event-base*: Public special variables
Special Variable, *event-base-next-id*: Public special variables
Special Variable, *event-base-registry*: Private special variables
Special Variable, *event-base-registry-lock*: Private special variables
Special Variable, *function-registry*: Public special variables
Special Variable, *input-buffer*: Public special variables
Special Variable, *ipv4-scanner*: Public special variables
Special Variable, *ipv6-scanner*: Public special variables
Special Variable, *loop-close-iters*: Private special variables
Special Variable, *output-buffer*: Public special variables
Special Variable, *passthrough-errors*: Public special variables
Special Variable, *safe-sldb-quit-restart*: Public special variables
stream: Private classes
streamish: Public conditions
streamish: Public conditions
streamish: Public classes


A.4 Data types

Jump to:   A   B   C   D   E   F   I   M   N   O   P   S   T  
Index Entry  Section

A
async-input-stream: Public classes
async-io-stream: Public classes
async-output-stream: Public classes
async-stream: Public classes
async-stream.lisp: The cl-async/src/async-stream․lisp file

B
bytes-or-string: Public types

C
callback: Public types
cl-async: The cl-async system
cl-async: The cl-async package
cl-async-base: The cl-async-base system
cl-async-base: The cl-async-base package
cl-async-util: The cl-async-util system
cl-async-util: The cl-async-util package
cl-async.asd: The cl-async/cl-async․asd file
Class, async-input-stream: Public classes
Class, async-io-stream: Public classes
Class, async-output-stream: Public classes
Class, async-stream: Public classes
Class, event: Public classes
Class, event-base: Public classes
Class, fs-monitor: Private classes
Class, idler: Public classes
Class, notifier: Public classes
Class, pipe: Private classes
Class, pipe-mixin: Private classes
Class, pipe-server: Public classes
Class, poller: Public classes
Class, process: Private classes
Class, socket: Public classes
Class, socket-server: Private classes
Class, streamish: Public classes
Class, tcp-mixin: Private classes
Class, tcp-server: Public classes
Class, tcp-socket: Public classes
Condition, dns-error: Public conditions
Condition, event-error: Public conditions
Condition, event-freed: Public conditions
Condition, event-info: Public conditions
Condition, filesystem-eacces: Public conditions
Condition, filesystem-enoent: Public conditions
Condition, filesystem-eperm: Public conditions
Condition, filesystem-error: Public conditions
Condition, notifier-freed: Private conditions
Condition, socket-aborted: Public conditions
Condition, socket-accept-error: Public conditions
Condition, socket-address-in-use: Public conditions
Condition, socket-closed: Public conditions
Condition, socket-eof: Public conditions
Condition, socket-error: Public conditions
Condition, socket-info: Public conditions
Condition, socket-refused: Public conditions
Condition, socket-reset: Public conditions
Condition, socket-timeout: Public conditions
Condition, streamish-broken-pipe: Public conditions
Condition, streamish-canceled: Public conditions
Condition, streamish-closed: Public conditions
Condition, streamish-enoent: Public conditions
Condition, streamish-eof: Public conditions
Condition, streamish-error: Public conditions
Condition, streamish-info: Public conditions
Condition, tcp-accept-error: Public conditions
Condition, tcp-eof: Public conditions
Condition, tcp-error: Public conditions
Condition, tcp-info: Public conditions
Condition, tcp-refused: Public conditions
Condition, tcp-reset: Public conditions
Condition, tcp-server-bind-error: Public conditions
Condition, tcp-timeout: Public conditions

D
dns-error: Public conditions
dns.lisp: The cl-async/src/dns․lisp file

E
event: Public classes
event-base: Public classes
event-error: Public conditions
event-freed: Public conditions
event-info: Public conditions
event-loop.lisp: The cl-async/src/event-loop․lisp file
event.lisp: The cl-async/src/event․lisp file

F
File, async-stream.lisp: The cl-async/src/async-stream․lisp file
File, cl-async.asd: The cl-async/cl-async․asd file
File, dns.lisp: The cl-async/src/dns․lisp file
File, event-loop.lisp: The cl-async/src/event-loop․lisp file
File, event.lisp: The cl-async/src/event․lisp file
File, filesystem.lisp: The cl-async/src/filesystem․lisp file
File, fsevent.lisp: The cl-async/src/fsevent․lisp file
File, idle.lisp: The cl-async/src/idle․lisp file
File, notify.lisp: The cl-async/src/notify․lisp file
File, package.lisp: The cl-async/src/package․lisp file
File, pipe.lisp: The cl-async/src/pipe․lisp file
File, poll.lisp: The cl-async/src/poll․lisp file
File, process.lisp: The cl-async/src/process․lisp file
File, signal.lisp: The cl-async/src/signal․lisp file
File, socket.lisp: The cl-async/src/socket․lisp file
File, src/base.lisp: The cl-async-base/src/base․lisp file
File, src/util/error.lisp: The cl-async-util/src/util/error․lisp file
File, src/util/foreign.lisp: The cl-async-util/src/util/foreign․lisp file
File, src/util/helpers.lisp: The cl-async-util/src/util/helpers․lisp file
File, src/util/package.lisp: The cl-async-util/src/util/package․lisp file
File, streamish.lisp: The cl-async/src/streamish․lisp file
File, tcp.lisp: The cl-async/src/tcp․lisp file
filesystem-eacces: Public conditions
filesystem-enoent: Public conditions
filesystem-eperm: Public conditions
filesystem-error: Public conditions
filesystem.lisp: The cl-async/src/filesystem․lisp file
fs-monitor: Private classes
fsevent.lisp: The cl-async/src/fsevent․lisp file

I
idle.lisp: The cl-async/src/idle․lisp file
idler: Public classes

M
Module, src: The cl-async/src module

N
notifier: Public classes
notifier-freed: Private conditions
notify.lisp: The cl-async/src/notify․lisp file

O
octet: Public types
octet-vector: Public types

P
Package, cl-async: The cl-async package
Package, cl-async-base: The cl-async-base package
Package, cl-async-util: The cl-async-util package
package.lisp: The cl-async/src/package․lisp file
pipe: Private classes
pipe-mixin: Private classes
pipe-server: Public classes
pipe.lisp: The cl-async/src/pipe․lisp file
poll.lisp: The cl-async/src/poll․lisp file
poller: Public classes
process: Private classes
process.lisp: The cl-async/src/process․lisp file

S
signal.lisp: The cl-async/src/signal․lisp file
socket: Public classes
socket-aborted: Public conditions
socket-accept-error: Public conditions
socket-address-in-use: Public conditions
socket-closed: Public conditions
socket-eof: Public conditions
socket-error: Public conditions
socket-info: Public conditions
socket-refused: Public conditions
socket-reset: Public conditions
socket-server: Private classes
socket-timeout: Public conditions
socket.lisp: The cl-async/src/socket․lisp file
src: The cl-async/src module
src/base.lisp: The cl-async-base/src/base․lisp file
src/util/error.lisp: The cl-async-util/src/util/error․lisp file
src/util/foreign.lisp: The cl-async-util/src/util/foreign․lisp file
src/util/helpers.lisp: The cl-async-util/src/util/helpers․lisp file
src/util/package.lisp: The cl-async-util/src/util/package․lisp file
streamish: Public classes
streamish-broken-pipe: Public conditions
streamish-canceled: Public conditions
streamish-closed: Public conditions
streamish-enoent: Public conditions
streamish-eof: Public conditions
streamish-error: Public conditions
streamish-info: Public conditions
streamish.lisp: The cl-async/src/streamish․lisp file
System, cl-async: The cl-async system
System, cl-async-base: The cl-async-base system
System, cl-async-util: The cl-async-util system

T
tcp-accept-error: Public conditions
tcp-eof: Public conditions
tcp-error: Public conditions
tcp-info: Public conditions
tcp-mixin: Private classes
tcp-refused: Public conditions
tcp-reset: Public conditions
tcp-server: Public classes
tcp-server-bind-error: Public conditions
tcp-socket: Public classes
tcp-timeout: Public conditions
tcp.lisp: The cl-async/src/tcp․lisp file
Type, bytes-or-string: Public types
Type, callback: Public types
Type, octet: Public types
Type, octet-vector: Public types