The basic-binary-ipc Reference Manual

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

• accept-connection (generic function).
• close-poller (generic function).
• close-socket (generic function).
• connection-available-p (generic function).
• connection-failed-p (generic function).
• connection-succeeded-p (generic function).
• data-available-p (generic function).
• determinedp (generic function).
• do-with-poller (function).
• do-with-socket (function).
• host-address (generic reader).
• local-host-address (generic reader).
• local-port (generic reader).
• monitor-socket (generic function).
• monitored-events (generic function).
• (setf monitored-events) (generic function).
• monitored-sockets (generic function).
• no-connection-available-error (condition).
• poll-socket (generic function).
• poll-sockets (generic function).
• port (generic reader).
• read-from-stream (generic function).
• ready-to-write-p (generic function).
• remote-disconnected-p (generic function).
• remote-host-address (generic reader).
• remote-port (generic reader).
• socket (reader method).
• socket (reader method).
• socket (class).
• socket-closed-p (generic function).
• socket-error (condition).
• stream-server (class).
• stream-socket (class).
• unmonitor-socket (generic function).
• wait-for-events (generic function).
• with-poller (macro).
• with-socket (macro).
• write-to-stream (generic function).

Internals

• connection-stream (generic function).
• monitoredp (generic function).
• poller (class).

---

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

Dependency

protocols.lisp (file).

Source

basic-binary-ipc.asd.

Parent Component

src (module).

Internals

• define-check-system-call (macro).
• define-system-call (macro).
• system-function-caller (generic reader).
• system-function-error (condition).
• system-function-error-message (generic reader).
• system-function-error-value (generic reader).
• system-function-name (generic reader).

---

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

Source

basic-binary-ipc.asd.

Parent Component

src/posix (module).

Internals

• %ff-get-errno (function).
• %ff-get-errno-pointer (function).
• %ff-strerror (function).
• c-function-name (generic function).
• check-posix (function).
• define-posix-system-call (macro).
• errnum-symbol (function).
• lisp-function-name (generic function).
• posix-error (condition).
• posix-error-code (function).
• posix-error-code-p (function).
• posix-error-interrupted-p (function).
• strerror (function).
• zero-memory (function).

---

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

• %ff-accept (function).
• %ff-bind (function).
• %ff-close (function).
• %ff-connect (function).
• %ff-fcntl-noarg (function).
• %ff-fcntl-setfl (function).
• %ff-freeaddrinfo (function).
• %ff-gai-strerror (function).
• %ff-getaddrinfo (function).
• %ff-getsockname (function).
• %ff-getsockopt (function).
• %ff-htons (function).
• %ff-inet-aton (function).
• %ff-inet-ntoa (function).
• %ff-listen (function).
• %ff-ntohl (function).
• %ff-ntohs (function).
• %ff-poll (function).
• %ff-recvfrom (function).
• %ff-sendto (function).
• %ff-setsockopt (function).
• %ff-socket (function).

---

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

• define-socket-option (macro).
• define-socket-option-argument (macro).
• do-define-socket-option/reader (function).
• do-define-socket-option/writer (function).
• ensure-socket-option-argument (function).
• soa-base-type (generic reader).
• soa-size (generic function).
• soa-translate-from-memory (generic function).
• soa-translate-to-memory (generic function).
• socket-option-argument (function).
• (setf socket-option-argument) (function).
• socket-option-argument (class).

---

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

• +ipv4-any+ (special variable).
• +ipv4-loopback+ (special variable).
• accept-connection (method).
• accept-connection (method).
• close-socket (method).
• close-socket (method).
• close-socket (method).
• close-socket (method).
• close-socket (method).
• connect-to-ipv4-tcp-server (function).
• connect-to-local-server (function).
• connection-available-p (method).
• connection-available-p (method).
• connection-failed-p (method).
• connection-failed-p (method).
• connection-succeeded-p (method).
• connection-succeeded-p (method).
• data-available-p (method).
• data-available-p (method).
• determinedp (method).
• determinedp (method).
• host-address (reader method).
• ipv4-tcp-server (class).
• ipv4-tcp-stream (class).
• local-host-address (reader method).
• local-pathname (generic reader).
• local-port (reader method).
• local-server (class).
• local-stream (class).
• make-ipv4-tcp-server (function).
• make-local-server (function).
• no-local-server-error (condition).
• port (reader method).
• print-object (method).
• print-object (method).
• print-object (method).
• read-from-stream (method).
• ready-to-write-p (method).
• remote-disconnected-p (method).
• remote-host-address (reader method).
• remote-host-address (reader method).
• remote-port (reader method).
• remote-port (reader method).
• resolve-ipv4-address (function).
• socket (generic reader).
• socket-closed-p (method).
• socket-closed-p (method).
• socket-closed-p (reader method).
• write-to-stream (method).

Internals

• communication-style (generic reader).
• delete-on-close-p (generic reader).
• do-with-sockaddr-in (function).
• do-with-sockaddr-un (function).
• failed-ipv4-tcp-stream (class).
• failed-posix-stream (class).
• file-descriptor (generic function).
• host-address-from-inaddr (function).
• host-address-from-sockaddr-in (function).
• keep-alive-p (method).
• (setf keep-alive-p) (method).
• make-posix-socket (function).
• namespace (generic reader).
• operating-modes (generic function).
• (setf operating-modes) (generic function).
• port-from-sockaddr-in (function).
• posix-error-would-block-p (function).
• posix-socket (class).
• posix-socket-initialisation-progn (macro).
• posix-stream (class).
• posix-stream-server (class).
• protocol (generic reader).
• reuse-address-p (method).
• (setf reuse-address-p) (method).
• soa-translate-from-memory (method).
• soa-translate-to-memory (method).
• with-sockaddr-in (macro).
• with-sockaddr-un (macro).

---

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

• poll-socket (method).
• poll-sockets (method).
• socket (reader method).

Internals

• compilable-poll-fd-event-expression (function).
• compile-poll-fd-event-expression (function).
• compute-poll-fd-events (generic function).
• define-poll-fd-event (macro).
• define-poll-fd-event-errors (macro).
• message (reader method).
• parse-poll-fd-result (generic function).
• poll-fd-event-test (function).
• poll-fd-event-test/sexp (function).
• poll-socket-error (condition).

---

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

• %ff-epoll-create (function).
• %ff-epoll-ctl (function).
• %ff-epoll-wait (function).

---

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

• close-poller (method).
• make-poller (function).
• monitor-socket (method).
• monitored-events (method).
• (setf monitored-events) (method).
• unmonitor-socket (method).
• wait-for-events (method).

Internals

• closedp (reader method).
• (setf closedp) (writer method).
• define-epoll-event (macro).
• descriptor-socket-table (generic reader).
• ensure-epoll-event-data (function).
• epoll-descriptor (generic reader).
• epoll-event-data (function).
• (setf epoll-event-data) (function).
• epoll-event-data (class).
• epoll-events (generic function).
• epoll-match-p (generic function).
• epoll-poller (class).
• maximum-number-of-events (generic reader).
• monitor-table (generic reader).
• prepare-epoll-event-test-function (function).
• prepare-epoll-event-test-function/expander (function).
• process-events (function).
• test-function (reader method).

---

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 ipv4-tcp-stream) stream) ¶

Source

posix-sockets.lisp.

Method: print-object ((object local-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

• accept-connection.
• compute-poll-fd-events.
• connection-available-p.
• host-address.
• parse-poll-fd-result.
• port.

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

• local-host-address.
• local-port.
• print-object.
• remote-host-address.
• remote-port.

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

• accept-connection.
• close-socket.
• compute-poll-fd-events.
• connection-available-p.
• delete-on-close-p.
• local-pathname.
• parse-poll-fd-result.

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

• local-pathname.
• print-object.

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

• stream-server.
• stream-socket.

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

• failed-posix-stream.
• posix-stream.

---

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.

---