node_modules
.bin
@ampproject
@babel
@discoveryjs
@gar
@istanbuljs
@jridgewell
@leichtgewicht
@npmcli
@riotjs
@tootallnate
@types
@ungap
@webassemblyjs
@webpack-cli
@xtuc
abab
abbrev
accepts
acorn
acorn-globals
acorn-import-assertions
acorn-walk
agent-base
agentkeepalive
aggregate-error
ajv
ajv-formats
ajv-keywords
ansi-colors
ansi-html-community
ansi-regex
ansi-styles
anymatch
append-transform
aproba
archy
are-we-there-yet
argparse
array-flatten
arrify
assertion-error
ast-types
async-foreach
asynckit
babel-plugin-dynamic-import-node
babel-plugin-polyfill-corejs2
babel-plugin-polyfill-corejs3
babel-plugin-polyfill-regenerator
balanced-match
batch
bianco.attr
bianco.dom-to-array
bianco.events
bianco.query
big.js
binary-extensions
body-parser
bonjour-service
boolbase
brace-expansion
braces
browser-process-hrtime
browser-stdout
browserslist
buffer-from
bytes
cacache
caching-transform
call-bind
camel-case
camelcase
camelcase-keys
caniuse-lite
chai
chalk
check-error
chokidar
chownr
chrome-trace-event
clean-css
clean-stack
cliui
clone-deep
color-convert
color-name
color-support
colorette
combined-stream
commander
commondir
compressible
compression
concat-map
connect-history-api-fallback
console-control-strings
content-disposition
content-type
convert-source-map
cookie
cookie-signature
core-js-compat
core-util-is
cross-spawn
css-select
css-what
cssesc
cssom
cssstyle
cumpa
curri
data-urls
debug
decamelize
decamelize-keys
decimal.js
deep-eql
deep-is
default-gateway
default-require-extensions
define-lazy-prop
define-properties
delayed-stream
delegates
depd
destroy
detect-node
diff
dns-equal
dns-packet
dom-converter
dom-nodes
dom-serializer
domelementtype
domexception
domhandler
domutils
dot-case
ee-first
electron-to-chromium
emoji-regex
emojis-list
encodeurl
encoding
enhanced-resolve
entities
env-paths
envinfo
err-code
erre
error-ex
es-module-lexer
es6-error
escalade
escape-html
escape-string-regexp
escodegen
eslint-scope
esm
esprima
esrecurse
estraverse
esutils
etag
eventemitter3
events
execa
express
fast-deep-equal
fast-json-stable-stringify
fast-levenshtein
fastest-levenshtein
faye-websocket
fill-range
finalhandler
find-up
flat
follow-redirects
foreground-child
form-data
forwarded
fresh
fromentries
fs-minipass
fs-monkey
fs.realpath
function-bind
gauge
gaze
gensync
get-caller-file
get-func-name
get-intrinsic
get-package-type
get-stdin
get-stream
glob
glob-parent
glob-to-regexp
globals
globule
graceful-fs
growl
handle-thing
hard-rejection
has
has-flag
has-property-descriptors
has-symbols
has-unicode
hasha
he
hosted-git-info
hpack.js
html-encoding-sniffer
html-entities
html-escaper
html-minifier-terser
html-webpack-plugin
htmlparser2
http-cache-semantics
http-deceiver
http-errors
http-parser-js
http-proxy
http-proxy-agent
http-proxy-middleware
https-proxy-agent
human-signals
humanize-ms
iconv-lite
imurmurhash
indent-string
infer-owner
inflight
inherits
interpret
ip
ipaddr.js
is-arrayish
is-binary-path
is-core-module
is-docker
is-extglob
is-fullwidth-code-point
is-glob
is-lambda
is-number
is-plain-obj
is-plain-object
is-potential-custom-element-name
is-stream
is-typedarray
is-windows
is-wsl
isarray
isexe
isobject
istanbul-lib-coverage
istanbul-lib-hook
istanbul-lib-instrument
istanbul-lib-processinfo
istanbul-lib-report
istanbul-lib-source-maps
istanbul-reports
jest-worker
js-base64
js-tokens
js-yaml
jsdom
jsdom-global
jsesc
json-parse-even-better-errors
json-schema-traverse
json5
kind-of
levn
lines-and-columns
loader-runner
locate-path
lodash
lodash.debounce
lodash.flattendeep
log-symbols
loupe
lower-case
lru-cache
make-fetch-happen
map-obj
media-typer
memfs
meow
merge-descriptors
merge-stream
methods
micromatch
mime
mime-db
mime-types
mimic-fn
min-indent
minimalistic-assert
minimatch
minimist-options
minipass
minipass-collect
minipass-fetch
minipass-flush
minipass-pipeline
minipass-sized
minizlib
mkdirp
mocha
ms
multicast-dns
nan
nanoid
negotiator
neo-async
no-case
node-forge
node-gyp
node-preload
node-releases
node-sass
nopt
normalize-package-data
normalize-path
npm-run-path
npmlog
nth-check
nwsapi
nyc
object-inspect
object-keys
object.assign
obuf
on-finished
on-headers
once
onetime
open
optionator
p-limit
p-locate
p-map
p-retry
p-try
package-hash
param-case
parse-json
parse5
parseurl
pascal-case
path-exists
path-is-absolute
path-key
path-parse
path-to-regexp
pathval
picocolors
picomatch
pirates
prelude-ls
pretty-error
process-nextick-args
process-on-spawn
promise-inflight
promise-retry
proxy-addr
psl
punycode
qs
quick-lru
randombytes
range-parser
raw-body
rawth
read-pkg
read-pkg-up
readable-stream
readdirp
recast
rechoir
redent
regenerate
regenerate-unicode-properties
regenerator-runtime
regenerator-transform
regexpu-core
regjsgen
regjsparser
relateurl
release-zalgo
renderkid
require-directory
require-from-string
require-main-filename
requires-port
resolve
retry
rimraf
riot
ruit
safe-buffer
safer-buffer
sass-graph
saxes
schema-utils
scss-tokenizer
select-hose
selfsigned
semver
send
serialize-javascript
serve-index
serve-static
set-blocking
setprototypeof
shallow-clone
shebang-command
shebang-regex
side-channel
signal-exit
smart-buffer
sockjs
socks
socks-proxy-agent
source-map
source-map-support
spawn-wrap
spdx-correct
spdx-exceptions
spdx-expression-parse
spdx-license-ids
spdy
spdy-transport
sprintf-js
ssri
statuses
stdout-stream
string-width
string_decoder
strip-ansi
strip-final-newline
strip-indent
strip-json-comments
supports-color
symbol-tree
tapable
tar
terser
terser-webpack-plugin
test-exclude
thunky
to-fast-properties
to-regex-range
toidentifier
tough-cookie
tr46
trim-newlines
true-case-path
tslib
type-check
type-detect
type-fest
type-is
typedarray-to-buffer
unicode-canonical-property-names-ecmascript
unicode-match-property-ecmascript
unicode-match-property-value-ecmascript
unicode-property-aliases-ecmascript
unique-filename
unique-slug
universalify
unpipe
update-browserslist-db
uri-js
util-deprecate
utila
utils-merge
uuid
validate-npm-package-license
vary
w3c-hr-time
w3c-xmlserializer
watchpack
wbuf
webidl-conversions
webpack
webpack-cli
webpack-dev-middleware
webpack-dev-server
webpack-merge
webpack-sources
websocket-driver
lib
websocket
driver
driver.js
http_parser.js
streams.js
CHANGELOG.md
LICENSE.md
README.md
package.json
websocket-extensions
whatwg-encoding
whatwg-mimetype
whatwg-url
which
which-module
wide-align
wildcard
word-wrap
workerpool
wrap-ansi
wrappy
write-file-atomic
ws
xml-name-validator
xmlchars
y18n
yallist
yargs
yargs-parser
yargs-unparser
yocto-queue
.package-lock.json
src
LICENSE
package-lock.json
package.json
readme.md
webpack.config.js
147 lines
4.8 KiB
JavaScript
147 lines
4.8 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
|
|
Streams in a WebSocket connection
|
|
---------------------------------
|
|
|
|
We model a WebSocket as two duplex streams: one stream is for the wire protocol
|
|
over an I/O socket, and the other is for incoming/outgoing messages.
|
|
|
|
|
|
+----------+ +---------+ +----------+
|
|
[1] write(chunk) -->| ~~~~~~~~ +----->| parse() +----->| ~~~~~~~~ +--> emit('data') [2]
|
|
| | +----+----+ | |
|
|
| | | | |
|
|
| IO | | [5] | Messages |
|
|
| | V | |
|
|
| | +---------+ | |
|
|
[4] emit('data') <--+ ~~~~~~~~ |<-----+ frame() |<-----+ ~~~~~~~~ |<-- write(chunk) [3]
|
|
+----------+ +---------+ +----------+
|
|
|
|
|
|
Message transfer in each direction is simple: IO receives a byte stream [1] and
|
|
sends this stream for parsing. The parser will periodically emit a complete
|
|
message text on the Messages stream [2]. Similarly, when messages are written
|
|
to the Messages stream [3], they are framed using the WebSocket wire format and
|
|
emitted via IO [4].
|
|
|
|
There is a feedback loop via [5] since some input from [1] will be things like
|
|
ping, pong and close frames. In these cases the protocol responds by emitting
|
|
responses directly back to [4] rather than emitting messages via [2].
|
|
|
|
For the purposes of flow control, we consider the sources of each Readable
|
|
stream to be as follows:
|
|
|
|
* [2] receives input from [1]
|
|
* [4] receives input from [1] and [3]
|
|
|
|
The classes below express the relationships described above without prescribing
|
|
anything about how parse() and frame() work, other than assuming they emit
|
|
'data' events to the IO and Messages streams. They will work with any protocol
|
|
driver having these two methods.
|
|
**/
|
|
|
|
|
|
var Stream = require('stream').Stream,
|
|
util = require('util');
|
|
|
|
|
|
var IO = function(driver) {
|
|
this.readable = this.writable = true;
|
|
this._paused = false;
|
|
this._driver = driver;
|
|
};
|
|
util.inherits(IO, Stream);
|
|
|
|
// The IO pause() and resume() methods will be called when the socket we are
|
|
// piping to gets backed up and drains. Since IO output [4] comes from IO input
|
|
// [1] and Messages input [3], we need to tell both of those to return false
|
|
// from write() when this stream is paused.
|
|
|
|
IO.prototype.pause = function() {
|
|
this._paused = true;
|
|
this._driver.messages._paused = true;
|
|
};
|
|
|
|
IO.prototype.resume = function() {
|
|
this._paused = false;
|
|
this.emit('drain');
|
|
|
|
var messages = this._driver.messages;
|
|
messages._paused = false;
|
|
messages.emit('drain');
|
|
};
|
|
|
|
// When we receive input from a socket, send it to the parser and tell the
|
|
// source whether to back off.
|
|
IO.prototype.write = function(chunk) {
|
|
if (!this.writable) return false;
|
|
this._driver.parse(chunk);
|
|
return !this._paused;
|
|
};
|
|
|
|
// The IO end() method will be called when the socket piping into it emits
|
|
// 'close' or 'end', i.e. the socket is closed. In this situation the Messages
|
|
// stream will not emit any more data so we emit 'end'.
|
|
IO.prototype.end = function(chunk) {
|
|
if (!this.writable) return;
|
|
if (chunk !== undefined) this.write(chunk);
|
|
this.writable = false;
|
|
|
|
var messages = this._driver.messages;
|
|
if (messages.readable) {
|
|
messages.readable = messages.writable = false;
|
|
messages.emit('end');
|
|
}
|
|
};
|
|
|
|
IO.prototype.destroy = function() {
|
|
this.end();
|
|
};
|
|
|
|
|
|
var Messages = function(driver) {
|
|
this.readable = this.writable = true;
|
|
this._paused = false;
|
|
this._driver = driver;
|
|
};
|
|
util.inherits(Messages, Stream);
|
|
|
|
// The Messages pause() and resume() methods will be called when the app that's
|
|
// processing the messages gets backed up and drains. If we're emitting
|
|
// messages too fast we should tell the source to slow down. Message output [2]
|
|
// comes from IO input [1].
|
|
|
|
Messages.prototype.pause = function() {
|
|
this._driver.io._paused = true;
|
|
};
|
|
|
|
Messages.prototype.resume = function() {
|
|
this._driver.io._paused = false;
|
|
this._driver.io.emit('drain');
|
|
};
|
|
|
|
// When we receive messages from the user, send them to the formatter and tell
|
|
// the source whether to back off.
|
|
Messages.prototype.write = function(message) {
|
|
if (!this.writable) return false;
|
|
if (typeof message === 'string') this._driver.text(message);
|
|
else this._driver.binary(message);
|
|
return !this._paused;
|
|
};
|
|
|
|
// The Messages end() method will be called when a stream piping into it emits
|
|
// 'end'. Many streams may be piped into the WebSocket and one of them ending
|
|
// does not mean the whole socket is done, so just process the input and move
|
|
// on leaving the socket open.
|
|
Messages.prototype.end = function(message) {
|
|
if (message !== undefined) this.write(message);
|
|
};
|
|
|
|
Messages.prototype.destroy = function() {};
|
|
|
|
|
|
exports.IO = IO;
|
|
exports.Messages = Messages;
|