The trivial-sockets Reference Manual

This is the trivial-sockets Reference Manual, version 0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:11:53 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-sockets

A trivial networking library for undemanding Internet applications

Maintainer

Chun Tian (binghe)

Author

Daniel Barlow

License

MIT

Version

0.4

Dependency

sb-bsd-sockets (system).

Source

trivial-sockets.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-sockets/trivial-sockets.asd

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

ASDF Systems

trivial-sockets.

Packages

trivial-sockets-system.


3.1.2 trivial-sockets/defpackage.lisp

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Packages

trivial-sockets.


3.1.3 trivial-sockets/errors.lisp

Dependency

defpackage.lisp (file).

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Public Interface

3.1.4 trivial-sockets/sbcl.lisp

Dependency

defpackage.lisp (file).

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Public Interface
Internals

resolve-hostname (function).


3.1.5 trivial-sockets/server.lisp

Dependency

defpackage.lisp (file).

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Public Interface

with-server (macro).


4 Packages

Packages are listed by definition order.


4.1 trivial-sockets

Source

defpackage.lisp.

Use List

common-lisp.

Public Interface
Internals

resolve-hostname (function).


4.2 trivial-sockets-system

Source

trivial-sockets.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with-server ((name arguments) &body forms)
Package

trivial-sockets.

Source

server.lisp.


5.1.2 Ordinary functions

Function: accept-connection (socket &key external-format element-type)
Package

trivial-sockets.

Source

sbcl.lisp.

Function: close-server (server)
Package

trivial-sockets.

Source

sbcl.lisp.

Function: open-server (&key host port reuse-address backlog protocol)

Returns a SERVER object and the port that was bound, as multiple values

Package

trivial-sockets.

Source

sbcl.lisp.

Function: open-stream (peer-host peer-port &key local-host local-port external-format element-type protocol)
Package

trivial-sockets.

Source

sbcl.lisp.


5.1.3 Generic functions

Generic Reader: socket-nested-error (condition)
Package

trivial-sockets.

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

errors.lisp.

Target Slot

nested-error.

Generic Reader: unsupported-feature (condition)
Package

trivial-sockets.

Methods
Reader Method: unsupported-feature ((condition unsupported))
Source

errors.lisp.

Target Slot

feature.


5.1.4 Conditions

Condition: socket-error
Package

trivial-sockets.

Source

errors.lisp.

Direct superclasses

error.

Direct methods

socket-nested-error.

Direct slots
Slot: nested-error
Initargs

:nested-error

Readers

socket-nested-error.

Writers

This slot is read-only.

Condition: unsupported
Package

trivial-sockets.

Source

errors.lisp.

Direct superclasses

error.

Direct methods

unsupported-feature.

Direct slots
Slot: feature
Initargs

:feature

Readers

unsupported-feature.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: resolve-hostname (name)
Package

trivial-sockets.

Source

sbcl.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   F   N   S  
Index Entry  Section

F
feature: Public conditions

N
nested-error: Public conditions

S
Slot, feature: Public conditions
Slot, nested-error: Public conditions