The basic-binary-ipc Reference Manual

This is the basic-binary-ipc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:24:05 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 basic-binary-ipc

A inter-process communication library for transmitting binary data over a stream.

Author

Mark Cox

License

Simplified BSD License variant

Dependency

cffi-grovel (system).

Source

basic-binary-ipc.asd.

Child Components

3 Modules

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


3.1 basic-binary-ipc/src

Source

basic-binary-ipc.asd.

Parent Component

basic-binary-ipc (system).

Child Components

3.2 basic-binary-ipc/src/posix

Dependency

src (module).

Source

basic-binary-ipc.asd.

Parent Component

basic-binary-ipc (system).

Child Components

3.3 basic-binary-ipc/src/epoll

Dependency

src/posix (module).

Source

basic-binary-ipc.asd.

Parent Component

basic-binary-ipc (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 basic-binary-ipc/basic-binary-ipc.asd

Source

basic-binary-ipc.asd.

Parent Component

basic-binary-ipc (system).

ASDF Systems

basic-binary-ipc.


4.1.2 basic-binary-ipc/src/packages.lisp

Source

basic-binary-ipc.asd.

Parent Component

src (module).

Packages

basic-binary-ipc.


4.1.3 basic-binary-ipc/src/protocols.lisp

Dependency

packages.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 basic-binary-ipc/src/system-calls.lisp

Dependency

protocols.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src (module).

Internals

4.1.5 basic-binary-ipc/src/posix/posix-helpers.lisp

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Internals

4.1.6 basic-binary-ipc/src/posix/posix-grovel.lisp

Dependency

posix-helpers.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).


4.1.7 basic-binary-ipc/src/posix/posix-cffi.lisp

Dependency

posix-grovel.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Internals

4.1.8 basic-binary-ipc/src/posix/posix-socket-options.lisp

Dependency

posix-cffi.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Internals

4.1.9 basic-binary-ipc/src/posix/posix-sockets.lisp

Dependency

posix-socket-options.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Public Interface
Internals

4.1.10 basic-binary-ipc/src/posix/posix-poll.lisp

Dependency

posix-sockets.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Public Interface
Internals

4.1.11 basic-binary-ipc/src/epoll/epoll-grovel.lisp

Source

basic-binary-ipc.asd.

Parent Component

src/epoll (module).


4.1.12 basic-binary-ipc/src/epoll/epoll-cffi.lisp

Dependency

epoll-grovel.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/epoll (module).

Internals

4.1.13 basic-binary-ipc/src/epoll/epoll-poller.lisp

Dependency

epoll-cffi.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src/epoll (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 basic-binary-ipc

Source

packages.lisp.

Use List

common-lisp.

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 Special variables

Special Variable: +ipv4-any+
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Special Variable: +ipv4-loopback+
Package

basic-binary-ipc.

Source

posix-sockets.lisp.


6.1.2 Macros

Macro: with-poller ((var form) &body body)
Package

basic-binary-ipc.

Source

protocols.lisp.

Macro: with-socket ((var form) &body body)
Package

basic-binary-ipc.

Source

protocols.lisp.


6.1.3 Ordinary functions

Function: connect-to-ipv4-tcp-server (host-address port &key local-host-address local-port)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: connect-to-local-server (pathname &key)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: do-with-poller (function poller)
Package

basic-binary-ipc.

Source

protocols.lisp.

Function: do-with-socket (socket function)
Package

basic-binary-ipc.

Source

protocols.lisp.

Function: make-ipv4-tcp-server (host-address port &key reuse-address backlog)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: make-local-server (pathname &key backlog delete-on-close)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: make-poller ()
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: resolve-ipv4-address (hostname)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.


6.1.4 Generic functions

Generic Function: accept-connection (server)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: accept-connection ((server local-server))
Source

posix-sockets.lisp.

Method: accept-connection ((server ipv4-tcp-server))
Source

posix-sockets.lisp.

Generic Function: close-poller (poller)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: close-poller ((poller epoll-poller))
Source

epoll-poller.lisp.

Generic Function: close-socket (socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: close-socket ((socket local-server))
Source

posix-sockets.lisp.

Method: close-socket ((object posix-stream-server))
Source

posix-sockets.lisp.

Method: close-socket ((socket failed-posix-stream))
Source

posix-sockets.lisp.

Method: close-socket ((object posix-stream))
Source

posix-sockets.lisp.

Method: close-socket ((socket posix-socket))
Source

posix-sockets.lisp.

Generic Function: connection-available-p (server)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: connection-available-p ((server local-server))
Source

posix-sockets.lisp.

Method: connection-available-p ((server ipv4-tcp-server))
Source

posix-sockets.lisp.

Generic Function: connection-failed-p (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: connection-failed-p ((socket-stream failed-posix-stream))
Source

posix-sockets.lisp.

Method: connection-failed-p ((future-connection posix-stream))
Source

posix-sockets.lisp.

Generic Function: connection-succeeded-p (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: connection-succeeded-p ((socket-stream failed-posix-stream))
Source

posix-sockets.lisp.

Method: connection-succeeded-p ((future-connection posix-stream))
Source

posix-sockets.lisp.

Generic Function: data-available-p (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: data-available-p ((socket-stream failed-posix-stream))
Source

posix-sockets.lisp.

Method: data-available-p ((stream posix-stream))
Source

posix-sockets.lisp.

Generic Function: determinedp (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: determinedp ((socket-stream failed-posix-stream))
Source

posix-sockets.lisp.

Method: determinedp ((future-connection posix-stream))
Source

posix-sockets.lisp.

Generic Reader: host-address (server)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: host-address ((ipv4-tcp-server ipv4-tcp-server))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

host-address.

Generic Reader: local-host-address (stream)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: local-host-address ((ipv4-tcp-stream ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

local-host-address.

Generic Reader: local-pathname (socket)

The pathname to the local socket.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: local-pathname ((condition no-local-server-error))
Target Slot

local-pathname.

Reader Method: local-pathname ((local-server local-server))

automatically generated reader method

Target Slot

local-pathname.

Reader Method: local-pathname ((local-stream local-stream))

automatically generated reader method

Target Slot

local-pathname.

Generic Reader: local-port (stream)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: local-port ((ipv4-tcp-stream ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

local-port.

Generic Function: monitor-socket (poller socket socket-events)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: monitor-socket ((poller epoll-poller) socket socket-events)
Source

epoll-poller.lisp.

Generic Function: monitored-events (poller socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: monitored-events ((poller epoll-poller) socket)
Source

epoll-poller.lisp.

Generic Function: (setf monitored-events) (poller socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: (setf monitored-events) ((poller epoll-poller) socket)
Source

epoll-poller.lisp.

Generic Function: monitored-sockets (poller)
Package

basic-binary-ipc.

Source

protocols.lisp.

Generic Function: poll-socket (socket socket-events timeout)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: poll-socket (socket socket-events timeout)
Source

posix-poll.lisp.

Generic Function: poll-sockets (all-sockets all-socket-events timeout)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: poll-sockets ((all-sockets list) (all-socket-events list) timeout)
Source

posix-poll.lisp.

Generic Reader: port (server)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: port ((ipv4-tcp-server ipv4-tcp-server))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

port.

Generic Function: read-from-stream (stream-socket buffer &key start end peek)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: read-from-stream ((stream posix-stream) buffer &key start end peek)
Source

posix-sockets.lisp.

Generic Function: ready-to-write-p (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: ready-to-write-p ((stream posix-stream))
Source

posix-sockets.lisp.

Generic Function: remote-disconnected-p (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: remote-disconnected-p ((stream posix-stream))
Source

posix-sockets.lisp.

Generic Reader: remote-host-address (stream)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: remote-host-address ((failed-ipv4-tcp-stream failed-ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

remote-host-address.

Reader Method: remote-host-address ((ipv4-tcp-stream ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

remote-host-address.

Generic Reader: remote-port (stream)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Reader Method: remote-port ((failed-ipv4-tcp-stream failed-ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

remote-port.

Reader Method: remote-port ((ipv4-tcp-stream ipv4-tcp-stream))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

remote-port.

Generic Reader: socket (object)

Return the POSIX-SOCKET object used by OBJECT.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: socket ((condition poll-socket-error))
Source

posix-poll.lisp.

Target Slot

socket.

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

automatically generated reader method

Target Slot

socket.

Reader Method: socket ((failed-posix-stream failed-posix-stream))

automatically generated reader method

Target Slot

socket.

Reader Method: socket ((posix-stream posix-stream))

automatically generated reader method

Target Slot

socket.

Reader Method: socket ((condition no-connection-available-error))
Source

protocols.lisp.

Target Slot

socket.

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

protocols.lisp.

Target Slot

socket.

Generic Function: socket-closed-p (socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: socket-closed-p ((socket posix-stream-server))
Source

posix-sockets.lisp.

Method: socket-closed-p ((socket posix-stream))
Source

posix-sockets.lisp.

Reader Method: socket-closed-p ((posix-socket posix-socket))

automatically generated reader method

Source

posix-sockets.lisp.

Target Slot

closedp.

Generic Function: unmonitor-socket (poller socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: unmonitor-socket ((poller epoll-poller) socket)
Source

epoll-poller.lisp.

Generic Function: wait-for-events (poller timeout)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: wait-for-events ((poller epoll-poller) timeout)
Source

epoll-poller.lisp.

Generic Function: write-to-stream (stream-socket buffer &key start end)
Package

basic-binary-ipc.

Source

protocols.lisp.

Methods
Method: write-to-stream ((stream posix-stream) buffer &key start end)
Source

posix-sockets.lisp.


6.1.5 Standalone methods

Method: print-object ((object local-stream) stream)
Source

posix-sockets.lisp.

Method: print-object ((object ipv4-tcp-stream) stream)
Source

posix-sockets.lisp.

Method: print-object ((object failed-ipv4-tcp-stream) stream)
Source

posix-sockets.lisp.


6.1.6 Conditions

Condition: no-connection-available-error
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct superclasses

error.

Direct methods

socket.

Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Condition: no-local-server-error
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

condition.

Direct methods

local-pathname.

Direct slots
Slot: local-pathname
Initargs

:local-pathname

Readers

local-pathname.

Writers

This slot is read-only.

Condition: socket-error
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct superclasses

error.

Direct subclasses

posix-error.

Direct methods

socket.

Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.


6.1.7 Classes

Class: ipv4-tcp-server
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

posix-stream-server.

Direct methods
Direct slots
Slot: host-address
Initargs

:host-address

Readers

host-address.

Writers

This slot is read-only.

Slot: port
Initargs

:port

Readers

port.

Writers

This slot is read-only.

Class: ipv4-tcp-stream
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

posix-stream.

Direct methods
Direct slots
Slot: remote-host-address
Initargs

:remote-host-address

Readers

remote-host-address.

Writers

This slot is read-only.

Slot: remote-port
Initargs

:remote-port

Readers

remote-port.

Writers

This slot is read-only.

Slot: local-host-address
Initargs

:local-host-address

Readers

local-host-address.

Writers

This slot is read-only.

Slot: local-port
Initargs

:local-port

Readers

local-port.

Writers

This slot is read-only.

Class: local-server
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

posix-stream-server.

Direct methods
Direct slots
Slot: local-pathname
Initargs

:local-pathname

Readers

local-pathname.

Writers

This slot is read-only.

Slot: delete-on-close-p
Initargs

:delete-on-close-p

Readers

delete-on-close-p.

Writers

This slot is read-only.

Class: local-stream
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

posix-stream.

Direct methods
Direct slots
Slot: local-pathname
Initargs

:local-pathname

Readers

local-pathname.

Writers

This slot is read-only.

Class: socket
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct subclasses
Class: stream-server
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct superclasses

socket.

Direct subclasses

posix-stream-server.

Class: stream-socket
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct superclasses

socket.

Direct subclasses

6.2 Internals


6.2.1 Macros

Macro: define-check-system-call (name (caller foreign-name return-value &rest args) &body body)
Package

basic-binary-ipc.

Source

system-calls.lisp.

Macro: define-epoll-event (name &body body)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Macro: define-poll-fd-event (name &body body)

Provide implementations for COMPUTE-POLL-FD-EVENTS and PARSE-POLL-FD-EVENTS for the poll-fd event macro NAME. BODY consists of expressions starting with :CLASSES, :INPUT or :TEST.

(:CLASSES <class1> ... <class N>) represents the classes in which this event macro should be defined.

(:INPUT <input1> <input2>) are the events that poll(2) should look for.

(:TEST <expression>) is an expression that determines if the event occurred.

Package

basic-binary-ipc.

Source

posix-poll.lisp.

Macro: define-poll-fd-event-errors (&body body)

A symbol macro for declaraing the messages that are to be used when PARSE-POLL-FD-RESULT encounters an event that represents a socket error. BODY is a collection (event-symbol message) forms.

Package

basic-binary-ipc.

Source

posix-poll.lisp.

Macro: define-posix-system-call (name return-value &body arguments)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Macro: define-socket-option ((name socket-option-name socket-option-argument) &rest args &key level)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Macro: define-socket-option-argument (name &body options)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Macro: define-system-call (name-and-options return-type-info &body args)
Package

basic-binary-ipc.

Source

system-calls.lisp.

Macro: posix-socket-initialisation-progn ((socket) &body body)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Macro: with-sockaddr-in ((var family host-address port) &body body)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Macro: with-sockaddr-un ((ptr-var length-var pathname) &body body)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.


6.2.2 Ordinary functions

Function: %ff-accept (socket address address-len)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-bind (socket socket-address socket-address-length)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-close (file-descriptor)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-connect (socket address address-len)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-epoll-create (size)
Package

basic-binary-ipc.

Source

epoll-cffi.lisp.

Function: %ff-epoll-ctl (epfd op fd event)
Package

basic-binary-ipc.

Source

epoll-cffi.lisp.

Function: %ff-epoll-wait (epfd events maxevents timeout)
Package

basic-binary-ipc.

Source

epoll-cffi.lisp.

Function: %ff-fcntl-noarg (file-descriptor command)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-fcntl-setfl (file-descriptor command mode)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-freeaddrinfo (address-info)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-gai-strerror (code)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-get-errno ()
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: %ff-get-errno-pointer ()
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: %ff-getaddrinfo (hostname service-name hints result)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-getsockname (socket address address-length)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-getsockopt (socket level option-name option-value option-length)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-htons (host-short)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-inet-aton (name addr)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-inet-ntoa (addr)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-listen (socket backlog)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-ntohl (network-long)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-ntohs (network-short)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-poll (fds nfds timeout)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-recvfrom (socket buffer length flags address address-len)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-sendto (socket buffer length flags dest-addr dest-len)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-setsockopt (socket level option-name option-value option-length)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-socket (domain type protocol)
Package

basic-binary-ipc.

Source

posix-cffi.lisp.

Function: %ff-strerror (errnum buffer buffer-size)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: check-posix (caller foreign-name return-value)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: compilable-poll-fd-event-expression (expression)
Package

basic-binary-ipc.

Source

posix-poll.lisp.

Function: compile-poll-fd-event-expression (expression)
Package

basic-binary-ipc.

Source

posix-poll.lisp.

Function: do-define-socket-option/reader (name socket-option-name socket-option-argument &key level)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Function: do-define-socket-option/writer (name socket-option-name socket-option-argument &key level)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Function: do-with-sockaddr-in (function family host-address port)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: do-with-sockaddr-un (function pathname)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: ensure-epoll-event-data (name events test-function)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: ensure-socket-option-argument (name &key base-type)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Function: epoll-event-data (symbol)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: (setf epoll-event-data) (symbol)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: errnum-symbol (errnum)

Map the error with integer ERRNUM to a symbol from the grovelled ERRNO-ENUM type.

Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: host-address-from-inaddr (in-addr)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: host-address-from-sockaddr-in (sockaddr-in)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: make-posix-socket (namespace communication-style protocol)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: poll-fd-event-test (expression events socket)
Package

basic-binary-ipc.

Source

posix-poll.lisp.

Function: poll-fd-event-test/sexp (expression events socket)
Package

basic-binary-ipc.

Source

posix-poll.lisp.

Function: port-from-sockaddr-in (sockaddr-in)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: posix-error-code (condition)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: posix-error-code-p (condition code)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: posix-error-interrupted-p (condition)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: posix-error-would-block-p (condition)

The predicate POSIX-ERROR-WOULD-BLOCK-P handles the potential sitation where EAGAIN and EWOULDBLOCK are defined to be the same ERRNO constant (this is true on OSX). This causes difficulties with the mapping between error codes and keywords in the enum ERRNO-ENUM.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Function: prepare-epoll-event-test-function (sexp)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: prepare-epoll-event-test-function/expander (sexp events-var socket-var)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: process-events (poller events number-of-events)
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Function: socket-option-argument (symbol)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Function: (setf socket-option-argument) (symbol)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Function: strerror (errnum)

Obtain the POSIX error string for the error with integer ERRNUM.

Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Function: zero-memory (pointer cffi-type)
Package

basic-binary-ipc.

Source

posix-helpers.lisp.


6.2.3 Generic functions

Generic Function: c-function-name (object)

The name of the foreign function that signalled the posix error.

Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Generic Reader: closedp (object)
Package

basic-binary-ipc.

Methods
Reader Method: closedp ((epoll-poller epoll-poller))

automatically generated reader method

Source

epoll-poller.lisp.

Target Slot

closedp.

Generic Writer: (setf closedp) (object)
Package

basic-binary-ipc.

Methods
Writer Method: (setf closedp) ((epoll-poller epoll-poller))

automatically generated writer method

Source

epoll-poller.lisp.

Target Slot

closedp.

Generic Reader: communication-style (posix-socket)

Return the posix communication style used by the POSIX-SOCKET.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: communication-style ((posix-socket posix-socket))

automatically generated reader method

Target Slot

communication-style.

Generic Function: compute-poll-fd-events (socket socket-events)

Return the list of POLL-EVENTS symbols required for
the events field in the pollfd structure. SOCKET-EVENTS can be a single symbol or a list of symbols that represent events that can be detected using poll(2).

Package

basic-binary-ipc.

Source

posix-poll.lisp.

Methods
Method: compute-poll-fd-events ((socket failed-posix-stream) socket-events)
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:remote-disconnected-p)))
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:ready-to-write-p)))
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:data-available-p)))
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:connection-succeeded-p)))
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:connection-failed-p)))
Method: compute-poll-fd-events ((object posix-stream) (socket-events (eql basic-binary-ipc:determinedp)))
Method: compute-poll-fd-events ((object local-server) (socket-events (eql basic-binary-ipc:connection-available-p)))
Method: compute-poll-fd-events ((object ipv4-tcp-server) (socket-events (eql basic-binary-ipc:connection-available-p)))
Method: compute-poll-fd-events (socket (socket-events list))
Generic Function: connection-stream (stream-socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Generic Reader: delete-on-close-p (socket)

Delete the pathname when closing the socket.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: delete-on-close-p ((local-server local-server))

automatically generated reader method

Target Slot

delete-on-close-p.

Generic Reader: descriptor-socket-table (object)

A table mapping file descriptors to socket objects.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Reader Method: descriptor-socket-table ((epoll-poller epoll-poller))

automatically generated reader method

Target Slot

descriptor-socket-table.

Generic Reader: epoll-descriptor (object)

The descriptor for the EPOLL object.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Reader Method: epoll-descriptor ((epoll-poller epoll-poller))

automatically generated reader method

Target Slot

epoll-descriptor.

Generic Function: epoll-events (object)

Return the list of events required for epoll to notify when the event OBJECT occurs.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Method: epoll-events ((object symbol))
Reader Method: epoll-events ((epoll-event-data epoll-event-data))

automatically generated reader method

Target Slot

events.

Generic Function: epoll-match-p (object events socket)

Inspect EVENTS and SOCKET to see if the OBJECT event has occurred.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Method: epoll-match-p ((object symbol) events socket)
Method: epoll-match-p ((object epoll-event-data) events socket)
Generic Function: file-descriptor (object)

Return the file descriptor of the object.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Method: file-descriptor ((object posix-stream-server))
Method: file-descriptor ((object failed-posix-stream))
Method: file-descriptor ((object posix-stream))
Reader Method: file-descriptor ((posix-socket posix-socket))

automatically generated reader method

Target Slot

file-descriptor.

Generic Function: keep-alive-p (object)
Package

basic-binary-ipc.

Methods
Method: keep-alive-p ((object posix-socket))
Source

posix-sockets.lisp.

Generic Function: (setf keep-alive-p) (object)
Package

basic-binary-ipc.

Methods
Method: (setf keep-alive-p) ((object posix-socket))
Source

posix-sockets.lisp.

Generic Function: lisp-function-name (object)

The name of the LISP function that wraps the foreign posix function.

Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Generic Reader: maximum-number-of-events (object)

The maximum number of events to retrieve when invoking epoll_wait.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Reader Method: maximum-number-of-events ((epoll-poller epoll-poller))

automatically generated reader method

Target Slot

maximum-number-of-events.

Generic Reader: message (condition)
Package

basic-binary-ipc.

Methods
Reader Method: message ((condition poll-socket-error))
Source

posix-poll.lisp.

Target Slot

message.

Generic Reader: monitor-table (object)

A table mapping sockets to epoll poller specific information.

Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Methods
Reader Method: monitor-table ((epoll-poller epoll-poller))

automatically generated reader method

Target Slot

monitor-table.

Generic Function: monitoredp (poller socket)
Package

basic-binary-ipc.

Source

protocols.lisp.

Generic Reader: namespace (posix-socket)

Return the posix namespace used by the POSIX-SOCKET.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: namespace ((posix-socket posix-socket))

automatically generated reader method

Target Slot

namespace.

Generic Function: operating-modes (socket)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Method: operating-modes ((object posix-socket))
Generic Function: (setf operating-modes) (socket)
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Method: (setf operating-modes) ((object posix-socket))
Generic Function: parse-poll-fd-result (socket socket-events revents)

Parse the POLL-EVENTS symbols returned by poll(2)
and determine if any event in SOCKET-EVENTS occurred. SOCKET-EVENTS may be a symbol or a list of symbols.

Package

basic-binary-ipc.

Source

posix-poll.lisp.

Methods
Method: parse-poll-fd-result ((socket failed-posix-stream) (socket-events symbol) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:remote-disconnected-p)) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:ready-to-write-p)) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:data-available-p)) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:connection-succeeded-p)) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:connection-failed-p)) revents)
Method: parse-poll-fd-result ((object posix-stream) (socket-events (eql basic-binary-ipc:determinedp)) revents)
Method: parse-poll-fd-result ((object local-server) (socket-events (eql basic-binary-ipc:connection-available-p)) revents)
Method: parse-poll-fd-result ((object ipv4-tcp-server) (socket-events (eql basic-binary-ipc:connection-available-p)) revents)
Method: parse-poll-fd-result (socket (socket-events list) revents)
Generic Reader: protocol (posix-socket)

Return the protocol used by the POSIX-SOCKET.

Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Methods
Reader Method: protocol ((posix-socket posix-socket))

automatically generated reader method

Target Slot

protocol.

Generic Function: reuse-address-p (object)
Package

basic-binary-ipc.

Methods
Method: reuse-address-p ((object posix-socket))
Source

posix-sockets.lisp.

Generic Function: (setf reuse-address-p) (object)
Package

basic-binary-ipc.

Methods
Method: (setf reuse-address-p) ((object posix-socket))
Source

posix-sockets.lisp.

Generic Reader: soa-base-type (soa)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Methods
Reader Method: soa-base-type ((socket-option-argument socket-option-argument))

automatically generated reader method

Target Slot

base-type.

Generic Function: soa-size (soa)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Methods
Method: soa-size ((object socket-option-argument))
Generic Function: soa-translate-from-memory (soa pointer)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Methods
Method: soa-translate-from-memory ((g0 (eql basic-binary-ipc::soa-boolean)) pointer)
Source

posix-sockets.lisp.

Generic Function: soa-translate-to-memory (soa value pointer)
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Methods
Method: soa-translate-to-memory ((g0 (eql basic-binary-ipc::soa-boolean)) value pointer)
Source

posix-sockets.lisp.

Generic Reader: system-function-caller (condition)

The name of the function which invoked the system function that failed.

Package

basic-binary-ipc.

Source

system-calls.lisp.

Methods
Reader Method: system-function-caller ((condition system-function-error))
Target Slot

caller.

Generic Reader: system-function-error-message (condition)

A user friendly message describing the system call failure.

Package

basic-binary-ipc.

Source

system-calls.lisp.

Methods
Reader Method: system-function-error-message ((condition system-function-error))
Target Slot

error-message.

Generic Reader: system-function-error-value (condition)

The error value communicated by the system call.

Package

basic-binary-ipc.

Source

system-calls.lisp.

Methods
Reader Method: system-function-error-value ((condition system-function-error))
Target Slot

error-value.

Generic Reader: system-function-name (condition)

The name of the system call that failed.

Package

basic-binary-ipc.

Source

system-calls.lisp.

Methods
Reader Method: system-function-name ((condition system-function-error))
Target Slot

name.

Generic Reader: test-function (object)
Package

basic-binary-ipc.

Methods
Reader Method: test-function ((epoll-event-data epoll-event-data))

automatically generated reader method

Source

epoll-poller.lisp.

Target Slot

test-function.


6.2.4 Conditions

Condition: poll-socket-error
Package

basic-binary-ipc.

Source

posix-poll.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Slot: message
Initargs

:message

Readers

message.

Writers

This slot is read-only.

Condition: posix-error

This error class provides a lisp representation of POSIX errors.

Package

basic-binary-ipc.

Source

posix-helpers.lisp.

Direct superclasses
Condition: system-function-error
Package

basic-binary-ipc.

Source

system-calls.lisp.

Direct superclasses

error.

Direct subclasses

posix-error.

Direct methods
Direct slots
Slot: caller
Initargs

:caller

Readers

system-function-caller.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

system-function-name.

Writers

This slot is read-only.

Slot: error-value
Initargs

:error-value

Readers

system-function-error-value.

Writers

This slot is read-only.

Slot: error-message
Initargs

:error-message

Readers

system-function-error-message.

Writers

This slot is read-only.


6.2.5 Classes

Class: epoll-event-data
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Direct methods
Direct slots
Slot: events
Initargs

:events

Readers

epoll-events.

Writers

This slot is read-only.

Slot: test-function
Initargs

:test-function

Readers

test-function.

Writers

This slot is read-only.

Class: epoll-poller
Package

basic-binary-ipc.

Source

epoll-poller.lisp.

Direct superclasses

poller.

Direct methods
Direct Default Initargs
InitargValue
:closedpnil
:maximum-number-of-events100
:monitor-table(make-hash-table)
:descriptor-socket-table(make-hash-table)
Direct slots
Slot: epoll-descriptor
Initargs

:epoll-descriptor

Readers

epoll-descriptor.

Writers

This slot is read-only.

Slot: closedp
Initargs

:closedp

Readers

closedp.

Writers

(setf closedp).

Slot: monitor-table
Initargs

:monitor-table

Readers

monitor-table.

Writers

This slot is read-only.

Slot: descriptor-socket-table
Initargs

:descriptor-socket-table

Readers

descriptor-socket-table.

Writers

This slot is read-only.

Slot: maximum-number-of-events
Initargs

:maximum-number-of-events

Readers

maximum-number-of-events.

Writers

This slot is read-only.

Class: failed-ipv4-tcp-stream
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

failed-posix-stream.

Direct methods
Direct slots
Slot: remote-port
Initargs

:remote-port

Readers

remote-port.

Writers

This slot is read-only.

Slot: remote-host-address
Initargs

:remote-host-address

Readers

remote-host-address.

Writers

This slot is read-only.

Class: failed-posix-stream
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

stream-socket.

Direct subclasses

failed-ipv4-tcp-stream.

Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Class: poller
Package

basic-binary-ipc.

Source

protocols.lisp.

Direct subclasses

epoll-poller.

Class: posix-socket
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct methods
Direct slots
Slot: namespace
Initargs

:namespace

Readers

namespace.

Writers

This slot is read-only.

Slot: communication-style
Initargs

:communication-style

Readers

communication-style.

Writers

This slot is read-only.

Slot: protocol
Initargs

:protocol

Readers

protocol.

Writers

This slot is read-only.

Slot: file-descriptor
Initform

(error "file descriptors must be specified.")

Initargs

:file-descriptor

Readers

file-descriptor.

Writers

This slot is read-only.

Slot: closedp
Initargs

:closedp

Readers

socket-closed-p.

Writers

This slot is read-only.

Class: posix-stream
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

stream-socket.

Direct subclasses
Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Class: posix-stream-server
Package

basic-binary-ipc.

Source

posix-sockets.lisp.

Direct superclasses

stream-server.

Direct subclasses
Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Class: socket-option-argument
Package

basic-binary-ipc.

Source

posix-socket-options.lisp.

Direct methods
Direct slots
Slot: base-type
Initargs

:base-type

Readers

soa-base-type.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

%
%ff-accept: Private ordinary functions
%ff-bind: Private ordinary functions
%ff-close: Private ordinary functions
%ff-connect: Private ordinary functions
%ff-epoll-create: Private ordinary functions
%ff-epoll-ctl: Private ordinary functions
%ff-epoll-wait: Private ordinary functions
%ff-fcntl-noarg: Private ordinary functions
%ff-fcntl-setfl: Private ordinary functions
%ff-freeaddrinfo: Private ordinary functions
%ff-gai-strerror: Private ordinary functions
%ff-get-errno: Private ordinary functions
%ff-get-errno-pointer: Private ordinary functions
%ff-getaddrinfo: Private ordinary functions
%ff-getsockname: Private ordinary functions
%ff-getsockopt: Private ordinary functions
%ff-htons: Private ordinary functions
%ff-inet-aton: Private ordinary functions
%ff-inet-ntoa: Private ordinary functions
%ff-listen: Private ordinary functions
%ff-ntohl: Private ordinary functions
%ff-ntohs: Private ordinary functions
%ff-poll: Private ordinary functions
%ff-recvfrom: Private ordinary functions
%ff-sendto: Private ordinary functions
%ff-setsockopt: Private ordinary functions
%ff-socket: Private ordinary functions
%ff-strerror: Private ordinary functions

(
(setf closedp): Private generic functions
(setf closedp): Private generic functions
(setf epoll-event-data): Private ordinary functions
(setf keep-alive-p): Private generic functions
(setf keep-alive-p): Private generic functions
(setf monitored-events): Public generic functions
(setf monitored-events): Public generic functions
(setf operating-modes): Private generic functions
(setf operating-modes): Private generic functions
(setf reuse-address-p): Private generic functions
(setf reuse-address-p): Private generic functions
(setf socket-option-argument): Private ordinary functions

A
accept-connection: Public generic functions
accept-connection: Public generic functions
accept-connection: Public generic functions

C
c-function-name: Private generic functions
check-posix: Private ordinary functions
close-poller: Public generic functions
close-poller: Public generic functions
close-socket: Public generic functions
close-socket: Public generic functions
close-socket: Public generic functions
close-socket: Public generic functions
close-socket: Public generic functions
close-socket: Public generic functions
closedp: Private generic functions
closedp: Private generic functions
communication-style: Private generic functions
communication-style: Private generic functions
compilable-poll-fd-event-expression: Private ordinary functions
compile-poll-fd-event-expression: Private ordinary functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
compute-poll-fd-events: Private generic functions
connect-to-ipv4-tcp-server: Public ordinary functions
connect-to-local-server: Public ordinary functions
connection-available-p: Public generic functions
connection-available-p: Public generic functions
connection-available-p: Public generic functions
connection-failed-p: Public generic functions
connection-failed-p: Public generic functions
connection-failed-p: Public generic functions
connection-stream: Private generic functions
connection-succeeded-p: Public generic functions
connection-succeeded-p: Public generic functions
connection-succeeded-p: Public generic functions

D
data-available-p: Public generic functions
data-available-p: Public generic functions
data-available-p: Public generic functions
define-check-system-call: Private macros
define-epoll-event: Private macros
define-poll-fd-event: Private macros
define-poll-fd-event-errors: Private macros
define-posix-system-call: Private macros
define-socket-option: Private macros
define-socket-option-argument: Private macros
define-system-call: Private macros
delete-on-close-p: Private generic functions
delete-on-close-p: Private generic functions
descriptor-socket-table: Private generic functions
descriptor-socket-table: Private generic functions
determinedp: Public generic functions
determinedp: Public generic functions
determinedp: Public generic functions
do-define-socket-option/reader: Private ordinary functions
do-define-socket-option/writer: Private ordinary functions
do-with-poller: Public ordinary functions
do-with-sockaddr-in: Private ordinary functions
do-with-sockaddr-un: Private ordinary functions
do-with-socket: Public ordinary functions

E
ensure-epoll-event-data: Private ordinary functions
ensure-socket-option-argument: Private ordinary functions
epoll-descriptor: Private generic functions
epoll-descriptor: Private generic functions
epoll-event-data: Private ordinary functions
epoll-events: Private generic functions
epoll-events: Private generic functions
epoll-events: Private generic functions
epoll-match-p: Private generic functions
epoll-match-p: Private generic functions
epoll-match-p: Private generic functions
errnum-symbol: Private ordinary functions

F
file-descriptor: Private generic functions
file-descriptor: Private generic functions
file-descriptor: Private generic functions
file-descriptor: Private generic functions
file-descriptor: Private generic functions
Function, %ff-accept: Private ordinary functions
Function, %ff-bind: Private ordinary functions
Function, %ff-close: Private ordinary functions
Function, %ff-connect: Private ordinary functions
Function, %ff-epoll-create: Private ordinary functions
Function, %ff-epoll-ctl: Private ordinary functions
Function, %ff-epoll-wait: Private ordinary functions
Function, %ff-fcntl-noarg: Private ordinary functions
Function, %ff-fcntl-setfl: Private ordinary functions
Function, %ff-freeaddrinfo: Private ordinary functions
Function, %ff-gai-strerror: Private ordinary functions
Function, %ff-get-errno: Private ordinary functions
Function, %ff-get-errno-pointer: Private ordinary functions
Function, %ff-getaddrinfo: Private ordinary functions
Function, %ff-getsockname: Private ordinary functions
Function, %ff-getsockopt: Private ordinary functions
Function, %ff-htons: Private ordinary functions
Function, %ff-inet-aton: Private ordinary functions
Function, %ff-inet-ntoa: Private ordinary functions
Function, %ff-listen: Private ordinary functions
Function, %ff-ntohl: Private ordinary functions
Function, %ff-ntohs: Private ordinary functions
Function, %ff-poll: Private ordinary functions
Function, %ff-recvfrom: Private ordinary functions
Function, %ff-sendto: Private ordinary functions
Function, %ff-setsockopt: Private ordinary functions
Function, %ff-socket: Private ordinary functions
Function, %ff-strerror: Private ordinary functions
Function, (setf epoll-event-data): Private ordinary functions
Function, (setf socket-option-argument): Private ordinary functions
Function, check-posix: Private ordinary functions
Function, compilable-poll-fd-event-expression: Private ordinary functions
Function, compile-poll-fd-event-expression: Private ordinary functions
Function, connect-to-ipv4-tcp-server: Public ordinary functions
Function, connect-to-local-server: Public ordinary functions
Function, do-define-socket-option/reader: Private ordinary functions
Function, do-define-socket-option/writer: Private ordinary functions
Function, do-with-poller: Public ordinary functions
Function, do-with-sockaddr-in: Private ordinary functions
Function, do-with-sockaddr-un: Private ordinary functions
Function, do-with-socket: Public ordinary functions
Function, ensure-epoll-event-data: Private ordinary functions
Function, ensure-socket-option-argument: Private ordinary functions
Function, epoll-event-data: Private ordinary functions
Function, errnum-symbol: Private ordinary functions
Function, host-address-from-inaddr: Private ordinary functions
Function, host-address-from-sockaddr-in: Private ordinary functions
Function, make-ipv4-tcp-server: Public ordinary functions
Function, make-local-server: Public ordinary functions
Function, make-poller: Public ordinary functions
Function, make-posix-socket: Private ordinary functions
Function, poll-fd-event-test: Private ordinary functions
Function, poll-fd-event-test/sexp: Private ordinary functions
Function, port-from-sockaddr-in: Private ordinary functions
Function, posix-error-code: Private ordinary functions
Function, posix-error-code-p: Private ordinary functions
Function, posix-error-interrupted-p: Private ordinary functions
Function, posix-error-would-block-p: Private ordinary functions
Function, prepare-epoll-event-test-function: Private ordinary functions
Function, prepare-epoll-event-test-function/expander: Private ordinary functions
Function, process-events: Private ordinary functions
Function, resolve-ipv4-address: Public ordinary functions
Function, socket-option-argument: Private ordinary functions
Function, strerror: Private ordinary functions
Function, zero-memory: Private ordinary functions

G
Generic Function, (setf closedp): Private generic functions
Generic Function, (setf keep-alive-p): Private generic functions
Generic Function, (setf monitored-events): Public generic functions
Generic Function, (setf operating-modes): Private generic functions
Generic Function, (setf reuse-address-p): Private generic functions
Generic Function, accept-connection: Public generic functions
Generic Function, c-function-name: Private generic functions
Generic Function, close-poller: Public generic functions
Generic Function, close-socket: Public generic functions
Generic Function, closedp: Private generic functions
Generic Function, communication-style: Private generic functions
Generic Function, compute-poll-fd-events: Private generic functions
Generic Function, connection-available-p: Public generic functions
Generic Function, connection-failed-p: Public generic functions
Generic Function, connection-stream: Private generic functions
Generic Function, connection-succeeded-p: Public generic functions
Generic Function, data-available-p: Public generic functions
Generic Function, delete-on-close-p: Private generic functions
Generic Function, descriptor-socket-table: Private generic functions
Generic Function, determinedp: Public generic functions
Generic Function, epoll-descriptor: Private generic functions
Generic Function, epoll-events: Private generic functions
Generic Function, epoll-match-p: Private generic functions
Generic Function, file-descriptor: Private generic functions
Generic Function, host-address: Public generic functions
Generic Function, keep-alive-p: Private generic functions
Generic Function, lisp-function-name: Private generic functions
Generic Function, local-host-address: Public generic functions
Generic Function, local-pathname: Public generic functions
Generic Function, local-port: Public generic functions
Generic Function, maximum-number-of-events: Private generic functions
Generic Function, message: Private generic functions
Generic Function, monitor-socket: Public generic functions
Generic Function, monitor-table: Private generic functions
Generic Function, monitored-events: Public generic functions
Generic Function, monitored-sockets: Public generic functions
Generic Function, monitoredp: Private generic functions
Generic Function, namespace: Private generic functions
Generic Function, operating-modes: Private generic functions
Generic Function, parse-poll-fd-result: Private generic functions
Generic Function, poll-socket: Public generic functions
Generic Function, poll-sockets: Public generic functions
Generic Function, port: Public generic functions
Generic Function, protocol: Private generic functions
Generic Function, read-from-stream: Public generic functions
Generic Function, ready-to-write-p: Public generic functions
Generic Function, remote-disconnected-p: Public generic functions
Generic Function, remote-host-address: Public generic functions
Generic Function, remote-port: Public generic functions
Generic Function, reuse-address-p: Private generic functions
Generic Function, soa-base-type: Private generic functions
Generic Function, soa-size: Private generic functions
Generic Function, soa-translate-from-memory: Private generic functions
Generic Function, soa-translate-to-memory: Private generic functions
Generic Function, socket: Public generic functions
Generic Function, socket-closed-p: Public generic functions
Generic Function, system-function-caller: Private generic functions
Generic Function, system-function-error-message: Private generic functions
Generic Function, system-function-error-value: Private generic functions
Generic Function, system-function-name: Private generic functions
Generic Function, test-function: Private generic functions
Generic Function, unmonitor-socket: Public generic functions
Generic Function, wait-for-events: Public generic functions
Generic Function, write-to-stream: Public generic functions

H
host-address: Public generic functions
host-address: Public generic functions
host-address-from-inaddr: Private ordinary functions
host-address-from-sockaddr-in: Private ordinary functions

K
keep-alive-p: Private generic functions
keep-alive-p: Private generic functions

L
lisp-function-name: Private generic functions
local-host-address: Public generic functions
local-host-address: Public generic functions
local-pathname: Public generic functions
local-pathname: Public generic functions
local-pathname: Public generic functions
local-pathname: Public generic functions
local-port: Public generic functions
local-port: Public generic functions

M
Macro, define-check-system-call: Private macros
Macro, define-epoll-event: Private macros
Macro, define-poll-fd-event: Private macros
Macro, define-poll-fd-event-errors: Private macros
Macro, define-posix-system-call: Private macros
Macro, define-socket-option: Private macros
Macro, define-socket-option-argument: Private macros
Macro, define-system-call: Private macros
Macro, posix-socket-initialisation-progn: Private macros
Macro, with-poller: Public macros
Macro, with-sockaddr-in: Private macros
Macro, with-sockaddr-un: Private macros
Macro, with-socket: Public macros
make-ipv4-tcp-server: Public ordinary functions
make-local-server: Public ordinary functions
make-poller: Public ordinary functions
make-posix-socket: Private ordinary functions
maximum-number-of-events: Private generic functions
maximum-number-of-events: Private generic functions
message: Private generic functions
message: Private generic functions
Method, (setf closedp): Private generic functions
Method, (setf keep-alive-p): Private generic functions
Method, (setf monitored-events): Public generic functions
Method, (setf operating-modes): Private generic functions
Method, (setf reuse-address-p): Private generic functions
Method, accept-connection: Public generic functions
Method, accept-connection: Public generic functions
Method, close-poller: Public generic functions
Method, close-socket: Public generic functions
Method, close-socket: Public generic functions
Method, close-socket: Public generic functions
Method, close-socket: Public generic functions
Method, close-socket: Public generic functions
Method, closedp: Private generic functions
Method, communication-style: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, compute-poll-fd-events: Private generic functions
Method, connection-available-p: Public generic functions
Method, connection-available-p: Public generic functions
Method, connection-failed-p: Public generic functions
Method, connection-failed-p: Public generic functions
Method, connection-succeeded-p: Public generic functions
Method, connection-succeeded-p: Public generic functions
Method, data-available-p: Public generic functions
Method, data-available-p: Public generic functions
Method, delete-on-close-p: Private generic functions
Method, descriptor-socket-table: Private generic functions
Method, determinedp: Public generic functions
Method, determinedp: Public generic functions
Method, epoll-descriptor: Private generic functions
Method, epoll-events: Private generic functions
Method, epoll-events: Private generic functions
Method, epoll-match-p: Private generic functions
Method, epoll-match-p: Private generic functions
Method, file-descriptor: Private generic functions
Method, file-descriptor: Private generic functions
Method, file-descriptor: Private generic functions
Method, file-descriptor: Private generic functions
Method, host-address: Public generic functions
Method, keep-alive-p: Private generic functions
Method, local-host-address: Public generic functions
Method, local-pathname: Public generic functions
Method, local-pathname: Public generic functions
Method, local-pathname: Public generic functions
Method, local-port: Public generic functions
Method, maximum-number-of-events: Private generic functions
Method, message: Private generic functions
Method, monitor-socket: Public generic functions
Method, monitor-table: Private generic functions
Method, monitored-events: Public generic functions
Method, namespace: Private generic functions
Method, operating-modes: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, parse-poll-fd-result: Private generic functions
Method, poll-socket: Public generic functions
Method, poll-sockets: Public generic functions
Method, port: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, protocol: Private generic functions
Method, read-from-stream: Public generic functions
Method, ready-to-write-p: Public generic functions
Method, remote-disconnected-p: Public generic functions
Method, remote-host-address: Public generic functions
Method, remote-host-address: Public generic functions
Method, remote-port: Public generic functions
Method, remote-port: Public generic functions
Method, reuse-address-p: Private generic functions
Method, soa-base-type: Private generic functions
Method, soa-size: Private generic functions
Method, soa-translate-from-memory: Private generic functions
Method, soa-translate-to-memory: Private generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket: Public generic functions
Method, socket-closed-p: Public generic functions
Method, socket-closed-p: Public generic functions
Method, socket-closed-p: Public generic functions
Method, system-function-caller: Private generic functions
Method, system-function-error-message: Private generic functions
Method, system-function-error-value: Private generic functions
Method, system-function-name: Private generic functions
Method, test-function: Private generic functions
Method, unmonitor-socket: Public generic functions
Method, wait-for-events: Public generic functions
Method, write-to-stream: Public generic functions
monitor-socket: Public generic functions
monitor-socket: Public generic functions
monitor-table: Private generic functions
monitor-table: Private generic functions
monitored-events: Public generic functions
monitored-events: Public generic functions
monitored-sockets: Public generic functions
monitoredp: Private generic functions

N
namespace: Private generic functions
namespace: Private generic functions

O
operating-modes: Private generic functions
operating-modes: Private generic functions

P
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
parse-poll-fd-result: Private generic functions
poll-fd-event-test: Private ordinary functions
poll-fd-event-test/sexp: Private ordinary functions
poll-socket: Public generic functions
poll-socket: Public generic functions
poll-sockets: Public generic functions
poll-sockets: Public generic functions
port: Public generic functions
port: Public generic functions
port-from-sockaddr-in: Private ordinary functions
posix-error-code: Private ordinary functions
posix-error-code-p: Private ordinary functions
posix-error-interrupted-p: Private ordinary functions
posix-error-would-block-p: Private ordinary functions
posix-socket-initialisation-progn: Private macros
prepare-epoll-event-test-function: Private ordinary functions
prepare-epoll-event-test-function/expander: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
process-events: Private ordinary functions
protocol: Private generic functions
protocol: Private generic functions

R
read-from-stream: Public generic functions
read-from-stream: Public generic functions
ready-to-write-p: Public generic functions
ready-to-write-p: Public generic functions
remote-disconnected-p: Public generic functions
remote-disconnected-p: Public generic functions
remote-host-address: Public generic functions
remote-host-address: Public generic functions
remote-host-address: Public generic functions
remote-port: Public generic functions
remote-port: Public generic functions
remote-port: Public generic functions
resolve-ipv4-address: Public ordinary functions
reuse-address-p: Private generic functions
reuse-address-p: Private generic functions

S
soa-base-type: Private generic functions
soa-base-type: Private generic functions
soa-size: Private generic functions
soa-size: Private generic functions
soa-translate-from-memory: Private generic functions
soa-translate-from-memory: Private generic functions
soa-translate-to-memory: Private generic functions
soa-translate-to-memory: Private generic functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket: Public generic functions
socket-closed-p: Public generic functions
socket-closed-p: Public generic functions
socket-closed-p: Public generic functions
socket-closed-p: Public generic functions
socket-option-argument: Private ordinary functions
strerror: Private ordinary functions
system-function-caller: Private generic functions
system-function-caller: Private generic functions
system-function-error-message: Private generic functions
system-function-error-message: Private generic functions
system-function-error-value: Private generic functions
system-function-error-value: Private generic functions
system-function-name: Private generic functions
system-function-name: Private generic functions

T
test-function: Private generic functions
test-function: Private generic functions

U
unmonitor-socket: Public generic functions
unmonitor-socket: Public generic functions

W
wait-for-events: Public generic functions
wait-for-events: Public generic functions
with-poller: Public macros
with-sockaddr-in: Private macros
with-sockaddr-un: Private macros
with-socket: Public macros
write-to-stream: Public generic functions
write-to-stream: Public generic functions

Z
zero-memory: Private ordinary functions


A.3 Variables

Jump to:   +  
B   C   D   E   F   H   L   M   N   P   R   S   T  
Index Entry  Section

+
+ipv4-any+: Public special variables
+ipv4-loopback+: Public special variables

B
base-type: Private classes

C
caller: Private conditions
closedp: Private classes
closedp: Private classes
communication-style: Private classes

D
delete-on-close-p: Public classes
descriptor-socket-table: Private classes

E
epoll-descriptor: Private classes
error-message: Private conditions
error-value: Private conditions
events: Private classes

F
file-descriptor: Private classes

H
host-address: Public classes

L
local-host-address: Public classes
local-pathname: Public conditions
local-pathname: Public classes
local-pathname: Public classes
local-port: Public classes

M
maximum-number-of-events: Private classes
message: Private conditions
monitor-table: Private classes

N
name: Private conditions
namespace: Private classes

P
port: Public classes
protocol: Private classes

R
remote-host-address: Public classes
remote-host-address: Private classes
remote-port: Public classes
remote-port: Private classes

S
Slot, base-type: Private classes
Slot, caller: Private conditions
Slot, closedp: Private classes
Slot, closedp: Private classes
Slot, communication-style: Private classes
Slot, delete-on-close-p: Public classes
Slot, descriptor-socket-table: Private classes
Slot, epoll-descriptor: Private classes
Slot, error-message: Private conditions
Slot, error-value: Private conditions
Slot, events: Private classes
Slot, file-descriptor: Private classes
Slot, host-address: Public classes
Slot, local-host-address: Public classes
Slot, local-pathname: Public conditions
Slot, local-pathname: Public classes
Slot, local-pathname: Public classes
Slot, local-port: Public classes
Slot, maximum-number-of-events: Private classes
Slot, message: Private conditions
Slot, monitor-table: Private classes
Slot, name: Private conditions
Slot, namespace: Private classes
Slot, port: Public classes
Slot, protocol: Private classes
Slot, remote-host-address: Public classes
Slot, remote-host-address: Private classes
Slot, remote-port: Public classes
Slot, remote-port: Private classes
Slot, socket: Public conditions
Slot, socket: Public conditions
Slot, socket: Private conditions
Slot, socket: Private classes
Slot, socket: Private classes
Slot, socket: Private classes
Slot, test-function: Private classes
socket: Public conditions
socket: Public conditions
socket: Private conditions
socket: Private classes
socket: Private classes
socket: Private classes
Special Variable, +ipv4-any+: Public special variables
Special Variable, +ipv4-loopback+: Public special variables

T
test-function: Private classes


A.4 Data types

Jump to:   B   C   E   F   I   L   M   N   P   S  
Index Entry  Section

B
basic-binary-ipc: The basic-binary-ipc system
basic-binary-ipc: The basic-binary-ipc package
basic-binary-ipc.asd: The basic-binary-ipc/basic-binary-ipc․asd file

C
Class, epoll-event-data: Private classes
Class, epoll-poller: Private classes
Class, failed-ipv4-tcp-stream: Private classes
Class, failed-posix-stream: Private classes
Class, ipv4-tcp-server: Public classes
Class, ipv4-tcp-stream: Public classes
Class, local-server: Public classes
Class, local-stream: Public classes
Class, poller: Private classes
Class, posix-socket: Private classes
Class, posix-stream: Private classes
Class, posix-stream-server: Private classes
Class, socket: Public classes
Class, socket-option-argument: Private classes
Class, stream-server: Public classes
Class, stream-socket: Public classes
Condition, no-connection-available-error: Public conditions
Condition, no-local-server-error: Public conditions
Condition, poll-socket-error: Private conditions
Condition, posix-error: Private conditions
Condition, socket-error: Public conditions
Condition, system-function-error: Private conditions

E
epoll-cffi.lisp: The basic-binary-ipc/src/epoll/epoll-cffi․lisp file
epoll-event-data: Private classes
epoll-grovel.lisp: The basic-binary-ipc/src/epoll/epoll-grovel․lisp file
epoll-poller: Private classes
epoll-poller.lisp: The basic-binary-ipc/src/epoll/epoll-poller․lisp file

F
failed-ipv4-tcp-stream: Private classes
failed-posix-stream: Private classes
File, basic-binary-ipc.asd: The basic-binary-ipc/basic-binary-ipc․asd file
File, epoll-cffi.lisp: The basic-binary-ipc/src/epoll/epoll-cffi․lisp file
File, epoll-grovel.lisp: The basic-binary-ipc/src/epoll/epoll-grovel․lisp file
File, epoll-poller.lisp: The basic-binary-ipc/src/epoll/epoll-poller․lisp file
File, packages.lisp: The basic-binary-ipc/src/packages․lisp file
File, posix-cffi.lisp: The basic-binary-ipc/src/posix/posix-cffi․lisp file
File, posix-grovel.lisp: The basic-binary-ipc/src/posix/posix-grovel․lisp file
File, posix-helpers.lisp: The basic-binary-ipc/src/posix/posix-helpers․lisp file
File, posix-poll.lisp: The basic-binary-ipc/src/posix/posix-poll․lisp file
File, posix-socket-options.lisp: The basic-binary-ipc/src/posix/posix-socket-options․lisp file
File, posix-sockets.lisp: The basic-binary-ipc/src/posix/posix-sockets․lisp file
File, protocols.lisp: The basic-binary-ipc/src/protocols․lisp file
File, system-calls.lisp: The basic-binary-ipc/src/system-calls․lisp file

I
ipv4-tcp-server: Public classes
ipv4-tcp-stream: Public classes

L
local-server: Public classes
local-stream: Public classes

M
Module, src: The basic-binary-ipc/src module
Module, src/epoll: The basic-binary-ipc/src/epoll module
Module, src/posix: The basic-binary-ipc/src/posix module

N
no-connection-available-error: Public conditions
no-local-server-error: Public conditions

P
Package, basic-binary-ipc: The basic-binary-ipc package
packages.lisp: The basic-binary-ipc/src/packages․lisp file
poll-socket-error: Private conditions
poller: Private classes
posix-cffi.lisp: The basic-binary-ipc/src/posix/posix-cffi․lisp file
posix-error: Private conditions
posix-grovel.lisp: The basic-binary-ipc/src/posix/posix-grovel․lisp file
posix-helpers.lisp: The basic-binary-ipc/src/posix/posix-helpers․lisp file
posix-poll.lisp: The basic-binary-ipc/src/posix/posix-poll․lisp file
posix-socket: Private classes
posix-socket-options.lisp: The basic-binary-ipc/src/posix/posix-socket-options․lisp file
posix-sockets.lisp: The basic-binary-ipc/src/posix/posix-sockets․lisp file
posix-stream: Private classes
posix-stream-server: Private classes
protocols.lisp: The basic-binary-ipc/src/protocols․lisp file

S
socket: Public classes
socket-error: Public conditions
socket-option-argument: Private classes
src: The basic-binary-ipc/src module
src/epoll: The basic-binary-ipc/src/epoll module
src/posix: The basic-binary-ipc/src/posix module
stream-server: Public classes
stream-socket: Public classes
System, basic-binary-ipc: The basic-binary-ipc system
system-calls.lisp: The basic-binary-ipc/src/system-calls․lisp file
system-function-error: Private conditions