The cl-server-manager Reference Manual

Table of Contents

The cl-server-manager Reference Manual

This is the cl-server-manager Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:19:18 2021 GMT+0.

1 Introduction

Common Lisp port-based server manager

Summary

Manage port-based Common Lisp servers (e.g., Swank and Hunchentoot) through a unified interface.

Purpose

Manage multiple instances of port-based servers through a unified interface. This is helpful if you want to quickly incorporate a console and a web server into your Common Lisp application. Swank is useful in providing an interactive interface to your application.

Quick setup (SBCL on Linux as example, YMMV)

• Get Quicklisp. http://www.quicklisp.org/beta/

• Configure ASDF to be able to find it. Copy/paste (optionally adapt) the following shell commands:

mkdir -p $HOME/.config/common-lisp/source-registry.conf.d/50-hacking.conf
echo '(:tree (:home "hacking/common-lisp/"))' > $HOME/.config/common-lisp/source-registry.conf.d/50-hacking.conf
mkdir -p $HOME/hacking/common-lisp
cd $HOME/hacking/common-lisp
git clone https://github.com/pw4ever/cl-server-manager

• To quickly launch it, use the provided Shell script $HOME/hacking/common-lisp/cl-server-manager/00-start-server.sh. It loads the package (with the help of Quicklisp) and drops into prepl (portable REPL).

• An example session inside REPL.

CL-USER> (ql:quickload :cl-server-manager) ; use Quicklisp to load CL-SERVER-MANAGER
To load "cl-server-manager":
  Load 1 ASDF system:
    cl-server-manager
; Loading "cl-server-manager"
........
(:CL-SERVER-MANAGER)
CL-USER> (in-package :cl-server-manager) ; save us from tying the package prefix
#<PACKAGE "CL-SERVER-MANAGER">
CL-SERVER-MANAGER> (launch-system-with-defaults nil :console :http) ; launch the console (Swank) and HTTP (Hunchentoot) servers 
(36325 #<HUNCHENTOOT:ACCEPTOR (host *, port 8085)>)
CL-SERVER-MANAGER> (list-servers) ; Which servers are available?
(:CONSOLE :HTTP)
CL-SERVER-MANAGER> (list-ports :name :console) ; which port the console server is using? now we can "slime-connect" to "127.0.0.1" with port "36325" to connect to this Lisp image
(36325)
CL-SERVER-MANAGER> (list-ports :name :http) ; which port the HTTP server is using? direct your browser to http://localhost:8085 
(8085)
CL-SERVER-MANAGER> (shutdown-server :name :http) ; shutdown the HTTP server
(NIL)
CL-SERVER-MANAGER> (shutdown-all-servers) ; quickly shutdown all servers
((T))
CL-SERVER-MANAGER> 

tips

• SLIME's documentation facility (especially "slime-apropos-package" with keymap "C-c C-d p") helps understanding the user interface.

• Alternatively, take a look at the export list of "package.lisp."

2 Systems

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

2.1 cl-server-manager

Author

Wei Peng <write.to.peng.wei@gmail.com>

License

MIT

Description

Manage port-based servers (e.g., Swank and Hunchentoot) through a unified interface.

Version

0.1

Dependencies

• alexandria
• swank
• hunchentoot
• prepl

Source

cl-server-manager.asd (file)

Components

• package.lisp (file)
• manager.lisp (file)
• util.lisp (file)
• types (module)
• vendors (module)

3 Modules

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

3.1 cl-server-manager/types

Dependency

util.lisp (file)

Parent

cl-server-manager (system)

Location

types/

Components

• console.lisp (file)
• http.lisp (file)
• https.lisp (file)

3.2 cl-server-manager/vendors

Dependency

types (module)

Parent

cl-server-manager (system)

Location

vendors/

Components

• swank.lisp (file)
• hunchentoot.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 cl-server-manager.asd

Location

cl-server-manager.asd

Systems

cl-server-manager (system)

4.1.2 cl-server-manager/package.lisp

Parent

cl-server-manager (system)

Location

package.lisp

Packages

cl-server-manager

4.1.3 cl-server-manager/manager.lisp

Dependency

package.lisp (file)

Parent

cl-server-manager (system)

Location

manager.lisp

Exported Definitions

• find-port (function)
• find-server (function)
• list-ports (function)
• list-server-types (function)
• list-server-vendors (function)
• list-servers (function)
• make-server (generic function)
• make-server (method)
• query (generic function)
• register-server-vendor-by-type (function)
• remove-port (function)
• remove-server (function)
• server (class)
• shutdown-server (function)
• start (generic function)
• start (method)
• start (method)
• stop (generic function)
• stop (method)
• stop (method)

Internal Definitions

• *default-server-class* (special variable)
• *default-server-make-server-initargs* (special variable)
• *default-server-name* (special variable)
• *default-server-port* (special variable)
• *default-server-start-initargs* (special variable)
• *server-types* (special variable)
• *servers* (special variable)
• default-server-class (function)
• (setf default-server-class) (function)
• default-server-make-server-initargs (function)
• (setf default-server-make-server-initargs) (function)
• default-server-name (function)
• (setf default-server-name) (function)
• default-server-port (function)
• (setf default-server-port) (function)
• default-server-start-initargs (function)
• (setf default-server-start-initargs) (function)
• define-default (macro)
• define-defaults (macro)
• define-server-type-with-defaults (macro)
• server-name (method)
• (setf server-name) (method)
• server-ports (method)
• (setf server-ports) (method)
• set-server-type-defaults (function)
• show-server-type-defaults (function)

4.1.4 cl-server-manager/util.lisp

Dependency

manager.lisp (file)

Parent

cl-server-manager (system)

Location

util.lisp

Exported Definitions

• launch-system-with-defaults (function)
• shutdown-all-servers (function)

4.1.5 cl-server-manager/types/console.lisp

Parent

types (module)

Location

types/console.lisp

Exported Definitions

server-console (class)

4.1.6 cl-server-manager/types/http.lisp

Parent

types (module)

Location

types/http.lisp

Exported Definitions

server-http (class)

4.1.7 cl-server-manager/types/https.lisp

Parent

types (module)

Location

types/https.lisp

Exported Definitions

server-https (class)

4.1.8 cl-server-manager/vendors/swank.lisp

Parent

vendors (module)

Location

vendors/swank.lisp

Exported Definitions

• query (method)
• start (method)
• stop (method)
• swank (class)

Internal Definitions

• port-pathname (method)
• (setf port-pathname) (method)

4.1.9 cl-server-manager/vendors/hunchentoot.lisp

Parent

vendors (module)

Location

vendors/hunchentoot.lisp

Exported Definitions

• hunchentoot (class)
• query (method)
• start (method)
• stop (method)

5 Packages

Packages are listed by definition order.

5.1 cl-server-manager

Source

package.lisp (file)

Use List

• alexandria
• common-lisp

Exported Definitions

• find-port (function)
• find-server (function)
• hunchentoot (class)
• launch-system-with-defaults (function)
• list-ports (function)
• list-server-types (function)
• list-server-vendors (function)
• list-servers (function)
• make-server (generic function)
• make-server (method)
• query (generic function)
• query (method)
• query (method)
• register-server-vendor-by-type (function)
• remove-port (function)
• remove-server (function)
• server (class)
• server-console (class)
• server-http (class)
• server-https (class)
• shutdown-all-servers (function)
• shutdown-server (function)
• start (generic function)
• start (method)
• start (method)
• start (method)
• start (method)
• stop (generic function)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• swank (class)

Internal Definitions

• *default-server-class* (special variable)
• *default-server-make-server-initargs* (special variable)
• *default-server-name* (special variable)
• *default-server-port* (special variable)
• *default-server-start-initargs* (special variable)
• *server-types* (special variable)
• *servers* (special variable)
• default-server-class (function)
• (setf default-server-class) (function)
• default-server-make-server-initargs (function)
• (setf default-server-make-server-initargs) (function)
• default-server-name (function)
• (setf default-server-name) (function)
• default-server-port (function)
• (setf default-server-port) (function)
• default-server-start-initargs (function)
• (setf default-server-start-initargs) (function)
• define-default (macro)
• define-defaults (macro)
• define-server-type-with-defaults (macro)
• port-pathname (generic function)
• port-pathname (method)
• (setf port-pathname) (method)
• (setf port-pathname) (generic function)
• server-name (generic function)
• server-name (method)
• (setf server-name) (method)
• (setf server-name) (generic function)
• server-ports (generic function)
• server-ports (method)
• (setf server-ports) (method)
• (setf server-ports) (generic function)
• set-server-type-defaults (function)
• show-server-type-defaults (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: find-port &key NAME PORT &allow-other-keys

Find PORT of server with NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Function: find-server &key NAME &allow-other-keys

Find a server with NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Function: launch-system-with-defaults START-REPL-P &rest SERVER-TYPES

Load the SERVER-TYPES with defaults; launch REPL if START-REPL-P.

Package

cl-server-manager

Source

util.lisp (file)

Function: list-ports &key NAME &allow-other-keys

List ports of the server with NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Function: list-server-types ()

List all server types.

Package

cl-server-manager

Source

manager.lisp (file)

Function: list-server-vendors ()

List registered server vendors.

Package

cl-server-manager

Source

manager.lisp (file)

Function: list-servers ()

List all server names.

Package

cl-server-manager

Source

manager.lisp (file)

Function: register-server-vendor-by-type SERVER-TYPE VENDOR VENDOR-INFO

Register server vendor by type.

Package

cl-server-manager

Source

manager.lisp (file)

Function: remove-port &key NAME PORT &allow-other-keys

Remove PORT of server with NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Function: remove-server &key NAME &allow-other-keys

Remove a server with NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Function: shutdown-all-servers ()

Shutdown all servers.

Package

cl-server-manager

Source

util.lisp (file)

Function: shutdown-server &key NAME &allow-other-keys

Stop all PORTS of the server with NAME and remove it; return the STOP result for the PORTS.

Package

cl-server-manager

Source

manager.lisp (file)

6.1.2 Generic functions

Generic Function: make-server SERVER-CLASS &rest ARGS &key NAME &allow-other-keys

Make a server of SERVER-CLASS with a given NAME.

Package

cl-server-manager

Source

manager.lisp (file)

Methods

Method: make-server SERVER-CLASS &rest ARGS &key NAME &allow-other-keys

Generic Function: query SERVER PORT &rest ARGS &key &allow-other-keys

Query PORT of SERVER.

Package

cl-server-manager

Source

manager.lisp (file)

Methods

Method: query (SERVER hunchentoot) (PORT integer) &rest ARGS &key &allow-other-keys

Source

hunchentoot.lisp (file)

Method: query (SERVER swank) (PORT integer) &rest ARGS &key &allow-other-keys

Source

swank.lisp (file)

Generic Function: start SERVER PORT &rest ARGS &key ACCEPTOR-CLASS &allow-other-keys

Start PORT of SERVER.

Package

cl-server-manager

Source

manager.lisp (file)

Methods

Method: start (SERVER hunchentoot) (PORT integer) &rest ARGS &key ACCEPTOR-CLASS &allow-other-keys

Source

hunchentoot.lisp (file)

Method: start (SERVER swank) (PORT integer) &rest ARGS &key &allow-other-keys

Source

swank.lisp (file)

Method: start (SERVER server) PORT &rest ARGS &key &allow-other-keys around

Prevent double start.

Method: start (SERVER (eql nil)) PORT &rest ARGS &key &allow-other-keys around

Prevent nil start.

Generic Function: stop SERVER PORT &rest ARGS &key &allow-other-keys

Stop PORT of SERVER.

Package

cl-server-manager

Source

manager.lisp (file)

Methods

Method: stop (SERVER hunchentoot) (PORT integer) &rest ARGS &key &allow-other-keys

Source

hunchentoot.lisp (file)

Method: stop (SERVER swank) (PORT integer) &rest ARGS &key &allow-other-keys

Source

swank.lisp (file)

Method: stop (SERVER server) PORT &rest ARGS &key &allow-other-keys around

Prevent double stop.

Method: stop (SERVER (eql nil)) PORT &rest ARGS &key &allow-other-keys around

Prevent nil stop.

6.1.3 Classes

Class: hunchentoot ()

Package

cl-server-manager

Source

hunchentoot.lisp (file)

Direct superclasses

• server-https (class)
• server-http (class)

Direct methods

• stop (method)
• query (method)
• start (method)

Class: server ()

Package

cl-server-manager

Source

manager.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• server-console (class)
• server-http (class)
• server-https (class)

Direct methods

• stop (method)
• start (method)
• server-ports (method)
• server-ports (method)
• server-name (method)
• server-name (method)

Direct slots

Slot: name

Server instance name.

Initargs

:name

Readers

server-name (generic function)

Writers

(setf server-name) (generic function)

Slot: ports

Client interface.

Initform

(make-hash-table :test (quote equal))

Readers

server-ports (generic function)

Writers

(setf server-ports) (generic function)

Class: server-console ()

Package

cl-server-manager

Source

console.lisp (file)

Direct superclasses

server (class)

Direct subclasses

swank (class)

Class: server-http ()

Package

cl-server-manager

Source

http.lisp (file)

Direct superclasses

server (class)

Direct subclasses

hunchentoot (class)

Class: server-https ()

Package

cl-server-manager

Source

https.lisp (file)

Direct superclasses

server (class)

Direct subclasses

hunchentoot (class)

Class: swank ()

Package

cl-server-manager

Source

swank.lisp (file)

Direct superclasses

server-console (class)

Direct methods

• stop (method)
• query (method)
• start (method)
• port-pathname (method)
• port-pathname (method)

Direct slots

Slot: port-pathname

pathname to save port

Initargs

:port-pathname

Readers

port-pathname (generic function)

Writers

(setf port-pathname) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *default-server-class*

Indexed by SERVER-TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *default-server-make-server-initargs*

Indexed by SERVER-TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *default-server-name*

Indexed by SERVER-TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *default-server-port*

Indexed by SERVER-TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *default-server-start-initargs*

Indexed by SERVER-TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *server-types*

Indexed by server TYPE.

Package

cl-server-manager

Source

manager.lisp (file)

Special Variable: *servers*

Indexed by server NAME.

Package

cl-server-manager

Source

manager.lisp (file)

6.2.2 Macros

Macro: define-default NAME

Define a default system parameter with accessor.

Package

cl-server-manager

Source

manager.lisp (file)

Macro: define-defaults &rest NAMES

Define all default system parameters.

Package

cl-server-manager

Source

manager.lisp (file)

Macro: define-server-type-with-defaults SERVER-TYPE &rest ARGS

Define SERVER-TYPE with defaults.

Package

cl-server-manager

Source

manager.lisp (file)

6.2.3 Functions

Function: default-server-class SERVER-TYPE

Function: (setf default-server-class) VALUE SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

Function: default-server-make-server-initargs SERVER-TYPE

Function: (setf default-server-make-server-initargs) VALUE SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

Function: default-server-name SERVER-TYPE

Function: (setf default-server-name) VALUE SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

Function: default-server-port SERVER-TYPE

Function: (setf default-server-port) VALUE SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

Function: default-server-start-initargs SERVER-TYPE

Function: (setf default-server-start-initargs) VALUE SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

Function: set-server-type-defaults SERVER-TYPE &key CLASS NAME MAKE-SERVER-INITARGS PORT START-INITARGS &allow-other-keys

Package

cl-server-manager

Source

manager.lisp (file)

Function: show-server-type-defaults SERVER-TYPE

Package

cl-server-manager

Source

manager.lisp (file)

6.2.4 Generic functions

Generic Function: port-pathname OBJECT

Generic Function: (setf port-pathname) NEW-VALUE OBJECT

Package

cl-server-manager

Methods

Method: port-pathname (SWANK swank)

Method: (setf port-pathname) NEW-VALUE (SWANK swank)

pathname to save port

Source

swank.lisp (file)

Generic Function: server-name OBJECT

Generic Function: (setf server-name) NEW-VALUE OBJECT

Package

cl-server-manager

Methods

Method: server-name (SERVER server)

Method: (setf server-name) NEW-VALUE (SERVER server)

Server instance name.

Source

manager.lisp (file)

Generic Function: server-ports OBJECT

Generic Function: (setf server-ports) NEW-VALUE OBJECT

Package

cl-server-manager

Methods

Method: server-ports (SERVER server)

Method: (setf server-ports) NEW-VALUE (SERVER server)

Client interface.

Source

manager.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types