This is the hunchensocket Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 05:20:30 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
hunchensocketWebSockets for Hunchentoot
capitaomorte
MIT
1.0.0
hunchentoot (system).
alexandria (system).
cl-base64 (system).
sha1 (system).
flexi-streams (system).
chunga (system).
trivial-utf-8 (system).
trivial-backtrace (system).
bordeaux-threads (system).
cl-fad (system).
package.lisp (file).
hunchensocket.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
hunchensocket/hunchensocket.lisppackage.lisp (file).
hunchensocket (system).
*websocket-dispatch-table* (special variable).
*websocket-maximum-fragment-size* (special variable).
*websocket-maximum-message-size* (special variable).
acceptor-dispatch-request (method).
binary-message-received (generic function).
check-message (generic function).
client-connected (generic function).
client-disconnected (generic function).
client-request (reader method).
clients (reader method).
close-connection (function).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
print-object (method).
process-connection (method).
process-request (method).
send-binary-message (function).
send-ping (function).
send-text-message (function).
text-message-received (generic function).
websocket-acceptor (class).
websocket-client (class).
websocket-resource (reader method).
(setf websocket-resource) (writer method).
websocket-resource (class).
websocket-ssl-acceptor (class).
*websocket-socket* (special variable).
+binary-frame+ (constant).
+connection-close+ (constant).
+continuation-frame+ (constant).
+ping+ (constant).
+pong+ (constant).
+text-frame+ (constant).
+websocket-magic-key+ (constant).
call-with-new-client-for-resource (function).
control-frame-p (function).
find-websocket-resource (function).
frame (class).
frame-data (reader method).
(setf frame-data) (writer method).
frame-opcode (reader method).
(setf frame-opcode) (writer method).
frame-payload-length (reader method).
(setf frame-payload-length) (writer method).
handle-frame (function).
handle-handshake (method).
mask-unmask (function).
read-application-data (function).
read-frame (function).
read-frame-from-client (function).
read-handle-loop (function).
read-n-bytes-into-sequence (function).
read-unsigned-big-endian (function).
send-frame (function).
websocket-error (function).
websocket-error (condition).
websocket-error-status (reader method).
websocket-reply (class).
websocket-request (class).
websocket-timeout (reader method).
(setf websocket-timeout) (writer method).
websocket-uri (function).
with-new-client-for-resource (macro).
write-frame (function).
Packages are listed by definition order.
hunchensocketalexandria.
bordeaux-threads.
cl-ppcre.
common-lisp.
flexi-streams.
hunchentoot.
trivial-utf-8.
*websocket-dispatch-table* (special variable).
*websocket-maximum-fragment-size* (special variable).
*websocket-maximum-message-size* (special variable).
binary-message-received (generic function).
check-message (generic function).
client-connected (generic function).
client-disconnected (generic function).
client-request (generic reader).
clients (generic reader).
close-connection (function).
send-binary-message (function).
send-ping (function).
send-text-message (function).
text-message-received (generic function).
websocket-acceptor (class).
websocket-client (class).
websocket-resource (generic reader).
(setf websocket-resource) (generic writer).
websocket-resource (class).
websocket-ssl-acceptor (class).
*websocket-socket* (special variable).
+binary-frame+ (constant).
+connection-close+ (constant).
+continuation-frame+ (constant).
+ping+ (constant).
+pong+ (constant).
+text-frame+ (constant).
+websocket-magic-key+ (constant).
call-with-new-client-for-resource (function).
control-frame-p (function).
find-websocket-resource (function).
frame (class).
frame-data (generic reader).
(setf frame-data) (generic writer).
frame-opcode (generic reader).
(setf frame-opcode) (generic writer).
frame-payload-length (generic reader).
(setf frame-payload-length) (generic writer).
handle-frame (function).
handle-handshake (generic function).
mask-unmask (function).
read-application-data (function).
read-frame (function).
read-frame-from-client (function).
read-handle-loop (function).
read-n-bytes-into-sequence (function).
read-unsigned-big-endian (function).
send-frame (function).
websocket-error (function).
websocket-error (condition).
websocket-error-status (generic reader).
websocket-reply (class).
websocket-request (class).
websocket-timeout (generic reader).
(setf websocket-timeout) (generic writer).
websocket-uri (function).
with-new-client-for-resource (macro).
write-frame (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
List of handler closures that will be queried for new connections
Send MESSAGE, an array of octets, to CLIENT
Send MESSAGE, a string, to CLIENT
websocket-resource) (client websocket-client) opcode length total) ¶websocket-resource) (client websocket-client) (opcode (eql 2)) length total) ¶websocket-client)) ¶automatically generated reader method
websocket-resource)) ¶automatically generated reader method
websocket-request)) ¶websocket-request)) ¶Message handler of the current request
websocket-acceptor) (request websocket-request)) ¶Attempt WebSocket connection, else fall back to HTTP
hunchentoot.
websocket-client) &key &allow-other-keys) ¶websocket-resource) &key client-class) ¶websocket-reply) &rest initargs) ¶Set the reply’s external format to Unix EOL / UTF-8 explicitly.
websocket-resource) stream) ¶websocket-acceptor) socket) ¶Sprinkle the current connection with dynamic bindings.
hunchentoot.
websocket-request)) ¶After HTTP processing REQUEST, maybe hijack into WebSocket loop.
hunchentoot.
acceptor.
| Initarg | Value |
|---|---|
:request-class | (quote websocket-request) |
:reply-class | (quote websocket-reply) |
Custom WebSocket timeout override.
300
:websocket-timeout
(error "must make clients with input streams")
hunchensocket::input-stream
(error "must make clients with output streams")
hunchensocket::output-stream
hunchentoot.
(error "must make clients with requests")
hunchentoot:request
This slot is read-only.
(bordeaux-threads:make-lock "websocket client write lock")
:disconnected
Special WebSocket SSL acceptor
ssl-acceptor.
websocket-acceptor.
Fixed magic WebSocket UUIDv4 key use in handshakes
The currently active WebSocket socket
Find the resource for REQUEST by looking up *WEBSOCKET-DISPATCH-TABLE*.
Read a text or binary message from CLIENT.
Implements the main WebSocket loop for supported protocol versions. Framing is handled automatically, CLIENT handles the actual payloads.
Return an array of N bytes read from stream
Read N bytes from stream and return the big-endian number
Signals an error of type HUNCHENTOOT-SIMPLE-ERROR with the provided format control and arguments.
Form WebSocket URL (ws:// or wss://) URL.
websocket-acceptor) request reply) ¶Analyse REQUEST for WebSocket handshake.
Destructively modify REPLY accordingly in case of success, exit non-locally with an error instead.
websocket-error)) ¶websocket-acceptor)) ¶websocket-acceptor)) ¶Custom WebSocket timeout override.
Superclass for all errors related to Websocket.
simple-error.
:status
This slot is read-only.
reply.
request.
Message handler of the current request
| Jump to: | (
A B C F G H I M P R S T W |
|---|
| Jump to: | (
A B C F G H I M P R S T W |
|---|
| Jump to: | *
+
C D E F H I L M O P R S W |
|---|
| Jump to: | *
+
C D E F H I L M O P R S W |
|---|
| Jump to: | C F H P S W |
|---|
| Jump to: | C F H P S W |
|---|