Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 Sun Dec 15 07:57:25 2024 GMT+0.

Next: Systems, Previous: The trivial-sockets Reference Manual, Up: The trivial-sockets Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The trivial-sockets Reference Manual [Contents][Index]

2 Systems

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

trivial-sockets

Previous: Systems, Up: Systems [Contents][Index]

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

defpackage.lisp (file).
errors.lisp (file).
sbcl.lisp (file).
server.lisp (file).

Next: Packages, Previous: Systems, Up: The trivial-sockets Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: trivial-sockets/defpackage.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Next: trivial-sockets/errors.lisp, Previous: trivial-sockets/trivial-sockets.asd, Up: Lisp [Contents][Index]

3.1.2 `trivial-sockets/defpackage.lisp`

Source: trivial-sockets.asd.
Parent Component: trivial-sockets (system).
Packages: trivial-sockets.

Next: trivial-sockets/sbcl.lisp, Previous: trivial-sockets/defpackage.lisp, Up: Lisp [Contents][Index]

3.1.3 `trivial-sockets/errors.lisp`

Dependency

defpackage.lisp (file).

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Public Interface

socket-error (condition).
socket-nested-error (reader method).
unsupported (condition).
unsupported-feature (reader method).

Next: trivial-sockets/server.lisp, Previous: trivial-sockets/errors.lisp, Up: Lisp [Contents][Index]

3.1.4 `trivial-sockets/sbcl.lisp`

Dependency

defpackage.lisp (file).

Source

trivial-sockets.asd.

Parent Component

trivial-sockets (system).

Public Interface

accept-connection (function).
close-server (function).
open-server (function).
open-stream (function).

Internals

resolve-hostname (function).

Previous: trivial-sockets/sbcl.lisp, Up: Lisp [Contents][Index]

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).

Next: Definitions, Previous: Files, Up: The trivial-sockets Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

trivial-sockets
trivial-sockets-system

Next: trivial-sockets-system, Previous: Packages, Up: Packages [Contents][Index]

4.1 `trivial-sockets`

Source

defpackage.lisp.

Use List

common-lisp.

Public Interface

accept-connection (function).
close-server (function).
open-server (function).
open-stream (function).
socket-error (condition).
socket-nested-error (generic reader).
unsupported (condition).
unsupported-feature (generic reader).
with-server (macro).

Internals

resolve-hostname (function).

Previous: trivial-sockets, Up: Packages [Contents][Index]

4.2 `trivial-sockets-system`

Source

trivial-sockets.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The trivial-sockets Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Conditions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

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

Package: trivial-sockets.
Source: server.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

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.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

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.

Previous: Generic functions, Up: Public Interface [Contents][Index]

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.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: resolve-hostname (name) ¶

Package: trivial-sockets.
Source: sbcl.lisp.

Previous: Definitions, Up: The trivial-sockets Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	A C F G M O R S U W

	Index Entry	Section

A
	`accept-connection`:	Public ordinary functions

C
	`close-server`:	Public ordinary functions

F
	`Function, accept-connection`:	Public ordinary functions
	`Function, close-server`:	Public ordinary functions
	`Function, open-server`:	Public ordinary functions
	`Function, open-stream`:	Public ordinary functions
	`Function, resolve-hostname`:	Private ordinary functions

G
	`Generic Function, socket-nested-error`:	Public generic functions
	`Generic Function, unsupported-feature`:	Public generic functions

M
	`Macro, with-server`:	Public macros
	`Method, socket-nested-error`:	Public generic functions
	`Method, unsupported-feature`:	Public generic functions

O
	`open-server`:	Public ordinary functions
	`open-stream`:	Public ordinary functions

R
	`resolve-hostname`:	Private ordinary functions

S
	`socket-nested-error`:	Public generic functions
	`socket-nested-error`:	Public generic functions

U
	`unsupported-feature`:	Public generic functions
	`unsupported-feature`:	Public generic functions

W
	`with-server`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

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

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C D E F P S T U

	Index Entry	Section

C
	`Condition, socket-error`:	Public conditions
	`Condition, unsupported`:	Public conditions

D
	`defpackage.lisp`:	The trivial-sockets/defpackage․lisp file

E
	`errors.lisp`:	The trivial-sockets/errors․lisp file

F
	`File, defpackage.lisp`:	The trivial-sockets/defpackage․lisp file
	`File, errors.lisp`:	The trivial-sockets/errors․lisp file
	`File, sbcl.lisp`:	The trivial-sockets/sbcl․lisp file
	`File, server.lisp`:	The trivial-sockets/server․lisp file
	`File, trivial-sockets.asd`:	The trivial-sockets/trivial-sockets․asd file

P
	`Package, trivial-sockets`:	The trivial-sockets package
	`Package, trivial-sockets-system`:	The trivial-sockets-system package

S
	`sbcl.lisp`:	The trivial-sockets/sbcl․lisp file
	`server.lisp`:	The trivial-sockets/server․lisp file
	`socket-error`:	Public conditions
	`System, trivial-sockets`:	The trivial-sockets system

T
	`trivial-sockets`:	The trivial-sockets system
	`trivial-sockets`:	The trivial-sockets package
	`trivial-sockets-system`:	The trivial-sockets-system package
	`trivial-sockets.asd`:	The trivial-sockets/trivial-sockets․asd file

U
	`unsupported`:	Public conditions

The trivial-sockets Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 trivial-sockets

3 Files

3.1 Lisp

3.1.1 trivial-sockets/trivial-sockets.asd

3.1.2 trivial-sockets/defpackage.lisp

3.1.3 trivial-sockets/errors.lisp

3.1.4 trivial-sockets/sbcl.lisp

3.1.5 trivial-sockets/server.lisp

4 Packages

4.1 trivial-sockets

4.2 trivial-sockets-system

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Conditions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `trivial-sockets`

3.1.1 `trivial-sockets/trivial-sockets.asd`

3.1.2 `trivial-sockets/defpackage.lisp`

3.1.3 `trivial-sockets/errors.lisp`

3.1.4 `trivial-sockets/sbcl.lisp`

3.1.5 `trivial-sockets/server.lisp`

4.1 `trivial-sockets`

4.2 `trivial-sockets-system`