The claxy Reference Manual

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

The claxy Reference Manual

This is the claxy Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:21:08 2022 GMT+0.

Table of Contents


1 Introduction

Claxy: simple proxy middleware for clack

Claxy is - at this point - a simple and unambitious proxy for clack web applications.

Usage

(lack:builder 
  ...
  (claxy:middleware '(("/resources/" "https://somewhe.re/else/resources/")
                      ("/places/" "https://somewhe.re/else/locations/")
                      ("/app/" "http://localhost:8080/")))
   ...
   )

Claxy accepts, as its parameter, a list of substitutions. Each substitution is a list containing an incoming URL path segment to match, and a replacement. The path segment must be at the root of the path.

Author

Ben McGunigle (bnmcgn at gmail.com)

Copyright

Copyright (c) 2021 Ben McGunigle

License

Apache License version 2.0


2 Systems

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


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

2.1 claxy

Simple proxy middleware for clack

Author

Ben McGunigle <bnmcgn@gmail.com>

License

Apache License, version 2.0

Version

0.0.1

Dependencies
  • alexandria (system).
  • dexador (system).
Source

claxy.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 claxy/claxy.asd

Source

claxy.asd.

Parent Component

claxy (system).

ASDF Systems

claxy.


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

3.1.2 claxy/package.lisp

Source

claxy.asd.

Parent Component

claxy (system).

Packages

claxy.


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

3.1.3 claxy/claxy.lisp

Dependency

package.lisp (file).

Source

claxy.asd.

Parent Component

claxy (system).

Public Interface

middleware (function).

Internals

4 Packages

Packages are listed by definition order.


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

4.1 claxy

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface

middleware (function).

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


5.1.1 Ordinary functions

Function: middleware (rewrite-table)
Package

claxy.

Source

claxy.lisp.


5.2 Internals


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

5.2.1 Ordinary functions

Function: claxy-core (url env)
Package

claxy.

Source

claxy.lisp.

Function: process-outgoing-headers (headers remote-addr)
Package

claxy.

Source

claxy.lisp.

Function: process-returned-headers (headers)
Package

claxy.

Source

claxy.lisp.

Function: rewrite-url (rewrite-table path)
Package

claxy.

Source

claxy.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables