The clack Reference Manual

This is the clack Reference Manual, version 2.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:20:43 2022 GMT+0.

1 Introduction

Clack - Web Application Environment for Common Lisp

Clack is a web application environment for Common Lisp inspired by Python's WSGI and Ruby's Rack.

Usage

(defvar *handler*
    (clack:clackup
      (lambda (env)
        (declare (ignore env))
        '(200 (:content-type "text/plain") ("Hello, Clack!")))))

Open your web browser and go to http://localhost:5000/. You should get "Hello, Clack!".

To stop the server, use (clack:stop *handler*).

Command-line interface

Clack provides a script to start a web server. It's useful when you deploy to production environment.

NOTE: Install Roswell before as it depends on it.

When you execute ros install clack, it copies clackup script to $HOME/.roswell/bin. Make sure the path is in your shell $PATH.

$ ros install clack
$ which clackup
/Users/nitro_idiot/.roswell/bin/clackup

$ cat <<EOF >> app.lisp
(lambda (env)
  (declare (ignore env))
  '(200 (:content-type "text/plain") ("Hello, Clack!")))
EOF
$ clackup app.lisp
Hunchentoot server is started.
Listening on localhost:5000.

Installation

(ql:quickload :clack)

Documentation

Quickdocs Page

Server

How to contribute

See CONTRIBUTING.md.

Author

Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

License

Licensed under the LLGPL License.

2 Systems

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

2.1 `clack`

Author

Eitaro Fukamachi

License

LLGPL

Description

Web application environment for Common Lisp

Long Description

# Clack - Web Application Environment for Common Lisp

[![Build Status](https://travis-ci.org/fukamachi/clack.svg?branch=master)](https://travis-ci.org/fukamachi/clack)
[![Coverage Status](https://coveralls.io/repos/fukamachi/clack/badge.svg?branch=master)](https://coveralls.io/r/fukamachi/clack) [![Quicklisp dist](http://quickdocs.org/badge/clack.svg)](http://quickdocs.org/clack/)

Clack is a web application environment for Common Lisp inspired by Python’s WSGI and Ruby’s Rack.

## Usage

“‘common-lisp
(defvar *handler*
(clack:clackup
(lambda (env)
(declare (ignore env))
’(200 (:content-type "text/plain") ("Hello, Clack!")))))
“‘

Open your web browser and go to [http://localhost:5000/](http://localhost:5000/). You should get "Hello, Clack!".

To stop the server, use ‘(clack:stop *handler*)‘.

## Command-line interface

Clack provides a script to start a web server. It’s useful when you deploy to production environment.

NOTE: Install [Roswell](https://github.com/snmsts/roswell) before as it depends on it.

When you execute ‘ros install clack‘, it copies ‘clackup‘ script to ‘$HOME/.roswell/bin‘. Make sure the path is in your shell ‘$PATH‘.

$ ros install clack
$ which clackup
/Users/nitro_idiot/.roswell/bin/clackup

$ cat <<EOF >> app.lisp
(lambda (env)
(declare (ignore env))
’(200 (:content-type "text/plain") ("Hello, Clack!")))
EOF
$ clackup app.lisp
Hunchentoot server is started.
Listening on localhost:5000.

## Installation

“‘common-lisp
(ql:quickload :clack)
“‘

## Documentation

- [Quickdocs Page](http://quickdocs.org/clack/)

## Server

* [Hunchentoot](http://weitz.de/hunchentoot/)
* [FastCGI](http://www.fastcgi.com/)
* [Wookie](http://wookie.beeets.com/)
* [Toot](https://github.com/gigamonkey/toot)
* [Woo](https://github.com/fukamachi/woo)

## How to contribute

See [CONTRIBUTING.md](CONTRIBUTING.md).

## See Also

* [Lack](https://github.com/fukamachi/lack): Clack application builder

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

## License

Licensed under the LLGPL License.

Version

2.0.0

Dependencies

lack
lack-middleware-backtrace
lack-util
bordeaux-threads
usocket
alexandria
uiop

Source

clack.asd (file)

Component

src (module)

3 Modules

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

3.1 `clack/src`

Parent

clack (system)

Location

src/

Components

clack.lisp (file)
handler.lisp (file)
util.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 `clack.asd`

Location: clack.asd
Systems: clack (system)
Packages: clack-asd

4.1.2 `clack/src/clack.lisp`

Dependencies

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

Parent

src (module)

Location

src/clack.lisp

Packages

clack

Exported Definitions

clackup (function)
eval-file (function)

Internal Definitions

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

4.1.3 `clack/src/handler.lisp`

Dependency

util.lisp (file)

Parent

src (module)

Location

src/handler.lisp

Packages

clack.handler

Exported Definitions

run (function)
stop (function)

Internal Definitions

copy-handler (function)
handler (structure)
handler-acceptor (function)
(setf handler-acceptor) (function)
handler-p (function)
handler-server (function)
(setf handler-server) (function)
make-handler (function)

4.1.4 `clack/src/util.lisp`

Parent: src (module)
Location: src/util.lisp
Packages: clack.util
Exported Definitions: find-handler (function)

5 Packages

Packages are listed by definition order.

5.1 `clack-asd`

Source

clack.asd

Use List

asdf/interface
common-lisp

5.2 `clack`

Source

clack.lisp (file)

Use List

common-lisp

Exported Definitions

clackup (function)
eval-file (function)

Internal Definitions

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

5.3 `clack.handler`

Source

handler.lisp (file)

Use List

common-lisp

Exported Definitions

run (function)
stop (function)

Internal Definitions

copy-handler (function)
handler (structure)
handler-acceptor (function)
(setf handler-acceptor) (function)
handler-p (function)
handler-server (function)
(setf handler-server) (function)
make-handler (function)

5.4 `clack.util`

Source: util.lisp (file)
Use List: common-lisp
Exported Definitions: find-handler (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: clackup APP &rest ARGS &key SERVER ADDRESS PORT DEBUG SILENT USE-THREAD USE-DEFAULT-MIDDLEWARES &allow-other-keys

Package: clack
Source: clack.lisp (file)

Function: eval-file FILE

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

Package: clack
Source: clack.lisp (file)

Function: find-handler SERVER

Package: clack.util
Source: util.lisp (file)

Function: run APP SERVER &rest ARGS &key ADDRESS USE-THREAD &allow-other-keys

Package: clack.handler
Source: handler.lisp (file)

Function: stop HANDLER

Package: clack.handler
Source: handler.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *app-file-cache*

Package: clack
Source: clack.lisp (file)

6.2.2 Macros

Macro: with-handle-interrupt INT-HANDLER &body BODY

Package: clack
Source: clack.lisp (file)

6.2.3 Functions

Function: %load-file FILE

Package: clack
Source: clack.lisp (file)

Function: copy-handler INSTANCE

Package: clack.handler
Source: handler.lisp (file)

Function: handler-acceptor INSTANCE

Function: (setf handler-acceptor) VALUE INSTANCE

Package: clack.handler
Source: handler.lisp (file)

Function: handler-p OBJECT

Package: clack.handler
Source: handler.lisp (file)

Function: handler-server INSTANCE

Function: (setf handler-server) VALUE INSTANCE

Package: clack.handler
Source: handler.lisp (file)

Function: make-handler &key (SERVER SERVER) (ACCEPTOR ACCEPTOR)

Package: clack.handler
Source: handler.lisp (file)

6.2.4 Structures

Structure: handler ()

Package

clack.handler

Source

handler.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: server

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

Slot: acceptor

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

Appendix A Indexes

A.1 Concepts

Jump to:	C F L M

	Index Entry	Section

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

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

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

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

Jump to:	C F L M

A.2 Functions

Jump to:	% ( C E F H M R S W

	Index Entry	Section

%
	`%load-file`:	Internal functions

(
	`(setf handler-acceptor)`:	Internal functions
	`(setf handler-server)`:	Internal functions

C
	`clackup`:	Exported functions
	`copy-handler`:	Internal functions

E
	`eval-file`:	Exported functions

F
	`find-handler`:	Exported functions
	`Function, %load-file`:	Internal functions
	`Function, (setf handler-acceptor)`:	Internal functions
	`Function, (setf handler-server)`:	Internal functions
	`Function, clackup`:	Exported functions
	`Function, copy-handler`:	Internal functions
	`Function, eval-file`:	Exported functions
	`Function, find-handler`:	Exported functions
	`Function, handler-acceptor`:	Internal functions
	`Function, handler-p`:	Internal functions
	`Function, handler-server`:	Internal functions
	`Function, make-handler`:	Internal functions
	`Function, run`:	Exported functions
	`Function, stop`:	Exported functions

H
	`handler-acceptor`:	Internal functions
	`handler-p`:	Internal functions
	`handler-server`:	Internal functions

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

R
	`run`:	Exported functions

S
	`stop`:	Exported functions

W
	`with-handle-interrupt`:	Internal macros

Jump to:	% ( C E F H M R S W

A.3 Variables

Jump to:	* A S

	Index Entry	Section

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

A
	`acceptor`:	Internal structures

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

Jump to:	* A S

A.4 Data types

Jump to:	C H P S

	Index Entry	Section

C
	`clack`:	The clack system
	`clack`:	The clack package
	`clack-asd`:	The clack-asd package
	`clack.handler`:	The clack․handler package
	`clack.util`:	The clack․util package

H
	`handler`:	Internal structures

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

S
	`Structure, handler`:	Internal structures
	`System, clack`:	The clack system

Jump to:	C H P S

• Introduction		What clack is all about
• Systems		The systems documentation
• Modules		The modules documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The clack.asd file
• The clack/src/clack.lisp file
• The clack/src/handler.lisp file
• The clack/src/util.lisp file

• The clack-asd package
• The clack package
• The clack.handler package
• The clack.util package

• Internal special variables
• Internal macros
• Internal functions
• Internal structures

• Concept index
• Function index
• Variable index
• Data type index

The clack Reference Manual

Table of Contents

The clack Reference Manual

1 Introduction

Clack - Web Application Environment for Common Lisp

Usage

Command-line interface

Installation

Documentation

Server

How to contribute

See Also

Author

Copyright

License

2 Systems

2.1 clack

3 Modules

3.1 clack/src

4 Files

4.1 Lisp

4.1.1 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-asd

5.2 clack

5.3 clack.handler

5.4 clack.util

6 Definitions

6.1 Exported definitions

6.1.1 Functions

6.2 Internal definitions

6.2.1 Special variables

6.2.2 Macros

6.2.3 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.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-asd`

5.2 `clack`

5.3 `clack.handler`

5.4 `clack.util`