A more advanced web socket wrapper for RxJS
bower install -S rx-socket-subject
npm install -S rx-socket-subject
The goals of this project is to produce an observable WebSocket implementation that meets a set of common needs for projects I'm currently working on. RxJS-DOM has a fine WebSocket implementation, which I modelled the initial work on this implementation off of. However, I need something that also does the following:
- Socket that will automatically reconnect itself.
- Socket that will automatically try additional endpoints.
- Has seperate hooks for open, close, and error.
- Will send proper close messages with WebSocket close codes to the server when
- Will send a close command to the server when
- Will always force a single instance of a socket regardless of the number of subscriptions.
- Will buffer messages fed to it via
onNextif the underlying socket isn't open, send them all when it does open.
// create a socket subject// at this point an underlying WebSocket has not yet been createdvar socket = RxSocketSubject;// use the socket subject as an Observer and send// messages with onNext()// even though the underlying socket still hasn't been created,// the messages will be buffered until a socket is made and connectedsocket;socket;// subscribing to the socket subject as an Observable// will start the socket and connect.socket;;
Closing the socket
var socket = RxSocketSubject;var disposable = socket;socket;socket;
Forcing an error close on the socket
There are some cases where you'll want to acknowledge what you've received from the
server was an error. With a normal web socket, this is generally done with
RxSocketSubject allows for this by leveraging
onError when the subject is used as an Observable.
More information about WebSocket status codes can be found on MDN.
var socket = RxSocketSubject;var disposable = socket;
Using fallback endpoints
// it's as simple as providing an array of endpoints to the `create()` method// in order to have the socket fallback to another endpoint if connection fails// or if an error closes the connection. The Subject will keep retrying each// endpoint until one connects successfullyvar socket = RxSocketSubject;