This is the yxorp Reference Manual, version 1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:33:57 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
yxorpA reverse proxy server that supports WebSocket, HTTP, HTTPS,
HTTP to HTTPS redirecting, port and host forwarding configuration using a real
programming language, HTTP header and body manipulation (also using a real
programming language).
Charles Jackson <charles.b.jackson@protonmail.com>
AGPL3
1.1
binding-arrows (system).
chipz (system).
chunga (system).
cl+ssl (system).
flexi-streams (system).
rutils (system).
salza2 (system).
smart-buffer (system).
str (system).
trivial-garbage (system).
usocket (system).
usocket-server (system).
package.lisp (file).
smart-buffer-stream.lisp (file).
threads.lisp (file).
coding.lisp (file).
config.lisp (file).
utils.lisp (file).
main.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
yxorp/yxorp.asdyxorp/package.lispyxorp/smart-buffer-stream.lispyxorp/threads.lispyxorp/coding.lispyxorp/config.lispyxorp/utils.lispyxorp/main.lispyxorp/smart-buffer-stream.lisppackage.lisp (file).
yxorp (system).
stream-write-byte (method).
stream-write-char (method).
stream-write-sequence (method).
stream-write-string (method).
size (reader method).
(setf size) (writer method).
smart-buffer-stream (class).
yxorp/threads.lispsmart-buffer-stream.lisp (file).
yxorp (system).
map-threads (function).
track-thread (function).
*threads* (special variable).
*threads*-lock (special variable).
yxorp/coding.lispthreads.lisp (file).
yxorp (system).
apply-decoding (function).
apply-decodings (function).
apply-encoding (function).
apply-encodings (function).
chunkify (function).
encoding (type).
encodingp (function).
yxorp/config.lispcoding.lisp (file).
yxorp (system).
config (function).
config (structure).
destination (class).
port (reader method).
port (type).
print-object (method).
read-config (function).
ssl-config (function).
ssl-config (structure).
config-destinator (reader).
config-p (function).
config-port (reader).
config-request-filter (reader).
config-response-filter (reader).
config-ssl (reader).
copy-config (function).
copy-ssl-config (function).
default-protocol-port (function).
destination-secure-p (function).
destination-specifier (type).
host (reader method).
make-destination (function).
protocol (reader method).
protocol (type).
secure-protocol (type).
ssl-config-certificate (reader).
ssl-config-key (reader).
ssl-config-p (function).
ssl-config-password (reader).
ssl-config-redirect-port (reader).
ssl-config-redirect-to (reader).
yxorp/utils.lispconfig.lisp (file).
yxorp (system).
*headers* (special variable).
*integer-headers* (special variable).
*request-headers* (special variable).
*response-headers* (special variable).
extract-charset (function).
header (function).
(setf header) (function).
read-headers (function).
websocket-p (function).
write-body-and-headers (function).
write-headers (function).
%parse-request-headers (function).
%parse-response-headers (function).
+crlf+ (special variable).
copy-stream-to-stream (function).
extract-encodings-from (function).
forward-stream (function).
handle-headers-and-body (function).
make-keyword (function).
make-ssl-stream (function).
parse-header-line (function).
parse-request-headers (function).
parse-response-headers (function).
read-sequence* (function).
serialize-headers (function).
yxorp/main.lisputils.lisp (file).
yxorp (system).
*suppress-errors* (special variable).
start (function).
stop (function).
filter-encodings (function).
http-handler (function).
main (function).
proxy-handler (function).
save-ip (function).
ssl-redirect (function).
websocket-handler (function).
with-socket-handler-case (macro).
Packages are listed by definition order.
yxorpcommon-lisp.
*headers* (special variable).
*integer-headers* (special variable).
*request-headers* (special variable).
*response-headers* (special variable).
*suppress-errors* (special variable).
config (function).
config (structure).
destination (class).
extract-charset (function).
header (function).
(setf header) (function).
map-threads (function).
port (generic reader).
port (type).
read-config (function).
read-headers (function).
ssl-config (function).
ssl-config (structure).
start (function).
stop (function).
track-thread (function).
websocket-p (function).
write-body-and-headers (function).
write-headers (function).
%parse-request-headers (function).
%parse-response-headers (function).
*threads* (special variable).
*threads*-lock (special variable).
+crlf+ (special variable).
apply-decoding (function).
apply-decodings (function).
apply-encoding (function).
apply-encodings (function).
chunkify (function).
config-destinator (reader).
config-p (function).
config-port (reader).
config-request-filter (reader).
config-response-filter (reader).
config-ssl (reader).
copy-config (function).
copy-ssl-config (function).
copy-stream-to-stream (function).
default-protocol-port (function).
destination-secure-p (function).
destination-specifier (type).
encoding (type).
encodingp (function).
extract-encodings-from (function).
filter-encodings (function).
forward-stream (function).
handle-headers-and-body (function).
host (generic reader).
http-handler (function).
main (function).
make-destination (function).
make-keyword (function).
make-ssl-stream (function).
parse-header-line (function).
parse-request-headers (function).
parse-response-headers (function).
protocol (generic reader).
protocol (type).
proxy-handler (function).
read-sequence* (function).
save-ip (function).
secure-protocol (type).
serialize-headers (function).
size (generic reader).
(setf size) (generic writer).
smart-buffer-stream (class).
ssl-config-certificate (reader).
ssl-config-key (reader).
ssl-config-p (function).
ssl-config-password (reader).
ssl-config-redirect-port (reader).
ssl-config-redirect-to (reader).
ssl-redirect (function).
websocket-handler (function).
with-socket-handler-case (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
destination)) ¶automatically generated reader method
port.
destination) out) ¶smart-buffer-stream) byte) ¶sb-gray.
smart-buffer-stream) char) ¶sb-gray.
smart-buffer-stream) sequence start end &key &allow-other-keys) ¶trivial-gray-streams.
smart-buffer-stream) string &optional start end) ¶sb-gray.
structure-object.
yxorp:port
8080
This slot is read-only.
(or (function nil yxorp::destination-specifier) symbol)
(lambda nil 8081)
This slot is read-only.
This slot is read-only.
This slot is read-only.
(or yxorp:ssl-config null)
This slot is read-only.
structure-object.
(or pathname string)
"cert.pem"
This slot is read-only.
(or pathname string)
"key.pem"
This slot is read-only.
(or string null)
This slot is read-only.
(or yxorp:port null)
This slot is read-only.
yxorp:port
443
This slot is read-only.
Read an http body from IN, run it through FILTER, and write headers and it to OUT.
destination)) ¶automatically generated reader method
host.
destination)) ¶automatically generated reader method
smart-buffer-stream)) ¶automatically generated reader method
size.
smart-buffer-stream)) ¶automatically generated writer method
size.
| Jump to: | %
   
( A C D E F G H M P R S T W | 
|---|
| Jump to: | %
   
( A C D E F G H M P R S T W | 
|---|
| Jump to: | *
   
+ C D H K P R S | 
|---|
| Jump to: | *
   
+ C D H K P R S | 
|---|
| Jump to: | C D E F M P S T U Y | 
|---|
| Jump to: | C D E F M P S T U Y | 
|---|