source: trip-planner-front/node_modules/websocket-driver/lib/websocket/streams.js@ 188ee53

Last change on this file since 188ee53 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 4.8 KB
Line 
1'use strict';
2
3/**
4
5Streams in a WebSocket connection
6---------------------------------
7
8We model a WebSocket as two duplex streams: one stream is for the wire protocol
9over an I/O socket, and the other is for incoming/outgoing messages.
10
11
12 +----------+ +---------+ +----------+
13 [1] write(chunk) -->| ~~~~~~~~ +----->| parse() +----->| ~~~~~~~~ +--> emit('data') [2]
14 | | +----+----+ | |
15 | | | | |
16 | IO | | [5] | Messages |
17 | | V | |
18 | | +---------+ | |
19 [4] emit('data') <--+ ~~~~~~~~ |<-----+ frame() |<-----+ ~~~~~~~~ |<-- write(chunk) [3]
20 +----------+ +---------+ +----------+
21
22
23Message transfer in each direction is simple: IO receives a byte stream [1] and
24sends this stream for parsing. The parser will periodically emit a complete
25message text on the Messages stream [2]. Similarly, when messages are written
26to the Messages stream [3], they are framed using the WebSocket wire format and
27emitted via IO [4].
28
29There is a feedback loop via [5] since some input from [1] will be things like
30ping, pong and close frames. In these cases the protocol responds by emitting
31responses directly back to [4] rather than emitting messages via [2].
32
33For the purposes of flow control, we consider the sources of each Readable
34stream to be as follows:
35
36* [2] receives input from [1]
37* [4] receives input from [1] and [3]
38
39The classes below express the relationships described above without prescribing
40anything about how parse() and frame() work, other than assuming they emit
41'data' events to the IO and Messages streams. They will work with any protocol
42driver having these two methods.
43**/
44
45
46var Stream = require('stream').Stream,
47 util = require('util');
48
49
50var IO = function(driver) {
51 this.readable = this.writable = true;
52 this._paused = false;
53 this._driver = driver;
54};
55util.inherits(IO, Stream);
56
57// The IO pause() and resume() methods will be called when the socket we are
58// piping to gets backed up and drains. Since IO output [4] comes from IO input
59// [1] and Messages input [3], we need to tell both of those to return false
60// from write() when this stream is paused.
61
62IO.prototype.pause = function() {
63 this._paused = true;
64 this._driver.messages._paused = true;
65};
66
67IO.prototype.resume = function() {
68 this._paused = false;
69 this.emit('drain');
70
71 var messages = this._driver.messages;
72 messages._paused = false;
73 messages.emit('drain');
74};
75
76// When we receive input from a socket, send it to the parser and tell the
77// source whether to back off.
78IO.prototype.write = function(chunk) {
79 if (!this.writable) return false;
80 this._driver.parse(chunk);
81 return !this._paused;
82};
83
84// The IO end() method will be called when the socket piping into it emits
85// 'close' or 'end', i.e. the socket is closed. In this situation the Messages
86// stream will not emit any more data so we emit 'end'.
87IO.prototype.end = function(chunk) {
88 if (!this.writable) return;
89 if (chunk !== undefined) this.write(chunk);
90 this.writable = false;
91
92 var messages = this._driver.messages;
93 if (messages.readable) {
94 messages.readable = messages.writable = false;
95 messages.emit('end');
96 }
97};
98
99IO.prototype.destroy = function() {
100 this.end();
101};
102
103
104var Messages = function(driver) {
105 this.readable = this.writable = true;
106 this._paused = false;
107 this._driver = driver;
108};
109util.inherits(Messages, Stream);
110
111// The Messages pause() and resume() methods will be called when the app that's
112// processing the messages gets backed up and drains. If we're emitting
113// messages too fast we should tell the source to slow down. Message output [2]
114// comes from IO input [1].
115
116Messages.prototype.pause = function() {
117 this._driver.io._paused = true;
118};
119
120Messages.prototype.resume = function() {
121 this._driver.io._paused = false;
122 this._driver.io.emit('drain');
123};
124
125// When we receive messages from the user, send them to the formatter and tell
126// the source whether to back off.
127Messages.prototype.write = function(message) {
128 if (!this.writable) return false;
129 if (typeof message === 'string') this._driver.text(message);
130 else this._driver.binary(message);
131 return !this._paused;
132};
133
134// The Messages end() method will be called when a stream piping into it emits
135// 'end'. Many streams may be piped into the WebSocket and one of them ending
136// does not mean the whole socket is done, so just process the input and move
137// on leaving the socket open.
138Messages.prototype.end = function(message) {
139 if (message !== undefined) this.write(message);
140};
141
142Messages.prototype.destroy = function() {};
143
144
145exports.IO = IO;
146exports.Messages = Messages;
Note: See TracBrowser for help on using the repository browser.