/***************************** BEGIN LICENSE BLOCK ***************************
The contents of this file are subject to the Mozilla Public License, v. 2.0.
If a copy of the MPL was not distributed with this file, You can obtain one
at http://mozilla.org/MPL/2.0/.
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the License.
Copyright (C) 2015-2020 Mathieu Dhainaut. All Rights Reserved.
Author: Mathieu Dhainaut <mathieu.dhainaut@gmail.com>
******************************* END LICENSE BLOCK ***************************/
import DataConnector from './DataConnector.js';
import {isDefined, isWebWorker} from '../utils/Utils.js';
import {Status} from './Status.js';
/**
* Defines the WebSocketConnector to connect to a remote server by creating a WebSocket channel.
* @extends DataConnector
* @example
* import WebSocketConnector from 'osh-js/dataconnector/WebSocketConnector.js';
*
* let url = ...;
* let connector = new WebSocketConnector(url);
*
* // connect
* connector.connect();
*
* // disconnect
* connector.disconnect();
*
* // close
* connector.close();
*
*/
let reconnectionInterval = -1;
class WebSocketConnector extends DataConnector {
/**
*
* @param url -
* @param {Object} properties -
*/
constructor(url, properties) {
super(url, properties);
this.interval = -1;
this.lastReceiveTime = 0;
this.extraUrl = '';
this.reconnectRetry = (properties && properties.reconnectRetry) || 10;
}
/**
* Connect to the webSocket. If the system supports WebWorker, it will automatically creates one otherwise use
* the main thread.
*/
doRequest(extraUrl = this.extraUrl,queryString= this.queryString) {
if (!this.init) {
this.extraUrl = extraUrl;
this.queryString = queryString;
let fullUrl = this.getUrl() + extraUrl;
if(isDefined(queryString)) {
fullUrl += '?'+queryString;
}
this.closed = false;
this.init = true;
//creates Web Socket
this.ws = new WebSocket(fullUrl);
this.ws.binaryType = 'arraybuffer';
this.checkStatus(Status.CONNECTING);
console.warn('WebSocket stream connecting');
this.ws.onopen = function(event) {
this.checkAndClearReconnection();
this.checkStatus(Status.CONNECTED);
console.warn('WebSocket stream connected');
}.bind(this);
this.ws.onmessage = function (event) {
this.lastReceiveTime = Date.now();
//callback data on message received
if (event.data.byteLength > 0) {
this.onMessage(event.data);
}
}.bind(this);
// closes socket if any errors occur
this.ws.onerror = function (event) {
console.error('WebSocket stream error');
this.checkStatus(Status.CLOSED_ERROR);
this.init = false;
this.lastReceiveTime = -1;
this.createReconnection();
this.onError(event);
}.bind(this);
this.ws.onclose = (event) => {
console.warn('WebSocket stream closed: ',event.reason, event.code);
if(event.code !== 1000 && !this.closed) {
this.checkStatus(Status.CLOSED_ERROR);
this.createReconnection();
} else {
this.checkStatus(Status.DISCONNECTED);
}
this.onClose(event.code);
};
if(this.reconnectionInterval !== -1) {
clearInterval(this.reconnectionInterval);
this.reconnectionInterval = -1;
}
}
}
/**
* Connect to the webSocket. If the system supports WebWorker, it will automatically creates one otherwise use
* the main thread.
*/
doAsyncRequest(extraUrl = this.extraUrl,queryString= this.queryString) {
return new Promise(async (resolve, reject) => {
if (!this.init) {
this.extraUrl = extraUrl;
this.queryString = queryString;
let fullUrl = this.getUrl() + extraUrl;
if (isDefined(queryString)) {
fullUrl += '?' + queryString;
}
this.closed = false;
this.init = true;
//creates Web Socket
this.ws = new WebSocket(fullUrl);
this.ws.binaryType = 'arraybuffer';
this.checkStatus(Status.CONNECTING);
console.warn('WebSocket stream connecting');
const results = [];
this.ws.onopen = function (event) {
this.checkAndClearReconnection();
this.checkStatus(Status.CONNECTED);
console.warn('WebSocket stream connected');
}.bind(this);
this.ws.onmessage = function (event) {
this.lastReceiveTime = Date.now();
//callback data on message received
if (event.data.byteLength > 0) {
// this.onMessage(event.data);
results.push(event.data);
}
}.bind(this);
// closes socket if any errors occur
this.ws.onerror = function (event) {
console.error('WebSocket stream error');
this.checkStatus(Status.CLOSED_ERROR);
this.init = false;
this.lastReceiveTime = -1;
this.createReconnection();
this.onError(event);
reject(`onError WS: ${event}`);
}.bind(this);
this.ws.onclose = (event) => {
console.warn('WebSocket stream closed: ', event.reason, event.code);
if (event.code !== 1000 && !this.closed) {
this.checkStatus(Status.CLOSED_ERROR);
this.createReconnection();
} else {
this.checkStatus(Status.DISCONNECTED);
}
this.onClose(event.code);
resolve(results);
};
if (this.reconnectionInterval !== -1) {
clearInterval(this.reconnectionInterval);
this.reconnectionInterval = -1;
}
}
});
}
connect() {
this.doRequest();
}
publishRequest(topic, payload) {
if(isDefined(this.ws)) {
this.ws.send(payload);
}
}
checkAndClearReconnection() {
if(reconnectionInterval !== -1) {
clearInterval(reconnectionInterval);
reconnectionInterval = -1;
}
}
createReconnection() {
if(!this.closed && reconnectionInterval === -1 && this.onReconnect()) {
let count = 0;
const url = this.url;
reconnectionInterval = setInterval(function () {
let delta = Date.now() - this.lastReceiveTime;
// -1 means the WS went in error
if (this.lastReceiveTime === -1 || (delta >= this.reconnectTimeout)) {
if(count++ >= this.reconnectRetry) {
console.warn(`Maximum reconnection retries attempted: ${this.reconnectRetry}`)
clearInterval(reconnectionInterval);
} else {
let fullUrl = url;
if(isDefined(this.extraUrl)) {
fullUrl += this.extraUrl;
}
if(isDefined(this.queryString)) {
fullUrl += '?'+this.queryString;
}
console.warn(`(${count}/${this.reconnectRetry}) trying to reconnect: ${fullUrl}`);
this.init = false;
this.connect();
}
}
}.bind(this), this.reconnectTimeout);
}
}
/**
* Disconnects and close the websocket.
*/
async disconnect() {
// super.disconnect();
this.init = false;
this.closed = true;
if (this.ws != null && this.ws.readyState !== WebSocket.CLOSED) {
this.ws.close();
}
}
/**
* The onMessage method used by the websocket to callback the data
* @param data the callback data
* @event
*/
async onMessage(data) {
}
isConnected() {
return (this.ws != null && this.ws.readyState === WebSocket.OPEN);
}
}
export default WebSocketConnector;