Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The websocket-driver Reference Manual
This is the websocket-driver Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 06:09:12 2022 GMT+0.
Table of Contents
- 1 Introduction
- 2 Systems
- 3 Modules
- 4 Files
- 4.1 Lisp
- 4.1.1 websocket-driver/websocket-driver.asd
- 4.1.2 websocket-driver-server/websocket-driver-server.asd
- 4.1.3 websocket-driver-base/websocket-driver-base.asd
- 4.1.4 websocket-driver-client/websocket-driver-client.asd
- 4.1.5 websocket-driver-server/src/server.lisp
- 4.1.6 websocket-driver-server/src/ws/server.lisp
- 4.1.7 websocket-driver-base/src/driver.lisp
- 4.1.8 websocket-driver-base/src/ws/base.lisp
- 4.1.9 websocket-driver-base/src/util.lisp
- 4.1.10 websocket-driver-client/src/ws/client.lisp
- 4.1.11 websocket-driver-client/src/client.lisp
- 4.1 Lisp
- 5 Packages
- 5.1 websocket-driver
- 5.2 websocket-driver.ws.base
- 5.3 websocket-driver-client-asd
- 5.4 websocket-driver-base-asd
- 5.5 websocket-driver-client
- 5.6 websocket-driver.util
- 5.7 websocket-driver-asd
- 5.8 websocket-driver.ws.client
- 5.9 websocket-driver.server
- 5.10 websocket-driver-server-asd
- 5.11 websocket-driver.ws.server
- 6 Definitions
- Appendix A Indexes
Next: Systems, Previous: The websocket-driver Reference Manual, Up: The websocket-driver Reference Manual [Contents][Index]
1 Introduction
Websocket Driver
This library provides WebSocket server & client implementation for Common Lisp.
Supported Servers
Usage
Server-side with Clack
WebSocket server implementation is designed to work with Clack, which is a abstraction layer for web servers.
(ql:quickload '(:websocket-driver-server :clack))
(use-package :websocket-driver)
(defvar *echo-server*
(lambda (env)
(let ((ws (make-server env)))
(on :message ws
(lambda (message)
(send ws message)))
(lambda (responder)
(declare (ignore responder))
(start-connection ws)))))
;; Start Wookie server
(clack:clackup *echo-server* :server :wookie :port 5000)
The backend server can be changed by replacing :wookie by other servers.
Client-side
(ql:quickload :websocket-driver-client)
(defvar *client* (wsd:make-client "ws://localhost:5000/echo"))
(wsd:start-connection *client*)
(wsd:on :message *client*
(lambda (message)
(format t "~&Got: ~A~%" message)))
(wsd:send *client* "Hi")
(wsd:close-connection *client*)
APIs
[Function] make-server (env &key max-length accept-protocols additional-headers)
Returns a new SERVER object. The ENV is a property list represents server information, which Clack provides.
The max-length is the maximum message size allowed. The default is #x3ffffff. If at any time it stays bigger than this, the connection will be closed with code 1009 (too-large).
The accept-protocols is a list of custom protocol names as strings. This will be used for checking Sec-WebSocket-Protocol header client sent. The default is an empty list.
The additional-headers is an association list which represents HTTP headers to use in WebSocket handshake response. The default is an empty list.
[Function] make-client (url &key max-length accept-protocols additional-headers)
Returns a new CLIENT object. The URL is a string to connect.
Additional keyword arguments max-length, accept-protocols and additional-headers are shared with make-server.
[Class] ws
The base class for server and client.
As this inherits event-emitter, its object can be attached event listerners by on.
[Event] :open
Called when the socket becomes open.
(on :open ws
(lambda ()
(format t "Connected.~%")))
[Event] :message
Called when a message is received. The callback function takes a MESSAGE as an argument which is either a string in the case of a text message or an (UNSIGNED-BYTE 8) vector in the case of a binary message.
(on :message ws
(lambda (message)
(format t "Received: ~S~%" message)))
[Event] :error
Called when a protocol error occurs due to the other peer sending an invalid byte sequence. The callback function takes a PROTOCOL-ERROR as an argument.
(on :error ws
(lambda (error)
(format t "Got an error: ~S~%" error)))
[Event] :close
Called when the socket becomes closed. The CALLBACK function takes CODE and REASON as arguments.
(on :close ws
(lambda (&key code reason)
(format t "Closed because '~A' (Code=~A)~%" reason code)))
[Class] server
The class for WebSocket (version 13) server implementation.
[Class] client
The class for WebSocket client implementation.
[Method] (start-connection ws)
Initiates the protocol by sending the handshake - either the response for a server-side driver or the request for a client-side one. This should be the first method you invoke. Returns T if a handshake was sent.
[Method] (send ws data &key start end type code callback)
Sends DATA over the socket.
[Function] (send-text ws message &key start end callback)
Sends a text message over the socket.
[Function] (send-binary ws usb8-vector &key start end callback)
Takes an (UNSIGNED-BYTE 8) vector and sends them as a binary message.
[Method] (send-ping ws &optional message callback)
Sends a ping frame over the socket, queueing it if necessary.
[Method] (close-connection ws)
Initiates the closing handshake if the socket is still open.
[Method] (version driver)
Returns the WebSocket version in use as a string (ex. "hybi-13").
[Method] (protocol driver)
Returns a string containing the selected subprotocol, if any was agreed upon using the Sec-WebSocket-Protocol mechanism.
[Method] (ready-state ws)
Returns the connection state as a keyword, which is one of :connecting, :open, :closing and :closed.
Author
- Eitaro Fukamachi (e.arrows@gmail.com)
Copyright
Copyright (c) 2014 Eitaro Fukamachi (e.arrows@gmail.com)
License
Licensed under the BSD 2-Clause License.
See Also
Next: Modules, Previous: Introduction, Up: The websocket-driver Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
Next: websocket-driver-server, Previous: Systems, Up: Systems [Contents][Index]
2.1 websocket-driver
WebSocket protocol handler
- Author
Eitaro Fukamachi
- License
BSD 2-Clause
- Version
0.2.0
- Dependencies
- websocket-driver-server (system).
- websocket-driver-client (system).
- Source
Next: websocket-driver-base, Previous: websocket-driver, Up: Systems [Contents][Index]
2.2 websocket-driver-server
WebSocket protocol handler
- Author
Eitaro Fukamachi
- License
BSD 2-Clause
- Version
0.2.0
- Dependencies
- websocket-driver-base (system).
- fast-websocket (system).
- fast-io (system).
- clack-socket (system).
- babel (system).
- Source
- Child Component
src (module).
Next: websocket-driver-client, Previous: websocket-driver-server, Up: Systems [Contents][Index]
2.3 websocket-driver-base
WebSocket protocol handler
- Author
Eitaro Fukamachi
- License
BSD 2-Clause
- Version
0.2.0
- Dependencies
- fast-websocket (system).
- fast-io (system).
- event-emitter (system).
- sha1 (system).
- cl-base64 (system).
- split-sequence (system).
- bordeaux-threads (system).
- Source
- Child Component
src (module).
Previous: websocket-driver-base, Up: Systems [Contents][Index]
2.4 websocket-driver-client
- Author
Eitaro Fukamachi
- License
BSD 2-Clause
- Version
0.2.0
- Dependencies
- websocket-driver-base (system).
- usocket (system).
- cl+ssl (system).
- fast-io (system).
- fast-websocket (system).
- fast-http (system).
- cl-base64 (system).
- babel (system).
- quri (system).
- Source
- Child Component
src (module).
Next: Files, Previous: Systems, Up: The websocket-driver Reference Manual [Contents][Index]
3 Modules
Modules are listed depth-first from the system components tree.
Next: websocket-driver-base/src, Previous: Modules, Up: Modules [Contents][Index]
3.1 websocket-driver-server/src
- Source
- Parent Component
websocket-driver-server (system).
- Child Components
- server.lisp (file).
- ws/server.lisp (file).
Next: websocket-driver-client/src, Previous: websocket-driver-server/src, Up: Modules [Contents][Index]
3.2 websocket-driver-base/src
- Source
- Parent Component
websocket-driver-base (system).
- Child Components
- driver.lisp (file).
- ws/base.lisp (file).
- util.lisp (file).
Previous: websocket-driver-base/src, Up: Modules [Contents][Index]
3.3 websocket-driver-client/src
- Source
- Parent Component
websocket-driver-client (system).
- Child Components
- ws/client.lisp (file).
- client.lisp (file).
Next: Packages, Previous: Modules, Up: The websocket-driver Reference Manual [Contents][Index]
4 Files
Files are sorted by type and then listed depth-first from the systems components trees.
4.1 Lisp
- websocket-driver/websocket-driver.asd
- websocket-driver-server/websocket-driver-server.asd
- websocket-driver-base/websocket-driver-base.asd
- websocket-driver-client/websocket-driver-client.asd
- websocket-driver-server/src/server.lisp
- websocket-driver-server/src/ws/server.lisp
- websocket-driver-base/src/driver.lisp
- websocket-driver-base/src/ws/base.lisp
- websocket-driver-base/src/util.lisp
- websocket-driver-client/src/ws/client.lisp
- websocket-driver-client/src/client.lisp
Next: websocket-driver-server/websocket-driver-server.asd, Previous: Lisp, Up: Lisp [Contents][Index]
4.1.1 websocket-driver/websocket-driver.asd
- Source
- Parent Component
websocket-driver (system).
- ASDF Systems
- Packages
Next: websocket-driver-base/websocket-driver-base.asd, Previous: websocket-driver/websocket-driver.asd, Up: Lisp [Contents][Index]
4.1.2 websocket-driver-server/websocket-driver-server.asd
- Source
- Parent Component
websocket-driver-server (system).
- ASDF Systems
- Packages
Next: websocket-driver-client/websocket-driver-client.asd, Previous: websocket-driver-server/websocket-driver-server.asd, Up: Lisp [Contents][Index]
4.1.3 websocket-driver-base/websocket-driver-base.asd
- Source
- Parent Component
websocket-driver-base (system).
- ASDF Systems
- Packages
Next: websocket-driver-server/src/server.lisp, Previous: websocket-driver-base/websocket-driver-base.asd, Up: Lisp [Contents][Index]
4.1.4 websocket-driver-client/websocket-driver-client.asd
- Source
- Parent Component
websocket-driver-client (system).
- ASDF Systems
- Packages
Next: websocket-driver-server/src/ws/server.lisp, Previous: websocket-driver-client/websocket-driver-client.asd, Up: Lisp [Contents][Index]
4.1.5 websocket-driver-server/src/server.lisp
- Dependency
ws/server.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
make-server (function).
Next: websocket-driver-base/src/driver.lisp, Previous: websocket-driver-server/src/server.lisp, Up: Lisp [Contents][Index]
4.1.6 websocket-driver-server/src/ws/server.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- close-connection (method).
- initialize-instance (method).
- require-masking (reader method).
- (setf require-masking) (writer method).
- send (method).
- send-handshake-response (method).
- server (class).
- start-connection (method).
- Internals
- headers (reader method).
- (setf headers) (writer method).
Next: websocket-driver-base/src/ws/base.lisp, Previous: websocket-driver-server/src/ws/server.lisp, Up: Lisp [Contents][Index]
4.1.7 websocket-driver-base/src/driver.lisp
- Dependency
ws/base.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
websocket-p (function).
Next: websocket-driver-base/src/util.lisp, Previous: websocket-driver-base/src/driver.lisp, Up: Lisp [Contents][Index]
4.1.8 websocket-driver-base/src/ws/base.lisp
- Dependency
util.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- accept-protocols (reader method).
- (setf accept-protocols) (writer method).
- additional-headers (reader method).
- (setf additional-headers) (writer method).
- close-connection (generic function).
- initialize-instance (method).
- open-connection (generic function).
- parse (generic function).
- protocol (reader method).
- (setf protocol) (writer method).
- read-websocket-frame (function).
- ready-state (generic function).
- (setf ready-state) (generic function).
- require-masking (reader method).
- (setf require-masking) (writer method).
- send (generic function).
- send-binary (function).
- send-handshake-request (generic function).
- send-handshake-response (generic function).
- send-ping (generic function).
- send-text (function).
- socket (reader method).
- (setf socket) (writer method).
- start-connection (generic function).
- version (reader method).
- (setf version) (writer method).
- ws (class).
- Internals
- +states+ (special variable).
- enqueue (function).
- max-length (reader method).
- (setf max-length) (writer method).
- parse-lock (reader method).
- parser (reader method).
- (setf parser) (writer method).
- ping-callbacks (reader method).
- (setf ping-callbacks) (writer method).
- queue (reader method).
- (setf queue) (writer method).
- send-close-frame (function).
- ws-parse (reader method).
- (setf ws-parse) (writer method).
Next: websocket-driver-client/src/ws/client.lisp, Previous: websocket-driver-base/src/ws/base.lisp, Up: Lisp [Contents][Index]
4.1.9 websocket-driver-base/src/util.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- generate-accept (function).
- split-by-comma (function).
- Internals
+guid+ (special variable).
Next: websocket-driver-client/src/client.lisp, Previous: websocket-driver-base/src/util.lisp, Up: Lisp [Contents][Index]
4.1.10 websocket-driver-client/src/ws/client.lisp
- Source
- Parent Component
src (module).
- Packages
- Public Interface
- client (class).
- close-connection (method).
- initialize-instance (method).
- require-masking (reader method).
- (setf require-masking) (writer method).
- send (method).
- send-handshake-request (method).
- start-connection (method).
- Internals
- accept (reader method).
- (setf accept) (writer method).
- generate-key (function).
- key (reader method).
- read-thread (reader method).
- (setf read-thread) (writer method).
- read-until-crlf*2 (function).
- url (reader method).
- (setf url) (writer method).
Previous: websocket-driver-client/src/ws/client.lisp, Up: Lisp [Contents][Index]
4.1.11 websocket-driver-client/src/client.lisp
- Dependency
ws/client.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
make-client (function).
Next: Definitions, Previous: Files, Up: The websocket-driver Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
- websocket-driver
- websocket-driver.ws.base
- websocket-driver-client-asd
- websocket-driver-base-asd
- websocket-driver-client
- websocket-driver.util
- websocket-driver-asd
- websocket-driver.ws.client
- websocket-driver.server
- websocket-driver-server-asd
- websocket-driver.ws.server
Next: websocket-driver.ws.base, Previous: Packages, Up: Packages [Contents][Index]
5.1 websocket-driver
- Source
- Nickname
wsd
- Use List
common-lisp.
- Public Interface
websocket-p (function).
Next: websocket-driver-client-asd, Previous: websocket-driver, Up: Packages [Contents][Index]
5.2 websocket-driver.ws.base
- Source
- Use List
common-lisp.
- Used By List
- Public Interface
- accept-protocols (generic reader).
- (setf accept-protocols) (generic writer).
- additional-headers (generic reader).
- (setf additional-headers) (generic writer).
- close-connection (generic function).
- open-connection (generic function).
- parse (generic function).
- protocol (generic reader).
- (setf protocol) (generic writer).
- read-websocket-frame (function).
- ready-state (generic function).
- (setf ready-state) (generic function).
- require-masking (generic reader).
- (setf require-masking) (generic writer).
- require-masking (slot).
- require-masking (slot).
- send (generic function).
- send-binary (function).
- send-handshake-request (generic function).
- send-handshake-response (generic function).
- send-ping (generic function).
- send-text (function).
- socket (generic reader).
- (setf socket) (generic writer).
- start-connection (generic function).
- version (generic reader).
- (setf version) (generic writer).
- version (slot).
- ws (class).
- Internals
- +states+ (special variable).
- enqueue (function).
- max-length (generic reader).
- (setf max-length) (generic writer).
- parse-lock (generic reader).
- parser (generic reader).
- (setf parser) (generic writer).
- ping-callbacks (generic reader).
- (setf ping-callbacks) (generic writer).
- queue (generic reader).
- (setf queue) (generic writer).
- send-close-frame (function).
- ws-parse (generic reader).
- (setf ws-parse) (generic writer).
Next: websocket-driver-base-asd, Previous: websocket-driver.ws.base, Up: Packages [Contents][Index]
5.3 websocket-driver-client-asd
- Source
- Use List
- asdf/interface.
- common-lisp.
Next: websocket-driver-client, Previous: websocket-driver-client-asd, Up: Packages [Contents][Index]
5.4 websocket-driver-base-asd
- Source
- Use List
- asdf/interface.
- common-lisp.
Next: websocket-driver.util, Previous: websocket-driver-base-asd, Up: Packages [Contents][Index]
5.5 websocket-driver-client
- Source
- Use List
common-lisp.
- Public Interface
make-client (function).
Next: websocket-driver-asd, Previous: websocket-driver-client, Up: Packages [Contents][Index]
5.6 websocket-driver.util
- Source
- Use List
common-lisp.
- Used By List
- Public Interface
- generate-accept (function).
- split-by-comma (function).
- Internals
+guid+ (special variable).
Next: websocket-driver.ws.client, Previous: websocket-driver.util, Up: Packages [Contents][Index]
5.7 websocket-driver-asd
- Source
- Use List
- asdf/interface.
- common-lisp.
Next: websocket-driver.server, Previous: websocket-driver-asd, Up: Packages [Contents][Index]
5.8 websocket-driver.ws.client
- Source
- Use List
- common-lisp.
- websocket-driver.util.
- websocket-driver.ws.base.
- Public Interface
client (class).
- Internals
- accept (generic reader).
- (setf accept) (generic writer).
- generate-key (function).
- key (generic reader).
- read-thread (generic reader).
- (setf read-thread) (generic writer).
- read-until-crlf*2 (function).
- url (generic reader).
- (setf url) (generic writer).
Next: websocket-driver-server-asd, Previous: websocket-driver.ws.client, Up: Packages [Contents][Index]
5.9 websocket-driver.server
- Source
- Use List
common-lisp.
- Public Interface
make-server (function).
Next: websocket-driver.ws.server, Previous: websocket-driver.server, Up: Packages [Contents][Index]
5.10 websocket-driver-server-asd
- Source
- Use List
- asdf/interface.
- common-lisp.
Previous: websocket-driver-server-asd, Up: Packages [Contents][Index]
5.11 websocket-driver.ws.server
- Source
- Use List
- common-lisp.
- websocket-driver.util.
- websocket-driver.ws.base.
- Public Interface
server (class).
- Internals
- headers (generic reader).
- (setf headers) (generic writer).
Next: Indexes, Previous: Packages, Up: The websocket-driver Reference Manual [Contents][Index]
6 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
6.1.1 Ordinary functions
- Function: generate-accept (key) ¶
-
- Package
- Source
- Function: make-client (url &rest options &key max-length accept-protocols additional-headers) ¶
-
- Package
- Source
- Function: make-server (env &rest options &key max-length accept-protocols additional-headers) ¶
-
- Package
- Source
- Function: read-websocket-frame (stream) ¶
-
- Package
- Source
- Function: send-binary (ws message &rest args &key start end callback) ¶
-
- Package
- Source
- Function: send-text (ws message &rest args &key start end callback) ¶
-
- Package
- Source
- Function: split-by-comma (string) ¶
-
- Package
- Source
- Function: websocket-p (env) ¶
-
- Package
- Source
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
6.1.2 Generic functions
- Generic Reader: accept-protocols (object) ¶
- Generic Writer: (setf accept-protocols) (object) ¶
- Generic Reader: additional-headers (object) ¶
- Generic Writer: (setf additional-headers) (object) ¶
- Generic Function: close-connection (ws &optional reason code) ¶
- Generic Function: open-connection (ws) ¶
-
- Package
- Source
- Methods
- Generic Function: parse (ws data &key start end) ¶
-
- Package
- Source
- Methods
- Method: parse (ws data &key start end) ¶
- Generic Reader: protocol (object) ¶
- Generic Writer: (setf protocol) (object) ¶
- Generic Function: ready-state (ws) ¶
-
- Package
- Source
- Methods
- Generic Function: (setf ready-state) (ws) ¶
-
- Package
- Source
- Methods
- Generic Reader: require-masking (object) ¶
-
- Package
- Methods
- Reader Method: require-masking ((client client)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Reader Method: require-masking ((server server)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf require-masking) (object) ¶
-
- Package
- Methods
- Writer Method: (setf require-masking) ((client client)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Writer Method: (setf require-masking) ((server server)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Function: send (ws data &key start end type code callback &allow-other-keys) ¶
- Generic Function: send-handshake-request (ws &key callback) ¶
- Generic Function: send-handshake-response (ws &key callback) ¶
- Generic Function: send-ping (ws &optional message callback) ¶
-
- Package
- Source
- Methods
- Generic Reader: socket (object) ¶
- Generic Writer: (setf socket) (object) ¶
- Generic Function: start-connection (ws &key verify ca-path &allow-other-keys) ¶
- Generic Reader: version (object) ¶
- Generic Writer: (setf version) (object) ¶
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
6.1.3 Standalone methods
Previous: Standalone methods, Up: Public Interface [Contents][Index]
6.1.4 Classes
- Class: client ¶
-
- Package
- Source
- Direct superclasses
ws.
- Direct methods
- Direct slots
-
- Slot: key ¶
-
- Initform
(websocket-driver.ws.client::generate-key)
- Readers
key.
- Writers
This slot is read-only.
- Slot: accept ¶
-
- Readers
- Writers
- Slot: version ¶
-
- Package
- Initform
"hybi-13"
- Slot: require-masking ¶
-
- Package
- Initargs
:require-masking
- Readers
- Writers
- Slot: read-thread ¶
-
- Readers
- Writers
- Class: server ¶
- Class: ws ¶
-
- Package
- Source
- Direct superclasses
event-emitter.
- Direct subclasses
- Direct methods
- (setf accept-protocols).
- accept-protocols.
- (setf additional-headers).
- additional-headers.
- close-connection.
- initialize-instance.
- (setf max-length).
- max-length.
- open-connection.
- parse-lock.
- (setf parser).
- parser.
- (setf ping-callbacks).
- ping-callbacks.
- (setf protocol).
- protocol.
- (setf queue).
- queue.
- (setf ready-state).
- ready-state.
- (setf require-masking).
- require-masking.
- send.
- send-ping.
- (setf socket).
- socket.
- (setf version).
- version.
- (setf ws-parse).
- ws-parse.
- Direct slots
- Slot: socket ¶
-
- Initargs
:socket
- Readers
- Writers
- Slot: accept-protocols ¶
-
- Initform
(quote nil)
- Initargs
:accept-protocols
- Readers
- Writers
- Slot: protocol ¶
-
- Type
(or null string)
- Readers
- Writers
- Slot: version ¶
-
- Readers
- Writers
- Slot: max-length ¶
-
- Initform
67108863
- Initargs
:max-length
- Readers
- Writers
- Slot: ready-state ¶
-
- Type
fixnum
- Initform
0
- Slot: additional-headers ¶
-
- Initform
(quote nil)
- Initargs
:additional-headers
- Readers
- Writers
- Slot: queue ¶
-
- Initform
(make-array 0 :adjustable t :fill-pointer 0)
- Readers
- Writers
- Slot: require-masking ¶
-
- Initargs
:require-masking
- Readers
- Writers
- Slot: ws-parse ¶
-
- Initform
(fast-websocket.ws:make-ws)
- Readers
- Writers
- Slot: ping-callbacks ¶
-
- Initform
(make-hash-table :test (quote equalp))
- Readers
- Writers
- Slot: parser ¶
-
- Readers
- Writers
- Slot: parse-lock ¶
-
- Initform
(bordeaux-threads:make-recursive-lock)
- Readers
- Writers
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
6.2.1 Special variables
- Special Variable: +guid+ ¶
-
- Package
- Source
- Special Variable: +states+ ¶
-
- Package
- Source
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
6.2.2 Ordinary functions
- Function: enqueue (ws message) ¶
-
- Package
- Source
- Function: generate-key () ¶
-
- Package
- Source
- Function: read-until-crlf*2 (stream) ¶
-
- Package
- Source
- Function: send-close-frame (ws reason code) ¶
-
- Package
- Source
Previous: Ordinary functions, Up: Internals [Contents][Index]
6.2.3 Generic functions
- Generic Reader: accept (object) ¶
- Generic Writer: (setf accept) (object) ¶
- Generic Reader: headers (object) ¶
- Generic Writer: (setf headers) (object) ¶
- Generic Reader: key (object) ¶
- Generic Reader: max-length (object) ¶
- Generic Writer: (setf max-length) (object) ¶
- Generic Reader: parse-lock (object) ¶
- Generic Reader: parser (object) ¶
- Generic Writer: (setf parser) (object) ¶
- Generic Reader: ping-callbacks (object) ¶
- Generic Writer: (setf ping-callbacks) (object) ¶
- Generic Reader: queue (object) ¶
- Generic Writer: (setf queue) (object) ¶
- Generic Reader: read-thread (object) ¶
- Generic Writer: (setf read-thread) (object) ¶
- Generic Reader: url (object) ¶
- Generic Writer: (setf url) (object) ¶
- Generic Reader: ws-parse (object) ¶
- Generic Writer: (setf ws-parse) (object) ¶
Previous: Definitions, Up: The websocket-driver Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | (
A C E F G H I K M O P Q R S U V W |
|---|
| Jump to: | (
A C E F G H I K M O P Q R S U V W |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | +
A H K M P Q R S U V W |
|---|
| Jump to: | +
A H K M P Q R S U V W |
|---|
A.4 Data types
| Jump to: | C D F M P S U W |
|---|
| Jump to: | C D F M P S U W |
|---|