The websocket-driver Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 12:45:30 2018 GMT+0.


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

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


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

2 Systems

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


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

2.1 websocket-driver

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies
Source

websocket-driver.asd (file)


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

2.2 websocket-driver-server

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies
Source

websocket-driver-server.asd (file)

Component

src (module)


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

2.3 websocket-driver-client

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.2.0

Dependencies
Source

websocket-driver-client.asd (file)

Component

src (module)


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

2.4 websocket-driver-base

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

WebSocket protocol handler

Version

0.2.0

Dependencies
Source

websocket-driver-base.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 websocket-driver-server/src

Parent

websocket-driver-server (system)

Location

src/

Components

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

3.2 websocket-driver-client/src

Parent

websocket-driver-client (system)

Location

src/

Components

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

3.3 websocket-driver-base/src

Parent

websocket-driver-base (system)

Location

src/

Components

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 websocket-driver.asd

Location

websocket-driver.asd

Systems

websocket-driver (system)

Packages

websocket-driver-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 websocket-driver-server.asd

Location

websocket-driver-server.asd

Systems

websocket-driver-server (system)

Packages

websocket-driver-server-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 websocket-driver-client.asd

Location

websocket-driver-client.asd

Systems

websocket-driver-client (system)

Packages

websocket-driver-client-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 websocket-driver-base.asd

Location

websocket-driver-base.asd

Systems

websocket-driver-base (system)

Packages

websocket-driver-base-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/util.lisp

Packages

websocket-driver.util

Exported Definitions
Internal Definitions

+guid+ (special variable)


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

5 Packages

Packages are listed by definition order.


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

5.1 websocket-driver-asd

Source

websocket-driver.asd

Use List

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

5.2 websocket-driver-server-asd

Source

websocket-driver-server.asd

Use List

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

5.3 websocket-driver.server

Source

server.lisp (file)

Use List

common-lisp

Exported Definitions

make-server (function)


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

5.4 websocket-driver.ws.server

Source

ws/server.lisp (file)

Use List
Exported Definitions

server (class)

Internal Definitions

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

5.5 websocket-driver-client-asd

Source

websocket-driver-client.asd

Use List

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

5.6 websocket-driver.ws.client

Source

ws/client.lisp (file)

Use List
Exported Definitions

client (class)

Internal Definitions

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

5.7 websocket-driver-client

Source

client.lisp (file)

Use List

common-lisp

Exported Definitions

make-client (function)


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

5.8 websocket-driver-base-asd

Source

websocket-driver-base.asd

Use List

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

5.9 websocket-driver

Source

driver.lisp (file)

Nickname

wsd

Use List

common-lisp

Exported Definitions

websocket-p (function)


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

5.10 websocket-driver.ws.base

Source

ws/base.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions
Internal Definitions

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

5.11 websocket-driver.util

Source

util.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions
Internal Definitions

+guid+ (special variable)


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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 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 &allow-other-keys
Package

websocket-driver.ws.base

Source

ws/base.lisp (file)

Methods
Method: start-connection (CLIENT client) &key VERIFY
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)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: client ()
Package

websocket-driver.ws.client

Source

ws/client.lisp (file)

Direct superclasses

ws (class)

Direct methods
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
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
Direct methods
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)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   W  
Index Entry  Section

F
File, Lisp, websocket-driver-base.asd: The websocket-driver-base<dot>asd file
File, Lisp, websocket-driver-base/src/driver.lisp: The websocket-driver-base/src/driver<dot>lisp file
File, Lisp, websocket-driver-base/src/util.lisp: The websocket-driver-base/src/util<dot>lisp file
File, Lisp, websocket-driver-base/src/ws/base.lisp: The websocket-driver-base/src/ws/base<dot>lisp file
File, Lisp, websocket-driver-client.asd: The websocket-driver-client<dot>asd file
File, Lisp, websocket-driver-client/src/client.lisp: The websocket-driver-client/src/client<dot>lisp file
File, Lisp, websocket-driver-client/src/ws/client.lisp: The websocket-driver-client/src/ws/client<dot>lisp file
File, Lisp, websocket-driver-server.asd: The websocket-driver-server<dot>asd file
File, Lisp, websocket-driver-server/src/server.lisp: The websocket-driver-server/src/server<dot>lisp file
File, Lisp, websocket-driver-server/src/ws/server.lisp: The websocket-driver-server/src/ws/server<dot>lisp file
File, Lisp, websocket-driver.asd: The websocket-driver<dot>asd file

L
Lisp File, websocket-driver-base.asd: The websocket-driver-base<dot>asd file
Lisp File, websocket-driver-base/src/driver.lisp: The websocket-driver-base/src/driver<dot>lisp file
Lisp File, websocket-driver-base/src/util.lisp: The websocket-driver-base/src/util<dot>lisp file
Lisp File, websocket-driver-base/src/ws/base.lisp: The websocket-driver-base/src/ws/base<dot>lisp file
Lisp File, websocket-driver-client.asd: The websocket-driver-client<dot>asd file
Lisp File, websocket-driver-client/src/client.lisp: The websocket-driver-client/src/client<dot>lisp file
Lisp File, websocket-driver-client/src/ws/client.lisp: The websocket-driver-client/src/ws/client<dot>lisp file
Lisp File, websocket-driver-server.asd: The websocket-driver-server<dot>asd file
Lisp File, websocket-driver-server/src/server.lisp: The websocket-driver-server/src/server<dot>lisp file
Lisp File, websocket-driver-server/src/ws/server.lisp: The websocket-driver-server/src/ws/server<dot>lisp file
Lisp File, websocket-driver.asd: The websocket-driver<dot>asd file

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

W
websocket-driver-base.asd: The websocket-driver-base<dot>asd file
websocket-driver-base/src: The websocket-driver-base/src module
websocket-driver-base/src/driver.lisp: The websocket-driver-base/src/driver<dot>lisp file
websocket-driver-base/src/util.lisp: The websocket-driver-base/src/util<dot>lisp file
websocket-driver-base/src/ws/base.lisp: The websocket-driver-base/src/ws/base<dot>lisp file
websocket-driver-client.asd: The websocket-driver-client<dot>asd file
websocket-driver-client/src: The websocket-driver-client/src module
websocket-driver-client/src/client.lisp: The websocket-driver-client/src/client<dot>lisp file
websocket-driver-client/src/ws/client.lisp: The websocket-driver-client/src/ws/client<dot>lisp file
websocket-driver-server.asd: The websocket-driver-server<dot>asd file
websocket-driver-server/src: The websocket-driver-server/src module
websocket-driver-server/src/server.lisp: The websocket-driver-server/src/server<dot>lisp file
websocket-driver-server/src/ws/server.lisp: The websocket-driver-server/src/ws/server<dot>lisp file
websocket-driver.asd: The websocket-driver<dot>asd file

Jump to:   F   L   M   W  

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

A.2 Functions

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

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

A
accept: Internal generic functions
accept: Internal generic functions
accept-protocols: Exported generic functions
accept-protocols: Exported generic functions
additional-headers: Exported generic functions
additional-headers: Exported generic functions

C
close-connection: Exported generic functions
close-connection: Exported generic functions
close-connection: Exported generic functions
close-connection: Exported generic functions

E
enqueue: Internal functions

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

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

H
headers: Internal generic functions
headers: Internal generic functions

K
key: Internal generic functions
key: Internal generic functions

M
make-client: Exported functions
make-server: Exported functions
max-length: Internal generic functions
max-length: Internal generic functions
Method, (setf accept): Internal generic functions
Method, (setf accept-protocols): Exported generic functions
Method, (setf additional-headers): Exported generic functions
Method, (setf headers): Internal generic functions
Method, (setf max-length): Internal generic functions
Method, (setf parser): Internal generic functions
Method, (setf ping-callbacks): Internal generic functions
Method, (setf protocol): Exported generic functions
Method, (setf queue): Internal generic functions
Method, (setf ready-state): Exported generic functions
Method, (setf require-masking): Exported generic functions
Method, (setf require-masking): Exported generic functions
Method, (setf require-masking): Exported generic functions
Method, (setf socket): Exported generic functions
Method, (setf url): Internal generic functions
Method, (setf version): Exported generic functions
Method, (setf ws-parse): Internal generic functions
Method, accept: Internal generic functions
Method, accept-protocols: Exported generic functions
Method, additional-headers: Exported generic functions
Method, close-connection: Exported generic functions
Method, close-connection: Exported generic functions
Method, close-connection: Exported generic functions
Method, headers: Internal generic functions
Method, key: Internal generic functions
Method, max-length: Internal generic functions
Method, open-connection: Exported generic functions
Method, parse: Exported generic functions
Method, parse-lock: Internal generic functions
Method, parser: Internal generic functions
Method, ping-callbacks: Internal generic functions
Method, protocol: Exported generic functions
Method, queue: Internal generic functions
Method, ready-state: Exported generic functions
Method, require-masking: Exported generic functions
Method, require-masking: Exported generic functions
Method, require-masking: Exported generic functions
Method, send: Exported generic functions
Method, send: Exported generic functions
Method, send: Exported generic functions
Method, send-handshake-request: Exported generic functions
Method, send-handshake-response: Exported generic functions
Method, send-ping: Exported generic functions
Method, socket: Exported generic functions
Method, start-connection: Exported generic functions
Method, start-connection: Exported generic functions
Method, url: Internal generic functions
Method, version: Exported generic functions
Method, ws-parse: Internal generic functions

O
open-connection: Exported generic functions
open-connection: Exported generic functions

P
parse: Exported generic functions
parse: Exported generic functions
parse-lock: Internal generic functions
parse-lock: Internal generic functions
parser: Internal generic functions
parser: Internal generic functions
ping-callbacks: Internal generic functions
ping-callbacks: Internal generic functions
protocol: Exported generic functions
protocol: Exported generic functions

Q
queue: Internal generic functions
queue: Internal generic functions

R
read-until-crlf*2: Internal functions
read-websocket-frame: Exported functions
ready-state: Exported generic functions
ready-state: Exported generic functions
require-masking: Exported generic functions
require-masking: Exported generic functions
require-masking: Exported generic functions
require-masking: Exported generic functions

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

U
url: Internal generic functions
url: Internal generic functions

V
version: Exported generic functions
version: Exported generic functions

W
websocket-p: Exported functions
ws-parse: Internal generic functions
ws-parse: Internal generic functions

Jump to:   (  
A   C   E   F   G   H   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+: Internal special variables
+states+: Internal special variables

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

H
headers: Exported classes

K
key: Exported classes

M
max-length: Exported classes

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

Q
queue: Exported classes

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

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

U
url: Exported classes

V
version: Exported classes
version: Exported classes

W
ws-parse: Exported 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   P   S   W  
Index Entry  Section

C
Class, client: Exported classes
Class, server: Exported classes
Class, ws: Exported classes
client: Exported classes

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<dot>server package
Package, websocket-driver.util: The websocket-driver<dot>util package
Package, websocket-driver.ws.base: The websocket-driver<dot>ws<dot>base package
Package, websocket-driver.ws.client: The websocket-driver<dot>ws<dot>client package
Package, websocket-driver.ws.server: The websocket-driver<dot>ws<dot>server package

S
server: Exported classes
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

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-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-server: The websocket-driver-server system
websocket-driver-server-asd: The websocket-driver-server-asd package
websocket-driver.server: The websocket-driver<dot>server package
websocket-driver.util: The websocket-driver<dot>util package
websocket-driver.ws.base: The websocket-driver<dot>ws<dot>base package
websocket-driver.ws.client: The websocket-driver<dot>ws<dot>client package
websocket-driver.ws.server: The websocket-driver<dot>ws<dot>server package
ws: Exported classes

Jump to:   C   P   S   W