The basic-binary-ipc Reference Manual

Table of Contents

The basic-binary-ipc Reference Manual

This is the basic-binary-ipc Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:45:45 2020 GMT+0.

1 Introduction

Basic Binary IPC

The basic binary IPC system provides an interface for performing inter process communication using IPv4 or local streams. The interface follows a non-blocking pattern which allows applications to communicate either synchronously or asynchronously.

The interface has been implemented for the following platforms:

• Linux (poll and epoll)
• OSX (poll and kqueue)
• FreeBSD (poll and kqueue)
• Windows 8 (Overlapped I/O)

The complete documentation to this system can be found in doc/basic-binary-ipc.html or online.

The only requirement for this system is CFFI.

Example

The file examples/echo-example.lisp contains an example echo server and echo client. The code for the server and client is shown below.

The echo server can be started using

(load "examples/echo-example.lisp")
(echo-example:run-server 12345)

The echo client can be executed using

(load "examples/echo-example.lisp")
(echo-example:send-to-server "Hello World" basic-binary-ipc:+ipv4-loopback+ 12345)

Server

(defun run-server (port &optional (host-address +ipv4-loopback+))
  (check-type port (unsigned-byte 16))
  (check-type host-address string)
  
  (with-socket (server (make-ipv4-tcp-server host-address port :reuse-address t))
    (loop
       :with buffer-size := 10000
       :with buffer := (make-array buffer-size :element-type '(unsigned-byte 8))       
       :for result := (poll-socket server 'connection-available-p 10)
       :when result
       :do
       (with-socket (client (accept-connection server))
         (loop
            :for attempts :from 0 :below 3
            :for data-available := (poll-socket client 'data-available-p 10)
            :when data-available
            :do
            (let ((bytes-read (read-from-stream client buffer)))
              (write-to-stream client buffer :end bytes-read)))))))

Client

(defun send-to-server (string host-address port)
  (check-type string string)
  (check-type host-address string)
  (check-type port (unsigned-byte 16))
  
  (with-socket (client (connect-to-ipv4-tcp-server host-address port))
    (unless (poll-socket client 'connection-succeeded-p 10)
      (error "Failed to connect to address ~A:~d" host-address port))

    (write-to-stream client (babel:string-to-octets string))
    
    (loop
       :for attempts :from 0 :below 3
       :for data-available := (poll-socket client 'data-available-p 10)
       :until data-available
       :finally (unless data-available
                  (error "Echo server not working.")))
    
    (let* ((buffer (make-array 100000 :element-type '(unsigned-byte 8)))
           (bytes-read (read-from-stream client buffer)))
      (babel:octets-to-string buffer :end bytes-read))))

2 Systems

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

2.1 basic-binary-ipc

Author

Mark Cox

License

Simplified BSD License variant

Description

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

Dependency

cffi-grovel

Source

basic-binary-ipc.asd (file)

Components

• src (module)
• src/posix (module)
• src/epoll (module)

3 Modules

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

3.1 basic-binary-ipc/src

Parent

basic-binary-ipc (system)

Location

src/

Components

• packages.lisp (file)
• protocols.lisp (file)
• system-calls.lisp (file)

3.2 basic-binary-ipc/src/posix

Dependency

src (module)

Parent

basic-binary-ipc (system)

Location

src/

Components

• posix-helpers.lisp (file)
• posix-grovel.lisp (file)
• posix-cffi.lisp (file)
• posix-socket-options.lisp (file)
• posix-sockets.lisp (file)
• posix-poll.lisp (file)

3.3 basic-binary-ipc/src/epoll

Dependency

src/posix (module)

Parent

basic-binary-ipc (system)

Location

src/

Components

• epoll-grovel.lisp (file)
• epoll-cffi.lisp (file)
• epoll-poller.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 basic-binary-ipc.asd

Location

basic-binary-ipc.asd

Systems

basic-binary-ipc (system)

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

Parent

src (module)

Location

src/packages.lisp

Packages

basic-binary-ipc

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

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/protocols.lisp

Exported Definitions

• 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 function)
• local-host-address (generic function)
• local-port (generic function)
• 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 function)
• read-from-stream (generic function)
• ready-to-write-p (generic function)
• remote-disconnected-p (generic function)
• remote-host-address (generic function)
• remote-port (generic function)
• socket (method)
• socket (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)

Internal Definitions

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

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

Dependency

protocols.lisp (file)

Parent

src (module)

Location

src/system-calls.lisp

Internal Definitions

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

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

Parent

src/posix (module)

Location

src/posix-helpers.lisp

Internal Definitions

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

Parent

src/posix (module)

Location

src/posix-grovel.lisp

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

Dependency

posix-grovel.lisp (file)

Parent

src/posix (module)

Location

src/posix-cffi.lisp

Internal Definitions

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

Parent

src/posix (module)

Location

src/posix-socket-options.lisp

Internal Definitions

• 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 function)
• soa-base-type (method)
• soa-size (generic function)
• soa-size (method)
• 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)

Parent

src/posix (module)

Location

src/posix-sockets.lisp

Exported Definitions

• +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 (method)
• ipv4-tcp-server (class)
• ipv4-tcp-stream (class)
• local-host-address (method)
• local-pathname (generic function)
• local-pathname (method)
• local-pathname (method)
• local-pathname (method)
• local-port (method)
• local-server (class)
• local-stream (class)
• make-ipv4-tcp-server (function)
• make-local-server (function)
• no-local-server-error (condition)
• port (method)
• read-from-stream (method)
• ready-to-write-p (method)
• remote-disconnected-p (method)
• remote-host-address (method)
• remote-host-address (method)
• remote-port (method)
• remote-port (method)
• resolve-ipv4-address (function)
• socket (generic function)
• socket (method)
• socket (method)
• socket (method)
• socket-closed-p (method)
• socket-closed-p (method)
• socket-closed-p (method)
• write-to-stream (method)

Internal Definitions

• communication-style (generic function)
• communication-style (method)
• delete-on-close-p (generic function)
• delete-on-close-p (method)
• do-with-sockaddr-in (function)
• do-with-sockaddr-un (function)
• failed-ipv4-tcp-stream (class)
• failed-posix-stream (class)
• file-descriptor (generic function)
• file-descriptor (method)
• file-descriptor (method)
• file-descriptor (method)
• file-descriptor (method)
• 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 function)
• namespace (method)
• operating-modes (generic function)
• operating-modes (method)
• (setf operating-modes) (method)
• (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 function)
• protocol (method)
• 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)

Parent

src/posix (module)

Location

src/posix-poll.lisp

Exported Definitions

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

Internal Definitions

• compilable-poll-fd-event-expression (function)
• compile-poll-fd-event-expression (function)
• compute-poll-fd-events (generic function)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• define-poll-fd-event (macro)
• define-poll-fd-event-errors (macro)
• message (method)
• parse-poll-fd-result (generic function)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• 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

Parent

src/epoll (module)

Location

src/epoll-grovel.lisp

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

Dependency

epoll-grovel.lisp (file)

Parent

src/epoll (module)

Location

src/epoll-cffi.lisp

Internal Definitions

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

Parent

src/epoll (module)

Location

src/epoll-poller.lisp

Exported Definitions

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

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 basic-binary-ipc

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• +ipv4-any+ (special variable)
• +ipv4-loopback+ (special variable)
• accept-connection (generic function)
• accept-connection (method)
• accept-connection (method)
• close-poller (generic function)
• close-poller (method)
• close-socket (generic function)
• 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 (generic function)
• connection-available-p (method)
• connection-available-p (method)
• connection-failed-p (generic function)
• connection-failed-p (method)
• connection-failed-p (method)
• connection-succeeded-p (generic function)
• connection-succeeded-p (method)
• connection-succeeded-p (method)
• data-available-p (generic function)
• data-available-p (method)
• data-available-p (method)
• determinedp (generic function)
• determinedp (method)
• determinedp (method)
• do-with-poller (function)
• do-with-socket (function)
• host-address (generic function)
• host-address (method)
• ipv4-tcp-server (class)
• ipv4-tcp-stream (class)
• local-host-address (generic function)
• local-host-address (method)
• local-pathname (generic function)
• local-pathname (method)
• local-pathname (method)
• local-pathname (method)
• local-port (generic function)
• local-port (method)
• local-server (class)
• local-stream (class)
• make-ipv4-tcp-server (function)
• make-local-server (function)
• make-poller (function)
• monitor-socket (generic function)
• monitor-socket (method)
• monitored-events (generic function)
• monitored-events (method)
• (setf monitored-events) (method)
• (setf monitored-events) (generic function)
• monitored-sockets (generic function)
• no-connection-available-error (condition)
• no-local-server-error (condition)
• poll-socket (generic function)
• poll-socket (method)
• poll-sockets (generic function)
• poll-sockets (method)
• port (generic function)
• port (method)
• read-from-stream (generic function)
• read-from-stream (method)
• ready-to-write-p (generic function)
• ready-to-write-p (method)
• remote-disconnected-p (generic function)
• remote-disconnected-p (method)
• remote-host-address (generic function)
• remote-host-address (method)
• remote-host-address (method)
• remote-port (generic function)
• remote-port (method)
• remote-port (method)
• resolve-ipv4-address (function)
• socket (generic function)
• socket (method)
• socket (method)
• socket (method)
• socket (method)
• socket (method)
• socket (method)
• socket (class)
• socket-closed-p (generic function)
• socket-closed-p (method)
• socket-closed-p (method)
• socket-closed-p (method)
• socket-error (condition)
• stream-server (class)
• stream-socket (class)
• unmonitor-socket (generic function)
• unmonitor-socket (method)
• wait-for-events (generic function)
• wait-for-events (method)
• with-poller (macro)
• with-socket (macro)
• write-to-stream (generic function)
• write-to-stream (method)

Internal Definitions

• %ff-accept (function)
• %ff-bind (function)
• %ff-close (function)
• %ff-connect (function)
• %ff-epoll-create (function)
• %ff-epoll-ctl (function)
• %ff-epoll-wait (function)
• %ff-fcntl-noarg (function)
• %ff-fcntl-setfl (function)
• %ff-freeaddrinfo (function)
• %ff-gai-strerror (function)
• %ff-get-errno (function)
• %ff-get-errno-pointer (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)
• %ff-strerror (function)
• addrinfo-tclass (class)
• ai-addrconfig (constant)
• ai-all (constant)
• ai-canonname (constant)
• ai-numerichost (constant)
• ai-numericserv (constant)
• ai-passive (constant)
• ai-v4mapped (constant)
• c-function-name (generic function)
• check-posix (function)
• closedp (generic function)
• closedp (method)
• (setf closedp) (method)
• (setf closedp) (generic function)
• communication-style (generic function)
• communication-style (method)
• compilable-poll-fd-event-expression (function)
• compile-poll-fd-event-expression (function)
• compute-poll-fd-events (generic function)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• compute-poll-fd-events (method)
• connection-stream (generic function)
• define-check-system-call (macro)
• define-epoll-event (macro)
• define-poll-fd-event (macro)
• define-poll-fd-event-errors (macro)
• define-posix-system-call (macro)
• define-socket-option (macro)
• define-socket-option-argument (macro)
• define-system-call (macro)
• delete-on-close-p (generic function)
• delete-on-close-p (method)
• descriptor-socket-table (generic function)
• descriptor-socket-table (method)
• do-define-socket-option/reader (function)
• do-define-socket-option/writer (function)
• do-with-sockaddr-in (function)
• do-with-sockaddr-un (function)
• ensure-epoll-event-data (function)
• ensure-socket-option-argument (function)
• epoll-descriptor (generic function)
• epoll-descriptor (method)
• epoll-event-data (function)
• (setf epoll-event-data) (function)
• epoll-event-data (class)
• epoll-event-tclass (class)
• epoll-events (generic function)
• epoll-events (method)
• epoll-events (method)
• epoll-match-p (generic function)
• epoll-match-p (method)
• epoll-match-p (method)
• epoll-poller (class)
• errnum-symbol (function)
• failed-ipv4-tcp-stream (class)
• failed-posix-stream (class)
• file-descriptor (generic function)
• file-descriptor (method)
• file-descriptor (method)
• file-descriptor (method)
• file-descriptor (method)
• host-address-from-inaddr (function)
• host-address-from-sockaddr-in (function)
• in-addr-tclass (class)
• inaddr-any (constant)
• inaddr-broadcast (constant)
• inaddr-loopback (constant)
• inaddr-none (constant)
• keep-alive-p (generic function)
• keep-alive-p (method)
• (setf keep-alive-p) (method)
• (setf keep-alive-p) (generic function)
• lisp-function-name (generic function)
• make-posix-socket (function)
• maximum-number-of-events (generic function)
• maximum-number-of-events (method)
• message (generic function)
• message (method)
• monitor-table (generic function)
• monitor-table (method)
• monitoredp (generic function)
• msg-dontroute (constant)
• msg-oob (constant)
• msg-peek (constant)
• msg-waitall (constant)
• namespace (generic function)
• namespace (method)
• o-nonblock (constant)
• operating-modes (generic function)
• operating-modes (method)
• (setf operating-modes) (method)
• (setf operating-modes) (generic function)
• parse-poll-fd-result (generic function)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• parse-poll-fd-result (method)
• poll-fd-event-test (function)
• poll-fd-event-test/sexp (function)
• poll-socket-error (condition)
• poller (class)
• pollerr (constant)
• pollfd-tclass (class)
• pollhup (constant)
• pollin (constant)
• pollnval (constant)
• pollout (constant)
• pollpri (constant)
• pollrdband (constant)
• pollrdnorm (constant)
• pollwrband (constant)
• pollwrnorm (constant)
• port-from-sockaddr-in (function)
• posix-error (condition)
• posix-error-code (function)
• posix-error-code-p (function)
• posix-error-interrupted-p (function)
• posix-error-would-block-p (function)
• posix-socket (class)
• posix-socket-initialisation-progn (macro)
• posix-stream (class)
• posix-stream-server (class)
• prepare-epoll-event-test-function (function)
• prepare-epoll-event-test-function/expander (function)
• process-events (function)
• protocol (generic function)
• protocol (method)
• reuse-address-p (generic function)
• reuse-address-p (method)
• (setf reuse-address-p) (method)
• (setf reuse-address-p) (generic function)
• size-of-addrinfo (constant)
• size-of-epoll-event (constant)
• size-of-in-addr (constant)
• size-of-nfds-t (constant)
• size-of-pollfd (constant)
• size-of-sa-family-t (constant)
• size-of-size-t (constant)
• size-of-sockaddr-in (constant)
• size-of-sockaddr-un (constant)
• size-of-socklen-t (constant)
• soa-base-type (generic function)
• soa-base-type (method)
• soa-size (generic function)
• soa-size (method)
• soa-translate-from-memory (generic function)
• soa-translate-from-memory (method)
• soa-translate-to-memory (generic function)
• soa-translate-to-memory (method)
• sockaddr-in-tclass (class)
• sockaddr-un-tclass (class)
• socket-option-argument (function)
• (setf socket-option-argument) (function)
• socket-option-argument (class)
• strerror (function)
• system-function-caller (generic function)
• system-function-caller (method)
• system-function-error (condition)
• system-function-error-message (generic function)
• system-function-error-message (method)
• system-function-error-value (generic function)
• system-function-error-value (method)
• system-function-name (generic function)
• system-function-name (method)
• test-function (generic function)
• test-function (method)
• with-sockaddr-in (macro)
• with-sockaddr-un (macro)
• zero-memory (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: +ipv4-any+

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Special Variable: +ipv4-loopback+

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

6.1.2 Macros

Macro: with-poller (VAR FORM) &body BODY

Package

basic-binary-ipc

Source

protocols.lisp (file)

Macro: with-socket (VAR FORM) &body BODY

Package

basic-binary-ipc

Source

protocols.lisp (file)

6.1.3 Functions

Function: connect-to-ipv4-tcp-server HOST-ADDRESS PORT &key LOCAL-HOST-ADDRESS LOCAL-PORT

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: connect-to-local-server PATHNAME &key

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: do-with-poller FUNCTION POLLER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Function: do-with-socket SOCKET FUNCTION

Package

basic-binary-ipc

Source

protocols.lisp (file)

Function: make-ipv4-tcp-server HOST-ADDRESS PORT &key REUSE-ADDRESS BACKLOG

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: make-local-server PATHNAME &key BACKLOG DELETE-ON-CLOSE

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: make-poller ()

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Function: resolve-ipv4-address HOSTNAME

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

6.1.4 Generic functions

Generic Function: accept-connection SERVER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: accept-connection (SERVER local-server)

Source

posix-sockets.lisp (file)

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

Source

posix-sockets.lisp (file)

Generic Function: close-poller POLLER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: close-poller (POLLER epoll-poller)

Source

epoll-poller.lisp (file)

Generic Function: close-socket SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: close-socket (SOCKET local-server)

Source

posix-sockets.lisp (file)

Method: close-socket (OBJECT posix-stream-server)

Source

posix-sockets.lisp (file)

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

Source

posix-sockets.lisp (file)

Method: close-socket (OBJECT posix-stream)

Source

posix-sockets.lisp (file)

Method: close-socket (SOCKET posix-socket)

Source

posix-sockets.lisp (file)

Generic Function: connection-available-p SERVER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: connection-available-p (SERVER local-server)

Source

posix-sockets.lisp (file)

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

Source

posix-sockets.lisp (file)

Generic Function: connection-failed-p STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: connection-failed-p (SOCKET-STREAM failed-posix-stream)

Source

posix-sockets.lisp (file)

Method: connection-failed-p (FUTURE-CONNECTION posix-stream)

Source

posix-sockets.lisp (file)

Generic Function: connection-succeeded-p STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: connection-succeeded-p (SOCKET-STREAM failed-posix-stream)

Source

posix-sockets.lisp (file)

Method: connection-succeeded-p (FUTURE-CONNECTION posix-stream)

Source

posix-sockets.lisp (file)

Generic Function: data-available-p STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: data-available-p (SOCKET-STREAM failed-posix-stream)

Source

posix-sockets.lisp (file)

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

Source

posix-sockets.lisp (file)

Generic Function: determinedp STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: determinedp (SOCKET-STREAM failed-posix-stream)

Source

posix-sockets.lisp (file)

Method: determinedp (FUTURE-CONNECTION posix-stream)

Source

posix-sockets.lisp (file)

Generic Function: host-address SERVER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: host-address (IPV4-TCP-SERVER ipv4-tcp-server)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: local-host-address STREAM

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: local-host-address (IPV4-TCP-STREAM ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: local-pathname SOCKET

The pathname to the local socket.

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: local-pathname (CONDITION no-local-server-error)

Method: local-pathname (LOCAL-SERVER local-server)

automatically generated reader method

Method: local-pathname (LOCAL-STREAM local-stream)

automatically generated reader method

Generic Function: local-port STREAM

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: local-port (IPV4-TCP-STREAM ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: monitor-socket POLLER SOCKET SOCKET-EVENTS

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: monitor-socket (POLLER epoll-poller) SOCKET SOCKET-EVENTS

Source

epoll-poller.lisp (file)

Generic Function: monitored-events POLLER SOCKET

Generic Function: (setf monitored-events) VALUE POLLER SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: monitored-events (POLLER epoll-poller) SOCKET

Method: (setf monitored-events) VALUE (POLLER epoll-poller) SOCKET

Source

epoll-poller.lisp (file)

Generic Function: monitored-sockets POLLER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Generic Function: poll-socket SOCKET SOCKET-EVENTS TIMEOUT

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: poll-socket SOCKET SOCKET-EVENTS TIMEOUT

Source

posix-poll.lisp (file)

Generic Function: poll-sockets ALL-SOCKETS ALL-SOCKET-EVENTS TIMEOUT

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: poll-sockets (ALL-SOCKETS list) (ALL-SOCKET-EVENTS list) TIMEOUT

Source

posix-poll.lisp (file)

Generic Function: port SERVER

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: port (IPV4-TCP-SERVER ipv4-tcp-server)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: read-from-stream STREAM-SOCKET BUFFER &key START END PEEK

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: read-from-stream (STREAM posix-stream) BUFFER &key START END PEEK

Source

posix-sockets.lisp (file)

Generic Function: ready-to-write-p STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: ready-to-write-p (STREAM posix-stream)

Source

posix-sockets.lisp (file)

Generic Function: remote-disconnected-p STREAM-SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: remote-disconnected-p (STREAM posix-stream)

Source

posix-sockets.lisp (file)

Generic Function: remote-host-address STREAM

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: remote-host-address (FAILED-IPV4-TCP-STREAM failed-ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Method: remote-host-address (IPV4-TCP-STREAM ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: remote-port STREAM

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: remote-port (FAILED-IPV4-TCP-STREAM failed-ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Method: remote-port (IPV4-TCP-STREAM ipv4-tcp-stream)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: socket OBJECT

Return the POSIX-SOCKET object used by OBJECT.

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: socket (CONDITION poll-socket-error)

Source

posix-poll.lisp (file)

Method: socket (POSIX-STREAM-SERVER posix-stream-server)

automatically generated reader method

Method: socket (FAILED-POSIX-STREAM failed-posix-stream)

automatically generated reader method

Method: socket (POSIX-STREAM posix-stream)

automatically generated reader method

Method: socket (CONDITION no-connection-available-error)

Source

protocols.lisp (file)

Method: socket (CONDITION socket-error)

Source

protocols.lisp (file)

Generic Function: socket-closed-p SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: socket-closed-p (SOCKET posix-stream-server)

Source

posix-sockets.lisp (file)

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

Source

posix-sockets.lisp (file)

Method: socket-closed-p (POSIX-SOCKET posix-socket)

automatically generated reader method

Source

posix-sockets.lisp (file)

Generic Function: unmonitor-socket POLLER SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: unmonitor-socket (POLLER epoll-poller) SOCKET

Source

epoll-poller.lisp (file)

Generic Function: wait-for-events POLLER TIMEOUT

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: wait-for-events (POLLER epoll-poller) TIMEOUT

Source

epoll-poller.lisp (file)

Generic Function: write-to-stream STREAM-SOCKET BUFFER &key START END

Package

basic-binary-ipc

Source

protocols.lisp (file)

Methods

Method: write-to-stream (STREAM posix-stream) BUFFER &key START END

Source

posix-sockets.lisp (file)

6.1.5 Conditions

Condition: no-connection-available-error ()

Package

basic-binary-ipc

Source

protocols.lisp (file)

Direct superclasses

error (condition)

Direct methods

socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

socket (generic function)

Condition: no-local-server-error ()

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Direct superclasses

condition (condition)

Direct methods

local-pathname (method)

Direct slots

Slot: local-pathname

Initargs

:local-pathname

Readers

local-pathname (generic function)

Condition: socket-error ()

Package

basic-binary-ipc

Source

protocols.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

posix-error (condition)

Direct methods

socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

socket (generic function)

6.1.6 Classes

Class: ipv4-tcp-server ()

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Direct superclasses

posix-stream-server (class)

Direct methods

• parse-poll-fd-result (method)
• compute-poll-fd-events (method)
• accept-connection (method)
• connection-available-p (method)
• port (method)
• host-address (method)

Direct slots

Slot: host-address

Initargs

:host-address

Readers

host-address (generic function)

Slot: port

Initargs

:port

Readers

port (generic function)

Class: ipv4-tcp-stream ()

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Direct superclasses

posix-stream (class)

Direct methods

• print-object (method)
• local-port (method)
• local-host-address (method)
• remote-port (method)
• remote-host-address (method)

Direct slots

Slot: remote-host-address

Initargs

:remote-host-address

Readers

remote-host-address (generic function)

Slot: remote-port

Initargs

:remote-port

Readers

remote-port (generic function)

Slot: local-host-address

Initargs

:local-host-address

Readers

local-host-address (generic function)

Slot: local-port

Initargs

:local-port

Readers

local-port (generic function)

Class: local-server ()

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Direct superclasses

posix-stream-server (class)

Direct methods

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

Direct slots

Slot: local-pathname

Initargs

:local-pathname

Readers

local-pathname (generic function)

Slot: delete-on-close-p

Initargs

:delete-on-close-p

Readers

delete-on-close-p (generic function)

Class: local-stream ()

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Direct superclasses

posix-stream (class)

Direct methods

• print-object (method)
• local-pathname (method)

Direct slots

Slot: local-pathname

Initargs

:local-pathname

Readers

local-pathname (generic function)

Class: socket ()

Package

basic-binary-ipc

Source

protocols.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• stream-server (class)
• stream-socket (class)

Class: stream-server ()

Package

basic-binary-ipc

Source

protocols.lisp (file)

Direct superclasses

socket (class)

Direct subclasses

posix-stream-server (class)

Class: stream-socket ()

Package

basic-binary-ipc

Source

protocols.lisp (file)

Direct superclasses

socket (class)

Direct subclasses

• posix-stream (class)
• failed-posix-stream (class)

6.2 Internal definitions

6.2.1 Constants

Constant: ai-addrconfig

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-all

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-canonname

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-numerichost

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-numericserv

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-passive

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: ai-v4mapped

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: inaddr-any

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: inaddr-broadcast

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: inaddr-loopback

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: inaddr-none

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: msg-dontroute

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: msg-oob

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: msg-peek

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: msg-waitall

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: o-nonblock

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollerr

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollhup

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollin

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollnval

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollout

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollpri

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollrdband

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollrdnorm

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollwrband

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: pollwrnorm

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-addrinfo

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-epoll-event

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/epoll-grovel.processed-grovel-file

Constant: size-of-in-addr

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-nfds-t

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-pollfd

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-sa-family-t

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-size-t

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-sockaddr-in

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-sockaddr-un

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

Constant: size-of-socklen-t

Package

basic-binary-ipc

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/basic-binary-ipc-20150804-git/src/posix-grovel.processed-grovel-file

6.2.2 Macros

Macro: define-check-system-call NAME (CALLER FOREIGN-NAME RETURN-VALUE &rest ARGS) &body BODY

Package

basic-binary-ipc

Source

system-calls.lisp (file)

Macro: define-epoll-event NAME &body BODY

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

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 (file)

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 (file)

Macro: define-posix-system-call NAME RETURN-VALUE &body ARGUMENTS

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Macro: define-socket-option (NAME SOCKET-OPTION-NAME SOCKET-OPTION-ARGUMENT) &rest ARGS &key LEVEL

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Macro: define-socket-option-argument NAME &body OPTIONS

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Macro: define-system-call NAME-AND-OPTIONS RETURN-TYPE-INFO &body ARGS

Package

basic-binary-ipc

Source

system-calls.lisp (file)

Macro: posix-socket-initialisation-progn (SOCKET) &body BODY

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Macro: with-sockaddr-in (VAR FAMILY HOST-ADDRESS PORT) &body BODY

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Macro: with-sockaddr-un (PTR-VAR LENGTH-VAR PATHNAME) &body BODY

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

6.2.3 Functions

Function: %ff-accept SOCKET ADDRESS ADDRESS-LEN

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-bind SOCKET SOCKET-ADDRESS SOCKET-ADDRESS-LENGTH

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-close FILE-DESCRIPTOR

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-connect SOCKET ADDRESS ADDRESS-LEN

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-epoll-create SIZE

Package

basic-binary-ipc

Source

epoll-cffi.lisp (file)

Function: %ff-epoll-ctl EPFD OP FD EVENT

Package

basic-binary-ipc

Source

epoll-cffi.lisp (file)

Function: %ff-epoll-wait EPFD EVENTS MAXEVENTS TIMEOUT

Package

basic-binary-ipc

Source

epoll-cffi.lisp (file)

Function: %ff-fcntl-noarg FILE-DESCRIPTOR COMMAND

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-fcntl-setfl FILE-DESCRIPTOR COMMAND MODE

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-freeaddrinfo ADDRESS-INFO

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-gai-strerror CODE

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-get-errno ()

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

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

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: %ff-getaddrinfo HOSTNAME SERVICE-NAME HINTS RESULT

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-getsockname SOCKET ADDRESS ADDRESS-LENGTH

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-getsockopt SOCKET LEVEL OPTION-NAME OPTION-VALUE OPTION-LENGTH

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-htons HOST-SHORT

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-inet-aton NAME ADDR

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-inet-ntoa ADDR

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-listen SOCKET BACKLOG

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-ntohl NETWORK-LONG

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-ntohs NETWORK-SHORT

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-poll FDS NFDS TIMEOUT

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-recvfrom SOCKET BUFFER LENGTH FLAGS ADDRESS ADDRESS-LEN

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-sendto SOCKET BUFFER LENGTH FLAGS DEST-ADDR DEST-LEN

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-setsockopt SOCKET LEVEL OPTION-NAME OPTION-VALUE OPTION-LENGTH

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-socket DOMAIN TYPE PROTOCOL

Package

basic-binary-ipc

Source

posix-cffi.lisp (file)

Function: %ff-strerror ERRNUM BUFFER BUFFER-SIZE

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: check-posix CALLER FOREIGN-NAME RETURN-VALUE

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: compilable-poll-fd-event-expression EXPRESSION

Package

basic-binary-ipc

Source

posix-poll.lisp (file)

Function: compile-poll-fd-event-expression EXPRESSION

Package

basic-binary-ipc

Source

posix-poll.lisp (file)

Function: do-define-socket-option/reader NAME SOCKET-OPTION-NAME SOCKET-OPTION-ARGUMENT &key LEVEL

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Function: do-define-socket-option/writer NAME SOCKET-OPTION-NAME SOCKET-OPTION-ARGUMENT &key LEVEL

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Function: do-with-sockaddr-in FUNCTION FAMILY HOST-ADDRESS PORT

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: do-with-sockaddr-un FUNCTION PATHNAME

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: ensure-epoll-event-data NAME EVENTS TEST-FUNCTION

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Function: ensure-socket-option-argument NAME &key BASE-TYPE

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Function: epoll-event-data SYMBOL

Function: (setf epoll-event-data) VALUE SYMBOL

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

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 (file)

Function: host-address-from-inaddr IN-ADDR

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: host-address-from-sockaddr-in SOCKADDR-IN

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: make-posix-socket NAMESPACE COMMUNICATION-STYLE PROTOCOL

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: poll-fd-event-test EXPRESSION EVENTS SOCKET

Package

basic-binary-ipc

Source

posix-poll.lisp (file)

Function: poll-fd-event-test/sexp EXPRESSION EVENTS SOCKET

Package

basic-binary-ipc

Source

posix-poll.lisp (file)

Function: port-from-sockaddr-in SOCKADDR-IN

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Function: posix-error-code CONDITION

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: posix-error-code-p CONDITION CODE

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: posix-error-interrupted-p CONDITION

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

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 (file)

Function: prepare-epoll-event-test-function SEXP

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Function: prepare-epoll-event-test-function/expander SEXP EVENTS-VAR SOCKET-VAR

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Function: process-events POLLER EVENTS NUMBER-OF-EVENTS

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Function: socket-option-argument SYMBOL

Function: (setf socket-option-argument) VALUE SYMBOL

Package

basic-binary-ipc

Source

posix-socket-options.lisp (file)

Function: strerror ERRNUM

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

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

Function: zero-memory POINTER CFFI-TYPE

Package

basic-binary-ipc

Source

posix-helpers.lisp (file)

6.2.4 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 (file)

Generic Function: closedp OBJECT

Generic Function: (setf closedp) NEW-VALUE OBJECT

Package

basic-binary-ipc

Methods

Method: closedp (EPOLL-POLLER epoll-poller)

automatically generated reader method

Source

epoll-poller.lisp (file)

Method: (setf closedp) NEW-VALUE (EPOLL-POLLER epoll-poller)

automatically generated writer method

Source

epoll-poller.lisp (file)

Generic Function: communication-style POSIX-SOCKET

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

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: communication-style (POSIX-SOCKET posix-socket)

automatically generated reader method

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 (file)

Methods

Method: compute-poll-fd-events (SOCKET failed-posix-stream) SOCKET-EVENTS

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql remote-disconnected-p))

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql ready-to-write-p))

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql data-available-p))

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql connection-succeeded-p))

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql connection-failed-p))

Method: compute-poll-fd-events (OBJECT posix-stream) (SOCKET-EVENTS (eql determinedp))

Method: compute-poll-fd-events (OBJECT local-server) (SOCKET-EVENTS (eql connection-available-p))

Method: compute-poll-fd-events (OBJECT ipv4-tcp-server) (SOCKET-EVENTS (eql 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 (file)

Generic Function: delete-on-close-p SOCKET

Delete the pathname when closing the socket.

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: delete-on-close-p (LOCAL-SERVER local-server)

automatically generated reader method

Generic Function: descriptor-socket-table OBJECT

A table mapping file descriptors to socket objects.

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Methods

Method: descriptor-socket-table (EPOLL-POLLER epoll-poller)

automatically generated reader method

Generic Function: epoll-descriptor OBJECT

The descriptor for the EPOLL object.

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Methods

Method: epoll-descriptor (EPOLL-POLLER epoll-poller)

automatically generated reader method

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 (file)

Methods

Method: epoll-events (OBJECT symbol)

Method: epoll-events (EPOLL-EVENT-DATA epoll-event-data)

automatically generated reader method

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 (file)

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 (file)

Methods

Method: file-descriptor (OBJECT posix-stream-server)

Method: file-descriptor (OBJECT failed-posix-stream)

Method: file-descriptor (OBJECT posix-stream)

Method: file-descriptor (POSIX-SOCKET posix-socket)

automatically generated reader method

Generic Function: keep-alive-p OBJECT

Generic Function: (setf keep-alive-p) VALUE OBJECT

Package

basic-binary-ipc

Methods

Method: keep-alive-p (OBJECT posix-socket)

Method: (setf keep-alive-p) VALUE (OBJECT posix-socket)

Source

posix-sockets.lisp (file)

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 (file)

Generic Function: maximum-number-of-events OBJECT

The maximum number of events to retrieve when invoking epoll_wait.

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Methods

Method: maximum-number-of-events (EPOLL-POLLER epoll-poller)

automatically generated reader method

Generic Function: message CONDITION

Package

basic-binary-ipc

Methods

Method: message (CONDITION poll-socket-error)

Source

posix-poll.lisp (file)

Generic Function: monitor-table OBJECT

A table mapping sockets to epoll poller specific information.

Package

basic-binary-ipc

Source

epoll-poller.lisp (file)

Methods

Method: monitor-table (EPOLL-POLLER epoll-poller)

automatically generated reader method

Generic Function: monitoredp POLLER SOCKET

Package

basic-binary-ipc

Source

protocols.lisp (file)

Generic Function: namespace POSIX-SOCKET

Return the posix namespace used by the POSIX-SOCKET.

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: namespace (POSIX-SOCKET posix-socket)

automatically generated reader method

Generic Function: operating-modes SOCKET

Generic Function: (setf operating-modes) VALUE SOCKET

Package

basic-binary-ipc

Source

posix-sockets.lisp (file)

Methods

Method: operating-modes (OBJECT posix-socket)

Method: (setf operating-modes) VALUE (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 (file)

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 remote-disconnected-p)) REVENTS

Method: parse-poll-fd-result (OBJECT posix-stream) (SOCKET-EVENTS (eql ready-to-write-p)) REVENTS

Method: parse-poll-fd-result (OBJECT posix-stream) (SOCKET-EVENTS (eql data-available-p)) REVENTS

Method: parse-poll-fd-result (OBJECT posix-stream) (SOCKET-EVENTS (eql connection-succeeded-p)) REVENTS

Method: parse-poll-fd-result (OBJECT posix-stream) (SOCKET-EVENTS (eql connection-failed-p)) REVENTS

Method: parse-poll-fd-result (OBJECT posix-stream) (SOCKET-EVENTS (eql determinedp)) REVENTS

Method: parse-poll-fd-result (OBJECT local-server) (SOCKET-EVENTS (eql connection-available-p)) REVENTS

Method: parse-poll-fd-result (OBJECT ipv4-tcp-server) (SOCKET-EVENTS (eql connection-available-p)) REVENTS

Method: parse-poll-fd-result SOCKET (SOCKET-EVENTS list) REVENTS