clack

API Reference

clack

Web application environment for Common Lisp

CLACK

  • Function EVAL-FILE (file)
    Safer way to read and eval a file content. This function returns the last value.
  • Function CLACKUP (app &rest args &key (server :hunchentoot) (address "127.0.0.1") (port 5000) (debug t) silent (use-thread t) (use-default-middlewares t) &allow-other-keys)

Also exports

  • CLACK.HANDLER:STOP

CLACK.HANDLER

  • Function RUN (app server &rest args &key use-thread &allow-other-keys)
  • Function STOP (handler)

CLACK.UTIL

  • Function FIND-HANDLER (server)

clack-handler-hunchentoot

Clack handler for Hunchentoot.

CLACK.HANDLER.HUNCHENTOOT

  • Function RUN (app &rest args &key debug (address "127.0.0.1") (port 5000) ssl ssl-key-file ssl-cert-file ssl-key-password max-thread-count max-accept-count (persistent-connections-p t))
    Start Hunchentoot server.

clack-handler-toot

Clack handler for Toot.

CLACK.HANDLER.TOOT

  • Function RUN (app &rest args &key debug (address "127.0.0.1") (port 5000) ssl ssl-key-file ssl-cert-file ssl-key-password)
    Start Toot server.

clack-handler-wookie

Clack handler for Wookie.

CLACK.HANDLER.WOOKIE

  • Function RUN (app &rest args &key (debug t) (address "127.0.0.1") (port 5000) ssl ssl-key-file ssl-cert-file ssl-key-password)

clack-middleware-auth-basic

Basic Authentication Middleware.

CLACK.MIDDLEWARE.AUTH.BASIC

  • Class <CLACK-MIDDLEWARE-AUTH-BASIC>  (<MIDDLEWARE>)
    Clack Middleware to authenticate.
    AUTHENTICATOR   Accessor: AUTHENTICATOR
    REALM   Accessor: REALM

clack-middleware-clsql

Middleware for CLSQL connection management

CLACK.MIDDLEWARE.CLSQL

  • Class <CLACK-MIDDLEWARE-CLSQL>  (<MIDDLEWARE>)
    DATABASE-TYPE   Accessor: DATABASE-TYPE
    CONNECTION-SPEC   Accessor: CONNECTION-SPEC
    CONNECT-ARGS   Accessor: CONNECT-ARGS

clack-middleware-csrf

Middleware for easy CSRF protection

CLACK.MIDDLEWARE.CSRF

  • Class <CLACK-MIDDLEWARE-CSRF>  (<MIDDLEWARE>)
    Clack Middleware for easy CSRF protection.
    BLOCK-APP   Accessor: BLOCK-APP
    ONE-TIME-P   Accessor: ONE-TIME-P
  • Function CSRF-TOKEN (session)
    Return a random CSRF token.
  • Function CSRF-HTML-TAG (session)
    Return an 'input' tag containing random CSRF token. Note this has a side-effect, natually. This function stores the generated id into the current session when called.

clack-middleware-dbi

Middleware for CL-DBI connection management.

CLACK.MIDDLEWARE.DBI

  • Variable *DB*
    nil
  • Class <CLACK-MIDDLEWARE-DBI>  (<MIDDLEWARE>)
    DRIVER-NAME   Accessor: DRIVER-NAME
    CONNECT-ARGS   Accessor: CONNECT-ARGS

clack-middleware-oauth

Supports authorization mechanism by OAuth

CLACK.MIDDLEWARE.OAUTH

  • Class <CLACK-MIDDLEWARE-OAUTH>  (<MIDDLEWARE>)
    PATH   Accessor: OAUTH-PATH
    CALLBACK-BASE   Accessor: OAUTH-CALLBACK-BASE
    CALLBACK-URI   Accessor: OAUTH-CALLBACK-URI
    CONSUMER-KEY   Accessor: OAUTH-CONSUMER-KEY
    CONSUMER-SECRET   Accessor: OAUTH-CONSUMER-SECRET
    AUTHORIZE-URI   Accessor: OAUTH-AUTHORIZE-URI
    REQUEST-TOKEN-URI   Accessor: OAUTH-REQUEST-TOKEN-URI
    ACCESS-TOKEN-URI   Accessor: OAUTH-ACCESS-TOKEN-URI
    AUTHORIZED   Accessor: OAUTH-AUTHORIZED
    STATE   Accessor: OAUTH-STATE
    STATE-EXPIRE   Accessor: OAUTH-STATE-EXPIRE

clack-middleware-postmodern

Middleware for POSTMODERN connection management

CLACK.MIDDLEWARE.POSTMODERN

  • Class <CLACK-MIDDLEWARE-POSTMODERN>  (<MIDDLEWARE>)
    This middleware opens a connection to the specified database and stores it in *database* as expected by postmodern. It also stores the connection(s) in an alist (database name as key) in the environment with the key :clack.postmodern.databases.
    DATABASE   Accessor: DATABASE
    The name of the database to connect to.
    USER   Accessor: USER
    The name of the database user.
    PASSWORD   Accessor: PASSWORD
    The password for the database.
    HOST   Accessor: HOST
    The host the database server is on.
    PORT   Accessor: PORT
    The port the database server is listening on.
    POOLED-P   Accessor: POOLED-P
    Shall the connections be pooled?
    USE-SSL   Accessor: USE-SSL
    Keyword for the use-ssl configuration.
  • Function GET-CONNECTION (db-name env)

clack-session-store-dbi

CL-DBI-based session store for Clack.Middleware.Session

CLACK.SESSION.STORE.DBI

  • Class <CLACK-SESSION-STORE-DBI>  (<CLACK-SESSION-STORE>)
    CONNECT-ARGS   Reader: STORE-CONNECT-ARGS
    CONNECTOR   Reader: STORE-CONNECTOR
    TABLE-NAME   Reader: STORE-TABLE-NAME
    %CONNECTION

clack-socket

CLACK.SOCKET

  • Generic-Function READ-CALLBACK (socket)
  • Generic-Function (setf READ-CALLBACK) (callback socket)
  • Generic-Function CLOSE-SOCKET (socket)
  • Generic-Function WRITE-SEQUENCE-TO-SOCKET (socket data &key callback)
  • Generic-Function WRITE-BYTE-TO-SOCKET (socket byte &key callback)
  • Method WRITE-BYTE-TO-SOCKET (socket byte &key callback)
  • Method WRITE-BYTE-TO-SOCKET (socket byte &key callback)
  • Method WRITE-BYTE-TO-SOCKET (socket byte &key callback)
  • Generic-Function WRITE-SEQUENCE-TO-SOCKET-BUFFER (socket data)
  • Method WRITE-SEQUENCE-TO-SOCKET-BUFFER (socket data)
  • Method WRITE-SEQUENCE-TO-SOCKET-BUFFER (socket data)
  • Method WRITE-SEQUENCE-TO-SOCKET-BUFFER (socket data)
  • Generic-Function WRITE-BYTE-TO-SOCKET-BUFFER (socket byte)
  • Method WRITE-BYTE-TO-SOCKET-BUFFER (socket byte)
  • Method WRITE-BYTE-TO-SOCKET-BUFFER (socket byte)
  • Method WRITE-BYTE-TO-SOCKET-BUFFER (socket byte)
  • Generic-Function FLUSH-SOCKET-BUFFER (socket &key callback)
  • Method FLUSH-SOCKET-BUFFER (socket &key callback)
  • Method FLUSH-SOCKET-BUFFER (socket &key callback)
  • Method FLUSH-SOCKET-BUFFER (socket &key callback)
  • Generic-Function SOCKET-ASYNC-P (socket)
  • Generic-Function SOCKET-STREAM (socket)

clack-test

No packages.

clack-v1-compat

No packages.

t-clack-middleware-auth-basic

No packages.

t-clack-middleware-csrf

No packages.

t-clack-v1-compat

No packages.