This is the restas Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:35:58 2024 GMT+0.
restas/restas.asdrestas/packages.lisprestas/special.lisprestas/declarations.lisprestas/errors.lisprestas/render.lisprestas/context.lisprestas/module.lisprestas/route.lisprestas/decorators.lisprestas/vhost.lisprestas/hunchentoot.lisprestas/policy.lispThe main system appears first, followed by any subsystem dependency.
restasRESTAS is a Common Lisp web application framework, based
on the Hunchentoot HTTP server. It was developed to simplify development of
web applications following the REST architectural style.
Moskvitin Andrey
LLGPL
cffi (system).
hunchentoot (system).
bordeaux-threads (system).
routes (system).
alexandria (system).
data-sift (system).
packages.lisp (file).
special.lisp (file).
declarations.lisp (file).
errors.lisp (file).
render.lisp (file).
context.lisp (file).
module.lisp (file).
route.lisp (file).
decorators.lisp (file).
vhost.lisp (file).
hunchentoot.lisp (file).
policy.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
restas/restas.asdrestas/packages.lisprestas/special.lisprestas/declarations.lisprestas/errors.lisprestas/render.lisprestas/context.lisprestas/module.lisprestas/route.lisprestas/decorators.lisprestas/vhost.lisprestas/hunchentoot.lisprestas/policy.lisprestas/special.lisppackages.lisp (file).
restas (system).
*default-host-redirect* (special variable).
*max-debugging-threads* (special variable).
*module* (special variable).
*render-method* (special variable).
*route* (special variable).
*acceptors* (special variable).
*catch-errors-p* (special variable).
*debugging-threads* (special variable).
*debugging-threads-lock* (special variable).
*standard-special-page-p* (special variable).
restas/declarations.lisppackages.lisp (file).
restas (system).
define-declaration (macro).
*mount-module-declarations* (special variable).
*route-declarations* (special variable).
parse-all-declarations (function).
parse-declarations (generic function).
split-code-declarations (function).
restas/errors.lispspecial.lisp (file).
restas (system).
debug-mode-off (function).
debug-mode-on (function).
after-close-swank-connection (function).
kill-all-debugging-threads (function).
maybe-invoke-debugger (function).
restas/render.lispspecial.lisp (file).
restas (system).
render-object (generic function).
restas/context.lispspecial.lisp (file).
restas (system).
context-add-variable (function).
context-remove-variable (function).
context-symbol-value (function).
(setf context-symbol-value) (function).
copy-restas-context (function).
make-context (function).
with-context (macro).
context-all-values (function).
context-all-vars (function).
context-prototype (reader method).
(setf context-prototype) (writer method).
context-values (reader method).
(setf context-values) (writer method).
context-vars (reader method).
(setf context-vars) (writer method).
restas-context (class).
restas/module.lispcontext.lisp (file).
declarations.lisp (file).
restas (system).
define-module (macro).
finalize-module-instance (generic function).
find-mounted-module (function).
initialize-module-instance (generic function).
module-context (generic function).
mount-module (macro).
shared-initialize (method).
with-module (macro).
*pkgmodules-traits* (special variable).
apply-decorators (function).
connect-module (generic function).
distribute-all-routes (function).
distribute-route (function).
find-pkgmodule-traits (function).
find-route (function).
module-decorators (function).
module-find-child-module (generic function).
module-find-route (generic function).
module-mount-url (generic reader).
module-parent (generic reader).
module-real-url (function).
module-render-method (generic reader).
module-symbol (generic reader).
pkgmodule (class).
pkgmodule-traits-append-reference (function).
pkgmodule-traits-content-type (function).
pkgmodule-traits-modules (function).
pkgmodule-traits-references (function).
pkgmodule-traits-routes (function).
register-pkgmodule-traits (function).
register-route-traits (function).
with-module-context (macro).
restas/route.lispmodule.lisp (file).
render.lisp (file).
restas (system).
abort-route-handler (function).
define-route (macro).
delete-route (function).
genurl (function).
genurl* (function).
make-route-url (generic function).
parse-route-url (function).
process-route (generic function).
redirect (function).
route (class).
route-check-conditions (method).
route-name (method).
route-symbol (method).
route-symbol (reader method).
apply-format-aux (function).
create-route-from-symbol (function).
get-ref-syms (function).
route-arbitrary-requirement (reader method).
route-headers (reader method).
route-module (generic function).
route-render-method (function).
route-required-method (reader method).
route-symbol-template (function).
route-template-from-symbol (function).
restas/decorators.lisproute.lisp (file).
restas (system).
*nginx-internal-alias* (special variable).
*nginx-internal-location* (special variable).
*nginx-internal-root* (special variable).
@apache-xsendfile (function).
@nginx-accel-redirect (function).
@no-cache (function).
process-route (method).
process-route (method).
process-route (method).
apache-xsendfile-route (class).
concat-pathnames (function).
nginx-accel-redirect-route (class).
no-cache-route (class).
restas/vhost.lispspecial.lisp (file).
restas (system).
reconnect-all-routes (function).
*vhosts* (special variable).
add-toplevel-module (generic function).
clear-all-vhost (function).
ensure-vhost-exist (function).
find-vhost (function).
vhost (class).
vhost-hostname (reader method).
vhost-hostname-port (function).
vhost-port (reader method).
restas/hunchentoot.lispvhost.lisp (file).
module.lisp (file).
errors.lisp (file).
restas (system).
acceptor-dispatch-request (method).
acceptor-dispatch-request (method).
acceptor-status-message (method).
header-in (method).
process-request (method).
request-full-uri (function).
restas-acceptor (class).
restas-ssl-acceptor (class).
start (function).
stop-all (function).
request-hostname-port (function).
restas-acceptor-mixin (class).
restas-dispatch-request (function).
restas-request (class).
restas-request-bindings (reader method).
(setf restas-request-bindings) (writer method).
restas/policy.lisppackages.lisp (file).
restas (system).
define-policy (macro).
%define-policy (function).
%parse-define-policy-options (function).
make-internal-function (function).
Packages are listed by definition order.
restascommon-lisp.
iterate.
split-sequence.
*default-host-redirect* (special variable).
*max-debugging-threads* (special variable).
*module* (special variable).
*nginx-internal-alias* (special variable).
*nginx-internal-location* (special variable).
*nginx-internal-root* (special variable).
*render-method* (special variable).
*route* (special variable).
@apache-xsendfile (function).
@nginx-accel-redirect (function).
@no-cache (function).
abort-route-handler (function).
context-add-variable (function).
context-remove-variable (function).
context-symbol-value (function).
(setf context-symbol-value) (function).
copy-restas-context (function).
debug-mode-off (function).
debug-mode-on (function).
define-declaration (macro).
define-module (macro).
define-policy (macro).
define-route (macro).
delete-route (function).
finalize-module-instance (generic function).
find-mounted-module (function).
genurl (function).
genurl* (function).
initialize-module-instance (generic function).
make-context (function).
make-route-url (generic function).
module-context (generic function).
mount-module (macro).
parse-route-url (function).
process-route (generic function).
reconnect-all-routes (function).
redirect (function).
render-object (generic function).
request-full-uri (function).
restas-acceptor (class).
restas-ssl-acceptor (class).
route (class).
route-symbol (generic function).
start (function).
stop-all (function).
with-context (macro).
with-module (macro).
%define-policy (function).
%parse-define-policy-options (function).
*acceptors* (special variable).
*catch-errors-p* (special variable).
*debugging-threads* (special variable).
*debugging-threads-lock* (special variable).
*mount-module-declarations* (special variable).
*pkgmodules-traits* (special variable).
*route-declarations* (special variable).
*standard-special-page-p* (special variable).
*vhosts* (special variable).
add-toplevel-module (generic function).
after-close-swank-connection (function).
apache-xsendfile-route (class).
apply-decorators (function).
apply-format-aux (function).
clear-all-vhost (function).
concat-pathnames (function).
connect-module (generic function).
context-all-values (function).
context-all-vars (function).
context-prototype (generic reader).
(setf context-prototype) (generic writer).
context-values (generic reader).
(setf context-values) (generic writer).
context-vars (generic reader).
(setf context-vars) (generic writer).
create-route-from-symbol (function).
distribute-all-routes (function).
distribute-route (function).
ensure-vhost-exist (function).
find-pkgmodule-traits (function).
find-route (function).
find-vhost (function).
get-ref-syms (function).
kill-all-debugging-threads (function).
make-internal-function (function).
maybe-invoke-debugger (function).
module-decorators (function).
module-find-child-module (generic function).
module-find-route (generic function).
module-mount-url (generic reader).
module-parent (generic reader).
module-real-url (function).
module-render-method (generic reader).
module-symbol (generic reader).
nginx-accel-redirect-route (class).
no-cache-route (class).
parse-all-declarations (function).
parse-declarations (generic function).
pkgmodule (class).
pkgmodule-traits-append-reference (function).
pkgmodule-traits-content-type (function).
pkgmodule-traits-modules (function).
pkgmodule-traits-references (function).
pkgmodule-traits-routes (function).
register-pkgmodule-traits (function).
register-route-traits (function).
request-hostname-port (function).
restas-acceptor-mixin (class).
restas-context (class).
restas-dispatch-request (function).
restas-request (class).
restas-request-bindings (generic reader).
(setf restas-request-bindings) (generic writer).
route-arbitrary-requirement (generic reader).
route-headers (generic reader).
route-module (generic function).
route-render-method (function).
route-required-method (generic reader).
route-symbol-template (function).
route-template-from-symbol (function).
split-code-declarations (function).
vhost (class).
vhost-hostname (generic reader).
vhost-hostname-port (function).
vhost-port (generic reader).
with-module-context (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Maximum number of simultaneous active calls invoke-debuger
Turn off debug mode
Enable debug mode
Call for module finalization
Call for module initialization
Context of the MODULE
apache-xsendfile-route) bindings) ¶nginx-accel-redirect-route) bindings) ¶no-cache-route) bindings) ¶proxy-route) bindings) ¶base-route) bindings) ¶Render object via designer
package) (octets vector)) ¶package) (string string)) ¶package) (file pathname)) ¶package) (code integer)) ¶package) object) ¶symbol) object) ¶function) (octets vector)) ¶function) (string string)) ¶function) (file pathname)) ¶function) (code integer)) ¶function) object) ¶(eql nil))) ¶vector)) ¶string)) ¶Default handler for string
integer)) ¶Default handler for HTTP status code
integer)) ¶pathname)) ¶Default handler for pathname
restas-ssl-acceptor) request) ¶hunchentoot.
restas-acceptor) request) ¶hunchentoot.
restas-acceptor-mixin) http-status-code &key &allow-other-keys) ¶hunchentoot.
(eql :host)) (request restas-request)) ¶hunchentoot.
restas-request)) ¶hunchentoot.
acceptor.
restas-acceptor-mixin.
| Initarg | Value |
|---|---|
:request-class | (quote restas-request) |
:error-template-directory | nil |
:access-log-destination | nil |
:message-log-destination | nil |
restas-acceptor-mixin.
ssl-acceptor.
| Initarg | Value |
|---|---|
:request-class | (quote restas-request) |
:error-template-directory | nil |
:access-log-destination | nil |
:message-log-destination | nil |
route.
common-lisp.
:symbol
This slot is read-only.
:module
This slot is read-only.
:required-method
This slot is read-only.
:arbitrary-requirement
This slot is read-only.
(lambda nil (function identity))
:render-method
:headers
This slot is read-only.
nil, :variables
:additional-variables
List debugged threads
A global lock to prevent two threads from modifying *debugging-threads* at the same time
Turns off debug mode and destroy debugging threads after closing the connection with the swank-server
Tests whether the vhost exist, and attempts to create them if they do not.
Used for destroy all debugging threads
Adds routes of the module to the routing table
restas-context)) ¶automatically generated reader method
restas-context)) ¶automatically generated writer method
restas-context)) ¶automatically generated reader method
restas-context)) ¶automatically generated writer method
restas-context)) ¶automatically generated reader method
vars.
restas-context)) ¶automatically generated writer method
vars.
Find the mounted module in the MODULE
Find the route in the MODULE
Return URL where the MODULE is mounted
Parent of the MODULE
Return MODULE render method
MODULE identifier
(eql :inherit-parent-context)) declarations target traits) ¶(eql :url)) declarations target traits) ¶(eql :requirement)) declarations target traits) ¶(eql :http-method)) declarations target traits) ¶(eql :decorators)) declarations target traits) ¶(eql :content-type)) declarations target traits) ¶(eql :apply-render-method)) declarations target traits) ¶(eql :render-method)) declarations target traits) ¶(eql :additional-variables)) declarations target traits) ¶(eql :sift-variables)) declarations target traits) ¶restas-request)) ¶automatically generated reader method
restas-request)) ¶automatically generated writer method
proxy-route.
proxy-route.
proxy-route.
common-lisp.
:symbol
This slot is read-only.
(restas:make-context)
:context
This slot is read-only.
:parent
This slot is read-only.
:url
This slot is read-only.
:render-method
This slot is read-only.
:decorators
common-lisp.
:package
(make-hash-table)
(make-hash-table)
request.
routes:+no-bindings+
restas::substitutions
| Jump to: | %
(
@
A C D E F G H I K M P R S V W |
|---|
| Jump to: | %
(
@
A C D E F G H I K M P R S V W |
|---|
| Jump to: | *
A C D H M P R S V |
|---|
| Jump to: | *
A C D H M P R S V |
|---|
| Jump to: | A C D E F H M N P R S V |
|---|
| Jump to: | A C D E F H M N P R S V |
|---|