The clack Reference Manual

Table of Contents

The clack Reference Manual

This is the clack Reference Manual, version 2.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:28:56 2018 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

• Hunchentoot
• FastCGI
• Wookie
• Toot
• Woo

How to contribute

See CONTRIBUTING.md.

See Also

• Lack: Clack application builder

Author

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

Copyright

Copyright (c) 2011-2015 Eitaro Fukamachi & contributors

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

[](https://travis-ci.org/fukamachi/clack)
[](https://coveralls.io/r/fukamachi/clack) [](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

Copyright (c) 2011-2015 Eitaro Fukamachi & [contributors](https://github.com/fukamachi/clack/graphs/contributors)

## License

Licensed under the LLGPL License.

Version

2.0.0

Dependencies

• lack
• lack-middleware-backtrace
• lack-util
• bordeaux-threads
• 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)

Internal Definitions

• eval-file (function)
• 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)

Internal Definitions

• eval-file (function)
• 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 PORT DEBUG SILENT USE-THREAD USE-DEFAULT-MIDDLEWARES &allow-other-keys

Package

clack

Source

clack.lisp (file)

Function: find-handler SERVER

Package

clack.util

Source

util.lisp (file)

Function: run APP SERVER &rest ARGS &key 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 Macros

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

Package

clack

Source

clack.lisp (file)

6.2.2 Functions

Function: copy-handler INSTANCE

Package

clack.handler

Source

handler.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: 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.3 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

A.2 Functions

A.3 Variables

A.4 Data types