The websocket-driver Reference Manual

Table of Contents

The websocket-driver Reference Manual

This is the websocket-driver Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 13:04:54 2021 GMT+0.

1 Introduction

Websocket Driver

This library provides WebSocket server & client implementation for Common Lisp.

Supported Servers

• Hunchentoot
• Wookie
• Woo

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

• Clack
• Event Emitter

2 Systems

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

2.1 websocket-driver

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies

• websocket-driver-server (system)
• websocket-driver-client (system)

Source

websocket-driver.asd (file)

2.2 websocket-driver-server

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies

• websocket-driver-base (system)
• fast-websocket
• fast-io
• clack-socket
• ironclad

Source

websocket-driver-server.asd (file)

Component

src (module)

2.3 websocket-driver-client

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.2.0

Dependencies

• websocket-driver-base (system)
• usocket
• cl+ssl
• fast-io
• fast-websocket
• fast-http
• cl-base64
• ironclad
• quri

Source

websocket-driver-client.asd (file)

Component

src (module)

2.4 websocket-driver-base

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies

• fast-websocket
• fast-io
• event-emitter
• ironclad
• cl-base64
• split-sequence
• bordeaux-threads

Source

websocket-driver-base.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 websocket-driver-server/src

Parent

websocket-driver-server (system)

Location

src/

Components

• server.lisp (file)
• ws/server.lisp (file)

3.2 websocket-driver-client/src

Parent

websocket-driver-client (system)

Location

src/

Components

• ws/client.lisp (file)
• client.lisp (file)

3.3 websocket-driver-base/src

Parent

websocket-driver-base (system)

Location

src/

Components

• driver.lisp (file)
• ws/base.lisp (file)
• util.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 websocket-driver.asd

Location

websocket-driver.asd

Systems

websocket-driver (system)

Packages

websocket-driver-asd

4.1.2 websocket-driver-server.asd

Location

websocket-driver-server.asd

Systems

websocket-driver-server (system)

Packages

websocket-driver-server-asd

4.1.3 websocket-driver-client.asd

Location

websocket-driver-client.asd

Systems

websocket-driver-client (system)

Packages

websocket-driver-client-asd

4.1.4 websocket-driver-base.asd

Location

websocket-driver-base.asd

Systems

websocket-driver-base (system)

Packages

websocket-driver-base-asd

4.1.5 websocket-driver-server/src/server.lisp

Dependency

ws/server.lisp (file)

Parent

src (module)

Location

src/server.lisp

Packages

websocket-driver.server

Exported Definitions

make-server (function)

4.1.6 websocket-driver-server/src/ws/server.lisp

Parent

src (module)

Location

src/ws/server.lisp

Packages

websocket-driver.ws.server

Exported Definitions

• close-connection (method)
• require-masking (method)
• (setf require-masking) (method)
• send (method)
• send-handshake-response (method)
• server (class)
• start-connection (method)

Internal Definitions

• headers (method)
• (setf headers) (method)

4.1.7 websocket-driver-client/src/ws/client.lisp

Parent

src (module)

Location

src/ws/client.lisp

Packages

websocket-driver.ws.client

Exported Definitions

• client (class)
• close-connection (method)
• require-masking (method)
• (setf require-masking) (method)
• send (method)
• send-handshake-request (method)
• start-connection (method)

Internal Definitions

• accept (method)
• (setf accept) (method)
• generate-key (function)
• key (method)
• read-until-crlf*2 (function)
• url (method)
• (setf url) (method)

4.1.8 websocket-driver-client/src/client.lisp

Dependency

ws/client.lisp (file)

Parent

src (module)

Location

src/client.lisp

Packages

websocket-driver-client

Exported Definitions

make-client (function)

4.1.9 websocket-driver-base/src/driver.lisp

Dependency

ws/base.lisp (file)

Parent

src (module)

Location

src/driver.lisp

Packages

websocket-driver

Exported Definitions

websocket-p (function)

4.1.10 websocket-driver-base/src/ws/base.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/ws/base.lisp

Packages

websocket-driver.ws.base

Exported Definitions

• accept-protocols (method)
• (setf accept-protocols) (method)
• additional-headers (method)
• (setf additional-headers) (method)
• close-connection (generic function)
• close-connection (method)
• open-connection (generic function)
• open-connection (method)
• parse (generic function)
• parse (method)
• protocol (method)
• (setf protocol) (method)
• read-websocket-frame (function)
• ready-state (generic function)
• ready-state (method)
• (setf ready-state) (method)
• (setf ready-state) (generic function)
• require-masking (method)
• (setf require-masking) (method)
• send (generic function)
• send (method)
• send-binary (function)
• send-handshake-request (generic function)
• send-handshake-response (generic function)
• send-ping (generic function)
• send-ping (method)
• send-text (function)
• socket (method)
• (setf socket) (method)
• start-connection (generic function)
• version (method)
• (setf version) (method)
• ws (class)

Internal Definitions

• +states+ (special variable)
• enqueue (function)
• max-length (method)
• (setf max-length) (method)
• parse-lock (method)
• parser (method)
• (setf parser) (method)
• ping-callbacks (method)
• (setf ping-callbacks) (method)
• queue (method)
• (setf queue) (method)
• send-close-frame (function)
• ws-parse (method)
• (setf ws-parse) (method)

4.1.11 websocket-driver-base/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

websocket-driver.util

Exported Definitions

• generate-accept (function)
• split-by-comma (function)

Internal Definitions

+guid+ (special variable)

5 Packages

Packages are listed by definition order.

5.1 websocket-driver-asd

Source

websocket-driver.asd

Use List

• asdf/interface
• common-lisp

5.2 websocket-driver-server-asd

Source

websocket-driver-server.asd

Use List

• asdf/interface
• common-lisp

5.3 websocket-driver.server

Source

server.lisp (file)

Use List

common-lisp

Exported Definitions

make-server (function)

5.4 websocket-driver.ws.server

Source

ws/server.lisp (file)

Use List

• websocket-driver.util
• websocket-driver.ws.base
• common-lisp

Exported Definitions

server (class)

Internal Definitions

• headers (generic function)
• headers (method)
• (setf headers) (method)
• (setf headers) (generic function)

5.5 websocket-driver-client-asd

Source

websocket-driver-client.asd

Use List

• asdf/interface
• common-lisp

5.6 websocket-driver.ws.client

Source

ws/client.lisp (file)

Use List

• websocket-driver.util
• websocket-driver.ws.base
• common-lisp

Exported Definitions

client (class)

Internal Definitions

• accept (generic function)
• accept (method)
• (setf accept) (method)
• (setf accept) (generic function)
• generate-key (function)
• key (generic function)
• key (method)
• read-until-crlf*2 (function)
• url (generic function)
• url (method)
• (setf url) (method)
• (setf url) (generic function)

5.7 websocket-driver-client

Source

client.lisp (file)

Use List

common-lisp

Exported Definitions

make-client (function)

5.8 websocket-driver-base-asd

Source

websocket-driver-base.asd

Use List

• asdf/interface
• common-lisp

5.9 websocket-driver

Source

driver.lisp (file)

Nickname

wsd

Use List

common-lisp

Exported Definitions

websocket-p (function)

5.10 websocket-driver.ws.base

Source

ws/base.lisp (file)

Use List

common-lisp

Used By List

• websocket-driver.ws.client
• websocket-driver.ws.server

Exported Definitions

• accept-protocols (generic function)
• accept-protocols (method)
• (setf accept-protocols) (method)
• (setf accept-protocols) (generic function)
• additional-headers (generic function)
• additional-headers (method)
• (setf additional-headers) (method)
• (setf additional-headers) (generic function)
• close-connection (generic function)
• close-connection (method)
• close-connection (method)
• close-connection (method)
• open-connection (generic function)
• open-connection (method)
• parse (generic function)
• parse (method)
• protocol (generic function)
• protocol (method)
• (setf protocol) (method)
• (setf protocol) (generic function)
• read-websocket-frame (function)
• ready-state (generic function)
• ready-state (method)
• (setf ready-state) (method)
• (setf ready-state) (generic function)
• require-masking (generic function)
• require-masking (method)
• (setf require-masking) (method)
• require-masking (method)
• (setf require-masking) (method)
• require-masking (method)
• (setf require-masking) (method)
• (setf require-masking) (generic function)
• send (generic function)
• send (method)
• send (method)
• send (method)
• send-binary (function)
• send-handshake-request (generic function)
• send-handshake-request (method)
• send-handshake-response (generic function)
• send-handshake-response (method)
• send-ping (generic function)
• send-ping (method)
• send-text (function)
• socket (generic function)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• start-connection (generic function)
• start-connection (method)
• start-connection (method)
• version (generic function)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• ws (class)

Internal Definitions

• +states+ (special variable)
• enqueue (function)
• max-length (generic function)
• max-length (method)
• (setf max-length) (method)
• (setf max-length) (generic function)
• parse-lock (generic function)
• parse-lock (method)
• parser (generic function)
• parser (method)
• (setf parser) (method)
• (setf parser) (generic function)
• ping-callbacks (generic function)
• ping-callbacks (method)
• (setf ping-callbacks) (method)
• (setf ping-callbacks) (generic function)
• queue (generic function)
• queue (method)
• (setf queue) (method)
• (setf queue) (generic function)
• send-close-frame (function)
• ws-parse (generic function)
• ws-parse (method)
• (setf ws-parse) (method)
• (setf ws-parse) (generic function)

5.11 websocket-driver.util

Source

util.lisp (file)

Use List

common-lisp

Used By List

• websocket-driver.ws.client
• websocket-driver.ws.server

Exported Definitions

• generate-accept (function)
• split-by-comma (function)

Internal Definitions

+guid+ (special variable)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: generate-accept KEY

Package

websocket-driver.util

Source

util.lisp (file)

Function: make-client URL &rest OPTIONS &key MAX-LENGTH ACCEPT-PROTOCOLS ADDITIONAL-HEADERS

Package

websocket-driver-client

Source

client.lisp (file)

Function: make-server ENV &rest OPTIONS &key MAX-LENGTH ACCEPT-PROTOCOLS ADDITIONAL-HEADERS

Package

websocket-driver.server

Source

server.lisp (file)

Function: read-websocket-frame STREAM

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Function: send-binary WS MESSAGE &rest ARGS &key START END CALLBACK

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Function: send-text WS MESSAGE &rest ARGS &key START END CALLBACK

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Function: split-by-comma STRING

Package

websocket-driver.util

Source

util.lisp (file)

Function: websocket-p ENV

Package

websocket-driver

Source

driver.lisp (file)

6.1.2 Generic functions

Generic Function: accept-protocols OBJECT

Generic Function: (setf accept-protocols) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: accept-protocols (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf accept-protocols) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: additional-headers OBJECT

Generic Function: (setf additional-headers) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: additional-headers (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf additional-headers) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: close-connection WS &optional REASON CODE

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: close-connection (CLIENT client) &optional REASON CODE

Source

ws/client.lisp (file)

Method: close-connection (SERVER server) &optional REASON CODE

Source

ws/server.lisp (file)

Method: close-connection (WS ws) &optional REASON CODE around

Generic Function: open-connection WS

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: open-connection (WS ws)

Generic Function: parse WS DATA &key START END

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: parse WS DATA &key START END

Generic Function: protocol OBJECT

Generic Function: (setf protocol) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: protocol (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf protocol) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: ready-state WS

Generic Function: (setf ready-state) STATE WS

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: ready-state (WS ws)

Method: (setf ready-state) STATE (WS ws)

Generic Function: require-masking OBJECT

Generic Function: (setf require-masking) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: require-masking (CLIENT client)

automatically generated reader method

Source

ws/client.lisp (file)

Method: (setf require-masking) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

ws/client.lisp (file)

Method: require-masking (SERVER server)

automatically generated reader method

Source

ws/server.lisp (file)

Method: (setf require-masking) NEW-VALUE (SERVER server)

automatically generated writer method

Source

ws/server.lisp (file)

Method: require-masking (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf require-masking) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: send WS DATA &key START END TYPE CODE CALLBACK &allow-other-keys

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: send (CLIENT client) DATA &key START END TYPE CODE CALLBACK

Source

ws/client.lisp (file)

Method: send (SERVER server) DATA &key START END TYPE CODE CALLBACK

Source

ws/server.lisp (file)

Method: send (WS ws) DATA &rest ARGS &key TYPE CALLBACK &allow-other-keys around

Generic Function: send-handshake-request WS &key CALLBACK

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: send-handshake-request (CLIENT client) &key CALLBACK

Source

ws/client.lisp (file)

Generic Function: send-handshake-response WS &key CALLBACK

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: send-handshake-response (SERVER server) &key CALLBACK

Source

ws/server.lisp (file)

Generic Function: send-ping WS &optional MESSAGE CALLBACK

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: send-ping (WS ws) &optional MESSAGE CALLBACK

Generic Function: socket OBJECT

Generic Function: (setf socket) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: socket (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf socket) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: start-connection WS &key VERIFY CA-PATH &allow-other-keys

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods

Method: start-connection (CLIENT client) &key VERIFY CA-PATH

Source

ws/client.lisp (file)

Method: start-connection (SERVER server) &key

Source

ws/server.lisp (file)

Generic Function: version OBJECT

Generic Function: (setf version) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: version (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf version) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

6.1.3 Classes

Class: client ()

Package

websocket-driver.ws.client

Source

ws/client.lisp (file)

Direct superclasses

ws (class)

Direct methods

• close-connection (method)
• send-handshake-request (method)
• send (method)
• start-connection (method)
• initialize-instance (method)
• require-masking (method)
• require-masking (method)
• accept (method)
• accept (method)
• key (method)
• url (method)
• url (method)

Direct slots

Slot: url

Initargs

:url

Initform

(error ":url is required")

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: key

Initform

(websocket-driver.ws.client::generate-key)

Readers

key (generic function)

Slot: accept

Readers

accept (generic function)

Writers

(setf accept) (generic function)

Slot: version

Initform

"hybi-13"

Slot: require-masking

Initargs

:require-masking

Readers

require-masking (generic function)

Writers

(setf require-masking) (generic function)

Slot: read-thread

Class: server ()

Package

websocket-driver.ws.server

Source

ws/server.lisp (file)

Direct superclasses

ws (class)

Direct methods

• send-handshake-response (method)
• send (method)
• close-connection (method)
• start-connection (method)
• initialize-instance (method)
• require-masking (method)
• require-masking (method)
• headers (method)
• headers (method)

Direct slots

Slot: headers

Type

hash-table

Initargs

:headers

Initform

(error ":headers is required")

Readers

headers (generic function)

Writers

(setf headers) (generic function)

Slot: require-masking

Initargs

:require-masking

Initform

t

Readers

require-masking (generic function)

Writers

(setf require-masking) (generic function)

Class: ws ()

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Direct superclasses

event-emitter (class)

Direct subclasses

• server (class)
• client (class)

Direct methods

• open-connection (method)
• close-connection (method)
• send-ping (method)
• send (method)
• ready-state (method)
• ready-state (method)
• initialize-instance (method)
• parse-lock (method)
• parser (method)
• parser (method)
• ping-callbacks (method)
• ping-callbacks (method)
• ws-parse (method)
• ws-parse (method)
• require-masking (method)
• require-masking (method)
• queue (method)
• queue (method)
• additional-headers (method)
• additional-headers (method)
• max-length (method)
• max-length (method)
• version (method)
• version (method)
• protocol (method)
• protocol (method)
• accept-protocols (method)
• accept-protocols (method)
• socket (method)
• socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: accept-protocols

Initargs

:accept-protocols

Initform

(quote nil)

Readers

accept-protocols (generic function)

Writers

(setf accept-protocols) (generic function)

Slot: protocol

Type

(or null string)

Readers

protocol (generic function)

Writers

(setf protocol) (generic function)

Slot: version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: max-length

Initargs

:max-length

Initform

67108863

Readers

max-length (generic function)

Writers

(setf max-length) (generic function)

Slot: ready-state

Type

fixnum

Initform

0

Slot: additional-headers

Initargs

:additional-headers

Initform

(quote nil)

Readers

additional-headers (generic function)

Writers

(setf additional-headers) (generic function)

Slot: queue

Initform

(make-array 0 :adjustable t :fill-pointer 0)

Readers

queue (generic function)

Writers

(setf queue) (generic function)

Slot: require-masking

Initargs

:require-masking

Readers

require-masking (generic function)

Writers

(setf require-masking) (generic function)

Slot: ws-parse

Initform

(fast-websocket.ws:make-ws)

Readers

ws-parse (generic function)

Writers

(setf ws-parse) (generic function)

Slot: ping-callbacks

Initform

(make-hash-table :test (quote equalp))

Readers

ping-callbacks (generic function)

Writers

(setf ping-callbacks) (generic function)

Slot: parser

Readers

parser (generic function)

Writers

(setf parser) (generic function)

Slot: parse-lock

Initform

(bordeaux-threads:make-recursive-lock)

Readers

parse-lock (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: +guid+

Package

websocket-driver.util

Source

util.lisp (file)

Special Variable: +states+

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

6.2.2 Functions

Function: enqueue WS MESSAGE

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Function: generate-key ()

Package

websocket-driver.ws.client

Source

ws/client.lisp (file)

Function: read-until-crlf*2 STREAM

Package

websocket-driver.ws.client

Source

ws/client.lisp (file)

Function: send-close-frame WS REASON CODE

Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

6.2.3 Generic functions

Generic Function: accept OBJECT

Generic Function: (setf accept) NEW-VALUE OBJECT

Package

websocket-driver.ws.client

Methods

Method: accept (CLIENT client)

automatically generated reader method

Source

ws/client.lisp (file)

Method: (setf accept) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

ws/client.lisp (file)

Generic Function: headers OBJECT

Generic Function: (setf headers) NEW-VALUE OBJECT

Package

websocket-driver.ws.server

Methods

Method: headers (SERVER server)

automatically generated reader method

Source

ws/server.lisp (file)

Method: (setf headers) NEW-VALUE (SERVER server)

automatically generated writer method

Source

ws/server.lisp (file)

Generic Function: key OBJECT

Package

websocket-driver.ws.client

Methods

Method: key (CLIENT client)

automatically generated reader method

Source

ws/client.lisp (file)

Generic Function: max-length OBJECT

Generic Function: (setf max-length) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: max-length (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf max-length) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: parse-lock OBJECT

Package

websocket-driver.ws.base

Methods

Method: parse-lock (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Generic Function: parser OBJECT

Generic Function: (setf parser) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: parser (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf parser) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: ping-callbacks OBJECT

Generic Function: (setf ping-callbacks) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: ping-callbacks (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf ping-callbacks) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: queue OBJECT

Generic Function: (setf queue) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: queue (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf queue) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Generic Function: url OBJECT

Generic Function: (setf url) NEW-VALUE OBJECT

Package

websocket-driver.ws.client

Methods

Method: url (CLIENT client)

automatically generated reader method

Source

ws/client.lisp (file)

Method: (setf url) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

ws/client.lisp (file)

Generic Function: ws-parse OBJECT

Generic Function: (setf ws-parse) NEW-VALUE OBJECT

Package

websocket-driver.ws.base

Methods

Method: ws-parse (WS ws)

automatically generated reader method

Source

ws/base.lisp (file)

Method: (setf ws-parse) NEW-VALUE (WS ws)

automatically generated writer method

Source

ws/base.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types