The cl-server-manager Reference Manual

This is the cl-server-manager Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:42:32 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-server-manager

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

Author

Wei Peng <>

License

MIT

Version

0.1

Dependencies
  • alexandria (system).
  • swank (system).
  • hunchentoot (system).
  • prepl (system).
Source

cl-server-manager.asd.

Child Components

3 Modules

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


3.1 cl-server-manager/types

Dependency

util.lisp (file).

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

Child Components

3.2 cl-server-manager/vendors

Dependency

types (module).

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

Child Components

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/cl-server-manager.asd

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

ASDF Systems

cl-server-manager.


4.1.2 cl-server-manager/package.lisp

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

Packages

cl-server-manager.


4.1.3 cl-server-manager/manager.lisp

Dependency

package.lisp (file).

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

Public Interface
Internals

4.1.4 cl-server-manager/util.lisp

Dependency

manager.lisp (file).

Source

cl-server-manager.asd.

Parent Component

cl-server-manager (system).

Public Interface

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

Source

cl-server-manager.asd.

Parent Component

types (module).

Public Interface

server-console (class).


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

Source

cl-server-manager.asd.

Parent Component

types (module).

Public Interface

server-http (class).


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

Source

cl-server-manager.asd.

Parent Component

types (module).

Public Interface

server-https (class).


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

Source

cl-server-manager.asd.

Parent Component

vendors (module).

Public Interface
Internals

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

Source

cl-server-manager.asd.

Parent Component

vendors (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 cl-server-manager

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


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)

Register server vendor by type.

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.


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.

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.

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

cl-server-manager.

Source

manager.lisp.

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

cl-server-manager.

Source

manager.lisp.

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.


6.1.3 Classes

Class: hunchentoot
Package

cl-server-manager.

Source

hunchentoot.lisp.

Direct superclasses
Direct methods
Class: server
Package

cl-server-manager.

Source

manager.lisp.

Direct subclasses
Direct methods
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

cl-server-manager.

Source

swank.lisp.

Direct superclasses

server-console.

Direct methods
Direct slots
Slot: port-pathname

pathname to save port

Initargs

:port-pathname

Readers

port-pathname.

Writers

(setf port-pathname).


6.2 Internals


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.


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.


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.


6.2.4 Generic functions

Generic Reader: port-pathname (object)
Generic Writer: (setf port-pathname) (object)
Package

cl-server-manager.

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

cl-server-manager.

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

cl-server-manager.

Methods
Reader Method: server-ports ((server server))
Writer Method: (setf server-ports) ((server server))

Client interface.

Source

manager.lisp.

Target Slot

ports.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
D   F   G   L   M   P   Q   R   S  
Index Entry  Section

(
(setf default-server-class): Private ordinary functions
(setf default-server-make-server-initargs): Private ordinary functions
(setf default-server-name): Private ordinary functions
(setf default-server-port): Private ordinary functions
(setf default-server-start-initargs): Private ordinary functions
(setf port-pathname): Private generic functions
(setf port-pathname): Private generic functions
(setf server-name): Private generic functions
(setf server-name): Private generic functions
(setf server-ports): Private generic functions
(setf server-ports): Private generic functions

D
default-server-class: Private ordinary functions
default-server-make-server-initargs: Private ordinary functions
default-server-name: Private ordinary functions
default-server-port: Private ordinary functions
default-server-start-initargs: Private ordinary functions
define-default: Private macros
define-defaults: Private macros
define-server-type-with-defaults: Private macros

F
find-port: Public ordinary functions
find-server: Public ordinary functions
Function, (setf default-server-class): Private ordinary functions
Function, (setf default-server-make-server-initargs): Private ordinary functions
Function, (setf default-server-name): Private ordinary functions
Function, (setf default-server-port): Private ordinary functions
Function, (setf default-server-start-initargs): Private ordinary functions
Function, default-server-class: Private ordinary functions
Function, default-server-make-server-initargs: Private ordinary functions
Function, default-server-name: Private ordinary functions
Function, default-server-port: Private ordinary functions
Function, default-server-start-initargs: Private ordinary functions
Function, find-port: Public ordinary functions
Function, find-server: Public ordinary functions
Function, launch-system-with-defaults: Public ordinary functions
Function, list-ports: Public ordinary functions
Function, list-server-types: Public ordinary functions
Function, list-server-vendors: Public ordinary functions
Function, list-servers: Public ordinary functions
Function, register-server-vendor-by-type: Public ordinary functions
Function, remove-port: Public ordinary functions
Function, remove-server: Public ordinary functions
Function, set-server-type-defaults: Private ordinary functions
Function, show-server-type-defaults: Private ordinary functions
Function, shutdown-all-servers: Public ordinary functions
Function, shutdown-server: Public ordinary functions

G
Generic Function, (setf port-pathname): Private generic functions
Generic Function, (setf server-name): Private generic functions
Generic Function, (setf server-ports): Private generic functions
Generic Function, make-server: Public generic functions
Generic Function, port-pathname: Private generic functions
Generic Function, query: Public generic functions
Generic Function, server-name: Private generic functions
Generic Function, server-ports: Private generic functions
Generic Function, start: Public generic functions
Generic Function, stop: Public generic functions

L
launch-system-with-defaults: Public ordinary functions
list-ports: Public ordinary functions
list-server-types: Public ordinary functions
list-server-vendors: Public ordinary functions
list-servers: Public ordinary functions

M
Macro, define-default: Private macros
Macro, define-defaults: Private macros
Macro, define-server-type-with-defaults: Private macros
make-server: Public generic functions
make-server: Public generic functions
Method, (setf port-pathname): Private generic functions
Method, (setf server-name): Private generic functions
Method, (setf server-ports): Private generic functions
Method, make-server: Public generic functions
Method, port-pathname: Private generic functions
Method, query: Public generic functions
Method, query: Public generic functions
Method, server-name: Private generic functions
Method, server-ports: Private generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, start: Public generic functions
Method, stop: Public generic functions
Method, stop: Public generic functions
Method, stop: Public generic functions
Method, stop: Public generic functions

P
port-pathname: Private generic functions
port-pathname: Private generic functions

Q
query: Public generic functions
query: Public generic functions
query: Public generic functions

R
register-server-vendor-by-type: Public ordinary functions
remove-port: Public ordinary functions
remove-server: Public ordinary functions

S
server-name: Private generic functions
server-name: Private generic functions
server-ports: Private generic functions
server-ports: Private generic functions
set-server-type-defaults: Private ordinary functions
show-server-type-defaults: Private ordinary functions
shutdown-all-servers: Public ordinary functions
shutdown-server: Public ordinary functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
start: Public generic functions
stop: Public generic functions
stop: Public generic functions
stop: Public generic functions
stop: Public generic functions
stop: Public generic functions


A.4 Data types

Jump to:   C   F   H   M   P   S   T   U   V  
Index Entry  Section

C
cl-server-manager: The cl-server-manager system
cl-server-manager: The cl-server-manager package
cl-server-manager.asd: The cl-server-manager/cl-server-manager․asd file
Class, hunchentoot: Public classes
Class, server: Public classes
Class, server-console: Public classes
Class, server-http: Public classes
Class, server-https: Public classes
Class, swank: Public classes
console.lisp: The cl-server-manager/types/console․lisp file

F
File, cl-server-manager.asd: The cl-server-manager/cl-server-manager․asd file
File, console.lisp: The cl-server-manager/types/console․lisp file
File, http.lisp: The cl-server-manager/types/http․lisp file
File, https.lisp: The cl-server-manager/types/https․lisp file
File, hunchentoot.lisp: The cl-server-manager/vendors/hunchentoot․lisp file
File, manager.lisp: The cl-server-manager/manager․lisp file
File, package.lisp: The cl-server-manager/package․lisp file
File, swank.lisp: The cl-server-manager/vendors/swank․lisp file
File, util.lisp: The cl-server-manager/util․lisp file

H
http.lisp: The cl-server-manager/types/http․lisp file
https.lisp: The cl-server-manager/types/https․lisp file
hunchentoot: Public classes
hunchentoot.lisp: The cl-server-manager/vendors/hunchentoot․lisp file

M
manager.lisp: The cl-server-manager/manager․lisp file
Module, types: The cl-server-manager/types module
Module, vendors: The cl-server-manager/vendors module

P
Package, cl-server-manager: The cl-server-manager package
package.lisp: The cl-server-manager/package․lisp file

S
server: Public classes
server-console: Public classes
server-http: Public classes
server-https: Public classes
swank: Public classes
swank.lisp: The cl-server-manager/vendors/swank․lisp file
System, cl-server-manager: The cl-server-manager system

T
types: The cl-server-manager/types module

U
util.lisp: The cl-server-manager/util․lisp file

V
vendors: The cl-server-manager/vendors module