The restas Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The restas Reference Manual

This is the restas Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:46:09 2022 GMT+0.

Table of Contents


1 Introduction

`RESTAS`_ is a Common Lisp web application framework. Its key features
are:

* `RESTAS`_ was developed to simplify development of web applications
  following the `REST`_ architectural style.

* RESTAS is based on the `Hunchentoot`_ HTTP server. Web application
  development with RESTAS is in many ways simpler than with
  `Hunchentoot`_, but some knowledge of `Hunchentoot`_ is required, at
  least about working with hunchentoot:*request* and
  hunchentoot:*reply*.

* Request dispatch is based on a route system. The route system is the
  key concept of `RESTAS`_ and provides unique features not found in
  other web frameworks.

* The other key `RESTAS`_ concept is its module system, which provides
  a simple and flexible mechanism for modularized code reuse.

* Interactive development support. Any RESTAS code (such as the
  definition of a route, a module or a submodule) can be recompiled at
  any time when you work in `SLIME`_ and any changes you made can be
  immediately seen in the browser. No web server restart or other
  complicated actions are needed.

* `SLIME`_ integration. The inner structure of a web application can
  be investigated with the standard "SLIME Inspector." For example,
  there is a "site map" and a simple code navigation with this map.

* Easy to use, pure Lisp web application daemonization facility based on
  `RESTAS`_ and `SBCL`_ in Linux without the use of `Screen`_ or `detachtty`_.

* RESTAS is not an MVC framework, although it is not incompatible with the concept.
  From the MVC point of view, `RESTAS`_ provides the controller level. Nevertheless,
  `RESTAS`_ provides an effective and flexible way for separation of logic and
  representation, because it does not put any constraints on the structure of
  applications. Separation of model and controller can be effectively
  performed with Common Lisp facilities, and, hence, doesn't need any special
  support from the framework.

* RESTAS does not come with a templating
  library. `cl-closure-template`_ and `HTML-TEMPLATE`_ are two good
  templating libraries that can be used with RESTAS.

`RESTAS`_ is distributed under the terms of the `Lisp LGPL`_ license.

.. _RESTAS: http://restas.lisper.ru/
.. _SLIME: http://common-lisp.net/project/slime/
.. _Hunchentoot: http://www.weitz.de/hunchentoot/
.. _SBCL: http://www.sbcl.org/
.. _Screen: http://www.gnu.org/software/screen/
.. _detachtty: http://www.cliki.net/detachtty
.. _HTML-TEMPLATE: http://www.weitz.de/html-template/
.. _cl-closure-template: https://github.com/archimag/cl-closure-template
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
.. _Lisp LGPL: http://opensource.franz.com/preamble.html



2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 restas

RESTAS 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.

Author

Moskvitin Andrey

License

LLGPL

Dependencies
  • cffi (system).
  • hunchentoot (system).
  • bordeaux-threads (system).
  • routes (system).
  • alexandria (system).
  • data-sift (system).
Source

restas.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 restas/restas.asd

Source

restas.asd.

Parent Component

restas (system).

ASDF Systems

restas.


3.1.2 restas/packages.lisp

Source

restas.asd.

Parent Component

restas (system).

Packages

restas.


3.1.3 restas/special.lisp

Dependency

packages.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.4 restas/declarations.lisp

Dependency

packages.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface

define-declaration (macro).

Internals

3.1.5 restas/errors.lisp

Dependency

special.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.6 restas/render.lisp

Dependency

special.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface

render-object (generic function).


3.1.7 restas/context.lisp

Dependency

special.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.8 restas/module.lisp

Dependencies
Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.9 restas/route.lisp

Dependencies
Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.10 restas/decorators.lisp

Dependency

route.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.11 restas/vhost.lisp

Dependency

special.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Public Interface

reconnect-all-routes (function).

Internals

3.1.12 restas/hunchentoot.lisp

Dependencies
Source

restas.asd.

Parent Component

restas (system).

Public Interface
Internals

3.1.13 restas/policy.lisp

Dependency

packages.lisp (file).

Source

restas.asd.

Parent Component

restas (system).

Packages

restas.policy.internal.

Public Interface

define-policy (macro).

Internals

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 restas.policy.internal

Source

policy.lisp.


4.2 restas

Source

packages.lisp.

Use List
  • common-lisp.
  • iterate.
  • split-sequence.
Public Interface
Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Special variables

Special Variable: *default-host-redirect*
Package

restas.

Source

special.lisp.

Special Variable: *max-debugging-threads*

Maximum number of simultaneous active calls invoke-debuger

Package

restas.

Source

special.lisp.

Special Variable: *module*
Package

restas.

Source

special.lisp.

Special Variable: *nginx-internal-alias*
Package

restas.

Source

decorators.lisp.

Special Variable: *nginx-internal-location*
Package

restas.

Source

decorators.lisp.

Special Variable: *nginx-internal-root*
Package

restas.

Source

decorators.lisp.

Special Variable: *render-method*
Package

restas.

Source

special.lisp.

Special Variable: *route*
Package

restas.

Source

special.lisp.


5.1.2 Macros

Macro: define-declaration (declaration scope (declarations target traits) &body body)
Package

restas.

Source

declarations.lisp.

Macro: define-module (name &body options)
Package

restas.

Source

module.lisp.

Macro: define-policy (name &body body)
Package

restas.

Source

policy.lisp.

Macro: define-route (name (template &key method content-type) &body body)
Package

restas.

Source

route.lisp.

Macro: mount-module (name (module) &body body)
Package

restas.

Source

module.lisp.

Macro: with-context (context &body body)
Package

restas.

Source

context.lisp.

Macro: with-module (module &body body)
Package

restas.

Source

module.lisp.


5.1.3 Ordinary functions

Function: @apache-xsendfile (origin)
Package

restas.

Source

decorators.lisp.

Function: @nginx-accel-redirect (origin)
Package

restas.

Source

decorators.lisp.

Function: @no-cache (route)
Package

restas.

Source

decorators.lisp.

Function: abort-route-handler (obj &key return-code content-type)
Package

restas.

Source

route.lisp.

Function: context-add-variable (context symbol &optional value)
Package

restas.

Source

context.lisp.

Function: context-remove-variable (context symbol)
Package

restas.

Source

context.lisp.

Function: context-symbol-value (context symbol)
Package

restas.

Source

context.lisp.

Function: (setf context-symbol-value) (context symbol)
Package

restas.

Source

context.lisp.

Function: copy-restas-context (rc)
Package

restas.

Source

context.lisp.

Function: debug-mode-off (&optional kill-debugging-threads)

Turn off debug mode

Package

restas.

Source

errors.lisp.

Function: debug-mode-on ()

Enable debug mode

Package

restas.

Source

errors.lisp.

Function: delete-route (route-symbol)
Package

restas.

Source

route.lisp.

Function: find-mounted-module (module-symbol &optional module)
Package

restas.

Source

module.lisp.

Function: genurl (route-symbol &rest args &key &allow-other-keys)
Package

restas.

Source

route.lisp.

Function: genurl* (route-symbol &rest args &key &allow-other-keys)
Package

restas.

Source

route.lisp.

Function: make-context (&optional bindings)
Package

restas.

Source

context.lisp.

Function: parse-route-url (url route-symbol)
Package

restas.

Source

route.lisp.

Function: reconnect-all-routes ()
Package

restas.

Source

vhost.lisp.

Function: redirect (route-symbol &rest args)
Package

restas.

Source

route.lisp.

Function: request-full-uri (&optional request)
Package

restas.

Source

hunchentoot.lisp.

Function: start (module &key ssl-certificate-file ssl-privatekey-file ssl-privatekey-password hostname port address acceptor-class context url render-method decorators)
Package

restas.

Source

hunchentoot.lisp.

Function: stop-all (&key soft)
Package

restas.

Source

hunchentoot.lisp.


5.1.4 Generic functions

Generic Function: finalize-module-instance (module context)

Call for module finalization

Package

restas.

Source

module.lisp.

Methods
Method: finalize-module-instance ((module pkgmodule) context)
Method: finalize-module-instance (module context)
Generic Function: initialize-module-instance (module context)

Call for module initialization

Package

restas.

Source

module.lisp.

Methods
Method: initialize-module-instance ((module pkgmodule) context)
Method: initialize-module-instance (module context)
Generic Function: make-route-url (obj args)
Package

restas.

Source

route.lisp.

Methods
Method: make-route-url ((route proxy-route) bindings)
Method: make-route-url ((route route) args)
Method: make-route-url ((route symbol) args)
Method: make-route-url ((tmpl list) args)
Generic Function: module-context (module)

Context of the MODULE

Package

restas.

Source

module.lisp.

Methods
Reader Method: module-context ((pkgmodule pkgmodule))

automatically generated reader method

Target Slot

context.

Method: module-context ((module symbol))

Get the context for a mounted module.

MODULE should be the name used for mount-module.

Generic Function: process-route (route bindings)
Package

restas.

Source

route.lisp.

Methods
Method: process-route ((route apache-xsendfile-route) bindings)
Source

decorators.lisp.

Method: process-route ((route nginx-accel-redirect-route) bindings)
Source

decorators.lisp.

Method: process-route :before ((route no-cache-route) bindings)
Source

decorators.lisp.

Method: process-route ((route proxy-route) bindings)
Method: process-route ((route route) bindings)
Method: process-route :around ((route base-route) bindings)
Generic Function: render-object (designer object)

Render object via designer

Package

restas.

Source

render.lisp.

Methods
Method: render-object ((designer package) (octets vector))
Method: render-object ((designer package) (string string))
Method: render-object ((designer package) (file pathname))
Method: render-object ((designer package) (code integer))
Method: render-object ((designer package) object)
Method: render-object ((designer symbol) object)
Method: render-object ((designer function) (octets vector))
Method: render-object ((designer function) (string string))
Method: render-object ((designer function) (file pathname))
Method: render-object ((designer function) (code integer))
Method: render-object ((designer function) object)
Method: render-object (designer object)
Method: render-object (designer (obj (eql nil)))
Method: render-object (designer (octets vector))
Method: render-object (designer (string string))

Default handler for string

Method: render-object (designer (code integer))

Default handler for HTTP status code

Method: render-object :before (designer (code integer))
Method: render-object (designer (file pathname))

Default handler for pathname

Generic Function: route-symbol (object)
Package

restas.

Methods
Method: route-symbol ((route proxy-route))
Source

route.lisp.

Reader Method: route-symbol ((route route))

automatically generated reader method

Source

route.lisp.

Target Slot

symbol.


5.1.5 Standalone methods

Method: acceptor-dispatch-request ((acceptor restas-ssl-acceptor) request)
Package

hunchentoot.

Source

hunchentoot.lisp.

Method: acceptor-dispatch-request ((acceptor restas-acceptor) request)
Package

hunchentoot.

Source

hunchentoot.lisp.

Method: acceptor-status-message :around ((acceptor restas-acceptor-mixin) http-status-code &key &allow-other-keys)
Package

hunchentoot.

Source

hunchentoot.lisp.

Method: header-in ((name (eql :host)) (request restas-request))
Package

hunchentoot.

Source

hunchentoot.lisp.

Method: process-request :around ((request restas-request))
Package

hunchentoot.

Source

hunchentoot.lisp.

Method: route-check-conditions ((route route) bindings)
Package

routes.

Source

route.lisp.

Method: route-name ((route route))
Package

routes.

Source

route.lisp.

Method: shared-initialize :after ((module pkgmodule) slot-names &key)
Source

module.lisp.


5.1.6 Classes

Class: restas-acceptor
Package

restas.

Source

hunchentoot.lisp.

Direct superclasses
Direct methods

acceptor-dispatch-request.

Direct Default Initargs
InitargValue
:request-class(quote restas-request)
:error-template-directorynil
:access-log-destinationnil
:message-log-destinationnil
Class: restas-ssl-acceptor
Package

restas.

Source

hunchentoot.lisp.

Direct superclasses
Direct methods

acceptor-dispatch-request.

Direct Default Initargs
InitargValue
:request-class(quote restas-request)
:error-template-directorynil
:access-log-destinationnil
:message-log-destinationnil
Class: route
Package

restas.

Source

route.lisp.

Direct superclasses

route.

Direct methods
Direct slots
Slot: symbol
Package

common-lisp.

Initargs

:symbol

Readers

route-symbol.

Writers

This slot is read-only.

Slot: module
Initargs

:module

Readers

route-module.

Writers

This slot is read-only.

Slot: required-method
Initargs

:required-method

Readers

route-required-method.

Writers

This slot is read-only.

Slot: arbitrary-requirement
Initargs

:arbitrary-requirement

Readers

route-arbitrary-requirement.

Writers

This slot is read-only.

Slot: render-method
Initform

(lambda nil (function identity))

Initargs

:render-method

Slot: headers
Initargs

:headers

Readers

route-headers.

Writers

This slot is read-only.

Slot: variables
Initargs

nil, :variables

Slot: additional-variables
Initargs

:additional-variables


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *acceptors*
Package

restas.

Source

special.lisp.

Special Variable: *catch-errors-p*
Package

restas.

Source

special.lisp.

Special Variable: *debugging-threads*

List debugged threads

Package

restas.

Source

special.lisp.

Special Variable: *debugging-threads-lock*

A global lock to prevent two threads from modifying *debugging-threads* at the same time

Package

restas.

Source

special.lisp.

Special Variable: *mount-module-declarations*
Package

restas.

Source

declarations.lisp.

Special Variable: *pkgmodules-traits*
Package

restas.

Source

module.lisp.

Special Variable: *route-declarations*
Package

restas.

Source

declarations.lisp.

Special Variable: *standard-special-page-p*
Package

restas.

Source

special.lisp.

Special Variable: *vhosts*
Package

restas.

Source

vhost.lisp.


5.2.2 Macros

Macro: with-module-context (module &body body)
Package

restas.

Source

module.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.3 Ordinary functions

Function: %define-policy (name methods &key interface-package interface-method-template internal-package internal-function-template)
Package

restas.

Source

policy.lisp.

Function: %parse-define-policy-options (options)
Package

restas.

Source

policy.lisp.

Function: after-close-swank-connection (connection)

Turns off debug mode and destroy debugging threads after closing the connection with the swank-server

Package

restas.

Source

errors.lisp.

Function: apply-decorators (route decorators)
Package

restas.

Source

module.lisp.

Function: apply-format-aux (format args)
Package

restas.

Source

route.lisp.

Function: clear-all-vhost ()
Package

restas.

Source

vhost.lisp.

Function: concat-pathnames (path1 path2)
Package

restas.

Source

decorators.lisp.

Function: context-all-values (context)
Package

restas.

Source

context.lisp.

Function: context-all-vars (context)
Package

restas.

Source

context.lisp.

Function: create-route-from-symbol (symbol module)
Package

restas.

Source

route.lisp.

Function: distribute-all-routes (package)
Package

restas.

Source

module.lisp.

Function: distribute-route (route-symbol)
Package

restas.

Source

module.lisp.

Function: ensure-vhost-exist (hostname port)

Tests whether the vhost exist, and attempts to create them if they do not.

Package

restas.

Source

vhost.lisp.

Function: find-pkgmodule-traits (package)
Package

restas.

Source

module.lisp.

Function: find-route (route-symbol &optional module)
Package

restas.

Source

module.lisp.

Function: find-vhost (hostname.port)
Package

restas.

Source

vhost.lisp.

Function: get-ref-syms (route-symbol &optional syms)
Package

restas.

Source

route.lisp.

Function: kill-all-debugging-threads ()

Used for destroy all debugging threads

Package

restas.

Source

errors.lisp.

Function: make-internal-function (name policy-var interface-method lambda-list &optional documentation)
Package

restas.

Source

policy.lisp.

Function: maybe-invoke-debugger (condition)
Package

restas.

Source

errors.lisp.

Function: module-decorators (pkgmodule)
Package

restas.

Source

module.lisp.

Function: module-real-url (module)
Package

restas.

Source

module.lisp.

Function: parse-all-declarations (declarations allowed-types target &optional traits)
Package

restas.

Source

declarations.lisp.

Function: pkgmodule-traits-append-reference (package reference)
Package

restas.

Source

module.lisp.

Function: pkgmodule-traits-content-type (package)
Package

restas.

Source

module.lisp.

Function: pkgmodule-traits-modules (package)
Package

restas.

Source

module.lisp.

Function: pkgmodule-traits-references (package)
Package

restas.

Source

module.lisp.

Function: pkgmodule-traits-routes (package)
Package

restas.

Source

module.lisp.

Function: register-pkgmodule-traits (package &rest traits &key &allow-other-keys)
Package

restas.

Source

module.lisp.

Function: register-route-traits (route-symbol traits)
Package

restas.

Source

module.lisp.

Function: request-hostname-port (acceptor request)
Package

restas.

Source

hunchentoot.lisp.

Function: restas-dispatch-request (acceptor request)
Package

restas.

Source

hunchentoot.lisp.

Function: route-render-method (route)
Package

restas.

Source

route.lisp.

Function: route-symbol-template (route-symbol)
Package

restas.

Source

route.lisp.

Function: route-template-from-symbol (symbol module)
Package

restas.

Source

route.lisp.

Function: split-code-declarations (body)
Package

restas.

Source

declarations.lisp.

Function: vhost-hostname-port (vhost)
Package

restas.

Source

vhost.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.4 Generic functions

Generic Function: add-toplevel-module (module hostname port &key context url render-method decorators)
Package

restas.

Source

vhost.lisp.

Methods
Method: add-toplevel-module ((package package) hostname port &key context url render-method decorators)
Method: add-toplevel-module ((module symbol) hostname port &key context url render-method decorators)
Generic Function: connect-module (module mapper)

Adds routes of the module to the routing table

Package

restas.

Source

module.lisp.

Methods
Method: connect-module ((module pkgmodule) mapper)
Generic Reader: context-prototype (object)
Package

restas.

Methods
Reader Method: context-prototype ((restas-context restas-context))

automatically generated reader method

Source

context.lisp.

Target Slot

prototype.

Generic Writer: (setf context-prototype) (object)
Package

restas.

Methods
Writer Method: (setf context-prototype) ((restas-context restas-context))

automatically generated writer method

Source

context.lisp.

Target Slot

prototype.

Generic Reader: context-values (object)
Package

restas.

Methods
Reader Method: context-values ((restas-context restas-context))

automatically generated reader method

Source

context.lisp.

Target Slot

values.

Generic Writer: (setf context-values) (object)
Package

restas.

Methods
Writer Method: (setf context-values) ((restas-context restas-context))

automatically generated writer method

Source

context.lisp.

Target Slot

values.

Generic Reader: context-vars (object)
Package

restas.

Methods
Reader Method: context-vars ((restas-context restas-context))

automatically generated reader method

Source

context.lisp.

Target Slot

vars.

Generic Writer: (setf context-vars) (object)
Package

restas.

Methods
Writer Method: (setf context-vars) ((restas-context restas-context))

automatically generated writer method

Source

context.lisp.

Target Slot

vars.

Generic Function: module-find-child-module (module module-symbol)

Find the mounted module in the MODULE

Package

restas.

Source

module.lisp.

Methods
Method: module-find-child-module ((module pkgmodule) module-symbol)
Generic Function: module-find-route (module route-symbol)

Find the route in the MODULE

Package

restas.

Source

module.lisp.

Methods
Method: module-find-route ((module pkgmodule) route-symbol)
Generic Reader: module-mount-url (module)

Return URL where the MODULE is mounted

Package

restas.

Source

module.lisp.

Methods
Reader Method: module-mount-url ((pkgmodule pkgmodule))

automatically generated reader method

Target Slot

mount-url.

Generic Reader: module-parent (module)

Parent of the MODULE

Package

restas.

Source

module.lisp.

Methods
Reader Method: module-parent ((pkgmodule pkgmodule))

automatically generated reader method

Target Slot

parent.

Generic Reader: module-render-method (module)

Return MODULE render method

Package

restas.

Source

module.lisp.

Methods
Reader Method: module-render-method ((pkgmodule pkgmodule))

automatically generated reader method

Target Slot

render-method.

Generic Reader: module-symbol (module)

MODULE identifier

Package

restas.

Source

module.lisp.

Methods
Reader Method: module-symbol ((pkgmodule pkgmodule))

automatically generated reader method

Target Slot

symbol.

Generic Function: parse-declarations (type declarations target traits)
Package

restas.

Source

declarations.lisp.

Methods
Method: parse-declarations ((type (eql :inherit-parent-context)) declarations target traits)
Method: parse-declarations ((type (eql :url)) declarations target traits)
Method: parse-declarations ((type (eql :requirement)) declarations target traits)
Method: parse-declarations ((type (eql :http-method)) declarations target traits)
Method: parse-declarations ((type (eql :decorators)) declarations target traits)
Method: parse-declarations ((type (eql :content-type)) declarations target traits)
Method: parse-declarations ((type (eql :apply-render-method)) declarations target traits)
Method: parse-declarations ((type (eql :render-method)) declarations target traits)
Method: parse-declarations ((type (eql :additional-variables)) declarations target traits)
Method: parse-declarations ((type (eql :sift-variables)) declarations target traits)
Method: parse-declarations (type declarations target traits)
Generic Reader: restas-request-bindings (object)
Package

restas.

Methods
Reader Method: restas-request-bindings ((restas-request restas-request))

automatically generated reader method

Source

hunchentoot.lisp.

Target Slot

substitutions.

Generic Writer: (setf restas-request-bindings) (object)
Package

restas.

Methods
Writer Method: (setf restas-request-bindings) ((restas-request restas-request))

automatically generated writer method

Source

hunchentoot.lisp.

Target Slot

substitutions.

Generic Reader: route-arbitrary-requirement (object)
Package

restas.

Methods
Reader Method: route-arbitrary-requirement ((route route))

automatically generated reader method

Source

route.lisp.

Target Slot

arbitrary-requirement.

Generic Reader: route-headers (object)
Package

restas.

Methods
Reader Method: route-headers ((route route))

automatically generated reader method

Source

route.lisp.

Target Slot

headers.

Generic Function: route-module (route)
Package

restas.

Source

route.lisp.

Methods
Method: route-module ((route proxy-route))
Reader Method: route-module ((route route))

automatically generated reader method

Target Slot

module.

Generic Reader: route-required-method (object)
Package

restas.

Methods
Reader Method: route-required-method ((route route))

automatically generated reader method

Source

route.lisp.

Target Slot

required-method.

Generic Reader: vhost-hostname (object)
Package

restas.

Methods
Reader Method: vhost-hostname ((vhost vhost))

automatically generated reader method

Source

vhost.lisp.

Target Slot

hostname.

Generic Reader: vhost-port (object)
Package

restas.

Methods
Reader Method: vhost-port ((vhost vhost))

automatically generated reader method

Source

vhost.lisp.

Target Slot

port.


Previous: , Up: Internals   [Contents][Index]

5.2.5 Classes

Class: apache-xsendfile-route
Package

restas.

Source

decorators.lisp.

Direct superclasses

proxy-route.

Direct methods

process-route.

Class: nginx-accel-redirect-route
Package

restas.

Source

decorators.lisp.

Direct superclasses

proxy-route.

Direct methods

process-route.

Class: no-cache-route
Package

restas.

Source

decorators.lisp.

Direct superclasses

proxy-route.

Direct methods

process-route.

Class: pkgmodule
Package

restas.

Source

module.lisp.

Direct methods
Direct slots
Slot: symbol
Package

common-lisp.

Initargs

:symbol

Readers

module-symbol.

Writers

This slot is read-only.

Slot: context
Initform

(restas:make-context)

Initargs

:context

Readers

module-context.

Writers

This slot is read-only.

Slot: parent
Initargs

:parent

Readers

module-parent.

Writers

This slot is read-only.

Slot: mount-url
Initargs

:url

Readers

module-mount-url.

Writers

This slot is read-only.

Slot: render-method
Initargs

:render-method

Readers

module-render-method.

Writers

This slot is read-only.

Slot: decorators
Initargs

:decorators

Slot: package
Package

common-lisp.

Initargs

:package

Slot: children
Initform

(make-hash-table)

Slot: routes
Initform

(make-hash-table)

Class: restas-acceptor-mixin
Package

restas.

Source

hunchentoot.lisp.

Direct subclasses
Direct methods

acceptor-status-message.

Class: restas-context
Package

restas.

Source

context.lisp.

Direct methods
Direct slots
Slot: vars
Initargs

:vars

Readers

context-vars.

Writers

(setf context-vars).

Slot: values
Package

common-lisp.

Initargs

:values

Readers

context-values.

Writers

(setf context-values).

Slot: prototype
Initargs

:prototype

Readers

context-prototype.

Writers

(setf context-prototype).

Class: restas-request
Package

restas.

Source

hunchentoot.lisp.

Direct superclasses

request.

Direct methods
Direct slots
Slot: substitutions
Initform

routes:+no-bindings+

Initargs

restas::substitutions

Readers

restas-request-bindings.

Writers

(setf restas-request-bindings).

Class: vhost
Package

restas.

Source

vhost.lisp.

Direct methods
Direct slots
Slot: hostname
Initargs

:hostname

Readers

vhost-hostname.

Writers

This slot is read-only.

Slot: port
Initargs

:port

Readers

vhost-port.

Writers

This slot is read-only.

Slot: mapper
Initform

(make-instance (quote routes:mapper))

Slot: modules

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (   @  
A   C   D   E   F   G   H   I   K   M   P   R   S   V   W  
Index Entry  Section

%
%define-policy: Private ordinary functions
%parse-define-policy-options: Private ordinary functions

(
(setf context-prototype): Private generic functions
(setf context-prototype): Private generic functions
(setf context-symbol-value): Public ordinary functions
(setf context-values): Private generic functions
(setf context-values): Private generic functions
(setf context-vars): Private generic functions
(setf context-vars): Private generic functions
(setf restas-request-bindings): Private generic functions
(setf restas-request-bindings): Private generic functions

@
@apache-xsendfile: Public ordinary functions
@nginx-accel-redirect: Public ordinary functions
@no-cache: Public ordinary functions

A
abort-route-handler: Public ordinary functions
acceptor-dispatch-request: Public standalone methods
acceptor-dispatch-request: Public standalone methods
acceptor-status-message: Public standalone methods
add-toplevel-module: Private generic functions
add-toplevel-module: Private generic functions
add-toplevel-module: Private generic functions
after-close-swank-connection: Private ordinary functions
apply-decorators: Private ordinary functions
apply-format-aux: Private ordinary functions

C
clear-all-vhost: Private ordinary functions
concat-pathnames: Private ordinary functions
connect-module: Private generic functions
connect-module: Private generic functions
context-add-variable: Public ordinary functions
context-all-values: Private ordinary functions
context-all-vars: Private ordinary functions
context-prototype: Private generic functions
context-prototype: Private generic functions
context-remove-variable: Public ordinary functions
context-symbol-value: Public ordinary functions
context-values: Private generic functions
context-values: Private generic functions
context-vars: Private generic functions
context-vars: Private generic functions
copy-restas-context: Public ordinary functions
create-route-from-symbol: Private ordinary functions

D
debug-mode-off: Public ordinary functions
debug-mode-on: Public ordinary functions
define-declaration: Public macros
define-module: Public macros
define-policy: Public macros
define-route: Public macros
delete-route: Public ordinary functions
distribute-all-routes: Private ordinary functions
distribute-route: Private ordinary functions

E
ensure-vhost-exist: Private ordinary functions

F
finalize-module-instance: Public generic functions
finalize-module-instance: Public generic functions
finalize-module-instance: Public generic functions
find-mounted-module: Public ordinary functions
find-pkgmodule-traits: Private ordinary functions
find-route: Private ordinary functions
find-vhost: Private ordinary functions
Function, %define-policy: Private ordinary functions
Function, %parse-define-policy-options: Private ordinary functions
Function, (setf context-symbol-value): Public ordinary functions
Function, @apache-xsendfile: Public ordinary functions
Function, @nginx-accel-redirect: Public ordinary functions
Function, @no-cache: Public ordinary functions
Function, abort-route-handler: Public ordinary functions
Function, after-close-swank-connection: Private ordinary functions
Function, apply-decorators: Private ordinary functions
Function, apply-format-aux: Private ordinary functions
Function, clear-all-vhost: Private ordinary functions
Function, concat-pathnames: Private ordinary functions
Function, context-add-variable: Public ordinary functions
Function, context-all-values: Private ordinary functions
Function, context-all-vars: Private ordinary functions
Function, context-remove-variable: Public ordinary functions
Function, context-symbol-value: Public ordinary functions
Function, copy-restas-context: Public ordinary functions
Function, create-route-from-symbol: Private ordinary functions
Function, debug-mode-off: Public ordinary functions
Function, debug-mode-on: Public ordinary functions
Function, delete-route: Public ordinary functions
Function, distribute-all-routes: Private ordinary functions
Function, distribute-route: Private ordinary functions
Function, ensure-vhost-exist: Private ordinary functions
Function, find-mounted-module: Public ordinary functions
Function, find-pkgmodule-traits: Private ordinary functions
Function, find-route: Private ordinary functions
Function, find-vhost: Private ordinary functions
Function, genurl: Public ordinary functions
Function, genurl*: Public ordinary functions
Function, get-ref-syms: Private ordinary functions
Function, kill-all-debugging-threads: Private ordinary functions
Function, make-context: Public ordinary functions
Function, make-internal-function: Private ordinary functions
Function, maybe-invoke-debugger: Private ordinary functions
Function, module-decorators: Private ordinary functions
Function, module-real-url: Private ordinary functions
Function, parse-all-declarations: Private ordinary functions
Function, parse-route-url: Public ordinary functions
Function, pkgmodule-traits-append-reference: Private ordinary functions
Function, pkgmodule-traits-content-type: Private ordinary functions
Function, pkgmodule-traits-modules: Private ordinary functions
Function, pkgmodule-traits-references: Private ordinary functions
Function, pkgmodule-traits-routes: Private ordinary functions
Function, reconnect-all-routes: Public ordinary functions
Function, redirect: Public ordinary functions
Function, register-pkgmodule-traits: Private ordinary functions
Function, register-route-traits: Private ordinary functions
Function, request-full-uri: Public ordinary functions
Function, request-hostname-port: Private ordinary functions
Function, restas-dispatch-request: Private ordinary functions
Function, route-render-method: Private ordinary functions
Function, route-symbol-template: Private ordinary functions
Function, route-template-from-symbol: Private ordinary functions
Function, split-code-declarations: Private ordinary functions
Function, start: Public ordinary functions
Function, stop-all: Public ordinary functions
Function, vhost-hostname-port: Private ordinary functions

G
Generic Function, (setf context-prototype): Private generic functions
Generic Function, (setf context-values): Private generic functions
Generic Function, (setf context-vars): Private generic functions
Generic Function, (setf restas-request-bindings): Private generic functions
Generic Function, add-toplevel-module: Private generic functions
Generic Function, connect-module: Private generic functions
Generic Function, context-prototype: Private generic functions
Generic Function, context-values: Private generic functions
Generic Function, context-vars: Private generic functions
Generic Function, finalize-module-instance: Public generic functions
Generic Function, initialize-module-instance: Public generic functions
Generic Function, make-route-url: Public generic functions
Generic Function, module-context: Public generic functions
Generic Function, module-find-child-module: Private generic functions
Generic Function, module-find-route: Private generic functions
Generic Function, module-mount-url: Private generic functions
Generic Function, module-parent: Private generic functions
Generic Function, module-render-method: Private generic functions
Generic Function, module-symbol: Private generic functions
Generic Function, parse-declarations: Private generic functions
Generic Function, process-route: Public generic functions
Generic Function, render-object: Public generic functions
Generic Function, restas-request-bindings: Private generic functions
Generic Function, route-arbitrary-requirement: Private generic functions
Generic Function, route-headers: Private generic functions
Generic Function, route-module: Private generic functions
Generic Function, route-required-method: Private generic functions
Generic Function, route-symbol: Public generic functions
Generic Function, vhost-hostname: Private generic functions
Generic Function, vhost-port: Private generic functions
genurl: Public ordinary functions
genurl*: Public ordinary functions
get-ref-syms: Private ordinary functions

H
header-in: Public standalone methods

I
initialize-module-instance: Public generic functions
initialize-module-instance: Public generic functions
initialize-module-instance: Public generic functions

K
kill-all-debugging-threads: Private ordinary functions

M
Macro, define-declaration: Public macros
Macro, define-module: Public macros
Macro, define-policy: Public macros
Macro, define-route: Public macros
Macro, mount-module: Public macros
Macro, with-context: Public macros
Macro, with-module: Public macros
Macro, with-module-context: Private macros
make-context: Public ordinary functions
make-internal-function: Private ordinary functions
make-route-url: Public generic functions
make-route-url: Public generic functions
make-route-url: Public generic functions
make-route-url: Public generic functions
make-route-url: Public generic functions
maybe-invoke-debugger: Private ordinary functions
Method, (setf context-prototype): Private generic functions
Method, (setf context-values): Private generic functions
Method, (setf context-vars): Private generic functions
Method, (setf restas-request-bindings): Private generic functions
Method, acceptor-dispatch-request: Public standalone methods
Method, acceptor-dispatch-request: Public standalone methods
Method, acceptor-status-message: Public standalone methods
Method, add-toplevel-module: Private generic functions
Method, add-toplevel-module: Private generic functions
Method, connect-module: Private generic functions
Method, context-prototype: Private generic functions
Method, context-values: Private generic functions
Method, context-vars: Private generic functions
Method, finalize-module-instance: Public generic functions
Method, finalize-module-instance: Public generic functions
Method, header-in: Public standalone methods
Method, initialize-module-instance: Public generic functions
Method, initialize-module-instance: Public generic functions
Method, make-route-url: Public generic functions
Method, make-route-url: Public generic functions
Method, make-route-url: Public generic functions
Method, make-route-url: Public generic functions
Method, module-context: Public generic functions
Method, module-context: Public generic functions
Method, module-find-child-module: Private generic functions
Method, module-find-route: Private generic functions
Method, module-mount-url: Private generic functions
Method, module-parent: Private generic functions
Method, module-render-method: Private generic functions
Method, module-symbol: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, parse-declarations: Private generic functions
Method, process-request: Public standalone methods
Method, process-route: Public generic functions
Method, process-route: Public generic functions
Method, process-route: Public generic functions
Method, process-route: Public generic functions
Method, process-route: Public generic functions
Method, process-route: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, render-object: Public generic functions
Method, restas-request-bindings: Private generic functions
Method, route-arbitrary-requirement: Private generic functions
Method, route-check-conditions: Public standalone methods
Method, route-headers: Private generic functions
Method, route-module: Private generic functions
Method, route-module: Private generic functions
Method, route-name: Public standalone methods
Method, route-required-method: Private generic functions
Method, route-symbol: Public generic functions
Method, route-symbol: Public generic functions
Method, shared-initialize: Public standalone methods
Method, vhost-hostname: Private generic functions
Method, vhost-port: Private generic functions
module-context: Public generic functions
module-context: Public generic functions
module-context: Public generic functions
module-decorators: Private ordinary functions
module-find-child-module: Private generic functions
module-find-child-module: Private generic functions
module-find-route: Private generic functions
module-find-route: Private generic functions
module-mount-url: Private generic functions
module-mount-url: Private generic functions
module-parent: Private generic functions
module-parent: Private generic functions
module-real-url: Private ordinary functions
module-render-method: Private generic functions
module-render-method: Private generic functions
module-symbol: Private generic functions
module-symbol: Private generic functions
mount-module: Public macros

P
parse-all-declarations: Private ordinary functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-declarations: Private generic functions
parse-route-url: Public ordinary functions
pkgmodule-traits-append-reference: Private ordinary functions
pkgmodule-traits-content-type: Private ordinary functions
pkgmodule-traits-modules: Private ordinary functions
pkgmodule-traits-references: Private ordinary functions
pkgmodule-traits-routes: Private ordinary functions
process-request: Public standalone methods
process-route: Public generic functions
process-route: Public generic functions
process-route: Public generic functions
process-route: Public generic functions
process-route: Public generic functions
process-route: Public generic functions
process-route: Public generic functions

R
reconnect-all-routes: Public ordinary functions
redirect: Public ordinary functions
register-pkgmodule-traits: Private ordinary functions
register-route-traits: Private ordinary functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
render-object: Public generic functions
request-full-uri: Public ordinary functions
request-hostname-port: Private ordinary functions
restas-dispatch-request: Private ordinary functions
restas-request-bindings: Private generic functions
restas-request-bindings: Private generic functions
route-arbitrary-requirement: Private generic functions
route-arbitrary-requirement: Private generic functions
route-check-conditions: Public standalone methods
route-headers: Private generic functions
route-headers: Private generic functions
route-module: Private generic functions
route-module: Private generic functions
route-module: Private generic functions
route-name: Public standalone methods
route-render-method: Private ordinary functions
route-required-method: Private generic functions
route-required-method: Private generic functions
route-symbol: Public generic functions
route-symbol: Public generic functions
route-symbol: Public generic functions
route-symbol-template: Private ordinary functions
route-template-from-symbol: Private ordinary functions

S
shared-initialize: Public standalone methods
split-code-declarations: Private ordinary functions
start: Public ordinary functions
stop-all: Public ordinary functions

V
vhost-hostname: Private generic functions
vhost-hostname: Private generic functions
vhost-hostname-port: Private ordinary functions
vhost-port: Private generic functions
vhost-port: Private generic functions

W
with-context: Public macros
with-module: Public macros
with-module-context: Private macros

Jump to:   %   (   @  
A   C   D   E   F   G   H   I   K   M   P   R   S   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   C   D   H   M   P   R   S   V  
Index Entry  Section

*
*acceptors*: Private special variables
*catch-errors-p*: Private special variables
*debugging-threads*: Private special variables
*debugging-threads-lock*: Private special variables
*default-host-redirect*: Public special variables
*max-debugging-threads*: Public special variables
*module*: Public special variables
*mount-module-declarations*: Private special variables
*nginx-internal-alias*: Public special variables
*nginx-internal-location*: Public special variables
*nginx-internal-root*: Public special variables
*pkgmodules-traits*: Private special variables
*render-method*: Public special variables
*route*: Public special variables
*route-declarations*: Private special variables
*standard-special-page-p*: Private special variables
*vhosts*: Private special variables

A
additional-variables: Public classes
arbitrary-requirement: Public classes

C
children: Private classes
context: Private classes

D
decorators: Private classes

H
headers: Public classes
hostname: Private classes

M
mapper: Private classes
module: Public classes
modules: Private classes
mount-url: Private classes

P
package: Private classes
parent: Private classes
port: Private classes
prototype: Private classes

R
render-method: Public classes
render-method: Private classes
required-method: Public classes
routes: Private classes

S
Slot, additional-variables: Public classes
Slot, arbitrary-requirement: Public classes
Slot, children: Private classes
Slot, context: Private classes
Slot, decorators: Private classes
Slot, headers: Public classes
Slot, hostname: Private classes
Slot, mapper: Private classes
Slot, module: Public classes
Slot, modules: Private classes
Slot, mount-url: Private classes
Slot, package: Private classes
Slot, parent: Private classes
Slot, port: Private classes
Slot, prototype: Private classes
Slot, render-method: Public classes
Slot, render-method: Private classes
Slot, required-method: Public classes
Slot, routes: Private classes
Slot, substitutions: Private classes
Slot, symbol: Public classes
Slot, symbol: Private classes
Slot, values: Private classes
Slot, variables: Public classes
Slot, vars: Private classes
Special Variable, *acceptors*: Private special variables
Special Variable, *catch-errors-p*: Private special variables
Special Variable, *debugging-threads*: Private special variables
Special Variable, *debugging-threads-lock*: Private special variables
Special Variable, *default-host-redirect*: Public special variables
Special Variable, *max-debugging-threads*: Public special variables
Special Variable, *module*: Public special variables
Special Variable, *mount-module-declarations*: Private special variables
Special Variable, *nginx-internal-alias*: Public special variables
Special Variable, *nginx-internal-location*: Public special variables
Special Variable, *nginx-internal-root*: Public special variables
Special Variable, *pkgmodules-traits*: Private special variables
Special Variable, *render-method*: Public special variables
Special Variable, *route*: Public special variables
Special Variable, *route-declarations*: Private special variables
Special Variable, *standard-special-page-p*: Private special variables
Special Variable, *vhosts*: Private special variables
substitutions: Private classes
symbol: Public classes
symbol: Private classes

V
values: Private classes
variables: Public classes
vars: Private classes

Jump to:   *  
A   C   D   H   M   P   R   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   D   E   F   H   M   N   P   R   S   V  
Index Entry  Section

A
apache-xsendfile-route: Private classes

C
Class, apache-xsendfile-route: Private classes
Class, nginx-accel-redirect-route: Private classes
Class, no-cache-route: Private classes
Class, pkgmodule: Private classes
Class, restas-acceptor: Public classes
Class, restas-acceptor-mixin: Private classes
Class, restas-context: Private classes
Class, restas-request: Private classes
Class, restas-ssl-acceptor: Public classes
Class, route: Public classes
Class, vhost: Private classes
context.lisp: The restas/context․lisp file

D
declarations.lisp: The restas/declarations․lisp file
decorators.lisp: The restas/decorators․lisp file

E
errors.lisp: The restas/errors․lisp file

F
File, context.lisp: The restas/context․lisp file
File, declarations.lisp: The restas/declarations․lisp file
File, decorators.lisp: The restas/decorators․lisp file
File, errors.lisp: The restas/errors․lisp file
File, hunchentoot.lisp: The restas/hunchentoot․lisp file
File, module.lisp: The restas/module․lisp file
File, packages.lisp: The restas/packages․lisp file
File, policy.lisp: The restas/policy․lisp file
File, render.lisp: The restas/render․lisp file
File, restas.asd: The restas/restas․asd file
File, route.lisp: The restas/route․lisp file
File, special.lisp: The restas/special․lisp file
File, vhost.lisp: The restas/vhost․lisp file

H
hunchentoot.lisp: The restas/hunchentoot․lisp file

M
module.lisp: The restas/module․lisp file

N
nginx-accel-redirect-route: Private classes
no-cache-route: Private classes

P
Package, restas: The restas package
Package, restas.policy.internal: The restas․policy․internal package
packages.lisp: The restas/packages․lisp file
pkgmodule: Private classes
policy.lisp: The restas/policy․lisp file

R
render.lisp: The restas/render․lisp file
restas: The restas system
restas: The restas package
restas-acceptor: Public classes
restas-acceptor-mixin: Private classes
restas-context: Private classes
restas-request: Private classes
restas-ssl-acceptor: Public classes
restas.asd: The restas/restas․asd file
restas.policy.internal: The restas․policy․internal package
route: Public classes
route.lisp: The restas/route․lisp file

S
special.lisp: The restas/special․lisp file
System, restas: The restas system

V
vhost: Private classes
vhost.lisp: The restas/vhost․lisp file

Jump to:   A   C   D   E   F   H   M   N   P   R   S   V