The modlisp Reference Manual

This is the modlisp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:15:44 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 modlisp

Dependency

kmrcl (system).

Source

modlisp.asd.

Child Components

2 Files

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


2.1 Lisp


2.1.1 modlisp/modlisp.asd

Source

modlisp.asd.

Parent Component

modlisp (system).

ASDF Systems

modlisp.

Packages

modlisp-system.


2.1.2 modlisp/package.lisp

Source

modlisp.asd.

Parent Component

modlisp (system).

Packages

modlisp.


2.1.3 modlisp/variables.lisp

Dependency

package.lisp (file).

Source

modlisp.asd.

Parent Component

modlisp (system).

Public Interface
Internals

2.1.4 modlisp/base.lisp

Dependency

variables.lisp (file).

Source

modlisp.asd.

Parent Component

modlisp (system).

Public Interface
Internals

2.1.5 modlisp/utils.lisp

Dependency

base.lisp (file).

Source

modlisp.asd.

Parent Component

modlisp (system).

Public Interface
Internals

2.1.6 modlisp/demo.lisp

Dependency

utils.lisp (file).

Source

modlisp.asd.

Parent Component

modlisp (system).

Internals

3 Packages

Packages are listed by definition order.


3.1 modlisp

Source

package.lisp.

Nickname

ml

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

3.2 modlisp-system

Source

modlisp.asd.

Use List
  • asdf/interface.
  • common-lisp.

4 Definitions

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


4.1 Public Interface


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.

Special Variable: *ml-server*

Current ml-server instance

Package

modlisp.

Source

variables.lisp.

Special Variable: *modlisp-socket*

the socket stream to modlisp

Package

modlisp.

Source

variables.lisp.

Special Variable: *number-server-requests*

number of requests for the server

Package

modlisp.

Source

variables.lisp.

Special Variable: *number-worker-requests*

number of requests for this worker process

Package

modlisp.

Source

variables.lisp.


4.1.2 Macros

Macro: output-ml-page (format html &key headers)
Package

modlisp.

Source

utils.lisp.

Macro: with-ml-page ((&key format precompute headers) &body body)
Package

modlisp.

Source

utils.lisp.


4.1.3 Ordinary functions

Function: header-value (header key)

Returns the value of a modlisp header

Package

modlisp.

Source

base.lisp.

Function: modlisp-start (&key port processor processor-args catch-errors timeout number-fixed-workers remote-host-checker)
Package

modlisp.

Source

base.lisp.

Function: modlisp-stop (server)
Package

modlisp.

Source

base.lisp.

Function: modlisp-stop-all ()
Package

modlisp.

Source

base.lisp.

Function: output-html-page (str &key headers)
Package

modlisp.

Source

utils.lisp.

Function: output-xml-page (str &key headers)
Package

modlisp.

Source

utils.lisp.

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.

Function: redirect-to-location (url)
Package

modlisp.

Source

utils.lisp.

Function: write-header-line (key value)
Package

modlisp.

Source

base.lisp.


4.1.4 Standalone methods

Writer Method: (setf listener) ((ml-server ml-server))

automatically generated writer method

Package

kmrcl.

Source

variables.lisp.

Target Slot

listener.

Reader Method: listener ((ml-server ml-server))

automatically generated reader method

Package

kmrcl.

Source

variables.lisp.

Target Slot

listener.


4.2 Internals


4.2.1 Constants

Constant: +default-modlisp-port+

Default port for listen

Package

modlisp.

Source

variables.lisp.


4.2.2 Macros

Macro: write-response ((&key headers len status) &body body)
Package

modlisp.

Source

utils.lisp.


4.2.3 Ordinary functions

Function: demo-modlisp-command-processor (command)

Sample function to process an modlisp command

Package

modlisp.

Source

demo.lisp.

Function: fetch-mod-lisp-url (server url &key num-fetch port close-socket)
Package

modlisp.

Source

demo.lisp.

Function: fixed-html-string ()
Package

modlisp.

Source

demo.lisp.

Function: format->string (fmt)
Package

modlisp.

Source

utils.lisp.

Function: format-string (fmt headers)
Package

modlisp.

Source

utils.lisp.

Function: modlisp-command-issuer (*modlisp-socket* server)

generates commands from modlisp, issues commands to processor-fun

Package

modlisp.

Source

base.lisp.

Function: read-modlisp-command ()
Package

modlisp.

Source

base.lisp.

Function: read-modlisp-header ()
Package

modlisp.

Source

base.lisp.

Function: read-modlisp-line ()
Package

modlisp.

Source

base.lisp.

Function: read-reply (socket)
Package

modlisp.

Source

demo.lisp.

Function: write-debug-table (command)
Package

modlisp.

Source

demo.lisp.

Function: write-precomputed-page ()
Package

modlisp.

Source

demo.lisp.

Function: write-request-counts (s)
Package

modlisp.

Source

demo.lisp.


4.2.4 Generic functions

Generic Reader: port (object)
Package

modlisp.

Methods
Reader Method: port ((ml-server ml-server))

automatically generated reader method

Source

variables.lisp.

Target Slot

port.

Generic Writer: (setf port) (object)
Package

modlisp.

Methods
Writer Method: (setf port) ((ml-server ml-server))

automatically generated writer method

Source

variables.lisp.

Target Slot

port.

Generic Reader: processor (object)
Package

modlisp.

Methods
Reader Method: processor ((ml-server ml-server))

automatically generated reader method

Source

variables.lisp.

Target Slot

processor.

Generic Writer: (setf processor) (object)
Package

modlisp.

Methods
Writer Method: (setf processor) ((ml-server ml-server))

automatically generated writer method

Source

variables.lisp.

Target Slot

processor.

Generic Reader: processor-args (object)
Package

modlisp.

Methods
Reader Method: processor-args ((ml-server ml-server))

automatically generated reader method

Source

variables.lisp.

Target Slot

processor-args.

Generic Writer: (setf processor-args) (object)
Package

modlisp.

Methods
Writer Method: (setf processor-args) ((ml-server ml-server))

automatically generated writer method

Source

variables.lisp.

Target Slot

processor-args.


4.2.5 Classes

Class: ml-server
Package

modlisp.

Source

variables.lisp.

Direct methods
Direct slots
Slot: listener
Package

kmrcl.

Initargs

:listener

Readers

listener.

Writers

(setf listener).

Slot: port
Initargs

:port

Readers

port.

Writers

(setf port).

Slot: processor
Initargs

:processor

Readers

processor.

Writers

(setf processor).

Slot: processor-args
Initargs

:processor-args

Readers

processor-args.

Writers

(setf processor-args).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
D   F   G   H   L   M   O   P   Q   R   W  
Index Entry  Section

(
(setf listener): Public standalone methods
(setf port): Private generic functions
(setf port): Private generic functions
(setf processor): Private generic functions
(setf processor): Private generic functions
(setf processor-args): Private generic functions
(setf processor-args): Private generic functions

D
demo-modlisp-command-processor: Private ordinary functions

F
fetch-mod-lisp-url: Private ordinary functions
fixed-html-string: Private ordinary functions
format->string: Private ordinary functions
format-string: Private ordinary functions
Function, demo-modlisp-command-processor: Private ordinary functions
Function, fetch-mod-lisp-url: Private ordinary functions
Function, fixed-html-string: Private ordinary functions
Function, format->string: Private ordinary functions
Function, format-string: Private ordinary functions
Function, header-value: Public ordinary functions
Function, modlisp-command-issuer: Private ordinary functions
Function, modlisp-start: Public ordinary functions
Function, modlisp-stop: Public ordinary functions
Function, modlisp-stop-all: Public ordinary functions
Function, output-html-page: Public ordinary functions
Function, output-xml-page: Public ordinary functions
Function, query-to-alist: Public ordinary functions
Function, read-modlisp-command: Private ordinary functions
Function, read-modlisp-header: Private ordinary functions
Function, read-modlisp-line: Private ordinary functions
Function, read-reply: Private ordinary functions
Function, redirect-to-location: Public ordinary functions
Function, write-debug-table: Private ordinary functions
Function, write-header-line: Public ordinary functions
Function, write-precomputed-page: Private ordinary functions
Function, write-request-counts: Private ordinary functions

G
Generic Function, (setf port): Private generic functions
Generic Function, (setf processor): Private generic functions
Generic Function, (setf processor-args): Private generic functions
Generic Function, port: Private generic functions
Generic Function, processor: Private generic functions
Generic Function, processor-args: Private generic functions

H
header-value: Public ordinary functions

L
listener: Public standalone methods

M
Macro, output-ml-page: Public macros
Macro, with-ml-page: Public macros
Macro, write-response: Private macros
Method, (setf listener): Public standalone methods
Method, (setf port): Private generic functions
Method, (setf processor): Private generic functions
Method, (setf processor-args): Private generic functions
Method, listener: Public standalone methods
Method, port: Private generic functions
Method, processor: Private generic functions
Method, processor-args: Private generic functions
modlisp-command-issuer: Private ordinary functions
modlisp-start: Public ordinary functions
modlisp-stop: Public ordinary functions
modlisp-stop-all: Public ordinary functions

O
output-html-page: Public ordinary functions
output-ml-page: Public macros
output-xml-page: Public ordinary functions

P
port: Private generic functions
port: Private generic functions
processor: Private generic functions
processor: Private generic functions
processor-args: Private generic functions
processor-args: Private generic functions

Q
query-to-alist: Public ordinary functions

R
read-modlisp-command: Private ordinary functions
read-modlisp-header: Private ordinary functions
read-modlisp-line: Private ordinary functions
read-reply: Private ordinary functions
redirect-to-location: Public ordinary functions

W
with-ml-page: Public macros
write-debug-table: Private ordinary functions
write-header-line: Public ordinary functions
write-precomputed-page: Private ordinary functions
write-request-counts: Private ordinary functions
write-response: Private macros