The claxy Reference Manual

Table of Contents

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 3.0 "Montgomery Scott" on Sun May 15 04:21:55 2022 GMT+0.


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

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


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

2 Systems

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


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

2.1 claxy

Author

Ben McGunigle <bnmcgn@gmail.com>

License

Apache License, version 2.0

Description

Simple proxy middleware for clack

Version

0.0.1

Dependencies
Source

claxy.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 claxy.asd

Location

claxy.asd

Systems

claxy (system)


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

3.1.2 claxy/package.lisp

Parent

claxy (system)

Location

package.lisp

Packages

claxy


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

3.1.3 claxy/claxy.lisp

Dependency

package.lisp (file)

Parent

claxy (system)

Location

claxy.lisp

Exported Definitions

middleware (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 claxy

Source

package.lisp (file)

Use List
Exported Definitions

middleware (function)

Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: middleware REWRITE-TABLE
Package

claxy

Source

claxy.lisp (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: claxy-core URL ENV
Package

claxy

Source

claxy.lisp (file)

Function: process-outgoing-headers HEADERS REMOTE-ADDR
Package

claxy

Source

claxy.lisp (file)

Function: process-returned-headers HEADERS
Package

claxy

Source

claxy.lisp (file)

Function: rewrite-url REWRITE-TABLE PATH
Package

claxy

Source

claxy.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
claxy.asd: The claxy․asd file
claxy/claxy.lisp: The claxy/claxy․lisp file
claxy/package.lisp: The claxy/package․lisp file

F
File, Lisp, claxy.asd: The claxy․asd file
File, Lisp, claxy/claxy.lisp: The claxy/claxy․lisp file
File, Lisp, claxy/package.lisp: The claxy/package․lisp file

L
Lisp File, claxy.asd: The claxy․asd file
Lisp File, claxy/claxy.lisp: The claxy/claxy․lisp file
Lisp File, claxy/package.lisp: The claxy/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   C   F   M   P   R  
Index Entry  Section

C
claxy-core: Internal functions

F
Function, claxy-core: Internal functions
Function, middleware: Exported functions
Function, process-outgoing-headers: Internal functions
Function, process-returned-headers: Internal functions
Function, rewrite-url: Internal functions

M
middleware: Exported functions

P
process-outgoing-headers: Internal functions
process-returned-headers: Internal functions

R
rewrite-url: Internal functions

Jump to:   C   F   M   P   R  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
claxy: The claxy system
claxy: The claxy package

P
Package, claxy: The claxy package

S
System, claxy: The claxy system

Jump to:   C   P   S