This is the portal Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:17:17 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
portalPortable websockets.
Charles Jackson <charles.b.jackson@protonmail.com>
LLGPL
1.2
usocket-server (system).
alexandria (system).
arrows (system).
global-vars (system).
str (system).
ironclad (system).
cl-base64 (system).
flexi-streams (system).
parse-float (system).
package.lisp (file).
portal.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
portal/portal.lisppackage.lisp (file).
portal (system).
*debug-on-error* (special variable).
close (method).
define-resource (function).
header (reader method).
ready-state (reader method).
send (method).
send-ping (method).
server (function).
server-close (function).
websocket (class).
+binary+ (constant).
+close+ (constant).
+closed+ (constant).
+closing+ (constant).
+connecting+ (constant).
+continuation+ (constant).
+crlf+ (constant).
+http-version+ (constant).
+ping+ (constant).
+pong+ (constant).
+ready+ (constant).
+sec-key+ (constant).
+text+ (constant).
alist->header (function).
append-stash (method).
call-resource-function (function).
can-upgrade-p (function).
clear-stash (method).
get-stash (method).
header->alist (function).
opcode (reader method).
read-frame (method).
read-until (function).
send-close-frame (method).
send-pong (method).
sha1-base64 (function).
socket-stream (reader method).
(setf socket-stream) (writer method).
starts-with (function).
stash (reader method).
websocket-handler (function).
Packages are listed by definition order.
portalpws
common-lisp.
*debug-on-error* (special variable).
close (generic function).
define-resource (function).
header (generic reader).
ready-state (generic reader).
send (generic function).
send-ping (generic function).
server (function).
server-close (function).
websocket (class).
+binary+ (constant).
+close+ (constant).
+closed+ (constant).
+closing+ (constant).
+connecting+ (constant).
+continuation+ (constant).
+crlf+ (constant).
+http-version+ (constant).
+ping+ (constant).
+pong+ (constant).
+ready+ (constant).
+sec-key+ (constant).
+text+ (constant).
alist->header (function).
append-stash (generic function).
call-resource-function (function).
can-upgrade-p (function).
clear-stash (generic function).
get-stash (generic function).
header->alist (function).
opcode (generic reader).
read-frame (generic function).
read-until (function).
send-close-frame (generic function).
send-pong (generic function).
sha1-base64 (function).
socket-stream (generic reader).
(setf socket-stream) (generic writer).
starts-with (function).
stash (generic reader).
websocket-handler (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
HTTP header for websocket upgrade.
list
:header
This slot is read-only.
common-lisp.
stream
:stream
number
0
This slot is read-only.
Store the type of frame we are currently on.
This slot is read-only.
When the first closing frame has been sent or received.
Return the string response header corresponding to ALIST.
True if the alist HEADER has qualified to be upgraded to a websocket. If nil, the second value will be the reason.
Return the alist corresponding to the request header STRING.
| Jump to: | (
A C D F G H M O R S W |
|---|
| Jump to: | (
A C D F G H M O R S W |
|---|
| Jump to: | *
+
C F H R S |
|---|
| Jump to: | *
+
C F H R S |
|---|
| Jump to: | C F P S W |
|---|
| Jump to: | C F P S W |
|---|