The cl-server-manager Reference Manual

Child Components

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

Next: Files, Previous: Systems, Up: The cl-server-manager Reference Manual [Contents][Index]

3 Modules

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

cl-server-manager/types
cl-server-manager/vendors

Next: cl-server-manager/vendors, Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-server-manager/types`

Dependency

util.lisp (file).

Source

Parent Component

cl-server-manager (system).

Child Components

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

Previous: cl-server-manager/types, Up: Modules [Contents][Index]

3.2 `cl-server-manager/vendors`

Dependency

types (module).

Source

Parent Component

cl-server-manager (system).

Child Components

swank.lisp (file).
hunchentoot.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-server-manager 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]

4.1 Lisp

cl-server-manager/cl-server-manager.asd
cl-server-manager/package.lisp
cl-server-manager/manager.lisp
cl-server-manager/util.lisp
cl-server-manager/types/console.lisp
cl-server-manager/types/http.lisp
cl-server-manager/types/https.lisp
cl-server-manager/vendors/swank.lisp
cl-server-manager/vendors/hunchentoot.lisp

Next: cl-server-manager/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-server-manager/cl-server-manager.asd`

Source: cl-server-manager.asd.
Parent Component: cl-server-manager (system).
ASDF Systems: cl-server-manager.

Next: cl-server-manager/manager.lisp, Previous: cl-server-manager/cl-server-manager.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-server-manager/package.lisp`

Source: cl-server-manager.asd.
Parent Component: cl-server-manager (system).
Packages: cl-server-manager.

Next: cl-server-manager/util.lisp, Previous: cl-server-manager/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-server-manager/manager.lisp`

Dependency

package.lisp (file).

Source

Parent Component

cl-server-manager (system).

Public Interface

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

Internals

*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 (reader method).
(setf server-name) (writer method).
server-ports (reader method).
(setf server-ports) (writer method).
set-server-type-defaults (function).
show-server-type-defaults (function).

Next: cl-server-manager/types/console.lisp, Previous: cl-server-manager/manager.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-server-manager/util.lisp`

Dependency

manager.lisp (file).

Source

Parent Component

cl-server-manager (system).

Public Interface

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

Next: cl-server-manager/types/http.lisp, Previous: cl-server-manager/util.lisp, Up: Lisp [Contents][Index]

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

Source: cl-server-manager.asd.
Parent Component: types (module).
Public Interface: server-console (class).

Next: cl-server-manager/types/https.lisp, Previous: cl-server-manager/types/console.lisp, Up: Lisp [Contents][Index]

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

Source: cl-server-manager.asd.
Parent Component: types (module).
Public Interface: server-http (class).

Next: cl-server-manager/vendors/swank.lisp, Previous: cl-server-manager/types/http.lisp, Up: Lisp [Contents][Index]

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

Source: cl-server-manager.asd.
Parent Component: types (module).
Public Interface: server-https (class).

Next: cl-server-manager/vendors/hunchentoot.lisp, Previous: cl-server-manager/types/https.lisp, Up: Lisp [Contents][Index]

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

Source

Parent Component

vendors (module).

Public Interface

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

Internals

port-pathname (reader method).
(setf port-pathname) (writer method).

Previous: cl-server-manager/vendors/swank.lisp, Up: Lisp [Contents][Index]

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

Source

Parent Component

vendors (module).

Public Interface

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

Next: Definitions, Previous: Files, Up: The cl-server-manager Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-server-manager

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

5.1 `cl-server-manager`

Source

package.lisp.

Use List

alexandria.
common-lisp.

Public Interface

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).
query (generic function).
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).
stop (generic function).
swank (class).

Internals

*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 reader).
(setf port-pathname) (generic writer).
server-name (generic reader).
(setf server-name) (generic writer).
server-ports (generic reader).
(setf server-ports) (generic writer).
set-server-type-defaults (function).
show-server-type-defaults (function).

Next: Indexes, Previous: Packages, Up: The cl-server-manager 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]

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

6.1.1 Ordinary functions

Function: find-port (&key name port &allow-other-keys) ¶

Find PORT of server with NAME.

Package: cl-server-manager.
Source: manager.lisp.

Function: find-server (&key name &allow-other-keys) ¶

Find a server with NAME.

Package: cl-server-manager.
Source: manager.lisp.

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.

Function: list-ports (&key name &allow-other-keys) ¶

List ports of the server with NAME.

Package: cl-server-manager.
Source: manager.lisp.

Function: list-server-types () ¶

List all server types.

Package: cl-server-manager.
Source: manager.lisp.

Function: list-server-vendors () ¶

List registered server vendors.

Package: cl-server-manager.
Source: manager.lisp.

Function: list-servers () ¶

List all server names.

Package: cl-server-manager.
Source: manager.lisp.

Function: register-server-vendor-by-type (server-type vendor vendor-info) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: remove-port (&key name port &allow-other-keys) ¶

Remove PORT of server with NAME.

Package: cl-server-manager.
Source: manager.lisp.

Function: remove-server (&key name &allow-other-keys) ¶

Remove a server with NAME.

Package: cl-server-manager.
Source: manager.lisp.

Function: shutdown-all-servers () ¶

Shutdown all servers.

Package: cl-server-manager.
Source: util.lisp.

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.

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

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

Source

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

Source

Methods

Method: query ((server hunchentoot) (port integer) &rest args &key &allow-other-keys) ¶

Source: hunchentoot.lisp.

Method: query ((server swank) (port integer) &rest args &key &allow-other-keys) ¶

Source: swank.lisp.

Generic Function: start (server port &rest args &key acceptor-class &allow-other-keys) ¶

Start PORT of SERVER.

Package

Source

Methods

Method: start ((server hunchentoot) (port integer) &rest args &key acceptor-class &allow-other-keys) ¶

Source: hunchentoot.lisp.

Method: start ((server swank) (port integer) &rest args &key &allow-other-keys) ¶

Source: swank.lisp.

Method: start :around ((server server) port &rest args &key &allow-other-keys) ¶: Prevent double start.

Method: start :around ((server (eql nil)) port &rest args &key &allow-other-keys) ¶: Prevent nil start.

Generic Function: stop (server port &rest args &key &allow-other-keys) ¶

Stop PORT of SERVER.

Package

Source

Methods

Method: stop ((server hunchentoot) (port integer) &rest args &key &allow-other-keys) ¶

Source: hunchentoot.lisp.

Method: stop ((server swank) (port integer) &rest args &key &allow-other-keys) ¶

Source: swank.lisp.

Method: stop :around ((server server) port &rest args &key &allow-other-keys) ¶: Prevent double stop.

Method: stop :around ((server (eql nil)) port &rest args &key &allow-other-keys) ¶: Prevent nil stop.

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

6.1.3 Classes

Class: hunchentoot ¶

Package

Source

hunchentoot.lisp.

Direct superclasses

server-http.
server-https.

Direct methods

query.
start.
stop.

Class: server ¶

Package

Source

Direct subclasses

server-console.
server-http.
server-https.

Direct methods

(setf server-name).
server-name.
(setf server-ports).
server-ports.
start.
stop.

Direct slots

Slot: name ¶

Server instance name.

Initargs: :name
Readers: server-name.
Writers: (setf server-name).

Slot: ports ¶

Client interface.

Initform: (make-hash-table :test (quote equal))
Readers: server-ports.
Writers: (setf server-ports).

Class: server-console ¶

Package: cl-server-manager.
Source: console.lisp.
Direct superclasses: server.
Direct subclasses: swank.

Class: server-http ¶

Package: cl-server-manager.
Source: http.lisp.
Direct superclasses: server.
Direct subclasses: hunchentoot.

Class: server-https ¶

Package: cl-server-manager.
Source: https.lisp.
Direct superclasses: server.
Direct subclasses: hunchentoot.

Class: swank ¶

Package

Source

swank.lisp.

Direct superclasses

server-console.

Direct methods

(setf port-pathname).
port-pathname.
query.
start.
stop.

Direct slots

Slot: port-pathname ¶

pathname to save port

Initargs: :port-pathname
Readers: port-pathname.
Writers: (setf port-pathname).

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

6.2 Internals

Special variables
Macros
Ordinary functions
Generic functions

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

6.2.1 Special variables

Special Variable: *default-server-class* ¶

Indexed by SERVER-TYPE.

Package: cl-server-manager.
Source: manager.lisp.

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

Indexed by SERVER-TYPE.

Package: cl-server-manager.
Source: manager.lisp.

Special Variable: *default-server-name* ¶

Indexed by SERVER-TYPE.

Package: cl-server-manager.
Source: manager.lisp.

Special Variable: *default-server-port* ¶

Indexed by SERVER-TYPE.

Package: cl-server-manager.
Source: manager.lisp.

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

Indexed by SERVER-TYPE.

Package: cl-server-manager.
Source: manager.lisp.

Special Variable: *server-types* ¶

Indexed by server TYPE.

Package: cl-server-manager.
Source: manager.lisp.

Special Variable: *servers* ¶

Indexed by server NAME.

Package: cl-server-manager.
Source: manager.lisp.

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

6.2.2 Macros

Macro: define-default (name) ¶

Define a default system parameter with accessor.

Package: cl-server-manager.
Source: manager.lisp.

Macro: define-defaults (&rest names) ¶

Define all default system parameters.

Package: cl-server-manager.
Source: manager.lisp.

Macro: define-server-type-with-defaults (server-type &rest args) ¶

Define SERVER-TYPE with defaults.

Package: cl-server-manager.
Source: manager.lisp.

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

6.2.3 Ordinary functions

Function: default-server-class (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: (setf default-server-class) (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: default-server-make-server-initargs (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: (setf default-server-make-server-initargs) (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: default-server-name (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: (setf default-server-name) (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: default-server-port (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: (setf default-server-port) (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: default-server-start-initargs (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

Function: (setf default-server-start-initargs) (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

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.

Function: show-server-type-defaults (server-type) ¶

Package: cl-server-manager.
Source: manager.lisp.

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

6.2.4 Generic functions

Generic Reader: port-pathname (object) ¶

Generic Writer: (setf port-pathname) (object) ¶

Package

Methods

Reader Method: port-pathname ((swank swank)) ¶

Writer Method: (setf port-pathname) ((swank swank)) ¶

pathname to save port

Source: swank.lisp.
Target Slot: port-pathname.

Generic Reader: server-name (object) ¶

Generic Writer: (setf server-name) (object) ¶

Package

Methods

Reader Method: server-name ((server server)) ¶

Writer Method: (setf server-name) ((server server)) ¶

Server instance name.

Source: manager.lisp.
Target Slot: name.

Generic Reader: server-ports (object) ¶

Generic Writer: (setf server-ports) (object) ¶

Package