This is the toot Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 07:41:38 2025 GMT+0.
toot/toot.asdtoot/packages.lisptoot/rfc2388.lisptoot/specials.lisptoot/conditions.lisptoot/mime-types.lisptoot/util.lisptoot/cookie.lisptoot/set-timeouts.lisptoot/taskmaster.lisptoot/log.lisptoot/http.lisptoot/api.lisptoot/tests.lisptoot/documentation.lispThe main system appears first, followed by any subsystem dependency.
tootA minimal web server originally built by stripping down Edi Weitz’s Hunchentoot
0.0.1
alexandria (system).
chunga (system).
cl-base64 (system).
cl-fad (system).
cl-ppcre (system).
flexi-streams (system).
cl+ssl (system).
md5 (system).
trivial-backtrace (system).
usocket (system).
bordeaux-threads (system).
puri (system).
packages.lisp (file).
rfc2388.lisp (file).
specials.lisp (file).
conditions.lisp (file).
mime-types.lisp (file).
util.lisp (file).
cookie.lisp (file).
set-timeouts.lisp (file).
taskmaster.lisp (file).
log.lisp (file).
http.lisp (file).
api.lisp (file).
tests.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
toot/toot.asdtoot/packages.lisptoot/rfc2388.lisptoot/specials.lisptoot/conditions.lisptoot/mime-types.lisptoot/util.lisptoot/cookie.lisptoot/set-timeouts.lisptoot/taskmaster.lisptoot/log.lisptoot/http.lisptoot/api.lisptoot/tests.lisptoot/documentation.lisptoot/toot.asdtoot (system).
toot.
*toot-version* (special variable).
toot/rfc2388.lisppackages.lisp (file).
toot (system).
content-type-sub (function).
(setf content-type-sub) (function).
content-type-super (function).
(setf content-type-super) (function).
find-content-disposition-header (function).
find-header (function).
find-parameter (function).
get-file-name (function).
header-name (function).
(setf header-name) (function).
header-parameters (function).
(setf header-parameters) (function).
header-value (function).
(setf header-value) (function).
lwsp-char-p (function).
make-content-type (function).
make-header (function).
make-mime-part (function).
mime-content-type (function).
mime-part-contents (function).
(setf mime-part-contents) (function).
mime-part-headers (function).
(setf mime-part-headers) (function).
parse-content-type (function).
parse-header (generic function).
parse-mime (generic function).
read-until-next-boundary (function).
skip-linear-whitespace (function).
unparse-content-type (function).
toot/specials.lisprfc2388.lisp (file).
toot (system).
*debug-errors-p* (special variable).
*default-connection-timeout* (special variable).
*default-content-type* (special variable).
*default-external-format* (special variable).
*header-stream* (special variable).
*lisp-errors-log-level* (special variable).
*lisp-warnings-log-level* (special variable).
*log-lisp-backtraces-p* (special variable).
*log-lisp-errors-p* (special variable).
*log-lisp-warnings-p* (special variable).
*show-lisp-backtraces-p* (special variable).
*show-lisp-errors-p* (special variable).
*tmp-directory* (special variable).
+http-accepted+ (constant).
+http-authorization-required+ (constant).
+http-bad-gateway+ (constant).
+http-bad-request+ (constant).
+http-conflict+ (constant).
+http-continue+ (constant).
+http-created+ (constant).
+http-expectation-failed+ (constant).
+http-failed-dependency+ (constant).
+http-forbidden+ (constant).
+http-gateway-time-out+ (constant).
+http-gone+ (constant).
+http-internal-server-error+ (constant).
+http-length-required+ (constant).
+http-method-not-allowed+ (constant).
+http-moved-permanently+ (constant).
+http-moved-temporarily+ (constant).
+http-multi-status+ (constant).
+http-multiple-choices+ (constant).
+http-no-content+ (constant).
+http-non-authoritative-information+ (constant).
+http-not-acceptable+ (constant).
+http-not-found+ (constant).
+http-not-implemented+ (constant).
+http-not-modified+ (constant).
+http-ok+ (constant).
+http-partial-content+ (constant).
+http-payment-required+ (constant).
+http-precondition-failed+ (constant).
+http-proxy-authentication-required+ (constant).
+http-request-entity-too-large+ (constant).
+http-request-time-out+ (constant).
+http-request-uri-too-large+ (constant).
+http-requested-range-not-satisfiable+ (constant).
+http-reset-content+ (constant).
+http-see-other+ (constant).
+http-service-unavailable+ (constant).
+http-switching-protocols+ (constant).
+http-temporary-redirect+ (constant).
+http-unsupported-media-type+ (constant).
+http-use-proxy+ (constant).
+http-version-not-supported+ (constant).
*default-charset* (special variable).
*http-reason-phrase-map* (special variable).
*hyperdoc-base-uri* (special variable).
*tmp-counter* (special variable).
*tmp-counter-lock* (special variable).
+buffer-length+ (constant).
+crlf+ (constant).
+day-names+ (constant).
+implementation-link+ (constant).
+latin-1+ (constant).
+month-names+ (constant).
+new-connection-wait-time+ (constant).
+toot-project-url+ (constant).
+utf-8+ (constant).
def-http-status-code (macro).
defconstant (macro).
hyperdoc-lookup (function).
toot/conditions.lispspecials.lisp (file).
toot (system).
body (reader method).
get-backtrace (function).
handler-case* (macro).
ignore-errors* (macro).
internal-error (function).
maybe-invoke-debugger (generic function).
not-implemented (function).
operation (reader method).
operation-not-implemented (condition).
parameter-error (function).
parameter-error (condition).
request-aborted (condition).
response-status-code (reader method).
toot-condition (condition).
toot-error (condition).
toot-simple-error (condition).
toot-simple-warning (condition).
toot-warn (function).
toot-warning (condition).
with-debugger (macro).
toot/mime-types.lispconditions.lisp (file).
toot (system).
*mime-type-hash* (special variable).
*mime-type-list* (special variable).
guess-mime-type (function).
toot/util.lispmime-types.lisp (file).
toot (system).
escape-for-html (function).
url-decode (function).
url-encode (function).
form-url-encoded-list-to-alist (function).
iso-time (function).
parse-content-type-header (function).
possible-tmp-filename (function).
quote-string (function).
rfc-1123-date (function).
sans (function).
tmp-filename (function).
upgrade-vector (macro).
toot/cookie.lisputil.lisp (file).
toot (system).
initialize-instance (method).
name (reader method).
cookie (class).
domain (reader method).
(setf domain) (writer method).
expires (reader method).
(setf expires) (writer method).
http-only (reader method).
(setf http-only) (writer method).
http-token-p (function).
path (reader method).
(setf path) (writer method).
secure (reader method).
(setf secure) (writer method).
stringify-cookie (function).
value (reader method).
(setf value) (writer method).
toot/set-timeouts.lispcookie.lisp (file).
toot (system).
set-timeouts (function).
toot/taskmaster.lispset-timeouts.lisp (file).
toot (system).
initialize-instance (method).
*default-max-accept-count* (special variable).
*default-max-thread-count* (special variable).
acceptor-process (reader method).
(setf acceptor-process) (writer method).
connection-handler-thread-name (function).
create-connection-handler-thread (function).
decrement-taskmaster-request-count (function).
execute-acceptor (generic function).
handle-incoming-connection (generic function).
increment-taskmaster-request-count (function).
listen-thread-name (function).
notify-free-connection (function).
shutdown (generic function).
single-threaded-taskmaster (class).
taskmaster-max-accept-count (reader method).
(setf taskmaster-max-accept-count) (writer method).
taskmaster-max-thread-count (reader method).
(setf taskmaster-max-thread-count) (writer method).
taskmaster-request-count (reader method).
(setf taskmaster-request-count) (writer method).
taskmaster-request-count-lock (reader method).
taskmaster-wait-lock (reader method).
taskmaster-wait-queue (reader method).
taskmaster-worker-thread-name-format (reader method).
(setf taskmaster-worker-thread-name-format) (writer method).
thread-per-connection-taskmaster (class).
wait-for-free-connection (function).
toot/log.lisptaskmaster.lisp (file).
toot (system).
lock (reader method).
stream-logger (class).
*default-logger* (special variable).
destination (reader method).
log-access (generic function).
log-message (generic function).
toot/http.lisplog.lisp (file).
toot (system).
acceptor (reader method).
acceptor (class).
access-logger (reader method).
(setf access-logger) (writer method).
address (reader method).
body-octets (reader method).
body-octets (method).
body-stream (reader method).
body-stream (method).
content-length (reader method).
(setf content-length) (writer method).
content-type (reader method).
(setf content-type) (writer method).
cookies-in (reader method).
error-generator (reader method).
(setf error-generator) (writer method).
generate-error-page (generic function).
get-parameters (reader method).
handle-request (generic function).
handler (reader method).
(setf handler) (writer method).
initialize-instance (method).
initialize-instance (method).
message-logger (reader method).
(setf message-logger) (writer method).
name (reader method).
persistent-connections-p (reader method).
(setf persistent-connections-p) (writer method).
port (reader method).
post-parameters (reader method).
post-parameters (method).
print-object (method).
read-timeout (reader method).
reason-phrase (function).
remote-addr (reader method).
remote-port (reader method).
request-headers (reader method).
request-method (reader method).
request-uri (reader method).
server-protocol (reader method).
status-code (reader method).
(setf status-code) (writer method).
taskmaster (reader method).
write-timeout (reader method).
*error-css* (special variable).
accept-connections (function).
charset-to-external-format (function).
chunking-input-p (function).
close-stream-p (reader method).
(setf close-stream-p) (writer method).
connection-values (function).
content-stream (reader method).
(setf content-stream) (writer method).
convert-hack (function).
cookies-out (reader method).
(setf cookies-out) (writer method).
default-error-message-generator (function).
delete-tmp-files (function).
drain-body-stream (function).
error-body (function).
external-format-from-content-type (function).
finalize-response-headers (function).
finish-response-body (function).
full-content-type (function).
get-peer-address-and-port (function).
headers-sent-p (reader method).
(setf headers-sent-p) (writer method).
keep-alive-p (function).
length-known-p (function).
listen-backlog (reader method).
listen-socket (reader method).
(setf listen-socket) (writer method).
log-message (method).
log-message (method).
make-header-stream (function).
make-socket-stream (function).
maybe-log-error (function).
maybe-log-warning (function).
parse-application/x-www-form-urlencoded (function).
parse-cookies (function).
parse-multipart/form-data (function).
parse-query-string (function).
parse-rfc2388-form-data (function).
printable-ascii-char-p (function).
process-connection (function).
process-request (function).
read-body-octets (function).
read-initial-request-line (function).
read-post-parameters (function).
read-request (function).
report-error-to-client (function).
request (class).
request-body-stream (function).
requests-in-progress (reader method).
(setf requests-in-progress) (writer method).
response-charset (reader method).
(setf response-charset) (writer method).
response-headers (reader method).
(setf response-headers) (writer method).
send-bad-request-response (function).
send-response (function).
send-response-headers (function).
send-service-unavailable-response (function).
setup-ssl-stream (function).
shutdown-lock (reader method).
(setf shutdown-lock) (writer method).
shutdown-p (reader method).
(setf shutdown-p) (writer method).
shutdown-queue (reader method).
(setf shutdown-queue) (writer method).
ssl-certificate-file (reader method).
ssl-private-key-file (reader method).
ssl-private-key-password (reader method).
text-type-p (function).
tmp-files (reader method).
(setf tmp-files) (writer method).
write-cookies (function).
write-header-line (function).
write-headers (function).
write-line-crlf (function).
write-simple-response (function).
write-status-line (function).
toot/api.lisphttp.lisp (file).
toot (system).
abort-request-handler (function).
add-index (function).
authorization (function).
cookie-value (function).
get-parameter (function).
handle-if-modified-since (function).
handle-range (function).
handle-request (method).
initialize-instance (method).
no-cache (function).
parameter (function).
post-parameter (function).
real-remote-addr (function).
redirect (function).
request-authority (function).
request-header (function).
request-host (function).
request-path (function).
request-port (function).
request-query (function).
request-scheme (function).
require-authorization (function).
response-header (function).
(setf response-header) (function).
response-sent-p (function).
safe-pathname-p (function).
send-headers (function).
serve-file (function).
set-cookie (function).
start-acceptor (function).
start-server (function).
static-file-handler (class).
stop-acceptor (function).
with-response-body (macro).
cookie-out (function).
path-checker (reader method).
(setf path-checker) (writer method).
root (reader method).
(setf root) (writer method).
toot/tests.lispapi.lisp (file).
toot (system).
handle-request (method).
*test-acceptor* (special variable).
add-handler (function).
enough-url (function).
form-test-get-params (function).
form-test-octets (function).
form-test-params (function).
form-test-stream (function).
handlers (reader method).
(setf handlers) (writer method).
make-exact-path-handler (function).
make-search-handler (function).
reset-test-handler (function).
resolve-file (function).
search-handler (class).
start-test-server (function).
start-trivial-server (function).
test-document-directory (function).
test-handler (function).
trivial-handler (function).
Packages are listed by definition order.
tootA very simple web server.
alexandria.
bordeaux-threads.
chunga.
cl-ppcre.
common-lisp.
flexi-streams.
puri.
*debug-errors-p* (special variable).
*default-connection-timeout* (special variable).
*default-content-type* (special variable).
*default-external-format* (special variable).
*header-stream* (special variable).
*lisp-errors-log-level* (special variable).
*lisp-warnings-log-level* (special variable).
*log-lisp-backtraces-p* (special variable).
*log-lisp-errors-p* (special variable).
*log-lisp-warnings-p* (special variable).
*show-lisp-backtraces-p* (special variable).
*show-lisp-errors-p* (special variable).
*tmp-directory* (special variable).
+http-accepted+ (constant).
+http-authorization-required+ (constant).
+http-bad-gateway+ (constant).
+http-bad-request+ (constant).
+http-conflict+ (constant).
+http-continue+ (constant).
+http-created+ (constant).
+http-expectation-failed+ (constant).
+http-failed-dependency+ (constant).
+http-forbidden+ (constant).
+http-gateway-time-out+ (constant).
+http-gone+ (constant).
+http-internal-server-error+ (constant).
+http-length-required+ (constant).
+http-method-not-allowed+ (constant).
+http-moved-permanently+ (constant).
+http-moved-temporarily+ (constant).
+http-multi-status+ (constant).
+http-multiple-choices+ (constant).
+http-no-content+ (constant).
+http-non-authoritative-information+ (constant).
+http-not-acceptable+ (constant).
+http-not-found+ (constant).
+http-not-implemented+ (constant).
+http-not-modified+ (constant).
+http-ok+ (constant).
+http-partial-content+ (constant).
+http-payment-required+ (constant).
+http-precondition-failed+ (constant).
+http-proxy-authentication-required+ (constant).
+http-request-entity-too-large+ (constant).
+http-request-time-out+ (constant).
+http-request-uri-too-large+ (constant).
+http-requested-range-not-satisfiable+ (constant).
+http-reset-content+ (constant).
+http-see-other+ (constant).
+http-service-unavailable+ (constant).
+http-switching-protocols+ (constant).
+http-temporary-redirect+ (constant).
+http-unsupported-media-type+ (constant).
+http-use-proxy+ (constant).
+http-version-not-supported+ (constant).
abort-request-handler (function).
acceptor (generic reader).
acceptor (class).
access-logger (generic reader).
(setf access-logger) (generic writer).
add-index (function).
address (generic reader).
authorization (function).
body-octets (generic function).
body-stream (generic function).
content-length (generic reader).
(setf content-length) (generic writer).
content-type (generic reader).
(setf content-type) (generic writer).
cookie-value (function).
cookies-in (generic reader).
error-generator (generic reader).
(setf error-generator) (generic writer).
escape-for-html (function).
generate-error-page (generic function).
get-parameter (function).
get-parameters (generic reader).
handle-if-modified-since (function).
handle-range (function).
handle-request (generic function).
handler (generic reader).
(setf handler) (generic writer).
message-logger (generic reader).
(setf message-logger) (generic writer).
name (generic reader).
no-cache (function).
parameter (function).
persistent-connections-p (generic reader).
(setf persistent-connections-p) (generic writer).
port (generic reader).
post-parameter (function).
post-parameters (generic function).
read-timeout (generic reader).
real-remote-addr (function).
reason-phrase (function).
redirect (function).
remote-addr (generic reader).
remote-port (generic reader).
request-authority (function).
request-header (function).
request-headers (generic reader).
request-host (function).
request-method (generic reader).
request-path (function).
request-port (function).
request-query (function).
request-scheme (function).
request-uri (generic reader).
require-authorization (function).
response-header (function).
(setf response-header) (function).
response-sent-p (function).
safe-pathname-p (function).
send-headers (function).
serve-file (function).
server-protocol (generic reader).
set-cookie (function).
start-acceptor (function).
start-server (function).
static-file-handler (class).
status-code (generic reader).
(setf status-code) (generic writer).
stop-acceptor (function).
stream-logger (class).
taskmaster (generic reader).
url-decode (function).
url-encode (function).
with-response-body (macro).
write-timeout (generic reader).
*default-charset* (special variable).
*default-logger* (special variable).
*default-max-accept-count* (special variable).
*default-max-thread-count* (special variable).
*error-css* (special variable).
*http-reason-phrase-map* (special variable).
*hyperdoc-base-uri* (special variable).
*mime-type-hash* (special variable).
*mime-type-list* (special variable).
*tmp-counter* (special variable).
*tmp-counter-lock* (special variable).
+buffer-length+ (constant).
+crlf+ (constant).
+day-names+ (constant).
+implementation-link+ (constant).
+latin-1+ (constant).
+month-names+ (constant).
+new-connection-wait-time+ (constant).
+toot-project-url+ (constant).
+utf-8+ (constant).
accept-connections (function).
acceptor-process (generic reader).
(setf acceptor-process) (generic writer).
body (generic reader).
charset-to-external-format (function).
chunking-input-p (function).
close-stream-p (generic reader).
(setf close-stream-p) (generic writer).
connection-handler-thread-name (function).
connection-values (function).
content-stream (generic reader).
(setf content-stream) (generic writer).
content-type-sub (function).
(setf content-type-sub) (function).
content-type-super (function).
(setf content-type-super) (function).
convert-hack (function).
cookie (class).
cookie-out (function).
cookies-out (generic reader).
(setf cookies-out) (generic writer).
copy-content-type (function).
copy-header (function).
copy-mime-part (function).
create-connection-handler-thread (function).
decrement-taskmaster-request-count (function).
def-http-status-code (macro).
default-error-message-generator (function).
defconstant (macro).
delete-tmp-files (function).
destination (generic reader).
domain (generic reader).
(setf domain) (generic writer).
drain-body-stream (function).
error-body (function).
execute-acceptor (generic function).
expires (generic reader).
(setf expires) (generic writer).
external-format-from-content-type (function).
finalize-response-headers (function).
find-content-disposition-header (function).
find-header (function).
find-parameter (function).
finish-response-body (function).
form-url-encoded-list-to-alist (function).
full-content-type (function).
get-backtrace (function).
get-file-name (function).
get-peer-address-and-port (function).
guess-mime-type (function).
handle-incoming-connection (generic function).
handler-case* (macro).
header-name (function).
(setf header-name) (function).
header-parameters (function).
(setf header-parameters) (function).
header-value (function).
(setf header-value) (function).
headers-sent-p (generic reader).
(setf headers-sent-p) (generic writer).
http-only (generic reader).
(setf http-only) (generic writer).
http-token-p (function).
hyperdoc-lookup (function).
ignore-errors* (macro).
increment-taskmaster-request-count (function).
internal-error (function).
iso-time (function).
keep-alive-p (function).
length-known-p (function).
listen-backlog (generic reader).
listen-socket (generic reader).
(setf listen-socket) (generic writer).
listen-thread-name (function).
log-access (generic function).
log-message (generic function).
lwsp-char-p (function).
make-content-type (function).
make-header (function).
make-header-stream (function).
make-mime-part (function).
make-socket-stream (function).
maybe-invoke-debugger (generic function).
maybe-log-error (function).
maybe-log-warning (function).
mime-content-type (function).
mime-part-contents (function).
(setf mime-part-contents) (function).
mime-part-headers (function).
(setf mime-part-headers) (function).
not-implemented (function).
notify-free-connection (function).
operation (generic reader).
operation-not-implemented (condition).
parameter-error (function).
parameter-error (condition).
parse-application/x-www-form-urlencoded (function).
parse-content-type (function).
parse-content-type-header (function).
parse-cookies (function).
parse-header (generic function).
parse-mime (generic function).
parse-multipart/form-data (function).
parse-query-string (function).
parse-rfc2388-form-data (function).
path (generic reader).
(setf path) (generic writer).
path-checker (generic reader).
(setf path-checker) (generic writer).
possible-tmp-filename (function).
printable-ascii-char-p (function).
process-connection (function).
process-request (function).
quote-string (function).
read-body-octets (function).
read-initial-request-line (function).
read-post-parameters (function).
read-request (function).
read-until-next-boundary (function).
report-error-to-client (function).
request (class).
request-aborted (condition).
request-body-stream (function).
requests-in-progress (generic reader).
(setf requests-in-progress) (generic writer).
response-charset (generic reader).
(setf response-charset) (generic writer).
response-headers (generic reader).
(setf response-headers) (generic writer).
response-status-code (generic reader).
rfc-1123-date (function).
root (generic reader).
(setf root) (generic writer).
sans (function).
secure (generic reader).
(setf secure) (generic writer).
send-bad-request-response (function).
send-response (function).
send-response-headers (function).
send-service-unavailable-response (function).
set-timeouts (function).
setup-ssl-stream (function).
shutdown (generic function).
shutdown-lock (generic reader).
(setf shutdown-lock) (generic writer).
shutdown-p (generic reader).
(setf shutdown-p) (generic writer).
shutdown-queue (generic reader).
(setf shutdown-queue) (generic writer).
single-threaded-taskmaster (class).
skip-linear-whitespace (function).
ssl-certificate-file (generic reader).
ssl-private-key-file (generic reader).
ssl-private-key-password (generic reader).
stringify-cookie (function).
taskmaster-max-accept-count (generic reader).
(setf taskmaster-max-accept-count) (generic writer).
taskmaster-max-thread-count (generic reader).
(setf taskmaster-max-thread-count) (generic writer).
taskmaster-request-count (generic reader).
(setf taskmaster-request-count) (generic writer).
taskmaster-request-count-lock (generic reader).
taskmaster-wait-lock (generic reader).
taskmaster-wait-queue (generic reader).
taskmaster-worker-thread-name-format (generic reader).
(setf taskmaster-worker-thread-name-format) (generic writer).
text-type-p (function).
thread-per-connection-taskmaster (class).
tmp-filename (function).
tmp-files (generic reader).
(setf tmp-files) (generic writer).
toot-condition (condition).
toot-error (condition).
toot-simple-error (condition).
toot-simple-warning (condition).
toot-warn (function).
toot-warning (condition).
unparse-content-type (function).
upgrade-vector (macro).
value (generic reader).
(setf value) (generic writer).
wait-for-free-connection (function).
with-debugger (macro).
write-cookies (function).
write-header-line (function).
write-headers (function).
write-line-crlf (function).
write-simple-response (function).
write-status-line (function).
toot-asdasdf/interface.
common-lisp.
*toot-version* (special variable).
toot-testsSanity tests for Toot.
common-lisp.
toot.
*test-acceptor* (special variable).
add-handler (function).
enough-url (function).
form-test-get-params (function).
form-test-octets (function).
form-test-params (function).
form-test-stream (function).
handlers (generic reader).
(setf handlers) (generic writer).
make-exact-path-handler (function).
make-search-handler (function).
reset-test-handler (function).
resolve-file (function).
search-handler (class).
start-test-server (function).
start-trivial-server (function).
test-document-directory (function).
test-handler (function).
trivial-handler (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
HTTP return code (401) for ’Authorization Required’.
toot.
HTTP return code (417) for ’Expectation Failed’.
toot.
HTTP return code (424) for ’Failed Dependency’.
toot.
HTTP return code (504) for ’Gateway Time-out’.
toot.
HTTP return code (500) for ’Internal Server Error’.
toot.
HTTP return code (411) for ’Length Required’.
toot.
HTTP return code (405) for ’Method Not Allowed’.
toot.
HTTP return code (301) for ’Moved Permanently’.
toot.
HTTP return code (302) for ’Moved Temporarily’.
toot.
HTTP return code (300) for ’Multiple Choices’.
toot.
HTTP return code (203) for ’Non-Authoritative Information’.
toot.
HTTP return code (501) for ’Not Implemented’.
toot.
HTTP return code (206) for ’Partial Content’.
toot.
HTTP return code (402) for ’Payment Required’.
toot.
HTTP return code (412) for ’Precondition Failed’.
toot.
HTTP return code (407) for ’Proxy Authentication Required’.
toot.
HTTP return code (413) for ’Request Entity Too Large’.
toot.
HTTP return code (408) for ’Request Time-out’.
toot.
HTTP return code (414) for ’Request-URI Too Large’.
toot.
HTTP return code (416) for ’Requested range not satisfiable’.
toot.
HTTP return code (503) for ’Service Unavailable’.
toot.
HTTP return code (101) for ’Switching Protocols’.
toot.
HTTP return code (307) for ’Temporary Redirect’.
toot.
HTTP return code (415) for ’Unsupported Media Type’.
toot.
HTTP return code (505) for ’Version not supported’.
toot.
When true, Toot drops into the debugger on unhandled errors. Otherwise unhandled errors signaled while processing requests are logged and a 500 error returned to the client.
toot.
The default connection timeout used when an acceptor is reading from and writing to a socket stream.
toot.
The default content-type header which is returned to the client. If this is text content type, the character set used for encoding the response will automatically be added to the content type in a “charset” attribute.
toot.
The external format used to compute the REQUEST object.
toot.
If this variable is not NIL, it should be bound to a stream to which incoming and outgoing headers will be written for debugging purposes.
toot.
Log level for Lisp errors. Should be one of :ERROR (the default), :WARNING, or :INFO.
toot.
Log level for Lisp warnings. Should be one of :ERROR, :WARNING (the default), or :INFO.
toot.
Whether Lisp backtraces should be logged. Only has an effect if *LOG-LISP-ERRORS-P* is true as well.
toot.
Whether Lisp errors in request handlers should be logged.
toot.
Whether Lisp warnings in request handlers should be logged.
toot.
Whether Lisp errors shown in HTML output should contain backtrace information.
toot.
Whether Lisp errors in request handlers should be shown in HTML output.
toot.
Directory for temporary files created by MAKE-TMP-FILE-NAME.
toot.
Send the response headers (any already set plus any more set via keyword arguments to this macro) and bind the stream to which the response body can be written to STREAM.
Abort the handling of a request, sending instead a response with the given response-status-code and either the given body or a default body based on the error code. A request can only be aborted if SEND-HEADERS has not been called. (SEND-HEADERS is called by WITH-RESPONSE-BODY). If a handler neither generates a response nor aborts, then a 404: Not Found response will be sent.
Add an index file name to a directory filename. Defaults to index.html
Returns as two values the user and password (if any) as encoded in the ’AUTHORIZATION’ header. Returns NIL if there is no such header.
Get the value of the cookie with the given name sent by the client or NIL if no such cookie was sent.
Escapes the characters #\<, #\>, #\’, #\", and #\& for HTML output.
Returns the GET parameter with name NAME (a string) - or NIL if there is none. Search is case-sensitive.
Handles the If-Modified-Since header of REQUEST, sending an ’304: Not modified’ response if the time represented by the UTC TIME is the same as the value in the If-Modified-Since header. Also sets the Last Modified header in the response to TIME.
If the request contains a Range header returns the starting position and the number of bytes to transfer. Otherwise returns 0 and bytes-available. An invalid specified range is reported to the client immediately with a ’416: Requested range not satisfiable’ response.
Adds appropriate response headers to completely prevent caching on most browsers.
Returns the GET or the POST parameter with name NAME (a string) - or NIL if there is none. If both a GET and a POST parameter with the same name exist the GET parameter is returned. Search is case-sensitive.
Returns the POST parameter with name NAME (a string) - or NIL if there is none. Search is case-sensitive.
Returns the ’X-Forwarded-For’ incoming http header as the second value in the form of a list of IP addresses and the first element of this list as the first value if this header exists. Otherwise returns the value of REMOTE-ADDR as the only value.
Returns a reason phrase for the HTTP return code STATUS-CODE (which should be an integer) or NIL for return codes Toot doesn’t know.
Redirects the browser to TARGET with status code CODE. Target must be a string and CODE should be one of the 3xx status codes. If TARGET is a full URL starting with a scheme, HOST, PORT and PROTOCOL are ignored. Otherwise, TARGET should denote the path part of a URL and the protocol, host, and port can be specified via keyword args. Any values not specified will be taken from the current request. (Note, however, that if no port was specified in the Host: header of the request, the redirect will likewise have no explicit port; if the protocol was changed this will result in a redirect to the default port for the new protocol. CODE must be a 3xx redirection code and will be sent as status code.
Get the authority part of the request’s URI.
Returns the incoming header with name NAME. NAME can be a keyword (recommended) or a string.
Get the host part of the request’s URI.
Get the path part of the request’s URI.
Get the port part of the request’s URI.
Get the query part of the request’s URI.
Get the scheme part of the request’s URI.
Sends 401: Authorization required reply to require basic HTTP authentication (see RFC 2617) for the realm REALM.
Returns the current value of the outgoing http header named NAME. NAME should be a keyword or a string.
Changes the current value of the outgoing http header named NAME (a keyword or a string). If a header with this name doesn’t exist, it is created.
Verify that a path, translated to a file doesn’t contain any tricky bits such as ’..’
Send the headers and return a stream to which the body of the reply can be written. If the content-type is text/* type, the stream returned will be a character stream that will encode the response properly for the charset specified. If the request was a HEAD request we dynamically abort rather than returning a stream.
Serve the file denoted by PATHNAME. Sends a content type header corresponding to CONTENT-TYPE or (if that is NIL) tries to determine the content type via the file’s suffix. Aborts the request with 404: Not found if the file does not exist. Also handles if-modified-since and range requests appropriately.
Set a cookie to be sent with the reply.
Start an existing acceptor listening for connections.
Instantiate an acceptor and start it listening.
Stop an acceptor from listening for connections. It can be restarted with START-ACCEPTOR.
Decodes a URL-encoded STRING which is assumed to be encoded using the external format EXTERNAL-FORMAT.
URL-encodes a string using the external format EXTERNAL-FORMAT.
acceptor that accepted this request.
logger object that can log HTTP accesses.
IP address to which the acceptor binds.
body of the request as octets.
body of the request as a stream.
length of the response about to be written.
the MIME type of the response about to be written.
cookies sent by the client as an alist.
object responsible for generating error pages.
Used by acceptor to generate an error page for a request based on the http status code.
parameters sent in the query string.
Used by the acceptor to handle a request. Returns
true if the handler actually sends a response. (This is arranged by
a default :around method. If for some reason a more-specific :around
method is defined, it must return the same value.
toot.
search-handler) request) ¶static-file-handler) request) ¶symbol) request) ¶function) request) ¶object responsible for generating a response to each request.
object that logs miscelaneous messages to the Toot message log.
name of the server, used in to set the Server response header.
flag controlling whether acceptor will allow persistent connections.
port the acceptor will listen on.
timeout for reading from the client.
IP address of the client side of the socket making the request.
port of the client side of the socket making the request.
complete set of headers sent in the request as an alist.
HTTP method (e.g. GET, POST, HEAD) of the request.
URI of the request as a puri:uri object.
server protocol of the request as a keyword.
HTTP status code of the response being generated.
object responsible for running the acceptor.
timeout for writing to the client.
static-file-handler) &key &allow-other-keys) ¶thread-per-connection-taskmaster) &rest init-args) ¶Ensure the if MAX-ACCEPT-COUNT is supplied, that it is greater than MAX-THREAD-COUNT.
cookie) &key name &allow-other-keys) ¶Ensure COOKIE has a correct slot-value for NAME.
stream-logger)) ¶automatically generated reader method
The object that listens on a socket for connections.
toot.
(setf access-logger).
access-logger.
address.
(setf error-generator).
error-generator.
(setf handler).
handler.
initialize-instance.
listen-backlog.
(setf listen-socket).
listen-socket.
log-message.
(setf message-logger).
message-logger.
name.
(setf persistent-connections-p).
persistent-connections-p.
port.
print-object.
read-timeout.
(setf requests-in-progress).
requests-in-progress.
(setf shutdown-lock).
shutdown-lock.
(setf shutdown-p).
shutdown-p.
(setf shutdown-queue).
shutdown-queue.
ssl-certificate-file.
ssl-private-key-file.
ssl-private-key-password.
taskmaster.
write-timeout.
| Initarg | Value |
|---|---|
:address | nil |
:port | nil |
:name | (format nil toot ~a *toot-version*) |
:listen-backlog | 50 |
:taskmaster | (make-instance (if *supports-threads-p* (quote thread-per-connection-taskmaster) (quote single-threaded-taskmaster))) |
:persistent-connections-p | t |
:read-timeout | *default-connection-timeout* |
:write-timeout | *default-connection-timeout* |
:error-generator | (quote default-error-message-generator) |
:persistent-connections-p
:read-timeout
This slot is read-only.
:write-timeout
This slot is read-only.
:listen-backlog
This slot is read-only.
:ssl-certificate-file
This slot is read-only.
:ssl-private-key-file
This slot is read-only.
:ssl-private-key-password
This slot is read-only.
:handler
:error-generator
:taskmaster
This slot is read-only.
(make-instance (quote toot:stream-logger) :destination *error-output*)
:access-logger
(make-instance (quote toot:stream-logger) :destination *error-output*)
:message-logger
t
0
(bordeaux-threads:make-condition-variable)
(bordeaux-threads:make-lock "toot-shutdown")
A handler that serves files found under a given
root directory. Checks the path before serving the file with
specified path-checker which should be a function that takes the
path and returns true if it is safe. If the path checker returns
false, the request is aborted with 403: Forbidden.
A logger that writes to a given stream.
A 2-element array consisting of the character codes for a CRLF sequence.
toot.
The three-character names of the seven days of the week - needed for cookie date format.
toot.
A link to the website of the underlying Lisp implementation.
toot.
A FLEXI-STREAMS external format used for ‘faithful’ input and output of binary data.
toot.
The three-character names of the twelve months - needed for cookie date format.
toot.
Time in seconds to wait for a new connection to arrive before performing a cleanup run.
toot.
A FLEXI-STREAMS external format used internally for logging and to encode cookie values.
toot.
The default charset for text/* content-types.
toot.
Used to map numerical return codes to reason phrases.
toot.
A hash table which maps file suffixes to MIME types.
toot.
An alist where the cars are MIME types and the cdrs are lists of file suffixes for the corresponding type.
toot.
Lock to protect access to *tmp-counter*.
toot.
A string denoting the current version of Toot. Used for diagnostic output.
Shortcut to define constants for return codes. NAME is a Lisp symbol, VALUE is the numerical value of the return code, and REASON-PHRASE is the phrase (a string) to be shown in the server’s status line.
toot.
Make sure VALUE is evaluated only once (to appease SBCL).
toot.
Like HANDLER-CASE, but observes *CATCH-ERRORS-P*.
toot.
Like IGNORE-ERRORS, but observes *CATCH-ERRORS-P*.
toot.
Returns a vector with the same length and the same elements as
VECTOR (a variable holding a vector) but having element type
NEW-TYPE. If CONVERTER is not NIL, it should designate a function
which will be applied to each element of VECTOR before the result is
stored in the new vector. The resulting vector will have a fill
pointer set to its end.
The macro also uses SETF to store the new vector in VECTOR.
Executes BODY and invokes the debugger if an error is signaled and *CATCH-ERRORS-P* is NIL.
toot.
Accept connections on our listen socket and hand them back to the taskmaster via handle-incoming-connection. Called by taskmaster’s execute-acceptor.
Whether input chunking is currently switched on for the acceptor’s content stream.
The rfc2388 code is buggy in that it operates on a character stream and thus only accepts encodings which are 8 bit transparent. In order to support different encodings for parameter values submitted, we post process whatever string values the rfc2388 package has returned.
Returns the current value of the outgoing cookie named NAME. Search is case-sensitive.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
toot.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
toot.
copy-seq.
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
toot.
copy-seq.
Create a thread for handling a single request
toot.
A function that generates a bare-bones error page to be used as an error page generator.
Returns the relative portion of URL relative to URL-PREFIX, similar to what ENOUGH-NAMESTRING does for pathnames.
Creates and returns an external format corresponding to the value of the content type header provided in CONTENT-TYPE. If the content type was not set or if the character set specified was invalid, NIL is returned.
Set certain headers automatically based on values in the request object.
Find header by label from set of headers.
toot.
Find header parameter by name from set of parameters.
toot.
Converts a list FORM-URL-ENCODED-LIST of name/value pairs into an alist. Both names and values are url-decoded while doing this.
Return the value for the Content-Type header, including a charset if it’s a text/* type.
Returns a string with a backtrace of what the Lisp system thinks is the "current" error.
toot.
Returns the peer address and port of the socket SOCKET as two values. The address is returned as a string in dotted IP address notation.
Tests whether TOKEN is a string which is a valid ’token’ according to HTTP/1.1 (RFC 2068).
toot.
Signals an error of type TOOT-SIMPLE-ERROR with the provided format control and arguments.
toot.
Returns the universal time TIME as a string in full ISO format.
Should the current connection be kept alive? Secondary value indicates whether the client explicitly requested keep-alive. (Always the same as the primary value for HTTP/1.0 but potentially different in HTTP/1.1.)
Returns true if CHAR is a linear-whitespace-char (LWSP-char). Either space or tab, in short.
toot.
Make a handler that handles the request with SUB-HANDLER if the file name of the request is exactly the given PATH.
Make a stream just for writing the HTTP headers.
Returns the Content-Type header of mime-part PART.
toot.
Used to signal an error if an operation named NAME is not implemented.
toot.
Signals an error of type PARAMETER-ERROR with the provided format control and arguments.
toot.
Returns content-type which is parsed from STRING.
toot.
Reads and parses a ‘Content-Type’ header and returns it as three values - the type, the subtype, and the requests’ character set as specified in the ’charset’ parameter in the header, if there is one and if the content type is "text". CONTENT-TYPE-HEADER is supposed to be the corresponding header value as a string.
Parse the REQUEST body as multipart/form-data, assuming that its content type has already been verified. Returns the form data as alist or NIL if there was no data or the data could not be parsed.
Creates an alist of POST parameters from the stream STREAM which is supposed to be of content type ’multipart/form-data’.
Actually process the connection accepted via accept connection. Called by taskmaster’s handle-incoming-connection, possibly in a different thread than accept-connection is running in.
Process a single request. Called repeatedly by process-connection.
Quotes string according to RFC 2616’s definition of ‘quoted-string’.
Read the post data and return it as a vector of octets.
Read the post parameters from the body of the request and return them as an alist.
Reads incoming headers from the client via STREAM. Returns as multiple values the headers as an alist, the request-method, the URI, and the protocol of the request. The reading of the headers is handled by Chunga’s read-http-headers method.
Reads from STREAM up to the next boundary. Returns two values: read data (nil if DISCARD is true), and true if the boundary is not last (i.e., there’s more data).
toot.
Return a stream from which the body of the request can be read. If the request specified a content-length, this stream will not read beyond it. And if the request is using chunked transfer encoding, the stream will be a chunked stream that will return :eof when it gets to the end of the input. After the request has been handled, any input remaining on the stream will be drained.
Generates a time string according to RFC 1123. Default is current time.
Send a full response with the given content as the body.
Send the response headers and return the stream to which the body of the response can be written. The stream is a binary stream. The public API function, SEND-HEADERS will wrap that stream in a flexi-stream based on the content-type and charset, if needed. Thus function is for functions that are going to take care of encoding the response themselves, such as SERVE-FILE, which just dumps an already encoded to the steam as octets. If the request was a HEAD request we dynamically abort rather than returning a stream.
Send a response to the client before we’ve created a request object. This can be used by taskmasters when they cannot accept a connection.
Sets up timeouts on the given USOCKET object. READ-TIMEOUT is the read timeout period, WRITE-TIMEOUT is the write timeout, specified in (fractional) seconds. The timeouts can either be implemented using the low-level socket options SO_RCVTIMEO and SO_SNDTIMEO or some other, implementation specific mechanism. On platforms that do not support separate read and write timeouts, both must be equal or an error will be signaled. READ-TIMEOUT and WRITE-TIMEOUT may be NIL, which means that the corresponding socket timeout value will not be set.
toot.
Returns the position of first non-linear-whitespace character in STRING bound by START and END.
toot.
Signals a warning of type TOOT-SIMPLE-WARNING with the provided format control and arguments.
toot.
Returns content-type CT in string representation.
toot.
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated writer method
toot.
request-aborted)) ¶body.
toot.
stream-logger)) ¶automatically generated reader method
Called on a taskmaster which should call accept-connections on the acceptor.
toot.
thread-per-connection-taskmaster) acceptor) ¶single-threaded-taskmaster) acceptor) ¶Called on a taskmaster to handle a new connection by calling process-connection on acceptor.
toot.
thread-per-connection-taskmaster) acceptor socket) ¶single-threaded-taskmaster) acceptor socket) ¶search-handler)) ¶automatically generated reader method
search-handler)) ¶automatically generated writer method
Write a log entry for the request to the access log.
toot.
stream-logger) request) ¶null) request) ¶Write a log entry to the message log.
toot.
stream-logger) log-level format-string &rest format-arguments) ¶null) log-level format-string &rest format-arguments) ¶This generic function is called whenever a
condition CONDITION is signaled in Toot. You might want to specialize
it on specific condition classes for debugging purposes. The default
method invokes the debugger with CONDITION if *CATCH-ERRORS-P* is
NIL.
toot.
operation-not-implemented)) ¶Parses SOURCE and returs a single MIME header.
Header is a list of the form (NAME VALUE PARAMETERS), PARAMETERS is a list of (NAME . VALUE)
Parses MIME entities, returning them as a list. Each element in the list is of form: (body headers), where BODY is the contents of MIME part, and HEADERS are all headers for that part. BOUNDARY is a string used to separate MIME entities.
toot.
static-file-handler)) ¶automatically generated reader method
toot.
static-file-handler)) ¶automatically generated writer method
toot.
request-aborted)) ¶toot.
static-file-handler)) ¶automatically generated reader method
toot.
static-file-handler)) ¶automatically generated writer method
Shutdown the taskmaster, cleaning up any threads it created.
toot.
thread-per-connection-taskmaster)) ¶single-threaded-taskmaster)) ¶toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated writer method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated writer method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated writer method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated reader method
toot.
thread-per-connection-taskmaster)) ¶automatically generated writer method
This warning is signalled when an operation (like SETUID for example) is not implemented for a specific Lisp.
toot.
Signalled if a function was called with incosistent or illegal parameters.
toot.
Signaled internally to cause handling of a request to be aborted and a response sent by Toot itself.
Superclass for all conditions related to Toot.
toot.
condition.
Superclass for all errors related to Toot.
toot.
error.
toot-condition.
Like TOOT-ERROR but with formatting capabilities.
toot.
simple-condition.
toot-error.
Like TOOT-WARNING but with formatting capabilities.
toot.
simple-condition.
toot-warning.
Superclass for all warnings related to Toot.
toot.
toot-condition.
warning.
toot.
""
:value
:expires
:domain
:secure
:http-only
toot.
acceptor.
body-octets.
body-octets.
body-stream.
body-stream.
(setf close-stream-p).
close-stream-p.
(setf content-length).
content-length.
(setf content-stream).
content-stream.
(setf content-type).
content-type.
cookies-in.
(setf cookies-out).
cookies-out.
get-parameters.
(setf headers-sent-p).
headers-sent-p.
initialize-instance.
log-message.
post-parameters.
post-parameters.
remote-addr.
remote-port.
request-headers.
request-method.
request-uri.
(setf response-charset).
response-charset.
(setf response-headers).
response-headers.
server-protocol.
(setf status-code).
status-code.
(setf tmp-files).
tmp-files.
:remote-addr
This slot is read-only.
:remote-port
This slot is read-only.
:request-method
This slot is read-only.
:server-protocol
This slot is read-only.
:request-uri
This slot is read-only.
This slot is read-only.
This slot is read-only.
This slot is read-only.
This slot is read-only.
:request-headers
This slot is read-only.
This slot is read-only.
toot:+http-ok+
toot:*default-content-type*
toot::*default-charset*
t
:content-stream
:handlers
A taskmaster that starts one thread for listening
to incoming requests and one new thread for each incoming connection.
If MAX-THREAD-COUNT is null, a new thread will always be created for
each request.
If MAX-THREAD-COUNT is supplied, the number of request threads is
limited to that. Furthermore, if MAX-ACCEPT-COUNT is not supplied, an
HTTP 503 will be sent if the thread limit is exceeded. Otherwise, if
MAX-ACCEPT-COUNT is supplied, it must be greater than MAX-THREAD-COUNT;
in this case, requests are accepted up to MAX-ACCEPT-COUNT, and only
then is HTTP 503 sent.
In a load-balanced environment with multiple Toot servers, it’s
reasonable to provide MAX-THREAD-COUNT but leave MAX-ACCEPT-COUNT null.
This will immediately result in HTTP 503 when one server is out of
resources, so the load balancer can try to find another server.
In an environment with a single Toot server, it’s reasonable
to provide both MAX-THREAD-COUNT and a somewhat larger value for
MAX-ACCEPT-COUNT. This will cause a server that’s almost out of
resources to wait a bit; if the server is completely out of resources,
then the reply will be HTTP 503.
This is the default taskmaster implementation for multi-threaded Lisp implementations.
toot.
(setf acceptor-process).
acceptor-process.
execute-acceptor.
handle-incoming-connection.
initialize-instance.
shutdown.
(setf taskmaster-max-accept-count).
taskmaster-max-accept-count.
(setf taskmaster-max-thread-count).
taskmaster-max-thread-count.
(setf taskmaster-request-count).
taskmaster-request-count.
taskmaster-request-count-lock.
taskmaster-wait-lock.
taskmaster-wait-queue.
(setf taskmaster-worker-thread-name-format).
taskmaster-worker-thread-name-format.
| Initarg | Value |
|---|---|
:max-thread-count | *default-max-thread-count* |
:max-accept-count | *default-max-accept-count* |
(or integer null)
:max-thread-count
(or integer null)
:max-accept-count
integer
0
(bordeaux-threads:make-lock "taskmaster-request-count")
This slot is read-only.
(bordeaux-threads:make-condition-variable)
This slot is read-only.
(bordeaux-threads:make-lock "taskmaster-thread-lock")
This slot is read-only.
(or string null)
"toot-worker-~a"
:worker-thread-name-format
| Jump to: | (
A B C D E F G H I K L M N O P Q R S T U V W |
|---|
| Jump to: | (
A B C D E F G H I K L M N O P Q R S T U V W |
|---|
| Jump to: | *
+
A B C D E G H L M N O P R S T V W |
|---|
| Jump to: | *
+
A B C D E G H L M N O P R S T V W |
|---|
| Jump to: | A C D F H L M O P R S T U |
|---|
| Jump to: | A C D F H L M O P R S T U |
|---|