The fast-websocket Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The fast-websocket Reference Manual

This is the fast-websocket Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 11:47:07 2020 GMT+0.

• Introduction  What fast-websocket is all about
• Systems  The systems documentation
• Modules  The modules documentation
• Files  The files documentation
• Packages  The packages documentation
• Definitions  The symbols documentation
• Indexes  Concepts, functions, variables and data types

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

1 Introduction

fast-websocket

Build Status Coverage Status Quicklisp dist

Optimized low-level WebSocket protocol parser/composer.

Warning

This software is still BETA quality. The APIs will be likely to change.

Usage

(use-package :fast-websocket)

(let* ((ws (make-ws))
       (body (make-string-output-stream))
       (parser (make-parser ws
                            :require-masking t
                            :message-callback
                            (lambda (message)
                              (princ message body))
                            :close-callback
                            (lambda (payload &key code)
                              (format t "Client closed a connection: ~A (Code: ~D)~%" payload code)))))
  (funcall parser (make-array 11 :element-type '(unsigned-byte 8)
                              :initial-contents (list 129 133 225 106 10 29 169 15 102 113 142)))

  (princ (opcode-name (ws-opcode ws)))
  ;-> :TEXT

  (princ (get-output-stream-string body))
  ;-> Hello

  t)

(compose-frame "bye" :type :close :code (error-code :protocol-error))
;=> #(136 5 3 234 98 121 101)

Installation

cd ~/common-lisp
git clone https://github.com/fukamachi/fast-websocket

(ql:quickload :fast-websocket)

See Also

Author

Copyright

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

License

Licensed under the BSD 2-Clause License.

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

2 Systems

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

• The fast-websocket system  

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

2.1 fast-websocket

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

Optimized WebSocket protocol parser

Long Description

# fast-websocket

[![Build Status](https://travis-ci.org/fukamachi/fast-websocket.svg?branch=master)](https://travis-ci.org/fukamachi/fast-websocket) [![Coverage Status](https://coveralls.io/repos/fukamachi/fast-websocket/badge.svg?branch=master)](https://coveralls.io/r/fukamachi/fast-websocket) [![Quicklisp dist](http://quickdocs.org/badge/fast-websocket.svg)](http://quickdocs.org/fast-websocket/)

Optimized low-level WebSocket protocol parser/composer.

## Warning

This software is still BETA quality. The APIs will be likely to change.

## Usage

“‘common-lisp
(use-package :fast-websocket)

(let* ((ws (make-ws))
(body (make-string-output-stream))
(parser (make-parser ws
:require-masking t
:message-callback
(lambda (message)
(princ message body))
:close-callback
(lambda (payload &key code)
(format t "Client closed a connection: ~A (Code: ~D)~%" payload code)))))
(funcall parser (make-array 11 :element-type ’(unsigned-byte 8)
:initial-contents (list 129 133 225 106 10 29 169 15 102 113 142)))

(princ (opcode-name (ws-opcode ws)))
;-> :TEXT

(princ (get-output-stream-string body))
;-> Hello

t)

(compose-frame "bye" :type :close :code (error-code :protocol-error))
;=> #(136 5 3 234 98 121 101)
“‘

## Installation

“‘
cd ~/common-lisp
git clone https://github.com/fukamachi/fast-websocket
“‘

“‘
(ql:quickload :fast-websocket)
“‘

## See Also

* [RFC 6455](https://tools.ietf.org/html/rfc6455)
* [websocket-driver](https://github.com/fukamachi/websocket-driver)

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

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

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
Source

fast-websocket.asd (file)

Component

src (module)

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

3 Modules

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

• The fast-websocket/src module  

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

3.1 fast-websocket/src

Parent

fast-websocket (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.

• Lisp files  

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

4.1 Lisp

• The fast-websocket.asd file  
• The fast-websocket/src/fast-websocket.lisp file  
• The fast-websocket/src/ws.lisp file  
• The fast-websocket/src/parser.lisp file  
• The fast-websocket/src/compose.lisp file  
• The fast-websocket/src/payload.lisp file  
• The fast-websocket/src/constants.lisp file  
• The fast-websocket/src/error.lisp file  

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

4.1.1 fast-websocket.asd

Location

fast-websocket.asd

Systems

fast-websocket (system)

Packages

fast-websocket-asd

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

4.1.2 fast-websocket/src/fast-websocket.lisp

Dependencies
Parent

src (module)

Location

src/fast-websocket.lisp

Packages

fast-websocket

Exported Definitions

make-parser (function)

Internal Definitions

make-payload-callback (function)

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

4.1.3 fast-websocket/src/ws.lisp

Parent

src (module)

Location

src/ws.lisp

Packages

fast-websocket.ws

Exported Definitions
Internal Definitions

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

4.1.4 fast-websocket/src/parser.lisp

Dependencies
Parent

src (module)

Location

src/parser.lisp

Packages

fast-websocket.parser

Exported Definitions

make-ll-parser (function)

Internal Definitions

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

4.1.5 fast-websocket/src/compose.lisp

Dependencies
Parent

src (module)

Location

src/compose.lisp

Packages

fast-websocket.compose

Exported Definitions

compose-frame (function)

Internal Definitions

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

4.1.6 fast-websocket/src/payload.lisp

Parent

src (module)

Location

src/payload.lisp

Packages

fast-websocket.payload

Exported Definitions
Internal Definitions

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

4.1.7 fast-websocket/src/constants.lisp

Parent

src (module)

Location

src/constants.lisp

Packages

fast-websocket.constants

Exported Definitions
Internal Definitions

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

4.1.8 fast-websocket/src/error.lisp

Parent

src (module)

Location

src/error.lisp

Packages

fast-websocket.error

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.

• The fast-websocket-asd package  
• The fast-websocket package  
• The fast-websocket.ws package  
• The fast-websocket.parser package  
• The fast-websocket.compose package  
• The fast-websocket.payload package  
• The fast-websocket.constants package  
• The fast-websocket.error package  

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

5.1 fast-websocket-asd

Source

fast-websocket.asd

Use List

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

5.2 fast-websocket

Source

fast-websocket.lisp (file)

Use List
Exported Definitions

make-parser (function)

Internal Definitions

make-payload-callback (function)

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

5.3 fast-websocket.ws

Source

ws.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions
Internal Definitions

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

5.4 fast-websocket.parser

Source

parser.lisp (file)

Use List
Exported Definitions

make-ll-parser (function)

Internal Definitions

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

5.5 fast-websocket.compose

Source

compose.lisp (file)

Use List
Exported Definitions

compose-frame (function)

Internal Definitions

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

5.6 fast-websocket.payload

Source

payload.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.7 fast-websocket.constants

Source

constants.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions
Internal Definitions

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

5.8 fast-websocket.error

Source

error.lisp (file)

Use List

common-lisp

Used By List

fast-websocket.parser

Exported Definitions
Internal Definitions

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

6 Definitions

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

• Exported definitions  
• Internal definitions  

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

6.1 Exported definitions

• Exported constants  
• Exported functions  
• Exported conditions  
• Exported structures  

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

6.1.1 Constants

Constant: +byte+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +fin+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +length+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +mask+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +opcode+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +rsv1+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +rsv2+
Package

fast-websocket.constants

Source

constants.lisp (file)

Constant: +rsv3+
Package

fast-websocket.constants

Source

constants.lisp (file)

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

6.1.2 Functions

Function: acceptable-error-code-p CODE
Package

fast-websocket.error

Source

error.lisp (file)

Function: compose-frame DATA &key START END TYPE CODE MASKING
Package

fast-websocket.compose

Source

compose.lisp (file)

Function: error-code ERROR
Package

fast-websocket.error

Source

error.lisp (file)

Function: error-code-name CODE
Package

fast-websocket.error

Source

error.lisp (file)

Function: fast-write-masked-sequence DATA OUTPUT-BUFFER MASK-KEYS &optional START END
Package

fast-websocket.payload

Source

payload.lisp (file)

Function: fragmented-opcode-p OPCODE
Package

fast-websocket.constants

Source

constants.lisp (file)

Function: make-ll-parser WS &key REQUIRE-MASKING MAX-LENGTH PAYLOAD-CALLBACK
Package

fast-websocket.parser

Source

parser.lisp (file)

Function: make-parser WS &key REQUIRE-MASKING MAX-LENGTH MESSAGE-CALLBACK PING-CALLBACK PONG-CALLBACK CLOSE-CALLBACK ERROR-CALLBACK
Package

fast-websocket

Source

fast-websocket.lisp (file)

Function: make-ws &key (FIN FIN) (OPCODE OPCODE) (MASK MASK) (MASKING-KEY MASKING-KEY) (LENGTH LENGTH) (LENGTH-SIZE LENGTH-SIZE) (MODE MODE) (STAGE STAGE)
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: mask-message DATA MASK-KEYS
Package

fast-websocket.payload

Source

payload.lisp (file)

Function: opcode NAME
Package

fast-websocket.constants

Source

constants.lisp (file)

Function: opcode-name OPCODE
Package

fast-websocket.constants

Source

constants.lisp (file)

Function: opening-opcode-p OPCODE
Package

fast-websocket.constants

Source

constants.lisp (file)

Function: valid-error-code-p CODE
Package

fast-websocket.error

Source

error.lisp (file)

Function: valid-opcode-p OPCODE
Package

fast-websocket.constants

Source

constants.lisp (file)

Function: ws-fin INSTANCE
Function: (setf ws-fin) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-length INSTANCE
Function: (setf ws-length) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-length-size INSTANCE
Function: (setf ws-length-size) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-mask INSTANCE
Function: (setf ws-mask) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-masking-key INSTANCE
Function: (setf ws-masking-key) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-mode INSTANCE
Function: (setf ws-mode) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-opcode INSTANCE
Function: (setf ws-opcode) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: ws-stage INSTANCE
Function: (setf ws-stage) VALUE INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

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

6.1.3 Conditions

Condition: encoding-error ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses

protocol-error (condition)

Condition: protocol-error ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses
Direct subclasses
Condition: too-large ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses

protocol-error (condition)

Direct slots
Slot: length
Initargs

:length

Slot: max-length
Initargs

:max-length

Condition: unacceptable ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses

protocol-error (condition)

Direct slots
Slot: require-masking
Initargs

:require-masking

Condition: websocket-error ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

websocket-parse-error (condition)

Condition: websocket-parse-error ()
Package

fast-websocket.error

Source

error.lisp (file)

Direct superclasses

websocket-error (condition)

Direct subclasses

protocol-error (condition)

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

6.1.4 Structures

Structure: ws ()
Package

fast-websocket.ws

Source

ws.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: fin
Type

boolean

Readers

ws-fin (function)

Writers

(setf ws-fin) (function)

Slot: opcode
Type

fixnum

Initform

-1

Readers

ws-opcode (function)

Writers

(setf ws-opcode) (function)

Slot: mask
Type

boolean

Readers

ws-mask (function)

Writers

(setf ws-mask) (function)

Slot: masking-key
Type

(simple-array (unsigned-byte 8) (4))

Initform

(make-array 4 :element-type (quote (unsigned-byte 8)))

Readers

ws-masking-key (function)

Writers

(setf ws-masking-key) (function)

Slot: length
Type

integer

Initform

0

Readers

ws-length (function)

Writers

(setf ws-length) (function)

Slot: length-size
Type

fixnum

Initform

0

Readers

ws-length-size (function)

Writers

(setf ws-length-size) (function)

Slot: mode
Type

symbol

Readers

ws-mode (function)

Writers

(setf ws-mode) (function)

Slot: stage
Type

fixnum

Initform

0

Readers

ws-stage (function)

Writers

(setf ws-stage) (function)

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

6.2 Internal definitions

• Internal constants  
• Internal special variables  
• Internal macros  
• Internal functions  
• Internal types  

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

6.2.1 Constants

Constant: +max-reserved-error+
Package

fast-websocket.error

Source

error.lisp (file)

Constant: +min-reserved-error+
Package

fast-websocket.error

Source

error.lisp (file)

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

6.2.2 Special variables

Special Variable: *error-codes*
Package

fast-websocket.error

Source

error.lisp (file)

Special Variable: *error-codes-map*
Package

fast-websocket.error

Source

error.lisp (file)

Special Variable: *error-codes-name-map*
Package

fast-websocket.error

Source

error.lisp (file)

Special Variable: *fragmented-opcodes*
Package

fast-websocket.constants

Source

constants.lisp (file)

Special Variable: *mask-key-indices*
Package

fast-websocket.payload

Source

payload.lisp (file)

Special Variable: *mask-random-state*
Package

fast-websocket.compose

Source

compose.lisp (file)

Special Variable: *opcode-valid-array*
Package

fast-websocket.constants

Source

constants.lisp (file)

Special Variable: *opcodes-map*
Package

fast-websocket.constants

Source

constants.lisp (file)

Special Variable: *opcodes-name-map*
Package

fast-websocket.constants

Source

constants.lisp (file)

Special Variable: *opening-opcodes*
Package

fast-websocket.constants

Source

constants.lisp (file)

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

6.2.3 Macros

Macro: with-masking (BYTE DATA &key START END MASK-KEYS I) &body BODY
Package

fast-websocket.payload

Source

payload.lisp (file)

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

6.2.4 Functions

Function: copy-ws INSTANCE
Package

fast-websocket.ws

Source

ws.lisp (file)

Function: make-payload-callback WS MESSAGE-CALLBACK PING-CALLBACK PONG-CALLBACK CLOSE-CALLBACK
Package

fast-websocket

Source

fast-websocket.lisp (file)

Function: mask-byte BYTE MASK-KEY
Package

fast-websocket.payload

Source

payload.lisp (file)

Function: random-mask-keys ()
Package

fast-websocket.compose

Source

compose.lisp (file)

Function: ws-p OBJECT
Package

fast-websocket.ws

Source

ws.lisp (file)

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

6.2.5 Types

Type: octet ()
Package

fast-websocket.parser

Source

parser.lisp (file)

Type: octets ()
Package

fast-websocket.parser

Source

parser.lisp (file)

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

Appendix A Indexes

• Concept index  
• Function index  
• Variable index  
• Data type index  

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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section
F
fast-websocket.asd: The fast-websocket․asd file
fast-websocket/src: The fast-websocket/src module
fast-websocket/src/compose.lisp: The fast-websocket/src/compose․lisp file
fast-websocket/src/constants.lisp: The fast-websocket/src/constants․lisp file
fast-websocket/src/error.lisp: The fast-websocket/src/error․lisp file
fast-websocket/src/fast-websocket.lisp: The fast-websocket/src/fast-websocket․lisp file
fast-websocket/src/parser.lisp: The fast-websocket/src/parser․lisp file
fast-websocket/src/payload.lisp: The fast-websocket/src/payload․lisp file
fast-websocket/src/ws.lisp: The fast-websocket/src/ws․lisp file
File, Lisp, fast-websocket.asd: The fast-websocket․asd file
File, Lisp, fast-websocket/src/compose.lisp: The fast-websocket/src/compose․lisp file
File, Lisp, fast-websocket/src/constants.lisp: The fast-websocket/src/constants․lisp file
File, Lisp, fast-websocket/src/error.lisp: The fast-websocket/src/error․lisp file
File, Lisp, fast-websocket/src/fast-websocket.lisp: The fast-websocket/src/fast-websocket․lisp file
File, Lisp, fast-websocket/src/parser.lisp: The fast-websocket/src/parser․lisp file
File, Lisp, fast-websocket/src/payload.lisp: The fast-websocket/src/payload․lisp file
File, Lisp, fast-websocket/src/ws.lisp: The fast-websocket/src/ws․lisp file
L
Lisp File, fast-websocket.asd: The fast-websocket․asd file
Lisp File, fast-websocket/src/compose.lisp: The fast-websocket/src/compose․lisp file
Lisp File, fast-websocket/src/constants.lisp: The fast-websocket/src/constants․lisp file
Lisp File, fast-websocket/src/error.lisp: The fast-websocket/src/error․lisp file
Lisp File, fast-websocket/src/fast-websocket.lisp: The fast-websocket/src/fast-websocket․lisp file
Lisp File, fast-websocket/src/parser.lisp: The fast-websocket/src/parser․lisp file
Lisp File, fast-websocket/src/payload.lisp: The fast-websocket/src/payload․lisp file
Lisp File, fast-websocket/src/ws.lisp: The fast-websocket/src/ws․lisp file
M
Module, fast-websocket/src: The fast-websocket/src module
Jump to:   F   L   M  

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

A.2 Functions

Jump to:   (  
A   C   E   F   M   O   R   V   W  
Index Entry  Section
(
(setf ws-fin): Exported functions
(setf ws-length): Exported functions
(setf ws-length-size): Exported functions
(setf ws-mask): Exported functions
(setf ws-masking-key): Exported functions
(setf ws-mode): Exported functions
(setf ws-opcode): Exported functions
(setf ws-stage): Exported functions
A
acceptable-error-code-p: Exported functions
C
compose-frame: Exported functions
copy-ws: Internal functions
E
error-code: Exported functions
error-code-name: Exported functions
F
fast-write-masked-sequence: Exported functions
fragmented-opcode-p: Exported functions
Function, (setf ws-fin): Exported functions
Function, (setf ws-length): Exported functions
Function, (setf ws-length-size): Exported functions
Function, (setf ws-mask): Exported functions
Function, (setf ws-masking-key): Exported functions
Function, (setf ws-mode): Exported functions
Function, (setf ws-opcode): Exported functions
Function, (setf ws-stage): Exported functions
Function, acceptable-error-code-p: Exported functions
Function, compose-frame: Exported functions
Function, copy-ws: Internal functions
Function, error-code: Exported functions
Function, error-code-name: Exported functions
Function, fast-write-masked-sequence: Exported functions
Function, fragmented-opcode-p: Exported functions
Function, make-ll-parser: Exported functions
Function, make-parser: Exported functions
Function, make-payload-callback: Internal functions
Function, make-ws: Exported functions
Function, mask-byte: Internal functions
Function, mask-message: Exported functions
Function, opcode: Exported functions
Function, opcode-name: Exported functions
Function, opening-opcode-p: Exported functions
Function, random-mask-keys: Internal functions
Function, valid-error-code-p: Exported functions
Function, valid-opcode-p: Exported functions
Function, ws-fin: Exported functions
Function, ws-length: Exported functions
Function, ws-length-size: Exported functions
Function, ws-mask: Exported functions
Function, ws-masking-key: Exported functions
Function, ws-mode: Exported functions
Function, ws-opcode: Exported functions
Function, ws-p: Internal functions
Function, ws-stage: Exported functions
M
Macro, with-masking: Internal macros
make-ll-parser: Exported functions
make-parser: Exported functions
make-payload-callback: Internal functions
make-ws: Exported functions
mask-byte: Internal functions
mask-message: Exported functions
O
opcode: Exported functions
opcode-name: Exported functions
opening-opcode-p: Exported functions
R
random-mask-keys: Internal functions
V
valid-error-code-p: Exported functions
valid-opcode-p: Exported functions
W
with-masking: Internal macros
ws-fin: Exported functions
ws-length: Exported functions
ws-length-size: Exported functions
ws-mask: Exported functions
ws-masking-key: Exported functions
ws-mode: Exported functions
ws-opcode: Exported functions
ws-p: Internal functions
ws-stage: Exported functions
Jump to:   (  
A   C   E   F   M   O   R   V   W  

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

A.3 Variables

Jump to:   *   +  
C   F   L   M   O   R   S  
Index Entry  Section
*
*error-codes*: Internal special variables
*error-codes-map*: Internal special variables
*error-codes-name-map*: Internal special variables
*fragmented-opcodes*: Internal special variables
*mask-key-indices*: Internal special variables
*mask-random-state*: Internal special variables
*opcode-valid-array*: Internal special variables
*opcodes-map*: Internal special variables
*opcodes-name-map*: Internal special variables
*opening-opcodes*: Internal special variables
+
+byte+: Exported constants
+fin+: Exported constants
+length+: Exported constants
+mask+: Exported constants
+max-reserved-error+: Internal constants
+min-reserved-error+: Internal constants
+opcode+: Exported constants
+rsv1+: Exported constants
+rsv2+: Exported constants
+rsv3+: Exported constants
C
Constant, +byte+: Exported constants
Constant, +fin+: Exported constants
Constant, +length+: Exported constants
Constant, +mask+: Exported constants
Constant, +max-reserved-error+: Internal constants
Constant, +min-reserved-error+: Internal constants
Constant, +opcode+: Exported constants
Constant, +rsv1+: Exported constants
Constant, +rsv2+: Exported constants
Constant, +rsv3+: Exported constants
F
fin: Exported structures
L
length: Exported conditions
length: Exported structures
length-size: Exported structures
M
mask: Exported structures
masking-key: Exported structures
max-length: Exported conditions
mode: Exported structures
O
opcode: Exported structures
R
require-masking: Exported conditions
S
Slot, fin: Exported structures
Slot, length: Exported conditions
Slot, length: Exported structures
Slot, length-size: Exported structures
Slot, mask: Exported structures
Slot, masking-key: Exported structures
Slot, max-length: Exported conditions
Slot, mode: Exported structures
Slot, opcode: Exported structures
Slot, require-masking: Exported conditions
Slot, stage: Exported structures
Special Variable, *error-codes*: Internal special variables
Special Variable, *error-codes-map*: Internal special variables
Special Variable, *error-codes-name-map*: Internal special variables
Special Variable, *fragmented-opcodes*: Internal special variables
Special Variable, *mask-key-indices*: Internal special variables
Special Variable, *mask-random-state*: Internal special variables
Special Variable, *opcode-valid-array*: Internal special variables
Special Variable, *opcodes-map*: Internal special variables
Special Variable, *opcodes-name-map*: Internal special variables
Special Variable, *opening-opcodes*: Internal special variables
stage: Exported structures
Jump to:   *   +  
C   F   L   M   O   R   S  

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

A.4 Data types

Jump to:   C   E   F   O   P   S   T   U   W  
Index Entry  Section
C
Condition, encoding-error: Exported conditions
Condition, protocol-error: Exported conditions
Condition, too-large: Exported conditions
Condition, unacceptable: Exported conditions
Condition, websocket-error: Exported conditions
Condition, websocket-parse-error: Exported conditions
E
encoding-error: Exported conditions
F
fast-websocket: The fast-websocket system
fast-websocket: The fast-websocket package
fast-websocket-asd: The fast-websocket-asd package
fast-websocket.compose: The fast-websocket․compose package
fast-websocket.constants: The fast-websocket․constants package
fast-websocket.error: The fast-websocket․error package
fast-websocket.parser: The fast-websocket․parser package
fast-websocket.payload: The fast-websocket․payload package
fast-websocket.ws: The fast-websocket․ws package
O
octet: Internal types
octets: Internal types
P
Package, fast-websocket: The fast-websocket package
Package, fast-websocket-asd: The fast-websocket-asd package
Package, fast-websocket.compose: The fast-websocket․compose package
Package, fast-websocket.constants: The fast-websocket․constants package
Package, fast-websocket.error: The fast-websocket․error package
Package, fast-websocket.parser: The fast-websocket․parser package
Package, fast-websocket.payload: The fast-websocket․payload package
Package, fast-websocket.ws: The fast-websocket․ws package
protocol-error: Exported conditions
S
Structure, ws: Exported structures
System, fast-websocket: The fast-websocket system
T
too-large: Exported conditions
Type, octet: Internal types
Type, octets: Internal types
U
unacceptable: Exported conditions
W
websocket-error: Exported conditions
websocket-parse-error: Exported conditions
ws: Exported structures
Jump to:   C   E   F   O   P   S   T   U   W