The modlisp Reference Manual

Table of Contents

The modlisp Reference Manual

This is the modlisp Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:03:29 2021 GMT+0.

1 Systems

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

1.1 modlisp

Dependency

kmrcl

Source

modlisp.asd (file)

Components

• package.lisp (file)
• variables.lisp (file)
• base.lisp (file)
• utils.lisp (file)
• demo.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 modlisp.asd

Location

modlisp.asd

Systems

modlisp (system)

Packages

modlisp-system

2.1.2 modlisp/package.lisp

Parent

modlisp (system)

Location

package.lisp

Packages

modlisp

2.1.3 modlisp/variables.lisp

Dependency

package.lisp (file)

Parent

modlisp (system)

Location

variables.lisp

Exported Definitions

• *close-modlisp-socket* (special variable)
• *ml-server* (special variable)
• *modlisp-socket* (special variable)
• *number-server-requests* (special variable)
• *number-worker-requests* (special variable)

Internal Definitions

• +default-modlisp-port+ (constant)
• ml-server (class)
• port (method)
• (setf port) (method)
• processor (method)
• (setf processor) (method)
• processor-args (method)
• (setf processor-args) (method)

2.1.4 modlisp/base.lisp

Dependency

variables.lisp (file)

Parent

modlisp (system)

Location

base.lisp

Exported Definitions

• header-value (function)
• modlisp-start (function)
• modlisp-stop (function)
• modlisp-stop-all (function)
• write-header-line (function)

Internal Definitions

• modlisp-command-issuer (function)
• read-modlisp-command (function)
• read-modlisp-header (function)
• read-modlisp-line (function)

2.1.5 modlisp/utils.lisp

Dependency

base.lisp (file)

Parent

modlisp (system)

Location

utils.lisp

Exported Definitions

• output-html-page (function)
• output-ml-page (macro)
• output-xml-page (function)
• query-to-alist (function)
• redirect-to-location (function)
• with-ml-page (macro)

Internal Definitions

• format->string (function)
• format-string (function)
• write-response (macro)

2.1.6 modlisp/demo.lisp

Dependency

utils.lisp (file)

Parent

modlisp (system)

Location

demo.lisp

Internal Definitions

• demo-modlisp-command-processor (function)
• fetch-mod-lisp-url (function)
• fixed-html-string (function)
• read-reply (function)
• write-debug-table (function)
• write-precomputed-page (function)
• write-request-counts (function)

3 Packages

Packages are listed by definition order.

3.1 modlisp-system

Source

modlisp.asd

Use List

• asdf/interface
• common-lisp

3.2 modlisp

Source

package.lisp (file)

Nickname

ml

Use List

• kmrcl
• common-lisp

Exported Definitions

• *close-modlisp-socket* (special variable)
• *ml-server* (special variable)
• *modlisp-socket* (special variable)
• *number-server-requests* (special variable)
• *number-worker-requests* (special variable)
• header-value (function)
• modlisp-start (function)
• modlisp-stop (function)
• modlisp-stop-all (function)
• output-html-page (function)
• output-ml-page (macro)
• output-xml-page (function)
• query-to-alist (function)
• redirect-to-location (function)
• with-ml-page (macro)
• write-header-line (function)

Internal Definitions

• +default-modlisp-port+ (constant)
• demo-modlisp-command-processor (function)
• fetch-mod-lisp-url (function)
• fixed-html-string (function)
• format->string (function)
• format-string (function)
• ml-server (class)
• modlisp-command-issuer (function)
• port (generic function)
• port (method)
• (setf port) (method)
• (setf port) (generic function)
• processor (generic function)
• processor (method)
• (setf processor) (method)
• (setf processor) (generic function)
• processor-args (generic function)
• processor-args (method)
• (setf processor-args) (method)
• (setf processor-args) (generic function)
• read-modlisp-command (function)
• read-modlisp-header (function)
• read-modlisp-line (function)
• read-reply (function)
• write-debug-table (function)
• write-precomputed-page (function)
• write-request-counts (function)
• write-response (macro)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *close-modlisp-socket*

whether to close the modlisp socket at the end of this request

Package

modlisp

Source

variables.lisp (file)

Special Variable: *ml-server*

Current ml-server instance

Package

modlisp

Source

variables.lisp (file)

Special Variable: *modlisp-socket*

the socket stream to modlisp

Package

modlisp

Source

variables.lisp (file)

Special Variable: *number-server-requests*

number of requests for the server

Package

modlisp

Source

variables.lisp (file)

Special Variable: *number-worker-requests*

number of requests for this worker process

Package

modlisp

Source

variables.lisp (file)

4.1.2 Macros

Macro: output-ml-page FORMAT HTML &key HEADERS

Package

modlisp

Source

utils.lisp (file)

Macro: with-ml-page (&key FORMAT PRECOMPUTE HEADERS) &body BODY

Package

modlisp

Source

utils.lisp (file)

4.1.3 Functions

Function: header-value HEADER KEY

Returns the value of a modlisp header

Package

modlisp

Source

base.lisp (file)

Function: modlisp-start &key PORT PROCESSOR PROCESSOR-ARGS CATCH-ERRORS TIMEOUT NUMBER-FIXED-WORKERS REMOTE-HOST-CHECKER

Package

modlisp

Source

base.lisp (file)

Function: modlisp-stop SERVER

Package

modlisp

Source

base.lisp (file)

Function: modlisp-stop-all ()

Package

modlisp

Source

base.lisp (file)

Function: output-html-page STR &key HEADERS

Package

modlisp

Source

utils.lisp (file)

Function: output-xml-page STR &key HEADERS

Package

modlisp

Source

utils.lisp (file)

Function: query-to-alist POSTED-STRING &key KEYWORD

Converts a posted string to an assoc list of keyword names and values, "a=1&bc=demo" => ((:a . "1") (:bc . "demo"))

Package

modlisp

Source

utils.lisp (file)

Function: redirect-to-location URL

Package

modlisp

Source

utils.lisp (file)

Function: write-header-line KEY VALUE

Package

modlisp

Source

base.lisp (file)

4.2 Internal definitions

4.2.1 Constants

Constant: +default-modlisp-port+

Default port for listen

Package

modlisp

Source

variables.lisp (file)

4.2.2 Macros

Macro: write-response (&key HEADERS LEN STATUS) &body BODY

Package

modlisp

Source

utils.lisp (file)

4.2.3 Functions

Function: demo-modlisp-command-processor COMMAND

Sample function to process an modlisp command

Package

modlisp

Source

demo.lisp (file)

Function: fetch-mod-lisp-url SERVER URL &key NUM-FETCH PORT CLOSE-SOCKET

Package

modlisp

Source

demo.lisp (file)

Function: fixed-html-string ()

Package

modlisp

Source

demo.lisp (file)

Function: format->string FMT

Package

modlisp

Source

utils.lisp (file)

Function: format-string FMT HEADERS

Package

modlisp

Source

utils.lisp (file)

Function: modlisp-command-issuer *MODLISP-SOCKET* SERVER

generates commands from modlisp, issues commands to processor-fun

Package

modlisp

Source

base.lisp (file)

Function: read-modlisp-command ()

Package

modlisp

Source

base.lisp (file)

Function: read-modlisp-header ()

Package

modlisp

Source

base.lisp (file)

Function: read-modlisp-line ()

Package

modlisp

Source

base.lisp (file)

Function: read-reply SOCKET

Package

modlisp

Source

demo.lisp (file)

Function: write-debug-table COMMAND

Package

modlisp

Source

demo.lisp (file)

Function: write-precomputed-page ()

Package

modlisp

Source

demo.lisp (file)

Function: write-request-counts S

Package

modlisp

Source

demo.lisp (file)

4.2.4 Generic functions

Generic Function: port OBJECT

Generic Function: (setf port) NEW-VALUE OBJECT

Package

modlisp

Methods

Method: port (ML-SERVER ml-server)

automatically generated reader method

Source

variables.lisp (file)

Method: (setf port) NEW-VALUE (ML-SERVER ml-server)

automatically generated writer method

Source

variables.lisp (file)

Generic Function: processor OBJECT

Generic Function: (setf processor) NEW-VALUE OBJECT

Package

modlisp

Methods

Method: processor (ML-SERVER ml-server)

automatically generated reader method

Source

variables.lisp (file)

Method: (setf processor) NEW-VALUE (ML-SERVER ml-server)

automatically generated writer method

Source

variables.lisp (file)

Generic Function: processor-args OBJECT

Generic Function: (setf processor-args) NEW-VALUE OBJECT

Package

modlisp

Methods

Method: processor-args (ML-SERVER ml-server)

automatically generated reader method

Source

variables.lisp (file)

Method: (setf processor-args) NEW-VALUE (ML-SERVER ml-server)

automatically generated writer method

Source

variables.lisp (file)

4.2.5 Classes

Class: ml-server ()

Package

modlisp

Source

variables.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• processor-args (method)
• processor-args (method)
• processor (method)
• processor (method)
• port (method)
• port (method)
• listener (method)
• listener (method)

Direct slots

Slot: listener

Initargs

:listener

Readers

listener (generic function)

Writers

(setf listener) (generic function)

Slot: port

Initargs

:port

Readers

port (generic function)

Writers

(setf port) (generic function)

Slot: processor

Initargs

:processor

Readers

processor (generic function)

Writers

(setf processor) (generic function)

Slot: processor-args

Initargs

:processor-args

Readers

processor-args (generic function)

Writers

(setf processor-args) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types