The usocket Reference Manual

Table of Contents

The usocket Reference Manual

This is the usocket Reference Manual, version 0.8.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:37:10 2019 GMT+0.

1 Introduction

USOCKET - Universal socket library for Common Lisp

https://common-lisp.net/project/usocket/

This is the usocket Common Lisp sockets library: a library to bring sockets access to the broadest of common lisp implementations as possible.

The library currently supports:

• Allegro CL
• ABCL (ArmedBear)
• Clasp
• Clozure CL
• Corman Lisp
• GNU CLISP
• CMUCL
• ECL
• LispWorks (4.3 and up)
• Digitool MCL and RMCL (5.0 and up)
• MOCL
• SBCL
• Scieneer CL
• Symbolics Genera

If your favorite common lisp misses in the list above, please contact usocket-devel@common-lisp.net and submit a request. Please include references to available sockets functions in your lisp implementation.

The library has been ASDF (http://cliki.net/ASDF) enabled, meaning that you can tar up a checkout and use that to ASDF-INSTALL:INSTALL the package in your system package site. (Or use your usual ASDF tricks to use the checkout directly.)

Remarks on licensing

Even though the source code has an MIT style license attached to it, when compiling this code with some of the supported lisp implementations you may not end up with an MIT style binary version due to the licensing of the implementations themselves. ECL is such an example and - when it will become supported - GCL is like that too.

Non-support of :external-format

Because of its definition in the hyperspec, there's no common external-format between lisp implementations: every vendor has chosen a different way to solve the problem of newline translation or character set recoding.

Because there's no way to avoid platform specific code in the application when using external-format, the purpose of a portability layer gets defeated. So, for now, usocket doesn't support external-format.

The workaround to get reasonably portable external-format support is to layer a flexi-stream (from flexi-streams) on top of a usocket stream.

API definition

• usocket (class)
• stream-usocket (class; usocket derivative)
• stream-server-usocket (class; usocket derivative)
• socket-connect (function) [ to create an active/connected socket ] socket-connect host port &key element-type where `host' is a vectorized ip or a string representation of a dotted ip address or a hostname for lookup in the DNS system
• socket-listen (function) [ to create a passive/listening socket ] socket-listen host port &key reuseaddress backlog element-type where `host' has the same definition as above
• socket-accept (method) [ to create an active/connected socket ] socket-accept socket &key element-type returns (server side) a connected socket derived from a listening/passive socket.
• socket-close (method) socket-close socket where socket a previously returned socket
• socket (usocket slot accessor), the internal/implementation defined socket representation
• socket-stream (usocket slot accessor), socket-stream socket the return value of which satisfies the normal stream interface
• socket-shutdown

Errors:

• address-in-use-error
• address-not-available-error
• bad-file-descriptor-error
• connection-refused-error
• connection-aborted-error
• connection-reset-error
• invalid-argument-error
• no-buffers-error
• operation-not-supported-error
• operation-not-permitted-error
• protocol-not-supported-error
• socket-type-not-supported-error
• network-unreachable-error
• network-down-error
• network-reset-error
• host-down-error
• host-unreachable-error
• shutdown-error
• timeout-error
• unkown-error

Non-fatal conditions:

• interrupted-condition
• unkown-condition

(for a description of the API methods and functions see https://common-lisp.net/project/usocket/api-docs.shtml)

Test suite

The test suite unfortunately isn't mature enough yet to run without some manual configuration. Several elements are required which are hard to programatically detect. Please adjust the test file before running the tests, for these variables:

• +non-existing-host+: The stringified IP address of a host on the same subnet. No physical host may be present.
• +unused-local-port+: A port number of a port not in use on the machine the tests run on.
• +common-lisp-net+: A vector with 4 integer elements which make up an IP address. This must be the IP "common-lisp.net" resolves to.

Known problems

• CMUCL error reporting wrt sockets raises only simple-errors meaning there's no way to tell different error conditions apart. All errors are mapped to unknown-error on CMUCL.

• The ArmedBear backend doesn't do any error mapping (yet). Java defines exceptions at the wrong level (IMO), since the exception reported bares a relation to the function failing, not the actual error that occurred: for example 'Address already in use' (when creating a passive socket) is reported as a BindException with an error text of 'Address already in use'. There's no way to sanely map 'BindException' to a meaningfull error in usocket. [This does not mean the backend should not at least map to 'unknown-error'!]

• When using the library with ECL, you need the C compiler installed to be able to compile and load the Foreign Function Interface. Not all ECL targets support DFFI yet, so on some targets this would be the case anyway. By depending on this technique, usocket can reuse the FFI code on all platforms (including Windows). This benefit currently outweighs the additional requirement. (hey, it's Embeddable Common Lisp, so, you probably wanted to embed it all along, right?)

2 Systems

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

2.1 usocket

Maintainer

Chun Tian (binghe) & Hans Huebner

Author

Erik Enge & Erik Huelsmann

License

MIT

Description

Universal socket library for Common Lisp

Version

0.8.2

Dependencies

• split-sequence
• sb-bsd-sockets

Source

usocket.asd (file)

Components

• package.lisp (file)
• vendor (module)
• usocket.lisp (file)
• condition.lisp (file)
• backend (module)
• option.lisp (file)

3 Modules

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

3.1 usocket/vendor

Dependency

package.lisp (file)

Parent

usocket (system)

Location

vendor/

3.2 usocket/backend

Dependency

condition.lisp (file)

Parent

usocket (system)

Location

backend/

Component

sbcl.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 usocket.asd

Location

usocket.asd

Systems

usocket (system)

4.1.2 usocket/package.lisp

Parent

usocket (system)

Location

package.lisp

Packages

usocket

4.1.3 usocket/usocket.lisp

Dependency

vendor (module)

Parent

usocket (system)

Location

usocket.lisp

Exported Definitions

• *auto-port* (special variable)
• *version* (special variable)
• *wildcard-host* (special variable)
• +max-datagram-packet-size+ (constant)
• add-waiter (function)
• datagram-usocket (class)
• datagram-usocket-p (function)
• dotted-quad-to-vector-quad (function)
• get-host-by-name (function)
• get-local-address (generic function)
• get-local-name (generic function)
• get-local-port (generic function)
• get-peer-address (generic function)
• get-peer-name (generic function)
• get-peer-port (generic function)
• get-random-host-by-name (function)
• hbo-to-dotted-quad (function)
• hbo-to-vector-quad (function)
• host-byte-order (generic function)
• host-byte-order (method)
• host-byte-order (method)
• host-byte-order (method)
• host-to-hostname (function)
• integer-to-octet-buffer (function)
• ip-from-octet-buffer (macro)
• ip-to-octet-buffer (macro)
• ip/= (function)
• ip= (function)
• ipv6-host-to-vector (function)
• make-wait-list (function)
• octet-buffer-to-integer (function)
• port-from-octet-buffer (macro)
• port-to-octet-buffer (macro)
• remove-all-waiters (function)
• remove-waiter (function)
• socket (method)
• (setf socket) (method)
• socket-accept (generic function)
• socket-close (generic function)
• socket-close (method)
• socket-receive (generic function)
• socket-send (generic function)
• socket-shutdown (generic function)
• socket-state (generic function)
• socket-state (method)
• socket-stream (method)
• (setf socket-stream) (method)
• stream-server-usocket (class)
• stream-server-usocket-p (function)
• stream-usocket (class)
• stream-usocket-p (function)
• usocket (class)
• usocket-p (function)
• vector-quad-to-dotted-quad (function)
• vector-to-ipv6-host (function)
• wait-for-input (function)
• with-client-socket (macro)
• with-connected-socket (macro)
• with-server-socket (macro)
• with-socket-listener (macro)

Internal Definitions

• %make-wait-list (function)
• bool->int (function)
• connected-p (method)
• (setf connected-p) (method)
• copy-wait-list (function)
• element-type (method)
• host-to-hbo (function)
• host-to-vector-quad (function)
• int->bool (function)
• ip-address-string-p (function)
• list-of-strings-to-integers (function)
• make-datagram-socket (function)
• make-socket (function)
• make-stream-server-socket (function)
• make-stream-socket (function)
• split-ipv6-address (function)
• split-timeout (function)
• state (method)
• (setf state) (method)
• wait-list (method)
• (setf wait-list) (method)
• wait-list (structure)
• wait-list-%wait (function)
• (setf wait-list-%wait) (function)
• wait-list-map (function)
• (setf wait-list-map) (function)
• wait-list-p (function)
• wait-list-waiters (function)
• (setf wait-list-waiters) (function)

4.1.4 usocket/condition.lisp

Dependency

usocket.lisp (file)

Parent

usocket (system)

Location

condition.lisp

Exported Definitions

• address-in-use-error (condition)
• address-not-available-error (condition)
• bad-file-descriptor-error (condition)
• connection-aborted-error (condition)
• connection-refused-error (condition)
• connection-reset-error (condition)
• deadline-timeout-error (condition)
• host-down-error (condition)
• host-or-ip (method)
• (setf host-or-ip) (method)
• host-unreachable-error (condition)
• insufficient-implementation (condition)
• interrupted-condition (condition)
• invalid-argument-error (condition)
• invalid-socket-error (condition)
• invalid-socket-stream-error (condition)
• network-down-error (condition)
• network-reset-error (condition)
• network-unreachable-error (condition)
• no-buffers-error (condition)
• ns-condition (condition)
• ns-error (condition)
• ns-host-not-found-error (condition)
• ns-no-recovery-error (condition)
• ns-try-again-condition (condition)
• ns-unknown-condition (condition)
• ns-unknown-error (condition)
• operation-not-permitted-error (condition)
• operation-not-supported-error (condition)
• protocol-not-supported-error (condition)
• shutdown-error (condition)
• socket-condition (condition)
• socket-error (condition)
• socket-type-not-supported-error (condition)
• timeout-error (condition)
• unimplemented (macro)
• unimplemented (condition)
• unknown-condition (condition)
• unknown-error (condition)
• unsupported (macro)
• unsupported (condition)
• with-mapped-conditions (macro)

Internal Definitions

• +unix-errno-condition-map+ (special variable)
• +unix-errno-error-map+ (special variable)
• +unix-ns-error-map+ (special variable)
• context (method)
• define-usocket-condition-class (function)
• define-usocket-condition-classes (macro)
• feature (method)
• ignore-unsupported-warnings (macro)
• map-errno-condition (function)
• map-errno-error (function)
• minimum (method)
• ns-real-condition (method)
• (setf ns-real-condition) (method)
• ns-real-error (method)
• (setf ns-real-error) (method)
• usocket-errno (method)
• usocket-real-condition (method)
• (setf usocket-real-condition) (method)
• usocket-real-error (method)
• (setf usocket-real-error) (method)
• usocket-socket (method)
• (setf usocket-socket) (method)

4.1.5 usocket/backend/sbcl.lisp

Parent

backend (module)

Location

backend/sbcl.lisp

Exported Definitions

• get-hosts-by-name (function)
• get-local-address (method)
• get-local-name (method)
• get-local-port (method)
• get-peer-address (method)
• get-peer-name (method)
• get-peer-port (method)
• socket-accept (method)
• socket-close (method)
• socket-close (method)
• socket-connect (function)
• socket-listen (function)
• socket-receive (method)
• socket-send (method)
• socket-shutdown (method)

Internal Definitions

• %add-waiter (function)
• %remove-waiter (function)
• %setup-wait-list (function)
• %with-timeout (macro)
• *dummy-stream* (special variable)
• +sbcl-condition-map+ (special variable)
• +sbcl-error-map+ (special variable)
• get-host-by-address (function)
• get-host-name (function)
• handle-condition (function)
• map-socket-error (function)
• wait-for-input-internal (function)

4.1.6 usocket/option.lisp

Dependency

backend (module)

Parent

usocket (system)

Location

option.lisp

Exported Definitions

• *backend* (special variable)
• socket-option (generic function)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• (setf socket-option) (generic function)

5 Packages

Packages are listed by definition order.

5.1 usocket

Source

package.lisp (file)

Use List

• split-sequence
• common-lisp

Exported Definitions

• *auto-port* (special variable)
• *backend* (special variable)
• *version* (special variable)
• *wildcard-host* (special variable)
• +max-datagram-packet-size+ (constant)
• add-waiter (function)
• address-in-use-error (condition)
• address-not-available-error (condition)
• bad-file-descriptor-error (condition)
• connection-aborted-error (condition)
• connection-refused-error (condition)
• connection-reset-error (condition)
• datagram-usocket (class)
• datagram-usocket-p (function)
• deadline-timeout-error (condition)
• dotted-quad-to-vector-quad (function)
• get-host-by-name (function)
• get-hosts-by-name (function)
• get-local-address (generic function)
• get-local-address (method)
• get-local-name (generic function)
• get-local-name (method)
• get-local-port (generic function)
• get-local-port (method)
• get-peer-address (generic function)
• get-peer-address (method)
• get-peer-name (generic function)
• get-peer-name (method)
• get-peer-port (generic function)
• get-peer-port (method)
• get-random-host-by-name (function)
• hbo-to-dotted-quad (function)
• hbo-to-vector-quad (function)
• host-byte-order (generic function)
• host-byte-order (method)
• host-byte-order (method)
• host-byte-order (method)
• host-down-error (condition)
• host-or-ip (generic function)
• host-or-ip (method)
• (setf host-or-ip) (method)
• (setf host-or-ip) (generic function)
• host-to-hostname (function)
• host-unreachable-error (condition)
• insufficient-implementation (condition)
• integer-to-octet-buffer (function)
• interrupted-condition (condition)
• invalid-argument-error (condition)
• invalid-socket-error (condition)
• invalid-socket-stream-error (condition)
• ip-from-octet-buffer (macro)
• ip-to-octet-buffer (macro)
• ip/= (function)
• ip= (function)
• ipv6-host-to-vector (function)
• make-wait-list (function)
• network-down-error (condition)
• network-reset-error (condition)
• network-unreachable-error (condition)
• no-buffers-error (condition)
• ns-condition (condition)
• ns-error (condition)
• ns-host-not-found-error (condition)
• ns-no-recovery-error (condition)
• ns-try-again-condition (condition)
• ns-unknown-condition (condition)
• ns-unknown-error (condition)
• octet-buffer-to-integer (function)
• operation-not-permitted-error (condition)
• operation-not-supported-error (condition)
• port-from-octet-buffer (macro)
• port-to-octet-buffer (macro)
• protocol-not-supported-error (condition)
• remove-all-waiters (function)
• remove-waiter (function)
• shutdown-error (condition)
• socket (generic function)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• socket-accept (generic function)
• socket-accept (method)
• socket-close (generic function)
• socket-close (method)
• socket-close (method)
• socket-close (method)
• socket-condition (condition)
• socket-connect (function)
• socket-error (condition)
• socket-listen (function)
• socket-option (generic function)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• (setf socket-option) (generic function)
• socket-receive (generic function)
• socket-receive (method)
• socket-send (generic function)
• socket-send (method)
• socket-shutdown (generic function)
• socket-shutdown (method)
• socket-state (generic function)
• socket-state (method)
• socket-stream (generic function)
• socket-stream (method)
• (setf socket-stream) (method)
• (setf socket-stream) (generic function)
• socket-type-not-supported-error (condition)
• stream-server-usocket (class)
• stream-server-usocket-p (function)
• stream-usocket (class)
• stream-usocket-p (function)
• timeout-error (condition)
• unimplemented (macro)
• unimplemented (condition)
• unknown-condition (condition)
• unknown-error (condition)
• unsupported (macro)
• unsupported (condition)
• usocket (class)
• usocket-p (function)
• vector-quad-to-dotted-quad (function)
• vector-to-ipv6-host (function)
• wait-for-input (function)
• with-client-socket (macro)
• with-connected-socket (macro)
• with-mapped-conditions (macro)
• with-server-socket (macro)
• with-socket-listener (macro)

Internal Definitions

• %add-waiter (function)
• %make-wait-list (function)
• %remove-waiter (function)
• %setup-wait-list (function)
• %with-timeout (macro)
• *dummy-stream* (special variable)
• +sbcl-condition-map+ (special variable)
• +sbcl-error-map+ (special variable)
• +unix-errno-condition-map+ (special variable)
• +unix-errno-error-map+ (special variable)
• +unix-ns-error-map+ (special variable)
• bool->int (function)
• connected-p (generic function)
• connected-p (method)
• (setf connected-p) (method)
• (setf connected-p) (generic function)
• context (generic function)
• context (method)
• copy-wait-list (function)
• define-usocket-condition-class (function)
• define-usocket-condition-classes (macro)
• element-type (generic function)
• element-type (method)
• feature (generic function)
• feature (method)
• get-host-by-address (function)
• get-host-name (function)
• handle-condition (function)
• host-to-hbo (function)
• host-to-vector-quad (function)
• ignore-unsupported-warnings (macro)
• int->bool (function)
• ip-address-string-p (function)
• list-of-strings-to-integers (function)
• make-datagram-socket (function)
• make-socket (function)
• make-stream-server-socket (function)
• make-stream-socket (function)
• map-errno-condition (function)
• map-errno-error (function)
• map-socket-error (function)
• minimum (generic function)
• minimum (method)
• ns-real-condition (generic function)
• ns-real-condition (method)
• (setf ns-real-condition) (method)
• (setf ns-real-condition) (generic function)
• ns-real-error (generic function)
• ns-real-error (method)
• (setf ns-real-error) (method)
• (setf ns-real-error) (generic function)
• split-ipv6-address (function)
• split-timeout (function)
• state (generic function)
• state (method)
• (setf state) (method)
• (setf state) (generic function)
• usocket-errno (generic function)
• usocket-errno (method)
• usocket-real-condition (generic function)
• usocket-real-condition (method)
• (setf usocket-real-condition) (method)
• (setf usocket-real-condition) (generic function)
• usocket-real-error (generic function)
• usocket-real-error (method)
• (setf usocket-real-error) (method)
• (setf usocket-real-error) (generic function)
• usocket-socket (generic function)
• usocket-socket (method)
• (setf usocket-socket) (method)
• (setf usocket-socket) (generic function)
• wait-for-input-internal (function)
• wait-list (generic function)
• wait-list (method)
• (setf wait-list) (method)
• (setf wait-list) (generic function)
• wait-list (structure)
• wait-list-%wait (function)
• (setf wait-list-%wait) (function)
• wait-list-map (function)
• (setf wait-list-map) (function)
• wait-list-p (function)
• wait-list-waiters (function)
• (setf wait-list-waiters) (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +max-datagram-packet-size+

The theoretical maximum amount of data in a UDP datagram.

The IPv4 UDP packets have a 16-bit length constraint, and IP+UDP header has 28-byte.

IP_MAXPACKET = 65535, /* netinet/ip.h */
sizeof(struct ip) = 20, /* netinet/ip.h */
sizeof(struct udphdr) = 8, /* netinet/udp.h */

65535 - 20 - 8 = 65507

(But for UDP broadcast, the maximum message size is limited by the MTU size of the underlying link)

Package

usocket

Source

usocket.lisp (file)

6.1.2 Special variables

Special Variable: *auto-port*

Port number to pass when an auto-assigned port number is wanted.

Package

usocket

Source

usocket.lisp (file)

Special Variable: *backend*

Package

usocket

Source

option.lisp (file)

Special Variable: *version*

usocket version string

Package

usocket

Source

usocket.lisp (file)

Special Variable: *wildcard-host*

Hostname to pass when all interfaces in the current system are to be bound. If this variable is passed to socket-listen, IPv6 capable systems will also listen for IPv6 connections.

Package

usocket

Source

usocket.lisp (file)

6.1.3 Macros

Macro: ip-from-octet-buffer BUFFER &key START

Package

usocket

Source

usocket.lisp (file)

Macro: ip-to-octet-buffer IP BUFFER &key START

Package

usocket

Source

usocket.lisp (file)

Macro: port-from-octet-buffer BUFFER &key START

Package

usocket

Source

usocket.lisp (file)

Macro: port-to-octet-buffer PORT BUFFER &key START

Package

usocket

Source

usocket.lisp (file)

Macro: unimplemented FEATURE CONTEXT

Package

usocket

Source

condition.lisp (file)

Macro: unsupported FEATURE CONTEXT &key MINIMUM

Package

usocket

Source

condition.lisp (file)

Macro: with-client-socket (SOCKET-VAR STREAM-VAR &rest SOCKET-CONNECT-ARGS) &body BODY

Bind the socket resulting from a call to ‘socket-connect’ with
the arguments ‘socket-connect-args’ to ‘socket-var’ and if ‘stream-var’ is non-nil, bind the associated socket stream to it.

Package

usocket

Source

usocket.lisp (file)

Macro: with-connected-socket (VAR SOCKET) &body BODY

Bind ‘socket’ to ‘var’, ensuring socket destruction on exit.

‘body’ is only evaluated when ‘var’ is bound to a non-null value.

The ‘body’ is an implied progn form.

Package

usocket

Source

usocket.lisp (file)

Macro: with-mapped-conditions (&optional SOCKET HOST-OR-IP) &body BODY

Package

usocket

Source

condition.lisp (file)

Macro: with-server-socket (VAR SERVER-SOCKET) &body BODY

Bind ‘server-socket’ to ‘var’, ensuring socket destruction on exit.

‘body’ is only evaluated when ‘var’ is bound to a non-null value.

The ‘body’ is an implied progn form.

Package

usocket

Source

usocket.lisp (file)

Macro: with-socket-listener (SOCKET-VAR &rest SOCKET-LISTEN-ARGS) &body BODY

Bind the socket resulting from a call to ‘socket-listen’ with arguments ‘socket-listen-args’ to ‘socket-var’.

Package

usocket

Source

usocket.lisp (file)

6.1.4 Functions

Function: add-waiter WAIT-LIST INPUT

Package

usocket

Source

usocket.lisp (file)

Function: datagram-usocket-p SOCKET

Package

usocket

Source

usocket.lisp (file)

Function: dotted-quad-to-vector-quad STRING

Package

usocket

Source

usocket.lisp (file)

Function: get-host-by-name NAME

0.7.1+: if there’re IPv4 addresses, return the first IPv4 address.

Package

usocket

Source

usocket.lisp (file)

Function: get-hosts-by-name NAME

Package

usocket

Source

sbcl.lisp (file)

Function: get-random-host-by-name NAME

0.7.1+: if there’re IPv4 addresses, only return a random IPv4 address.

Package

usocket

Source

usocket.lisp (file)

Function: hbo-to-dotted-quad INTEGER

Host-byte-order integer to dotted-quad string conversion utility.

Package

usocket

Source

usocket.lisp (file)

Function: hbo-to-vector-quad INTEGER

Host-byte-order integer to dotted-quad string conversion utility.

Package

usocket

Source

usocket.lisp (file)

Function: host-to-hostname HOST

Translate a string, vector quad or 16 byte IPv6 address to a stringified hostname.

Package

usocket

Source

usocket.lisp (file)

Function: integer-to-octet-buffer INTEGER BUFFER OCTETS &key START

Package

usocket

Source

usocket.lisp (file)

Function: ip/= IP1 IP2

Package

usocket

Source

usocket.lisp (file)

Function: ip= IP1 IP2

Package

usocket

Source

usocket.lisp (file)

Function: ipv6-host-to-vector STRING

Package

usocket

Source

usocket.lisp (file)

Function: make-wait-list WAITERS

Package

usocket

Source

usocket.lisp (file)

Function: octet-buffer-to-integer BUFFER OCTETS &key START

Package

usocket

Source

usocket.lisp (file)

Function: remove-all-waiters WAIT-LIST

Package

usocket

Source

usocket.lisp (file)

Function: remove-waiter WAIT-LIST INPUT

Package

usocket

Source

usocket.lisp (file)

Function: socket-connect HOST PORT &key PROTOCOL ELEMENT-TYPE TIMEOUT DEADLINE NODELAY LOCAL-HOST LOCAL-PORT &aux SOCKOPT-TCP-NODELAY-P

Connect to ‘host’ on ‘port’. ‘host’ is assumed to be a string or
an IP address represented in vector notation, such as #(192 168 1 1).
‘port’ is assumed to be an integer.

‘element-type’ specifies the element type to use when constructing the
stream associated with the socket. The default is ’character.

‘nodelay’ Allows to disable/enable Nagle’s algorithm (http://en.wikipedia.org/wiki/Nagle%27s_algorithm). If this parameter is omitted, the behaviour is inherited from the
CL implementation (in most cases, Nagle’s algorithm is
enabled by default, but for example in ACL it is disabled).
If the parameter is specified, one of these three values is possible:
T - Disable Nagle’s algorithm; signals an UNSUPPORTED
condition if the implementation does not support explicit
manipulation with that option.
NIL - Leave Nagle’s algorithm enabled on the socket;
signals an UNSUPPORTED condition if the implementation does
not support explicit manipulation with that option.
:IF-SUPPORTED - Disables Nagle’s algorithm if the implementation
allows this, otherwises just ignore this option.

Returns a usocket object.

Package

usocket

Source

sbcl.lisp (file)

Function: socket-listen HOST PORT &key REUSEADDRESS REUSE-ADDRESS BACKLOG ELEMENT-TYPE

Bind to interface ‘host’ on ‘port’. ‘host’ should be the representation of an ready-interface address. The implementation is not required to do an address lookup, making no guarantees that hostnames will be correctly resolved. If ‘*wildcard-host*’ or NIL is passed for ‘host’, the socket will be bound to all available interfaces for the system. ‘port’ can be selected by the IP stack by passing ‘*auto-port*’.

Returns an object of type ‘stream-server-usocket’.

‘reuse-address’ and ‘backlog’ are advisory parameters for setting socket options at creation time. ‘element-type’ is the element type of the streams to be created by ‘socket-accept’. ‘reuseaddress’ is supported for backward compatibility (but deprecated); when both ‘reuseaddress’ and ‘reuse-address’ have been specified, the latter takes precedence.

Package

usocket

Source

sbcl.lisp (file)

Function: stream-server-usocket-p SOCKET

Package

usocket

Source

usocket.lisp (file)

Function: stream-usocket-p SOCKET

Package

usocket

Source

usocket.lisp (file)

Function: usocket-p SOCKET

Package

usocket

Source

usocket.lisp (file)

Function: vector-quad-to-dotted-quad VECTOR

Package

usocket

Source

usocket.lisp (file)

Function: vector-to-ipv6-host VECTOR

Package

usocket

Source

usocket.lisp (file)

Function: wait-for-input SOCKET-OR-SOCKETS &key TIMEOUT READY-ONLY &aux SINGLE-SOCKET-P

Waits for one or more streams to become ready for reading from
the socket. When ‘timeout’ (a non-negative real number) is specified, wait ‘timeout’ seconds, or wait indefinitely when
it isn’t specified. A ‘timeout’ value of 0 (zero) means polling.

Returns two values: the first value is the list of streams which are readable (or in case of server streams acceptable). NIL may
be returned for this value either when waiting timed out or when
it was interrupted (EINTR). The second value is a real number indicating the time remaining within the timeout period or NIL if none.

Without the READY-ONLY arg, WAIT-FOR-INPUT will return all sockets in the original list you passed it. This prevents a new list from being consed up. Some users of USOCKET were reluctant to use it if it wouldn’t behave that way, expecting it to cost significant performance to do the associated garbage collection.

Without the READY-ONLY arg, you need to check the socket STATE slot for the values documented in usocket.lisp in the usocket class.

Package

usocket

Source

usocket.lisp (file)

6.1.5 Generic functions

Generic Function: get-local-address SOCKET

Returns the IP address of the socket.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-local-address (USOCKET usocket)

Source

sbcl.lisp (file)

Generic Function: get-local-name SOCKET

Returns the IP address and port of the socket as values.

This function applies to both ‘stream-usocket’ and ‘server-stream-usocket’ type objects.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-local-name (USOCKET usocket)

Source

sbcl.lisp (file)

Generic Function: get-local-port SOCKET

Returns the IP port of the socket.

This function applies to both ‘stream-usocket’ and ‘server-stream-usocket’ type objects.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-local-port (USOCKET usocket)

Source

sbcl.lisp (file)

Generic Function: get-peer-address SOCKET

Returns the IP address of the peer the socket is connected to.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-peer-address (USOCKET stream-usocket)

Source

sbcl.lisp (file)

Generic Function: get-peer-name SOCKET

Returns the IP address and port of the peer the socket is connected to as values.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-peer-name (USOCKET stream-usocket)

Source

sbcl.lisp (file)

Generic Function: get-peer-port SOCKET

Returns the IP port of the peer the socket to.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: get-peer-port (USOCKET stream-usocket)

Source

sbcl.lisp (file)

Generic Function: host-byte-order ADDRESS

Package

usocket

Source

usocket.lisp (file)

Methods

Method: host-byte-order (INT integer)

Method: host-byte-order (VECTOR vector)

Convert a vector, such as #(192 168 1 1), to host-byte-order, such as 3232235777.

Method: host-byte-order (STRING string)

Convert a string, such as 192.168.1.1, to host-byte-order, such as 3232235777.

Generic Function: host-or-ip CONDITION

Generic Function: (setf host-or-ip) NEW-VALUE CONDITION

Package

usocket

Methods

Method: host-or-ip (CONDITION ns-condition)

Method: (setf host-or-ip) NEW-VALUE (CONDITION ns-condition)

Source

condition.lisp (file)

Generic Function: socket OBJECT

Generic Function: (setf socket) NEW-VALUE OBJECT

Package

usocket

Methods

Method: socket (USOCKET usocket)

Method: (setf socket) NEW-VALUE (USOCKET usocket)

Implementation specific socket object instance.’

Source

usocket.lisp (file)

Generic Function: socket-accept SOCKET &key ELEMENT-TYPE

Accepts a connection from ‘socket’, returning a ‘stream-socket’.

The stream associated with the socket returned has ‘element-type’ when explicitly specified, or the element-type passed to ‘socket-listen’ otherwise.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-accept (USOCKET stream-server-usocket) &key ELEMENT-TYPE

Source

sbcl.lisp (file)

Generic Function: socket-close USOCKET

Close a previously opened ‘usocket’.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-close (USOCKET stream-usocket)

Source

sbcl.lisp (file)

Method: socket-close (USOCKET usocket)

Source

sbcl.lisp (file)

Method: socket-close (USOCKET usocket) before

Generic Function: socket-option SOCKET OPTION &key

Get a socket’s internal options

Package

usocket

Source

option.lisp (file)

Writer

(setf socket-option) (generic function)

Methods

Method: socket-option (USOCKET stream-usocket) (OPTION (eql tcp-nodelay)) &key

Method: socket-option (USOCKET stream-usocket) (OPTION (eql tcp-no-delay)) &key

Method: socket-option (USOCKET datagram-usocket) (OPTION (eql broadcast)) &key

Method: socket-option (USOCKET stream-server-usocket) (OPTION (eql reuse-address)) &key

Method: socket-option (USOCKET stream-usocket) (OPTION (eql send-timeout)) &key

Method: socket-option (USOCKET stream-usocket) (OPTION (eql receive-timeout)) &key

Method: socket-option (SOCKET usocket) (OPTION symbol) &key

Method: socket-option (SOCKET usocket) OPTION &key

Generic Function: (setf socket-option) NEW-VALUE SOCKET OPTION &key

Set a socket’s internal options

Package

usocket

Source

option.lisp (file)

Reader

socket-option (generic function)

Methods

Method: (setf socket-option) NEW-VALUE (USOCKET stream-usocket) (OPTION (eql tcp-nodelay)) &key

Method: (setf socket-option) NEW-VALUE (USOCKET stream-usocket) (OPTION (eql tcp-no-delay)) &key

Method: (setf socket-option) NEW-VALUE (USOCKET datagram-usocket) (OPTION (eql broadcast)) &key

Method: (setf socket-option) NEW-VALUE (USOCKET stream-server-usocket) (OPTION (eql reuse-address)) &key

Method: (setf socket-option) NEW-VALUE (USOCKET stream-usocket) (OPTION (eql send-timeout)) &key

Method: (setf socket-option) NEW-VALUE (USOCKET stream-usocket) (OPTION (eql receive-timeout)) &key

Method: (setf socket-option) NEW-VALUE (SOCKET usocket) (OPTION symbol) &key

Method: (setf socket-option) NEW-VALUE (SOCKET usocket) OPTION &key

Generic Function: socket-receive USOCKET BUFFER LENGTH &key ELEMENT-TYPE

Receive packets from a previously opend ‘usocket’.

Returns 4 values: (values buffer size host port)

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-receive (USOCKET datagram-usocket) BUFFER LENGTH &key ELEMENT-TYPE

Source

sbcl.lisp (file)

Generic Function: socket-send USOCKET BUFFER LENGTH &key HOST PORT OFFSET

Send packets through a previously opend ‘usocket’.

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-send (USOCKET datagram-usocket) BUFFER SIZE &key HOST PORT OFFSET

Source

sbcl.lisp (file)

Generic Function: socket-shutdown USOCKET DIRECTION

Shutdown communication on the socket in DIRECTION.

After a shutdown no input and/or output of the indicated DIRECTION can be performed on the ‘usocket’.

DIRECTION should be either :INPUT or :OUTPUT or :IO

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-shutdown (USOCKET stream-usocket) DIRECTION

Source

sbcl.lisp (file)

Generic Function: socket-state SOCKET

NIL - not ready
:READ - ready to read :READ-WRITE - ready to read and write :WRITE - ready to write

Package

usocket

Source

usocket.lisp (file)

Methods

Method: socket-state (SOCKET usocket)

Generic Function: socket-stream OBJECT

Generic Function: (setf socket-stream) NEW-VALUE OBJECT

Package

usocket

Methods

Method: socket-stream (STREAM-USOCKET stream-usocket)

Method: (setf socket-stream) NEW-VALUE (STREAM-USOCKET stream-usocket)

Stream instance associated with the socket.

Source

usocket.lisp (file)

6.1.6 Conditions

Condition: address-in-use-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: address-not-available-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: bad-file-descriptor-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: connection-aborted-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: connection-refused-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: connection-reset-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: deadline-timeout-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: host-down-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: host-unreachable-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: insufficient-implementation ()

The ancestor of all errors usocket may generate
because of insufficient support from the underlying implementation with respect to the arguments given to ‘function’.

One call may signal several errors, if the caller allows processing to continue.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• unsupported (condition)
• unimplemented (condition)

Direct methods

• context (method)
• feature (method)

Direct slots

Slot: feature

Initargs

:feature

Readers

feature (generic function)

Slot: context

String designator of the public API function which the feature belongs to.

Initargs

:context

Readers

context (generic function)

Condition: interrupted-condition ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-condition (condition)

Condition: invalid-argument-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: invalid-socket-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: invalid-socket-stream-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: network-down-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: network-reset-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: network-unreachable-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: no-buffers-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: ns-condition ()

Parent condition for all name resolution conditions.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses

• ns-error (condition)
• ns-try-again-condition (condition)
• ns-unknown-condition (condition)

Direct methods

• host-or-ip (method)
• host-or-ip (method)

Direct slots

Slot: host-or-ip

Initargs

:host-or-ip

Readers

host-or-ip (generic function)

Writers

(setf host-or-ip) (generic function)

Condition: ns-error ()

Parent error for all name resolution errors.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

• error (condition)
• ns-condition (condition)

Direct subclasses

• ns-host-not-found-error (condition)
• ns-no-recovery-error (condition)
• ns-unknown-error (condition)

Condition: ns-host-not-found-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

ns-error (condition)

Condition: ns-no-recovery-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

ns-error (condition)

Condition: ns-try-again-condition ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

ns-condition (condition)

Condition: ns-unknown-condition ()

Condition raised when there’s no other - more applicable - condition available.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

ns-condition (condition)

Direct methods

• ns-real-condition (method)
• ns-real-condition (method)

Direct slots

Slot: real-condition

Initargs

:real-condition

Initform

(quote nil)

Readers

ns-real-condition (generic function)

Writers

(setf ns-real-condition) (generic function)

Condition: ns-unknown-error ()

Error raised when there’s no other - more applicable - error available.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

ns-error (condition)

Direct methods

• ns-real-error (method)
• ns-real-error (method)

Direct slots

Slot: real-error

Initargs

:real-error

Initform

(quote nil)

Readers

ns-real-error (generic function)

Writers

(setf ns-real-error) (generic function)

Condition: operation-not-permitted-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: operation-not-supported-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: protocol-not-supported-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: shutdown-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: socket-condition ()

Parent condition for all socket related conditions.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses

• socket-error (condition)
• interrupted-condition (condition)
• unknown-condition (condition)

Direct methods

• usocket-socket (method)
• usocket-socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

usocket-socket (generic function)

Writers

(setf usocket-socket) (generic function)

Condition: socket-error ()

Parent error for all socket related errors

Package

usocket

Source

condition.lisp (file)

Direct superclasses

• error (condition)
• socket-condition (condition)

Direct subclasses

• address-in-use-error (condition)
• address-not-available-error (condition)
• bad-file-descriptor-error (condition)
• connection-refused-error (condition)
• connection-aborted-error (condition)
• connection-reset-error (condition)
• invalid-argument-error (condition)
• no-buffers-error (condition)
• operation-not-supported-error (condition)
• operation-not-permitted-error (condition)
• protocol-not-supported-error (condition)
• socket-type-not-supported-error (condition)
• network-unreachable-error (condition)
• network-down-error (condition)
• network-reset-error (condition)
• host-down-error (condition)
• host-unreachable-error (condition)
• shutdown-error (condition)
• timeout-error (condition)
• deadline-timeout-error (condition)
• invalid-socket-error (condition)
• invalid-socket-stream-error (condition)
• unknown-error (condition)

Condition: socket-type-not-supported-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: timeout-error ()

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Condition: unimplemented ()

Signalled if a certain feature might be implemented,
based on the features of the underlying implementation, but hasn’t been implemented yet.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

insufficient-implementation (condition)

Condition: unknown-condition ()

Condition raised when there’s no other - more applicable - condition available.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-condition (condition)

Direct methods

• usocket-real-condition (method)
• usocket-real-condition (method)

Direct slots

Slot: real-condition

Initargs

:real-condition

Readers

usocket-real-condition (generic function)

Writers

(setf usocket-real-condition) (generic function)

Condition: unknown-error ()

Error raised when there’s no other - more applicable - error available.

Package

usocket

Source

condition.lisp (file)

Direct superclasses

socket-error (condition)

Direct methods

• usocket-errno (method)
• usocket-real-error (method)
• usocket-real-error (method)

Direct slots

Slot: real-error

Initargs

:real-error

Initform

(quote nil)

Readers

usocket-real-error (generic function)

Writers

(setf usocket-real-error) (generic function)

Slot: errno

Initargs

:errno

Initform

(quote 0)

Readers

usocket-errno (generic function)

Condition: unsupported ()

Signalled when the underlying implementation
doesn’t allow supporting the requested feature.

When you see this error, go bug your vendor/implementation developer!

Package

usocket

Source

condition.lisp (file)

Direct superclasses

insufficient-implementation (condition)

Direct methods

minimum (method)

Direct slots

Slot: minimum

Indicates the minimal version of the
implementation required to support the requested feature.

Initargs

:minimum

Readers

minimum (generic function)

6.1.7 Classes

Class: datagram-usocket ()

UDP (inet-datagram) socket

Package

usocket

Source

usocket.lisp (file)

Direct superclasses

usocket (class)

Direct methods

• socket-option (method)
• socket-option (method)
• socket-receive (method)
• socket-send (method)
• connected-p (method)
• connected-p (method)

Direct slots

Slot: connected-p

Type

boolean

Initargs

:connected-p

Readers

connected-p (generic function)

Writers

(setf connected-p) (generic function)

Class: stream-server-usocket ()

Socket which listens for stream connections to be initiated from remote sockets.

Package

usocket

Source

usocket.lisp (file)

Direct superclasses

usocket (class)

Direct methods

• socket-option (method)
• socket-option (method)
• socket-accept (method)
• element-type (method)

Direct slots

Slot: element-type

Default element type for streams created by ‘socket-accept’.

Initargs

:element-type

Initform

(quote character)

Readers

element-type (generic function)

Class: stream-usocket ()

Stream socket class.
’
Contrary to other sockets, these sockets may be closed either with the ‘socket-close’ method or by closing the associated stream (which can be retrieved with the ‘socket-stream’ accessor).

Package

usocket

Source

usocket.lisp (file)

Direct superclasses

usocket (class)

Direct methods

• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• get-peer-port (method)
• get-peer-address (method)
• get-peer-name (method)
• socket-shutdown (method)
• socket-close (method)
• socket-stream (method)
• socket-stream (method)

Direct slots

Slot: stream

Stream instance associated with the socket.

Initargs

:stream

Readers

socket-stream (generic function)

Writers

(setf socket-stream) (generic function)

Class: usocket ()

The main socket class.

Sockets should be closed using the ‘socket-close’ method.

Package

usocket

Source

usocket.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• stream-usocket (class)
• stream-server-usocket (class)
• datagram-usocket (class)

Direct methods

• socket-option (method)
• socket-option (method)
• socket-option (method)
• socket-option (method)
• get-local-port (method)
• get-local-address (method)
• get-local-name (method)
• socket-close (method)
• socket-close (method)
• socket-state (method)
• state (method)
• state (method)
• wait-list (method)
• wait-list (method)
• socket (method)
• socket (method)

Direct slots

Slot: socket

Implementation specific socket object instance.’

Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: wait-list

WAIT-LIST the object is associated with.

Readers

wait-list (generic function)

Writers

(setf wait-list) (generic function)

Slot: state

Per-socket return value for the ‘wait-for-input’ function.

The value stored in this slot can be any of
NIL - not ready
:READ - ready to read
:READ-WRITE - ready to read and write
:WRITE - ready to write

The last two remain unused in the current version.

Readers

state (generic function)

Writers

(setf state) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *dummy-stream*

Package

usocket

Source

sbcl.lisp (file)

Special Variable: +sbcl-condition-map+

Package

usocket

Source

sbcl.lisp (file)

Special Variable: +sbcl-error-map+

Package

usocket

Source

sbcl.lisp (file)

Special Variable: +unix-errno-condition-map+

Package

usocket

Source

condition.lisp (file)

Special Variable: +unix-errno-error-map+

Package

usocket

Source

condition.lisp (file)

Special Variable: +unix-ns-error-map+

Package

usocket

Source

condition.lisp (file)

6.2.2 Macros

Macro: %with-timeout (SECONDS TIMEOUT-FORM) &body BODY

Runs BODY as an implicit PROGN with timeout of SECONDS. If timeout occurs before BODY has finished, BODY is unwound and TIMEOUT-FORM is executed with its values returned instead.

Note that BODY is unwound asynchronously when a timeout occurs, so unless all code executed during it – including anything down the call chain – is asynch unwind safe, bad things will happen. Use with care.

Package

usocket

Source

sbcl.lisp (file)

Macro: define-usocket-condition-classes CLASS-LIST PARENTS

Package

usocket

Source

condition.lisp (file)

Macro: ignore-unsupported-warnings &body BODY

Package

usocket

Source

condition.lisp (file)

6.2.3 Functions

Function: %add-waiter WAIT-LIST WAITER

Package

usocket

Source

sbcl.lisp (file)

Function: %make-wait-list &key (%WAIT %WAIT) (WAITERS WAITERS) (MAP MAP)

Package

usocket

Source

usocket.lisp (file)

Function: %remove-waiter WAIT-LIST WAITER

Package

usocket

Source

sbcl.lisp (file)

Function: %setup-wait-list WAIT-LIST

Package

usocket

Source

sbcl.lisp (file)

Function: bool->int BOOL

Package

usocket

Source

usocket.lisp (file)

Function: copy-wait-list INSTANCE

Package

usocket

Source

usocket.lisp (file)

Function: define-usocket-condition-class CLASS &rest PARENTS

Package

usocket

Source

condition.lisp (file)

Function: get-host-by-address ADDRESS

Package

usocket

Source

sbcl.lisp (file)

Function: get-host-name ()

Package

usocket

Source

sbcl.lisp (file)

Function: handle-condition CONDITION &optional SOCKET HOST-OR-IP

Dispatch correct usocket condition.

Package

usocket

Source

sbcl.lisp (file)

Function: host-to-hbo HOST

Package

usocket

Source

usocket.lisp (file)

Function: host-to-vector-quad HOST

Translate a host specification (vector quad, dotted quad or domain name) to a vector quad.

Package

usocket

Source

usocket.lisp (file)

Function: int->bool INT

Package

usocket

Source

usocket.lisp (file)

Function: ip-address-string-p STRING

Return a true value if the given string could be an IP address.

Package

usocket

Source

usocket.lisp (file)

Function: list-of-strings-to-integers LIST

Take a list of strings and return a new list of integers (from parse-integer) on each of the string elements.

Package

usocket

Source

usocket.lisp (file)

Function: make-datagram-socket SOCKET &key CONNECTED-P

Package

usocket

Source

usocket.lisp (file)

Function: make-socket &key SOCKET

Create a usocket socket type from implementation specific socket.

Package

usocket

Source

usocket.lisp (file)

Function: make-stream-server-socket SOCKET &key ELEMENT-TYPE

Create a usocket-server socket type from an implementation-specific socket object.

The returned value is a subtype of ‘stream-server-usocket’.

Package

usocket

Source

usocket.lisp (file)

Function: make-stream-socket &key SOCKET STREAM

Create a usocket socket type from implementation specific socket and stream objects.

Sockets returned should be closed using the ‘socket-close’ method or by closing the stream associated with the socket.

Package

usocket

Source

usocket.lisp (file)

Function: map-errno-condition ERRNO

Package

usocket

Source

condition.lisp (file)

Function: map-errno-error ERRNO

Package

usocket

Source

condition.lisp (file)

Function: map-socket-error SOCK-ERR

Package

usocket

Source

sbcl.lisp (file)

Function: split-ipv6-address STRING

Package

usocket

Source

usocket.lisp (file)

Function: split-timeout TIMEOUT &optional FRACTIONAL

Split real value timeout into seconds and microseconds. Optionally, a different fractional part can be specified.

Package

usocket

Source

usocket.lisp (file)

Function: wait-for-input-internal SOCKETS &key TIMEOUT

Package

usocket

Source

sbcl.lisp (file)

Function: wait-list-%wait INSTANCE

Function: (setf wait-list-%wait) VALUE INSTANCE

Package

usocket

Source

usocket.lisp (file)

Function: wait-list-map INSTANCE

Function: (setf wait-list-map) VALUE INSTANCE

Package

usocket

Source

usocket.lisp (file)

Function: wait-list-p OBJECT

Package

usocket

Source

usocket.lisp (file)

Function: wait-list-waiters INSTANCE

Function: (setf wait-list-waiters) VALUE INSTANCE

Package

usocket

Source

usocket.lisp (file)

6.2.4 Generic functions

Generic Function: connected-p OBJECT

Generic Function: (setf connected-p) NEW-VALUE OBJECT

Package

usocket

Methods

Method: connected-p (DATAGRAM-USOCKET datagram-usocket)

automatically generated reader method

Source

usocket.lisp (file)

Method: (setf connected-p) NEW-VALUE (DATAGRAM-USOCKET datagram-usocket)

automatically generated writer method

Source

usocket.lisp (file)

Generic Function: context CONDITION

Package

usocket

Methods

Method: context (CONDITION insufficient-implementation)

Source

condition.lisp (file)

Generic Function: element-type OBJECT

Package

usocket

Methods

Method: element-type (STREAM-SERVER-USOCKET stream-server-usocket)

Default element type for streams created by ‘socket-accept’.

Source

usocket.lisp (file)

Generic Function: feature CONDITION

Package

usocket

Methods

Method: feature (CONDITION insufficient-implementation)

Source

condition.lisp (file)

Generic Function: minimum CONDITION

Package

usocket

Methods

Method: minimum (CONDITION unsupported)

Source

condition.lisp (file)

Generic Function: ns-real-condition CONDITION

Generic Function: (setf ns-real-condition) NEW-VALUE CONDITION

Package

usocket

Methods

Method: ns-real-condition (CONDITION ns-unknown-condition)

Method: (setf ns-real-condition) NEW-VALUE (CONDITION ns-unknown-condition)

Source

condition.lisp (file)

Generic Function: ns-real-error CONDITION

Generic Function: (setf ns-real-error) NEW-VALUE CONDITION

Package

usocket

Methods

Method: ns-real-error (CONDITION ns-unknown-error)

Method: (setf ns-real-error) NEW-VALUE (CONDITION ns-unknown-error)

Source

condition.lisp (file)

Generic Function: state OBJECT

Generic Function: (setf state) NEW-VALUE OBJECT

Package

usocket

Methods

Method: state (USOCKET usocket)

Method: (setf state) NEW-VALUE (USOCKET usocket)

Per-socket return value for the ‘wait-for-input’ function.

The value stored in this slot can be any of
NIL - not ready
:READ - ready to read
:READ-WRITE - ready to read and write
:WRITE - ready to write

The last two remain unused in the current version.

Source

usocket.lisp (file)

Generic Function: usocket-errno CONDITION

Package

usocket

Methods

Method: usocket-errno (CONDITION unknown-error)

Source

condition.lisp (file)

Generic Function: usocket-real-condition CONDITION

Generic Function: (setf usocket-real-condition) NEW-VALUE CONDITION

Package

usocket

Methods

Method: usocket-real-condition (CONDITION unknown-condition)

Method: (setf usocket-real-condition) NEW-VALUE (CONDITION unknown-condition)

Source

condition.lisp (file)

Generic Function: usocket-real-error CONDITION

Generic Function: (setf usocket-real-error) NEW-VALUE CONDITION

Package

usocket

Methods

Method: usocket-real-error (CONDITION unknown-error)

Method: (setf usocket-real-error) NEW-VALUE (CONDITION unknown-error)

Source

condition.lisp (file)

Generic Function: usocket-socket CONDITION

Generic Function: (setf usocket-socket) NEW-VALUE CONDITION

Package

usocket

Methods

Method: usocket-socket (CONDITION socket-condition)

Method: (setf usocket-socket) NEW-VALUE (CONDITION socket-condition)

Source

condition.lisp (file)

Generic Function: wait-list OBJECT

Generic Function: (setf wait-list) NEW-VALUE OBJECT

Package

usocket

Methods

Method: wait-list (USOCKET usocket)

Method: (setf wait-list) NEW-VALUE (USOCKET usocket)

WAIT-LIST the object is associated with.

Source

usocket.lisp (file)

6.2.5 Structures

Structure: wait-list ()

Package

usocket

Source

usocket.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: %wait

Readers

wait-list-%wait (function)

Writers

(setf wait-list-%wait) (function)

Slot: waiters

Readers

wait-list-waiters (function)

Writers

(setf wait-list-waiters) (function)

Slot: map

Readers

wait-list-map (function)

Writers

(setf wait-list-map) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions