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 Tue Dec 22 12:33:07 2020 GMT+0.
1 Systems
The main system appears first, followed by any subsystem dependency.
1.1 modlisp
- Dependency
kmrcl
- Source
modlisp.asd (file)
- 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.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
-
- Internal Definitions
-
2.1.4 modlisp/base.lisp
- Dependency
variables.lisp (file)
- Parent
modlisp (system)
- Location
base.lisp
- Exported Definitions
-
- Internal Definitions
-
2.1.5 modlisp/utils.lisp
- Dependency
base.lisp (file)
- Parent
modlisp (system)
- Location
utils.lisp
- Exported Definitions
-
- Internal Definitions
-
2.1.6 modlisp/demo.lisp
- Dependency
utils.lisp (file)
- Parent
modlisp (system)
- Location
demo.lisp
- Internal Definitions
-
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
-
- Exported Definitions
-
- Internal Definitions
-
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
-
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)
-
- 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)
-
- 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
| Index Entry | | Section |
|
F | | |
| File, Lisp, modlisp.asd: | | The modlisp․asd file |
| File, Lisp, modlisp/base.lisp: | | The modlisp/base․lisp file |
| File, Lisp, modlisp/demo.lisp: | | The modlisp/demo․lisp file |
| File, Lisp, modlisp/package.lisp: | | The modlisp/package․lisp file |
| File, Lisp, modlisp/utils.lisp: | | The modlisp/utils․lisp file |
| File, Lisp, modlisp/variables.lisp: | | The modlisp/variables․lisp file |
|
L | | |
| Lisp File, modlisp.asd: | | The modlisp․asd file |
| Lisp File, modlisp/base.lisp: | | The modlisp/base․lisp file |
| Lisp File, modlisp/demo.lisp: | | The modlisp/demo․lisp file |
| Lisp File, modlisp/package.lisp: | | The modlisp/package․lisp file |
| Lisp File, modlisp/utils.lisp: | | The modlisp/utils․lisp file |
| Lisp File, modlisp/variables.lisp: | | The modlisp/variables․lisp file |
|
M | | |
| modlisp.asd: | | The modlisp․asd file |
| modlisp/base.lisp: | | The modlisp/base․lisp file |
| modlisp/demo.lisp: | | The modlisp/demo․lisp file |
| modlisp/package.lisp: | | The modlisp/package․lisp file |
| modlisp/utils.lisp: | | The modlisp/utils․lisp file |
| modlisp/variables.lisp: | | The modlisp/variables․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf port) : | | Internal generic functions |
| (setf port) : | | Internal generic functions |
| (setf processor) : | | Internal generic functions |
| (setf processor) : | | Internal generic functions |
| (setf processor-args) : | | Internal generic functions |
| (setf processor-args) : | | Internal generic functions |
|
D | | |
| demo-modlisp-command-processor : | | Internal functions |
|
F | | |
| fetch-mod-lisp-url : | | Internal functions |
| fixed-html-string : | | Internal functions |
| format->string : | | Internal functions |
| format-string : | | Internal functions |
| Function, demo-modlisp-command-processor : | | Internal functions |
| Function, fetch-mod-lisp-url : | | Internal functions |
| Function, fixed-html-string : | | Internal functions |
| Function, format->string : | | Internal functions |
| Function, format-string : | | Internal functions |
| Function, header-value : | | Exported functions |
| Function, modlisp-command-issuer : | | Internal functions |
| Function, modlisp-start : | | Exported functions |
| Function, modlisp-stop : | | Exported functions |
| Function, modlisp-stop-all : | | Exported functions |
| Function, output-html-page : | | Exported functions |
| Function, output-xml-page : | | Exported functions |
| Function, query-to-alist : | | Exported functions |
| Function, read-modlisp-command : | | Internal functions |
| Function, read-modlisp-header : | | Internal functions |
| Function, read-modlisp-line : | | Internal functions |
| Function, read-reply : | | Internal functions |
| Function, redirect-to-location : | | Exported functions |
| Function, write-debug-table : | | Internal functions |
| Function, write-header-line : | | Exported functions |
| Function, write-precomputed-page : | | Internal functions |
| Function, write-request-counts : | | Internal functions |
|
G | | |
| Generic Function, (setf port) : | | Internal generic functions |
| Generic Function, (setf processor) : | | Internal generic functions |
| Generic Function, (setf processor-args) : | | Internal generic functions |
| Generic Function, port : | | Internal generic functions |
| Generic Function, processor : | | Internal generic functions |
| Generic Function, processor-args : | | Internal generic functions |
|
H | | |
| header-value : | | Exported functions |
|
M | | |
| Macro, output-ml-page : | | Exported macros |
| Macro, with-ml-page : | | Exported macros |
| Macro, write-response : | | Internal macros |
| Method, (setf port) : | | Internal generic functions |
| Method, (setf processor) : | | Internal generic functions |
| Method, (setf processor-args) : | | Internal generic functions |
| Method, port : | | Internal generic functions |
| Method, processor : | | Internal generic functions |
| Method, processor-args : | | Internal generic functions |
| modlisp-command-issuer : | | Internal functions |
| modlisp-start : | | Exported functions |
| modlisp-stop : | | Exported functions |
| modlisp-stop-all : | | Exported functions |
|
O | | |
| output-html-page : | | Exported functions |
| output-ml-page : | | Exported macros |
| output-xml-page : | | Exported functions |
|
P | | |
| port : | | Internal generic functions |
| port : | | Internal generic functions |
| processor : | | Internal generic functions |
| processor : | | Internal generic functions |
| processor-args : | | Internal generic functions |
| processor-args : | | Internal generic functions |
|
Q | | |
| query-to-alist : | | Exported functions |
|
R | | |
| read-modlisp-command : | | Internal functions |
| read-modlisp-header : | | Internal functions |
| read-modlisp-line : | | Internal functions |
| read-reply : | | Internal functions |
| redirect-to-location : | | Exported functions |
|
W | | |
| with-ml-page : | | Exported macros |
| write-debug-table : | | Internal functions |
| write-header-line : | | Exported functions |
| write-precomputed-page : | | Internal functions |
| write-request-counts : | | Internal functions |
| write-response : | | Internal macros |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *close-modlisp-socket* : | | Exported special variables |
| *ml-server* : | | Exported special variables |
| *modlisp-socket* : | | Exported special variables |
| *number-server-requests* : | | Exported special variables |
| *number-worker-requests* : | | Exported special variables |
|
+ | | |
| +default-modlisp-port+ : | | Internal constants |
|
C | | |
| Constant, +default-modlisp-port+ : | | Internal constants |
|
L | | |
| listener : | | Internal classes |
|
P | | |
| port : | | Internal classes |
| processor : | | Internal classes |
| processor-args : | | Internal classes |
|
S | | |
| Slot, listener : | | Internal classes |
| Slot, port : | | Internal classes |
| Slot, processor : | | Internal classes |
| Slot, processor-args : | | Internal classes |
| Special Variable, *close-modlisp-socket* : | | Exported special variables |
| Special Variable, *ml-server* : | | Exported special variables |
| Special Variable, *modlisp-socket* : | | Exported special variables |
| Special Variable, *number-server-requests* : | | Exported special variables |
| Special Variable, *number-worker-requests* : | | Exported special variables |
|
A.4 Data types