The websocket-driver Reference Manual

Next: , Previous: , 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

Websocket Driver

Build Status Quicklisp dist

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

Copyright

Copyright (c) 2014 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the BSD 2-Clause License.

See Also


2 Systems

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


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 websocket-driver

WebSocket protocol handler

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.2.0

Dependencies
Source

websocket-driver.asd.


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

websocket-driver-server.asd.

Child Component

src (module).


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

websocket-driver-base.asd.

Child Component

src (module).


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

websocket-driver-client.asd.

Child Component

src (module).


3 Modules

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


3.1 websocket-driver-server/src

Source

websocket-driver-server.asd.

Parent Component

websocket-driver-server (system).

Child Components

3.2 websocket-driver-base/src

Source

websocket-driver-base.asd.

Parent Component

websocket-driver-base (system).

Child Components

3.3 websocket-driver-client/src

Source

websocket-driver-client.asd.

Parent Component

websocket-driver-client (system).

Child Components

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


4.1.1 websocket-driver/websocket-driver.asd

Source

websocket-driver.asd.

Parent Component

websocket-driver (system).

ASDF Systems

websocket-driver.

Packages

websocket-driver-asd.


4.1.2 websocket-driver-server/websocket-driver-server.asd

Source

websocket-driver-server.asd.

Parent Component

websocket-driver-server (system).

ASDF Systems

websocket-driver-server.

Packages

websocket-driver-server-asd.


4.1.3 websocket-driver-base/websocket-driver-base.asd

Source

websocket-driver-base.asd.

Parent Component

websocket-driver-base (system).

ASDF Systems

websocket-driver-base.

Packages

websocket-driver-base-asd.


4.1.4 websocket-driver-client/websocket-driver-client.asd

Source

websocket-driver-client.asd.

Parent Component

websocket-driver-client (system).

ASDF Systems

websocket-driver-client.

Packages

websocket-driver-client-asd.


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

Dependency

ws/server.lisp (file).

Source

websocket-driver-server.asd.

Parent Component

src (module).

Packages

websocket-driver.server.

Public Interface

make-server (function).


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

Source

websocket-driver-server.asd.

Parent Component

src (module).

Packages

websocket-driver.ws.server.

Public Interface
Internals

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

Dependency

ws/base.lisp (file).

Source

websocket-driver-base.asd.

Parent Component

src (module).

Packages

websocket-driver.

Public Interface

websocket-p (function).


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

Dependency

util.lisp (file).

Source

websocket-driver-base.asd.

Parent Component

src (module).

Packages

websocket-driver.ws.base.

Public Interface
Internals

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

Source

websocket-driver-base.asd.

Parent Component

src (module).

Packages

websocket-driver.util.

Public Interface
Internals

+guid+ (special variable).


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

Source

websocket-driver-client.asd.

Parent Component

src (module).

Packages

websocket-driver.ws.client.

Public Interface
Internals

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

Dependency

ws/client.lisp (file).

Source

websocket-driver-client.asd.

Parent Component

src (module).

Packages

websocket-driver-client.

Public Interface

make-client (function).


5 Packages

Packages are listed by definition order.


5.1 websocket-driver

Source

driver.lisp.

Nickname

wsd

Use List

common-lisp.

Public Interface

websocket-p (function).


5.2 websocket-driver.ws.base

Source

ws/base.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

5.3 websocket-driver-client-asd

Source

websocket-driver-client.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.4 websocket-driver-base-asd

Source

websocket-driver-base.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.5 websocket-driver-client

Source

client.lisp.

Use List

common-lisp.

Public Interface

make-client (function).


5.6 websocket-driver.util

Source

util.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

+guid+ (special variable).


5.7 websocket-driver-asd

Source

websocket-driver.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.8 websocket-driver.ws.client

Source

ws/client.lisp.

Use List
Public Interface

client (class).

Internals

5.9 websocket-driver.server

Source

server.lisp.

Use List

common-lisp.

Public Interface

make-server (function).


5.10 websocket-driver-server-asd

Source

websocket-driver-server.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.11 websocket-driver.ws.server

Source

ws/server.lisp.

Use List
Public Interface

server (class).

Internals

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


6.1.1 Ordinary functions

Function: generate-accept (key)
Package

websocket-driver.util.

Source

util.lisp.

Function: make-client (url &rest options &key max-length accept-protocols additional-headers)
Package

websocket-driver-client.

Source

client.lisp.

Function: make-server (env &rest options &key max-length accept-protocols additional-headers)
Package

websocket-driver.server.

Source

server.lisp.

Function: read-websocket-frame (stream)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Function: send-binary (ws message &rest args &key start end callback)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Function: send-text (ws message &rest args &key start end callback)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Function: split-by-comma (string)
Package

websocket-driver.util.

Source

util.lisp.

Function: websocket-p (env)
Package

websocket-driver.

Source

driver.lisp.


6.1.2 Generic functions

Generic Reader: accept-protocols (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: accept-protocols ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

accept-protocols.

Generic Writer: (setf accept-protocols) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf accept-protocols) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

accept-protocols.

Generic Reader: additional-headers (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: additional-headers ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

additional-headers.

Generic Writer: (setf additional-headers) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf additional-headers) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

additional-headers.

Generic Function: close-connection (ws &optional reason code)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: close-connection ((client client) &optional reason code)
Source

ws/client.lisp.

Method: close-connection ((server server) &optional reason code)
Source

ws/server.lisp.

Method: close-connection :around ((ws ws) &optional reason code)
Generic Function: open-connection (ws)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: open-connection ((ws ws))
Generic Function: parse (ws data &key start end)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: parse (ws data &key start end)
Generic Reader: protocol (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: protocol ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

protocol.

Generic Writer: (setf protocol) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf protocol) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

protocol.

Generic Function: ready-state (ws)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: ready-state ((ws ws))
Generic Function: (setf ready-state) (ws)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: (setf ready-state) ((ws ws))
Generic Reader: require-masking (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: require-masking ((client client))

automatically generated reader method

Source

ws/client.lisp.

Target Slot

require-masking.

Reader Method: require-masking ((server server))

automatically generated reader method

Source

ws/server.lisp.

Target Slot

require-masking.

Reader Method: require-masking ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

require-masking.

Generic Writer: (setf require-masking) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf require-masking) ((client client))

automatically generated writer method

Source

ws/client.lisp.

Target Slot

require-masking.

Writer Method: (setf require-masking) ((server server))

automatically generated writer method

Source

ws/server.lisp.

Target Slot

require-masking.

Writer Method: (setf require-masking) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

require-masking.

Generic Function: send (ws data &key start end type code callback &allow-other-keys)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: send ((client client) data &key start end type code callback)
Source

ws/client.lisp.

Method: send ((server server) data &key start end type code callback)
Source

ws/server.lisp.

Method: send :around ((ws ws) data &rest args &key type callback &allow-other-keys)
Generic Function: send-handshake-request (ws &key callback)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: send-handshake-request ((client client) &key callback)
Source

ws/client.lisp.

Generic Function: send-handshake-response (ws &key callback)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: send-handshake-response ((server server) &key callback)
Source

ws/server.lisp.

Generic Function: send-ping (ws &optional message callback)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: send-ping ((ws ws) &optional message callback)
Generic Reader: socket (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: socket ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

socket.

Generic Writer: (setf socket) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf socket) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

socket.

Generic Function: start-connection (ws &key verify ca-path &allow-other-keys)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Methods
Method: start-connection ((client client) &key verify ca-path)
Source

ws/client.lisp.

Method: start-connection ((server server) &key)
Source

ws/server.lisp.

Generic Reader: version (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: version ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

version.

Generic Writer: (setf version) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf version) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

version.


6.1.3 Standalone methods

Method: initialize-instance :after ((ws ws) &key)
Source

ws/base.lisp.

Method: initialize-instance :after ((client client) &key)
Source

ws/client.lisp.

Method: initialize-instance :after ((server server) &key)
Source

ws/server.lisp.


6.1.4 Classes

Class: client
Package

websocket-driver.ws.client.

Source

ws/client.lisp.

Direct superclasses

ws.

Direct methods
Direct slots
Slot: url
Initform

(error ":url is required")

Initargs

:url

Readers

url.

Writers

(setf url).

Slot: key
Initform

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

Readers

key.

Writers

This slot is read-only.

Slot: accept
Readers

accept.

Writers

(setf accept).

Slot: version
Package

websocket-driver.ws.base.

Initform

"hybi-13"

Slot: require-masking
Package

websocket-driver.ws.base.

Initargs

:require-masking

Readers

require-masking.

Writers

(setf require-masking).

Slot: read-thread
Readers

read-thread.

Writers

(setf read-thread).

Class: server
Package

websocket-driver.ws.server.

Source

ws/server.lisp.

Direct superclasses

ws.

Direct methods
Direct slots
Slot: headers
Type

hash-table

Initform

(error ":headers is required")

Initargs

:headers

Readers

headers.

Writers

(setf headers).

Slot: require-masking
Package

websocket-driver.ws.base.

Initform

t

Initargs

:require-masking

Readers

require-masking.

Writers

(setf require-masking).

Class: ws
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Direct superclasses

event-emitter.

Direct subclasses
Direct methods
Direct slots
Slot: socket
Initargs

:socket

Readers

socket.

Writers

(setf socket).

Slot: accept-protocols
Initform

(quote nil)

Initargs

:accept-protocols

Readers

accept-protocols.

Writers

(setf accept-protocols).

Slot: protocol
Type

(or null string)

Readers

protocol.

Writers

(setf protocol).

Slot: version
Readers

version.

Writers

(setf version).

Slot: max-length
Initform

67108863

Initargs

:max-length

Readers

max-length.

Writers

(setf max-length).

Slot: ready-state
Type

fixnum

Initform

0

Slot: additional-headers
Initform

(quote nil)

Initargs

:additional-headers

Readers

additional-headers.

Writers

(setf additional-headers).

Slot: queue
Initform

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

Readers

queue.

Writers

(setf queue).

Slot: require-masking
Initargs

:require-masking

Readers

require-masking.

Writers

(setf require-masking).

Slot: ws-parse
Initform

(fast-websocket.ws:make-ws)

Readers

ws-parse.

Writers

(setf ws-parse).

Slot: ping-callbacks
Initform

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

Readers

ping-callbacks.

Writers

(setf ping-callbacks).

Slot: parser
Readers

parser.

Writers

(setf parser).

Slot: parse-lock
Initform

(bordeaux-threads:make-recursive-lock)

Readers

parse-lock.

Writers

This slot is read-only.


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Special variables

Special Variable: +guid+
Package

websocket-driver.util.

Source

util.lisp.

Special Variable: +states+
Package

websocket-driver.ws.base.

Source

ws/base.lisp.


6.2.2 Ordinary functions

Function: enqueue (ws message)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.

Function: generate-key ()
Package

websocket-driver.ws.client.

Source

ws/client.lisp.

Function: read-until-crlf*2 (stream)
Package

websocket-driver.ws.client.

Source

ws/client.lisp.

Function: send-close-frame (ws reason code)
Package

websocket-driver.ws.base.

Source

ws/base.lisp.


6.2.3 Generic functions

Generic Reader: accept (object)
Package

websocket-driver.ws.client.

Methods
Reader Method: accept ((client client))

automatically generated reader method

Source

ws/client.lisp.

Target Slot

accept.

Generic Writer: (setf accept) (object)
Package

websocket-driver.ws.client.

Methods
Writer Method: (setf accept) ((client client))

automatically generated writer method

Source

ws/client.lisp.

Target Slot

accept.

Generic Reader: headers (object)
Package

websocket-driver.ws.server.

Methods
Reader Method: headers ((server server))

automatically generated reader method

Source

ws/server.lisp.

Target Slot

headers.

Generic Writer: (setf headers) (object)
Package

websocket-driver.ws.server.

Methods
Writer Method: (setf headers) ((server server))

automatically generated writer method

Source

ws/server.lisp.

Target Slot

headers.

Generic Reader: key (object)
Package

websocket-driver.ws.client.

Methods
Reader Method: key ((client client))

automatically generated reader method

Source

ws/client.lisp.

Target Slot

key.

Generic Reader: max-length (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: max-length ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

max-length.

Generic Writer: (setf max-length) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf max-length) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

max-length.

Generic Reader: parse-lock (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: parse-lock ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

parse-lock.

Generic Reader: parser (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: parser ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

parser.

Generic Writer: (setf parser) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf parser) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

parser.

Generic Reader: ping-callbacks (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: ping-callbacks ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

ping-callbacks.

Generic Writer: (setf ping-callbacks) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf ping-callbacks) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

ping-callbacks.

Generic Reader: queue (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: queue ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

queue.

Generic Writer: (setf queue) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf queue) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

queue.

Generic Reader: read-thread (object)
Package

websocket-driver.ws.client.

Methods
Reader Method: read-thread ((client client))

automatically generated reader method

Source

ws/client.lisp.

Target Slot

read-thread.

Generic Writer: (setf read-thread) (object)
Package

websocket-driver.ws.client.

Methods
Writer Method: (setf read-thread) ((client client))

automatically generated writer method

Source

ws/client.lisp.

Target Slot

read-thread.

Generic Reader: url (object)
Package

websocket-driver.ws.client.

Methods
Reader Method: url ((client client))

automatically generated reader method

Source

ws/client.lisp.

Target Slot

url.

Generic Writer: (setf url) (object)
Package

websocket-driver.ws.client.

Methods
Writer Method: (setf url) ((client client))

automatically generated writer method

Source

ws/client.lisp.

Target Slot

url.

Generic Reader: ws-parse (object)
Package

websocket-driver.ws.base.

Methods
Reader Method: ws-parse ((ws ws))

automatically generated reader method

Source

ws/base.lisp.

Target Slot

ws-parse.

Generic Writer: (setf ws-parse) (object)
Package

websocket-driver.ws.base.

Methods
Writer Method: (setf ws-parse) ((ws ws))

automatically generated writer method

Source

ws/base.lisp.

Target Slot

ws-parse.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   E   F   G   H   I   K   M   O   P   Q   R   S   U   V   W  
Index Entry  Section

(
(setf accept): Private generic functions
(setf accept): Private generic functions
(setf accept-protocols): Public generic functions
(setf accept-protocols): Public generic functions
(setf additional-headers): Public generic functions
(setf additional-headers): Public generic functions
(setf headers): Private generic functions
(setf headers): Private generic functions
(setf max-length): Private generic functions
(setf max-length): Private generic functions
(setf parser): Private generic functions
(setf parser): Private generic functions
(setf ping-callbacks): Private generic functions
(setf ping-callbacks): Private generic functions
(setf protocol): Public generic functions
(setf protocol): Public generic functions
(setf queue): Private generic functions
(setf queue): Private generic functions
(setf read-thread): Private generic functions
(setf read-thread): Private generic functions
(setf ready-state): Public generic functions
(setf ready-state): Public generic functions
(setf require-masking): Public generic functions
(setf require-masking): Public generic functions
(setf require-masking): Public generic functions
(setf require-masking): Public generic functions
(setf socket): Public generic functions
(setf socket): Public generic functions
(setf url): Private generic functions
(setf url): Private generic functions
(setf version): Public generic functions
(setf version): Public generic functions
(setf ws-parse): Private generic functions
(setf ws-parse): Private generic functions

A
accept: Private generic functions
accept: Private generic functions
accept-protocols: Public generic functions
accept-protocols: Public generic functions
additional-headers: Public generic functions
additional-headers: Public generic functions

C
close-connection: Public generic functions
close-connection: Public generic functions
close-connection: Public generic functions
close-connection: Public generic functions

E
enqueue: Private ordinary functions

F
Function, enqueue: Private ordinary functions
Function, generate-accept: Public ordinary functions
Function, generate-key: Private ordinary functions
Function, make-client: Public ordinary functions
Function, make-server: Public ordinary functions
Function, read-until-crlf*2: Private ordinary functions
Function, read-websocket-frame: Public ordinary functions
Function, send-binary: Public ordinary functions
Function, send-close-frame: Private ordinary functions
Function, send-text: Public ordinary functions
Function, split-by-comma: Public ordinary functions
Function, websocket-p: Public ordinary functions

G
generate-accept: Public ordinary functions
generate-key: Private ordinary functions
Generic Function, (setf accept): Private generic functions
Generic Function, (setf accept-protocols): Public generic functions
Generic Function, (setf additional-headers): Public generic functions
Generic Function, (setf headers): Private generic functions
Generic Function, (setf max-length): Private generic functions
Generic Function, (setf parser): Private generic functions
Generic Function, (setf ping-callbacks): Private generic functions
Generic Function, (setf protocol): Public generic functions
Generic Function, (setf queue): Private generic functions
Generic Function, (setf read-thread): Private generic functions
Generic Function, (setf ready-state): Public generic functions
Generic Function, (setf require-masking): Public generic functions
Generic Function, (setf socket): Public generic functions
Generic Function, (setf url): Private generic functions
Generic Function, (setf version): Public generic functions
Generic Function, (setf ws-parse): Private generic functions
Generic Function, accept: Private generic functions
Generic Function, accept-protocols: Public generic functions
Generic Function, additional-headers: Public generic functions
Generic Function, close-connection: Public generic functions
Generic Function, headers: Private generic functions
Generic Function, key: Private generic functions
Generic Function, max-length: Private generic functions
Generic Function, open-connection: Public generic functions
Generic Function, parse: Public generic functions
Generic Function, parse-lock: Private generic functions
Generic Function, parser: Private generic functions
Generic Function, ping-callbacks: Private generic functions
Generic Function, protocol: Public generic functions
Generic Function, queue: Private generic functions
Generic Function, read-thread: Private generic functions
Generic Function, ready-state: Public generic functions
Generic Function, require-masking: Public generic functions
Generic Function, send: Public generic functions
Generic Function, send-handshake-request: Public generic functions
Generic Function, send-handshake-response: Public generic functions
Generic Function, send-ping: Public generic functions
Generic Function, socket: Public generic functions
Generic Function, start-connection: Public generic functions
Generic Function, url: Private generic functions
Generic Function, version: Public generic functions
Generic Function, ws-parse: Private generic functions

H
headers: Private generic functions
headers: Private generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

K
key: Private generic functions
key: Private generic functions

M
make-client: Public ordinary functions
make-server: Public ordinary functions
max-length: Private generic functions
max-length: Private generic functions
Method, (setf accept): Private generic functions
Method, (setf accept-protocols): Public generic functions
Method, (setf additional-headers): Public generic functions
Method, (setf headers): Private generic functions
Method, (setf max-length): Private generic functions
Method, (setf parser): Private generic functions
Method, (setf ping-callbacks): Private generic functions
Method, (setf protocol): Public generic functions
Method, (setf queue): Private generic functions
Method, (setf read-thread): Private generic functions
Method, (setf ready-state): Public generic functions
Method, (setf require-masking): Public generic functions
Method, (setf require-masking): Public generic functions
Method, (setf require-masking): Public generic functions
Method, (setf socket): Public generic functions
Method, (setf url): Private generic functions
Method, (setf version): Public generic functions
Method, (setf ws-parse): Private generic functions
Method, accept: Private generic functions
Method, accept-protocols: Public generic functions
Method, additional-headers: Public generic functions
Method, close-connection: Public generic functions
Method, close-connection: Public generic functions
Method, close-connection: Public generic functions
Method, headers: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, key: Private generic functions
Method, max-length: Private generic functions
Method, open-connection: Public generic functions
Method, parse: Public generic functions
Method, parse-lock: Private generic functions
Method, parser: Private generic functions
Method, ping-callbacks: Private generic functions
Method, protocol: Public generic functions
Method, queue: Private generic functions
Method, read-thread: Private generic functions
Method, ready-state: Public generic functions
Method, require-masking: Public generic functions
Method, require-masking: Public generic functions
Method, require-masking: Public generic functions
Method, send: Public generic functions
Method, send: Public generic functions
Method, send: Public generic functions
Method, send-handshake-request: Public generic functions
Method, send-handshake-response: Public generic functions
Method, send-ping: Public generic functions
Method, socket: Public generic functions
Method, start-connection: Public generic functions
Method, start-connection: Public generic functions
Method, url: Private generic functions
Method, version: Public generic functions
Method, ws-parse: Private generic functions

O
open-connection: Public generic functions
open-connection: Public generic functions

P
parse: Public generic functions
parse: Public generic functions
parse-lock: Private generic functions
parse-lock: Private generic functions
parser: Private generic functions
parser: Private generic functions
ping-callbacks: Private generic functions
ping-callbacks: Private generic functions
protocol: Public generic functions
protocol: Public generic functions

Q
queue: Private generic functions
queue: Private generic functions

R
read-thread: Private generic functions
read-thread: Private generic functions
read-until-crlf*2: Private ordinary functions
read-websocket-frame: Public ordinary functions
ready-state: Public generic functions
ready-state: Public generic functions
require-masking: Public generic functions
require-masking: Public generic functions
require-masking: Public generic functions
require-masking: Public generic functions

S
send: Public generic functions
send: Public generic functions
send: Public generic functions
send: Public generic functions
send-binary: Public ordinary functions
send-close-frame: Private ordinary functions
send-handshake-request: Public generic functions
send-handshake-request: Public generic functions
send-handshake-response: Public generic functions
send-handshake-response: Public generic functions
send-ping: Public generic functions
send-ping: Public generic functions
send-text: Public ordinary functions
socket: Public generic functions
socket: Public generic functions
split-by-comma: Public ordinary functions
start-connection: Public generic functions
start-connection: Public generic functions
start-connection: Public generic functions

U
url: Private generic functions
url: Private generic functions

V
version: Public generic functions
version: Public generic functions

W
websocket-p: Public ordinary functions
ws-parse: Private generic functions
ws-parse: Private generic functions

Jump to:   (  
A   C   E   F   G   H   I   K   M   O   P   Q   R   S   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
A   H   K   M   P   Q   R   S   U   V   W  
Index Entry  Section

+
+guid+: Private special variables
+states+: Private special variables

A
accept: Public classes
accept-protocols: Public classes
additional-headers: Public classes

H
headers: Public classes

K
key: Public classes

M
max-length: Public classes

P
parse-lock: Public classes
parser: Public classes
ping-callbacks: Public classes
protocol: Public classes

Q
queue: Public classes

R
read-thread: Public classes
ready-state: Public classes
require-masking: Public classes
require-masking: Public classes
require-masking: Public classes

S
Slot, accept: Public classes
Slot, accept-protocols: Public classes
Slot, additional-headers: Public classes
Slot, headers: Public classes
Slot, key: Public classes
Slot, max-length: Public classes
Slot, parse-lock: Public classes
Slot, parser: Public classes
Slot, ping-callbacks: Public classes
Slot, protocol: Public classes
Slot, queue: Public classes
Slot, read-thread: Public classes
Slot, ready-state: Public classes
Slot, require-masking: Public classes
Slot, require-masking: Public classes
Slot, require-masking: Public classes
Slot, socket: Public classes
Slot, url: Public classes
Slot, version: Public classes
Slot, version: Public classes
Slot, ws-parse: Public classes
socket: Public classes
Special Variable, +guid+: Private special variables
Special Variable, +states+: Private special variables

U
url: Public classes

V
version: Public classes
version: Public classes

W
ws-parse: Public classes

Jump to:   +  
A   H   K   M   P   Q   R   S   U   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   F   M   P   S   U   W  
Index Entry  Section

C
Class, client: Public classes
Class, server: Public classes
Class, ws: Public classes
client: Public classes
client.lisp: The websocket-driver-client/src/client․lisp file

D
driver.lisp: The websocket-driver-base/src/driver․lisp file

F
File, client.lisp: The websocket-driver-client/src/client․lisp file
File, driver.lisp: The websocket-driver-base/src/driver․lisp file
File, server.lisp: The websocket-driver-server/src/server․lisp file
File, util.lisp: The websocket-driver-base/src/util․lisp file
File, websocket-driver-base.asd: The websocket-driver-base/websocket-driver-base․asd file
File, websocket-driver-client.asd: The websocket-driver-client/websocket-driver-client․asd file
File, websocket-driver-server.asd: The websocket-driver-server/websocket-driver-server․asd file
File, websocket-driver.asd: The websocket-driver/websocket-driver․asd file
File, ws/base.lisp: The websocket-driver-base/src/ws/base․lisp file
File, ws/client.lisp: The websocket-driver-client/src/ws/client․lisp file
File, ws/server.lisp: The websocket-driver-server/src/ws/server․lisp file

M
Module, src: The websocket-driver-server/src module
Module, src: The websocket-driver-base/src module
Module, src: The websocket-driver-client/src module

P
Package, websocket-driver: The websocket-driver package
Package, websocket-driver-asd: The websocket-driver-asd package
Package, websocket-driver-base-asd: The websocket-driver-base-asd package
Package, websocket-driver-client: The websocket-driver-client package
Package, websocket-driver-client-asd: The websocket-driver-client-asd package
Package, websocket-driver-server-asd: The websocket-driver-server-asd package
Package, websocket-driver.server: The websocket-driver․server package
Package, websocket-driver.util: The websocket-driver․util package
Package, websocket-driver.ws.base: The websocket-driver․ws․base package
Package, websocket-driver.ws.client: The websocket-driver․ws․client package
Package, websocket-driver.ws.server: The websocket-driver․ws․server package

S
server: Public classes
server.lisp: The websocket-driver-server/src/server․lisp file
src: The websocket-driver-server/src module
src: The websocket-driver-base/src module
src: The websocket-driver-client/src module
System, websocket-driver: The websocket-driver system
System, websocket-driver-base: The websocket-driver-base system
System, websocket-driver-client: The websocket-driver-client system
System, websocket-driver-server: The websocket-driver-server system

U
util.lisp: The websocket-driver-base/src/util․lisp file

W
websocket-driver: The websocket-driver system
websocket-driver: The websocket-driver package
websocket-driver-asd: The websocket-driver-asd package
websocket-driver-base: The websocket-driver-base system
websocket-driver-base-asd: The websocket-driver-base-asd package
websocket-driver-base.asd: The websocket-driver-base/websocket-driver-base․asd file
websocket-driver-client: The websocket-driver-client system
websocket-driver-client: The websocket-driver-client package
websocket-driver-client-asd: The websocket-driver-client-asd package
websocket-driver-client.asd: The websocket-driver-client/websocket-driver-client․asd file
websocket-driver-server: The websocket-driver-server system
websocket-driver-server-asd: The websocket-driver-server-asd package
websocket-driver-server.asd: The websocket-driver-server/websocket-driver-server․asd file
websocket-driver.asd: The websocket-driver/websocket-driver․asd file
websocket-driver.server: The websocket-driver․server package
websocket-driver.util: The websocket-driver․util package
websocket-driver.ws.base: The websocket-driver․ws․base package
websocket-driver.ws.client: The websocket-driver․ws․client package
websocket-driver.ws.server: The websocket-driver․ws․server package
ws: Public classes
ws/base.lisp: The websocket-driver-base/src/ws/base․lisp file
ws/client.lisp: The websocket-driver-client/src/ws/client․lisp file
ws/server.lisp: The websocket-driver-server/src/ws/server․lisp file

Jump to:   C   D   F   M   P   S   U   W