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

The clack Reference Manual

This is the clack Reference Manual, version 2.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:54:57 2024 GMT+0.

Next: Systems, Previous: The clack Reference Manual, Up: The clack Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The clack Reference Manual [Contents][Index]

2 Systems

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

clack

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

2.1 `clack`

Web application environment for Common Lisp

Author

Eitaro Fukamachi

License

MIT

Version

2.1.0

Dependencies

lack (system).
lack-middleware-backtrace (system).
lack-util (system).
bordeaux-threads (system).
usocket (system).
swank (system).
alexandria (system).
uiop (system).

Source

clack.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The clack Reference Manual [Contents][Index]

3 Modules

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

clack/src

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

3.1 `clack/src`

Source

clack.asd.

Parent Component

clack (system).

Child Components

clack.lisp (file).
handler.lisp (file).
util.lisp (file).

Next: Packages, Previous: Modules, Up: The clack Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: clack/src/clack.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `clack/clack.asd`

Source: clack.asd.
Parent Component: clack (system).
ASDF Systems: clack.

Next: clack/src/handler.lisp, Previous: clack/clack.asd, Up: Lisp [Contents][Index]

4.1.2 `clack/src/clack.lisp`

Dependencies

handler.lisp (file).
util.lisp (file).

Source

clack.asd.

Parent Component

src (module).

Packages

clack.

Public Interface

clackup (function).
eval-file (function).

Internals

%load-file (function).
*app-file-cache* (special variable).
with-handle-interrupt (macro).

Next: clack/src/util.lisp, Previous: clack/src/clack.lisp, Up: Lisp [Contents][Index]

4.1.3 `clack/src/handler.lisp`

Dependency

util.lisp (file).

Source

clack.asd.

Parent Component

src (module).

Packages

clack.handler.

Public Interface

run (function).
stop (function).

Internals

copy-handler (function).
handler (structure).
handler-acceptor (reader).
(setf handler-acceptor) (writer).
handler-p (function).
handler-server (reader).
(setf handler-server) (writer).
handler-swank-port (reader).
(setf handler-swank-port) (writer).
make-handler (function).

Previous: clack/src/handler.lisp, Up: Lisp [Contents][Index]

4.1.4 `clack/src/util.lisp`

Source: clack.asd.
Parent Component: src (module).
Packages: clack.util.
Public Interface: find-handler (function).

Next: Definitions, Previous: Files, Up: The clack Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

clack.util
clack.handler
clack

Next: clack.handler, Previous: Packages, Up: Packages [Contents][Index]

5.1 `clack.util`

Source: util.lisp.
Use List: common-lisp.
Public Interface: find-handler (function).

Next: clack, Previous: clack.util, Up: Packages [Contents][Index]

5.2 `clack.handler`

Source

handler.lisp.

Use List

common-lisp.

Public Interface

run (function).
stop (function).

Internals

copy-handler (function).
handler (structure).
handler-acceptor (reader).
(setf handler-acceptor) (writer).
handler-p (function).
handler-server (reader).
(setf handler-server) (writer).
handler-swank-port (reader).
(setf handler-swank-port) (writer).
make-handler (function).

Previous: clack.handler, Up: Packages [Contents][Index]

5.3 `clack`

Source

clack.lisp.

Use List

common-lisp.

Public Interface

clackup (function).
eval-file (function).

Internals

%load-file (function).
*app-file-cache* (special variable).
with-handle-interrupt (macro).

Next: Indexes, Previous: Packages, Up: The clack Reference Manual [Contents][Index]

6 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]

6.1 Public Interface

Ordinary functions

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

6.1.1 Ordinary functions

Function: clackup (app &rest args &key server address port swank-interface swank-port debug silent use-thread use-default-middlewares &allow-other-keys) ¶

Package: clack.
Source: clack.lisp.

Function: eval-file (file) ¶

Safer way to read and eval a file content. This function returns the last value.

Package: clack.
Source: clack.lisp.

Function: find-handler (server) ¶

Package: clack.util.
Source: util.lisp.

Function: run (app server &rest args &key address use-thread swank-interface swank-port &allow-other-keys) ¶

Package: clack.handler.
Source: handler.lisp.

Function: stop (handler) ¶

Package: clack.handler.
Source: handler.lisp.

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

6.2 Internals

Special variables
Macros
Ordinary functions
Structures

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

6.2.1 Special variables

Special Variable: *app-file-cache* ¶

Package: clack.
Source: clack.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

6.2.2 Macros

Macro: with-handle-interrupt (int-handler &body body) ¶

Package: clack.
Source: clack.lisp.

Next: Structures, Previous: Macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: %load-file (file) ¶

Package: clack.
Source: clack.lisp.

Function: copy-handler (instance) ¶

Package: clack.handler.
Source: handler.lisp.

Reader: handler-acceptor (instance) ¶

Writer: (setf handler-acceptor) (instance) ¶

Package: clack.handler.
Source: handler.lisp.
Target Slot: acceptor.

Function: handler-p (object) ¶

Package: clack.handler.
Source: handler.lisp.

Reader: handler-server (instance) ¶

Writer: (setf handler-server) (instance) ¶

Package: clack.handler.
Source: handler.lisp.
Target Slot: server.

Reader: handler-swank-port (instance) ¶

Writer: (setf handler-swank-port) (instance) ¶

Package: clack.handler.
Source: handler.lisp.
Target Slot: swank-port.

Function: make-handler (&key server swank-port acceptor) ¶

Package: clack.handler.
Source: handler.lisp.

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

6.2.4 Structures

Structure: handler ¶

Package

clack.handler.

Source

handler.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: server ¶

Readers: handler-server.
Writers: (setf handler-server).

Slot: swank-port ¶

Readers: handler-swank-port.
Writers: (setf handler-swank-port).

Slot: acceptor ¶

Readers: handler-acceptor.
Writers: (setf handler-acceptor).

Previous: Definitions, Up: The clack 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:	% ( C E F H M R S W

	Index Entry	Section

%
	`%load-file`:	Private ordinary functions

(
	`(setf handler-acceptor)`:	Private ordinary functions
	`(setf handler-server)`:	Private ordinary functions
	`(setf handler-swank-port)`:	Private ordinary functions

C
	`clackup`:	Public ordinary functions
	`copy-handler`:	Private ordinary functions

E
	`eval-file`:	Public ordinary functions

F
	`find-handler`:	Public ordinary functions
	`Function, %load-file`:	Private ordinary functions
	`Function, (setf handler-acceptor)`:	Private ordinary functions
	`Function, (setf handler-server)`:	Private ordinary functions
	`Function, (setf handler-swank-port)`:	Private ordinary functions
	`Function, clackup`:	Public ordinary functions
	`Function, copy-handler`:	Private ordinary functions
	`Function, eval-file`:	Public ordinary functions
	`Function, find-handler`:	Public ordinary functions
	`Function, handler-acceptor`:	Private ordinary functions
	`Function, handler-p`:	Private ordinary functions
	`Function, handler-server`:	Private ordinary functions
	`Function, handler-swank-port`:	Private ordinary functions
	`Function, make-handler`:	Private ordinary functions
	`Function, run`:	Public ordinary functions
	`Function, stop`:	Public ordinary functions

H
	`handler-acceptor`:	Private ordinary functions
	`handler-p`:	Private ordinary functions
	`handler-server`:	Private ordinary functions
	`handler-swank-port`:	Private ordinary functions

M
	`Macro, with-handle-interrupt`:	Private macros
	`make-handler`:	Private ordinary functions

R
	`run`:	Public ordinary functions

S
	`stop`:	Public ordinary functions

W
	`with-handle-interrupt`:	Private macros

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

A.3 Variables

Jump to:	* A S

	Index Entry	Section

*
	`app-file-cache`:	Private special variables

A
	`acceptor`:	Private structures

S
	`server`:	Private structures
	`Slot, acceptor`:	Private structures
	`Slot, server`:	Private structures
	`Slot, swank-port`:	Private structures
	`Special Variable, app-file-cache`:	Private special variables
	`swank-port`:	Private structures

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

A.4 Data types

Jump to:	C F H M P S U

	Index Entry	Section

C
	`clack`:	The clack system
	`clack`:	The clack package
	`clack.asd`:	The clack/clack․asd file
	`clack.handler`:	The clack․handler package
	`clack.lisp`:	The clack/src/clack․lisp file
	`clack.util`:	The clack․util package

F
	`File, clack.asd`:	The clack/clack․asd file
	`File, clack.lisp`:	The clack/src/clack․lisp file
	`File, handler.lisp`:	The clack/src/handler․lisp file
	`File, util.lisp`:	The clack/src/util․lisp file

H
	`handler`:	Private structures
	`handler.lisp`:	The clack/src/handler․lisp file

M
	`Module, src`:	The clack/src module

P
	`Package, clack`:	The clack package
	`Package, clack.handler`:	The clack․handler package
	`Package, clack.util`:	The clack․util package

S
	`src`:	The clack/src module
	`Structure, handler`:	Private structures
	`System, clack`:	The clack system

U
	`util.lisp`:	The clack/src/util․lisp file

The clack Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 clack

3 Modules

3.1 clack/src

4 Files

4.1 Lisp

4.1.1 clack/clack.asd

4.1.2 clack/src/clack.lisp

4.1.3 clack/src/handler.lisp

4.1.4 clack/src/util.lisp

5 Packages

5.1 clack.util

5.2 clack.handler

5.3 clack

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Special variables

6.2.2 Macros

6.2.3 Ordinary functions

6.2.4 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `clack`

3.1 `clack/src`

4.1.1 `clack/clack.asd`

4.1.2 `clack/src/clack.lisp`

4.1.3 `clack/src/handler.lisp`

4.1.4 `clack/src/util.lisp`

5.1 `clack.util`

5.2 `clack.handler`

5.3 `clack`