================================================
FILE: jmqtt-doc/docs/TEST_REPORT.md
================================================
# Jmqtt 最新版功能及性能测试报告
线上版连接：https://www.yuque.com/tristan-ku8np/zze/xghq80
最新版链接：[https://github.com/Cicizz/jmqtt](https://github.com/Cicizz/jmqtt)
# 一、目标
1. 检测Jmqtt功能及性能运行情况
1. 为使用者提供参考
说明：以下测试为Jmqtt作者闲暇之时进行的测试，仅供参考，再线上使用Jmqtt时，请自行测试，感谢 朱霄 同学提供的服务器等测试资源
# 二、测试机配置
| | 数量 | 操作系统 | 配置 |
| --------------- | ----------- | --------------- | ----------------------------- |
| Jmqtt运行服务器 | 2台（集群） | linux centos 7 | 8C16G |
| Jmqtt压测机 | 2台 | linux centos 7 | 8C16G |
| Mysql | 单库单表 | mysql5.7 | 阿里云rds基础版：ESSD OL1云盘 |
| SLB | 1 | 支持4层负载均衡 | 支持20万长连接 |
测试脚本：
1. jmeter
1. emqx-bench
# 三、功能测试报告
| 功能项 | 是否满足 | 备注 |
| --------------------------- | -------- | --------------------------------------------------------- |
| 集群连接 | ✅ | |
| 集群cleansession为false连接 | ✅ | |
| 设备在集群互发消息 | ✅ | |
| retain消息 | ✅ | |
| will消息 | ✅ | |
| qos0 | ✅ | |
| qos1 | ✅ | |
| qos2 | ✅ | |
| 离线消息 | ✅ | 不限离线消息数量 |
| 设备信息持久化 | ✅ | 见sql表：jmqtt_session |
| 订阅关系持久化 | ✅ | 见sql表：jmqtt_subscription |
| 消息持久化 | ✅ | 见sql表：jmqtt_message |
| 集群事件消息 | ✅ | 包含集群间转发消息，连接事件，见sql表：jmqtt_cluser_event |
| 设备消息接收状态 | ✅ | 见sql表：jmqtt_client_inbox |
| 监控topic | ❎ | 不支持，需自行实现 |
| 各个消息桥接 | ❎ | 不支持，需自行实现 |
| 规则引擎 | ❎ | 不支持，需自行实现 |
# 四、单机性能测试报告
## 4.1 连接数性能报告
连接数单机测试达到10W级连接，连接tps1000，未出现报错，
注意：因测试机资源问题，未压测到上限。详细截图报告见下图
### 4.1.1 连接数200，连接持续3min
### 4.1.2 连接数1000，连接持续3min
### 4.1.3 连接数2000，连接持续3min
### 4.1.4 连接数5000，连接持续3min
### 4.1.5 连接数1W，连接持续3min
### 4.1.6 连接数2W，连接持续3min
超过2W采用开源emqx-bench进行性能压测
### 4.1.7 连接数5W，连接持续10min
### 4.1.8 连接数10W，连接持续10min
压到10W后，未持续压测，尚未压到连接数上限，两台测试机截图如下：
服务器load截图：
## 4.2 发送消息性能报告
### 4.2.1 设备连接2W，再启动1000连接持续发送消息
消息大小：256byte
qos：0
每隔10ms发送1条消息
对比emq服务（没有2W长连接设备保持）：broker.emqx.io
### 4.2.2 设备连接2W，再启动200连接持续发送消息
消息大小：256byte
qos：1
每隔10ms发送1条消息
### 4.2.3 设备连接2W，再启动200连接持续发送消息
消息大小：100byte
qos：1
每隔10ms发送1条消息
## 4.3 订阅性能报告
### 4.3.1 启动2W个设备，订阅2W个topic
### 
# 五、集群性能测试报告
## 5.1 连接数性能报告
Jmqtt服务器两台，设备连接数10W，未压测到上限
## 5.2 发送消息性能报告
发送消息强依赖db进行保存，性能瓶颈在db侧，故tps上不去
### 5.2.1 设备连接2W，启动200连接持续发送消息
消息大小：256byte
qos：1
### 5.2.2 设备连接2W，启动200连接持续发送消息
消息大小：100byte
qos：1
## 5.3 订阅性能报告
### 5.3.1 启动2W个设备，订阅2W个topic
### 5.3.2 启动5W个设备，订阅5W个topic
# 六、性能测试说明
## 6.1 关于连接数
1. 单机和集群都未压测到上线，受限于时间和测试机问题
1. 实际使用时，单机连接数不要超过5w，方式服务器重启时，大量重连请求导致不可预知的问题
## 6.2 关于消息发送tps
1. 整体看消息tps与emq的测试服务器消息tps差不多
1. 为什么集群tps上不去？
1. 因为消息保存强依赖mysql进行存储，mysql存储tps已达上限，这也是消息发送的可优化项
## 6.3 关于订阅
1. 目前订阅强依赖db存储，不存在订阅关系丢失的问题
1. 本地采用tri树进行订阅关系的管理
## 6.3 Jmqtt性能可优化项指南
1. 升级mysql
1. 集群事件转发器 用 mq替代（kafka或其他的mq都可以），减少集群服务器从db long pull的模式
1. 消息存储采用其他存储中间件，例如时序数据库，甚至kafka都行
# 七、测试常见问题
## 7.1 测试机需要修改端口限制，否则无法启动5W长连接
linux centos7默认限制了端口可用范围，需要修改一下，不然连接数无法达到5w
查看端口范围：cat /proc/sys/net/ipv4/ip_local_port_range
## 7.2 jmqtt服务器需要修改文件句柄数
linux 万物皆文件，需要修改文件句柄数，否则无法支持那么大的长连接
linux默认为65535个文件句柄数，需要修改两个地方：
ulimit -n 和vim /etc/security/limits.conf
## 7.3 jmqtt集群的负载均衡需要升级
mqtt协议的复杂均衡需要4层的负载均衡代理，
默认购买的SLB一般只支持5W长连接，故需要升级
# 八、附：Jmqtt启动问题
1. 目前jmqtt尽量减少各种依赖，代码简单，很容易进行二次开发和开箱即用
1. 请使用最新发布版本或master 分支代码
1. 建议从源码构建
1. 本地启动，直接在BrokerStartup执行main方法
## 8.1 结构介绍
## 8.2 在db库中初始化好脚本
t默认使用的是mysql驱动，依赖其他db需要自行修改
1. 在自己的库中，执行jmqtt.sql
1. 执行后如截图所示：
## 8.3 打包
在broker模块下，执行 ：mvn -Ppackage-all -DskipTests clean install -U
打包后：
## 8.4 修改配置文件
如截图：这里修改为自己的db连接串
## 8.5 上传资源到服务器
1. 将jar，conf下的资源，bin下的脚本都上传到服务器：
其中 config为conf下的配置文件
2. 执行启动命令：./runbroker.sh jmqtt-broker-3.0.0.jar -h config/
3. 查看启动日志：
1. cd jmqttlogs
1. tailf -200 brokerLog.log : 显示如下截图说明启动成功
jmqt
================================================
FILE: jmqtt-doc/pom.xml
================================================
jmqttorg.jmqtt3.0.04.0.0jmqtt-docjmqtt-doc
================================================
FILE: jmqtt-example/pom.xml
================================================
jmqttorg.jmqtt3.0.04.0.0jmqtt-examplejmqtt-exampleUTF-81.81.8org.eclipse.pahoorg.eclipse.paho.client.mqttv31.2.5
================================================
FILE: jmqtt-example/src/main/java/org/jmqtt/java/Consumer.java
================================================
package org.jmqtt.java;
import org.eclipse.paho.client.mqttv3.*;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
public class Consumer {
private static final String broker = "tcp://127.0.0.1:1883";
private static final String topic = "MQTT/TOPIC";
private static final String clientId = "MQTT_SUB_CLIENT";
public static void main(String[] args) throws MqttException {
MqttClient subClient = getMqttClient();
subClient.setCallback(new MqttCallback() {
@Override
public void connectionLost(Throwable throwable) {
System.out.println("Connect lost,do some thing to solve it");
}
@Override
public void messageArrived(String s, MqttMessage mqttMessage) {
System.out.println("From topic: " + s);
System.out.println("Message content: " + new String(mqttMessage.getPayload()));
}
@Override
public void deliveryComplete(IMqttDeliveryToken iMqttDeliveryToken) {
System.out.println("deliveryComplete");
}
});
subClient.subscribe(topic);
}
private static MqttClient getMqttClient() {
try {
MqttClient pubClient = new MqttClient(broker, clientId, new MemoryPersistence());
MqttConnectOptions connectOptions = new MqttConnectOptions();
connectOptions.setCleanSession(false);
System.out.println("Connecting to broker: " + broker);
pubClient.connect(connectOptions);
return pubClient;
} catch (MqttException e) {
e.printStackTrace();
}
return null;
}
}
================================================
FILE: jmqtt-example/src/main/java/org/jmqtt/java/Producer.java
================================================
package org.jmqtt.java;
import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
public class Producer {
private static final String broker = "tcp://8.142.122.137:1883";
private static final String content = "Message from MqttProducer";
private static final int qos = 1;
private static final String topic = "MQTT/TOPIC";
private static final String clientId = "MQTT_PUB_CLIENT";
public static void main(String[] args) throws MqttException, InterruptedException {
MqttClient pubClient = getMqttClient();
for (int i = 0; i < 3; i++) {
MqttMessage mqttMessage = getMqttMessage();
pubClient.publish(topic, mqttMessage);
System.out.println("Send message success.");
}
}
private static MqttMessage getMqttMessage() {
MqttMessage mqttMessage = new MqttMessage(content.getBytes());
mqttMessage.setQos(qos);
return mqttMessage;
}
private static MqttClient getMqttClient() {
try {
MqttClient pubClient = new MqttClient(broker, clientId, new MemoryPersistence());
MqttConnectOptions connectOptions = new MqttConnectOptions();
connectOptions.setWill("lwt", "this is a will message".getBytes(), 1, false);
connectOptions.setCleanSession(false);
System.out.println("Connecting to broker: " + broker);
pubClient.connect(connectOptions);
return pubClient;
} catch (MqttException e) {
e.printStackTrace();
}
return null;
}
}
================================================
FILE: jmqtt-example/src/main/java/org/jmqtt/websocket/paho-mqtt-min.js
================================================
/*******************************************************************************
* Copyright (c) 2013, 2014 IBM Corp.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v1.0 which accompany this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
*******************************************************************************/
"undefined"===typeof Paho&&(Paho={});
Paho.MQTT=function(u){function y(a,b,c){b[c++]=a>>8;b[c++]=a%256;return c}function r(a,b,c,h){h=y(b,c,h);F(a,c,h);return h+b}function m(a){for(var b=0,c=0;c=h&&(c++,b++),b+=3):127=e){var d=a.charCodeAt(++h);if(isNaN(d))throw Error(f(g.MALFORMED_UNICODE,[e,d]));e=(e-55296<<10)+(d-56320)+65536}127>=e?b[c++]=e:(2047>=e?b[c++]=e>>6&31|
192:(65535>=e?b[c++]=e>>12&15|224:(b[c++]=e>>18&7|240,b[c++]=e>>12&63|128),b[c++]=e>>6&63|128),b[c++]=e&63|128)}return b}function G(a,b,c){for(var h="",e,d=b;de)){var p=a[d++]-128;if(0>p)throw Error(f(g.MALFORMED_UTF,[e.toString(16),p.toString(16),""]));if(224>e)e=64*(e-192)+p;else{var t=a[d++]-128;if(0>t)throw Error(f(g.MALFORMED_UTF,[e.toString(16),p.toString(16),t.toString(16)]));if(240>e)e=4096*(e-224)+64*p+t;else{var l=a[d++]-128;if(0>l)throw Error(f(g.MALFORMED_UTF,
[e.toString(16),p.toString(16),t.toString(16),l.toString(16)]));if(248>e)e=262144*(e-240)+4096*p+64*t+l;else throw Error(f(g.MALFORMED_UTF,[e.toString(16),p.toString(16),t.toString(16),l.toString(16)]));}}}65535>10)),e=56320+(e&1023));h+=String.fromCharCode(e)}return h}var A=function(a,b){for(var c in a)if(a.hasOwnProperty(c))if(b.hasOwnProperty(c)){if(typeof a[c]!==b[c])throw Error(f(g.INVALID_TYPE,[typeof a[c],c]));}else{var h="Unknown property, "+c+
". Valid properties are:";for(c in b)b.hasOwnProperty(c)&&(h=h+" "+c);throw Error(h);}},q=function(a,b){return function(){return a.apply(b,arguments)}},g={OK:{code:0,text:"AMQJSC0000I OK."},CONNECT_TIMEOUT:{code:1,text:"AMQJSC0001E Connect timed out."},SUBSCRIBE_TIMEOUT:{code:2,text:"AMQJS0002E Subscribe timed out."},UNSUBSCRIBE_TIMEOUT:{code:3,text:"AMQJS0003E Unsubscribe timed out."},PING_TIMEOUT:{code:4,text:"AMQJS0004E Ping timed out."},INTERNAL_ERROR:{code:5,text:"AMQJS0005E Internal error. Error Message: {0}, Stack trace: {1}"},
CONNACK_RETURNCODE:{code:6,text:"AMQJS0006E Bad Connack return code:{0} {1}."},SOCKET_ERROR:{code:7,text:"AMQJS0007E Socket error:{0}."},SOCKET_CLOSE:{code:8,text:"AMQJS0008I Socket closed."},MALFORMED_UTF:{code:9,text:"AMQJS0009E Malformed UTF data:{0} {1} {2}."},UNSUPPORTED:{code:10,text:"AMQJS0010E {0} is not supported by this browser."},INVALID_STATE:{code:11,text:"AMQJS0011E Invalid state {0}."},INVALID_TYPE:{code:12,text:"AMQJS0012E Invalid type {0} for {1}."},INVALID_ARGUMENT:{code:13,text:"AMQJS0013E Invalid argument {0} for {1}."},
UNSUPPORTED_OPERATION:{code:14,text:"AMQJS0014E Unsupported operation."},INVALID_STORED_DATA:{code:15,text:"AMQJS0015E Invalid data in local storage key={0} value={1}."},INVALID_MQTT_MESSAGE_TYPE:{code:16,text:"AMQJS0016E Invalid MQTT message type {0}."},MALFORMED_UNICODE:{code:17,text:"AMQJS0017E Malformed Unicode string:{0} {1}."}},J={0:"Connection Accepted",1:"Connection Refused: unacceptable protocol version",2:"Connection Refused: identifier rejected",3:"Connection Refused: server unavailable",
4:"Connection Refused: bad user name or password",5:"Connection Refused: not authorized"},f=function(a,b){var c=a.text;if(b)for(var h,e,d=0;d>7;0l);f=d.length+1;b=new ArrayBuffer(b+f);l=new Uint8Array(b);
l[0]=a;l.set(d,1);if(3==this.type)f=r(this.payloadMessage.destinationName,h,l,f);else if(1==this.type){switch(this.mqttVersion){case 3:l.set(B,f);f+=B.length;break;case 4:l.set(C,f),f+=C.length}a=0;this.cleanSession&&(a=2);void 0!=this.willMessage&&(a=a|4|this.willMessage.qos<<3,this.willMessage.retained&&(a|=32));void 0!=this.userName&&(a|=128);void 0!=this.password&&(a|=64);l[f++]=a;f=y(this.keepAliveInterval,l,f)}void 0!=this.messageIdentifier&&(f=y(this.messageIdentifier,l,f));switch(this.type){case 1:f=
r(this.clientId,m(this.clientId),l,f);void 0!=this.willMessage&&(f=r(this.willMessage.destinationName,m(this.willMessage.destinationName),l,f),f=y(e.byteLength,l,f),l.set(e,f),f+=e.byteLength);void 0!=this.userName&&(f=r(this.userName,m(this.userName),l,f));void 0!=this.password&&r(this.password,m(this.password),l,f);break;case 3:l.set(g,f);break;case 8:for(d=0;dthis.connectOptions.mqttVersion?new WebSocket(a,["mqttv3.1"]):new WebSocket(a,["mqtt"]);this.socket.binaryType=
"arraybuffer";this.socket.onopen=q(this._on_socket_open,this);this.socket.onmessage=q(this._on_socket_message,this);this.socket.onerror=q(this._on_socket_error,this);this.socket.onclose=q(this._on_socket_close,this);this.sendPinger=new H(this,window,this.connectOptions.keepAliveInterval);this.receivePinger=new H(this,window,this.connectOptions.keepAliveInterval);this._connectTimeout=new D(this,window,this.connectOptions.timeout,this._disconnected,[g.CONNECT_TIMEOUT.code,f(g.CONNECT_TIMEOUT)])};k.prototype._schedule_message=
function(a){this._msg_queue.push(a);this.connected&&this._process_queue()};k.prototype.store=function(a,b){var c={type:b.type,messageIdentifier:b.messageIdentifier,version:1};switch(b.type){case 3:b.pubRecReceived&&(c.pubRecReceived=!0);c.payloadMessage={};for(var h="",e=b.payloadMessage.payloadBytes,d=0;d=e[d]?h+"0"+e[d].toString(16):h+e[d].toString(16);c.payloadMessage.payloadHex=h;c.payloadMessage.qos=b.payloadMessage.qos;c.payloadMessage.destinationName=b.payloadMessage.destinationName;
b.payloadMessage.duplicate&&(c.payloadMessage.duplicate=!0);b.payloadMessage.retained&&(c.payloadMessage.retained=!0);0==a.indexOf("Sent:")&&(void 0===b.sequence&&(b.sequence=++this._sequence),c.sequence=b.sequence);break;default:throw Error(f(g.INVALID_STORED_DATA,[key,c]));}localStorage.setItem(a+this._localKey+b.messageIdentifier,JSON.stringify(c))};k.prototype.restore=function(a){var b=localStorage.getItem(a),c=JSON.parse(b),h=new n(c.type,c);switch(c.type){case 3:for(var b=c.payloadMessage.payloadHex,
e=new ArrayBuffer(b.length/2),e=new Uint8Array(e),d=0;2<=b.length;){var k=parseInt(b.substring(0,2),16),b=b.substring(2,b.length);e[d++]=k}b=new Paho.MQTT.Message(e);b.qos=c.payloadMessage.qos;b.destinationName=c.payloadMessage.destinationName;c.payloadMessage.duplicate&&(b.duplicate=!0);c.payloadMessage.retained&&(b.retained=!0);h.payloadMessage=b;break;default:throw Error(f(g.INVALID_STORED_DATA,[a,b]));}0==a.indexOf("Sent:"+this._localKey)?(h.payloadMessage.duplicate=!0,this._sentMessages[h.messageIdentifier]=
h):0==a.indexOf("Received:"+this._localKey)&&(this._receivedMessages[h.messageIdentifier]=h)};k.prototype._process_queue=function(){for(var a=null,b=this._msg_queue.reverse();a=b.pop();)this._socket_send(a),this._notify_msg_sent[a]&&(this._notify_msg_sent[a](),delete this._notify_msg_sent[a])};k.prototype._requires_ack=function(a){var b=Object.keys(this._sentMessages).length;if(b>this.maxMessageIdentifier)throw Error("Too many messages:"+b);for(;void 0!==this._sentMessages[this._message_identifier];)this._message_identifier++;
a.messageIdentifier=this._message_identifier;this._sentMessages[a.messageIdentifier]=a;3===a.type&&this.store("Sent:",a);this._message_identifier===this.maxMessageIdentifier&&(this._message_identifier=1)};k.prototype._on_socket_open=function(){var a=new n(1,this.connectOptions);a.clientId=this.clientId;this._socket_send(a)};k.prototype._on_socket_message=function(a){this._trace("Client._on_socket_message",a.data);this.receivePinger.reset();a=this._deframeMessages(a.data);for(var b=0;b>4,z=t&15,d=d+1,v=void 0,E=0,m=1;do{if(d==e.length){h=[null,k];break a}v=e[d++];E+=(v&127)*m;m*=128}while(0!=(v&128));v=d+E;if(v>e.length)h=[null,k];else{var w=new n(l);switch(l){case 2:e[d++]&
1&&(w.sessionPresent=!0);w.returnCode=e[d++];break;case 3:var k=z>>1&3,r=256*e[d]+e[d+1],d=d+2,u=G(e,d,r),d=d+r;0b)throw Error(f(g.INVALID_TYPE,[typeof b,"port"]));if("string"!==typeof c)throw Error(f(g.INVALID_TYPE,[typeof c,"path"]));e="ws://"+(-1!=a.indexOf(":")&&"["!=a.slice(0,1)&&"]"!=a.slice(-1)?"["+a+"]":a)+":"+b+c}for(var p=d=0;p=m&&p++;d++}if("string"!==typeof h||65535a.mqttVersion)throw Error(f(g.INVALID_ARGUMENT,[a.mqttVersion,"connectOptions.mqttVersion"]));void 0===a.mqttVersion?(a.mqttVersionExplicit=!1,a.mqttVersion=4):a.mqttVersionExplicit=!0;if(void 0===a.password&&void 0!==a.userName)throw Error(f(g.INVALID_ARGUMENT,
[a.password,"connectOptions.password"]));if(a.willMessage){if(!(a.willMessage instanceof x))throw Error(f(g.INVALID_TYPE,[a.willMessage,"connectOptions.willMessage"]));a.willMessage.stringPayload;if("undefined"===typeof a.willMessage.destinationName)throw Error(f(g.INVALID_TYPE,[typeof a.willMessage.destinationName,"connectOptions.willMessage.destinationName"]));}"undefined"===typeof a.cleanSession&&(a.cleanSession=!0);if(a.hosts){if(!(a.hosts instanceof Array))throw Error(f(g.INVALID_ARGUMENT,[a.hosts,
"connectOptions.hosts"]));if(1>a.hosts.length)throw Error(f(g.INVALID_ARGUMENT,[a.hosts,"connectOptions.hosts"]));for(var b=!1,d=0;da.ports[d])throw Error(f(g.INVALID_TYPE,[typeof a.ports[d],"connectOptions.ports["+d+"]"]));var b=a.hosts[d],h=
a.ports[d];e="ws://"+(-1!=b.indexOf(":")?"["+b+"]":b)+":"+h+c;a.uris.push(e)}}}l.connect(a)};this.subscribe=function(a,b){if("string"!==typeof a)throw Error("Invalid argument:"+a);b=b||{};A(b,{qos:"number",invocationContext:"object",onSuccess:"function",onFailure:"function",timeout:"number"});if(b.timeout&&!b.onFailure)throw Error("subscribeOptions.timeout specified with no onFailure callback.");if("undefined"!==typeof b.qos&&0!==b.qos&&1!==b.qos&&2!==b.qos)throw Error(f(g.INVALID_ARGUMENT,[b.qos,
"subscribeOptions.qos"]));l.subscribe(a,b)};this.unsubscribe=function(a,b){if("string"!==typeof a)throw Error("Invalid argument:"+a);b=b||{};A(b,{invocationContext:"object",onSuccess:"function",onFailure:"function",timeout:"number"});if(b.timeout&&!b.onFailure)throw Error("unsubscribeOptions.timeout specified with no onFailure callback.");l.unsubscribe(a,b)};this.send=function(a,b,c,d){var e;if(0==arguments.length)throw Error("Invalid argument.length");if(1==arguments.length){if(!(a instanceof x)&&
"string"!==typeof a)throw Error("Invalid argument:"+typeof a);e=a;if("undefined"===typeof e.destinationName)throw Error(f(g.INVALID_ARGUMENT,[e.destinationName,"Message.destinationName"]));}else e=new x(b),e.destinationName=a,3<=arguments.length&&(e.qos=c),4<=arguments.length&&(e.retained=d);l.send(e)};this.disconnect=function(){l.disconnect()};this.getTraceLog=function(){return l.getTraceLog()};this.startTrace=function(){l.startTrace()};this.stopTrace=function(){l.stopTrace()};this.isConnected=function(){return l.connected}};
I.prototype={get host(){return this._getHost()},set host(a){this._setHost(a)},get port(){return this._getPort()},set port(a){this._setPort(a)},get path(){return this._getPath()},set path(a){this._setPath(a)},get clientId(){return this._getClientId()},set clientId(a){this._setClientId(a)},get onConnectionLost(){return this._getOnConnectionLost()},set onConnectionLost(a){this._setOnConnectionLost(a)},get onMessageDelivered(){return this._getOnMessageDelivered()},set onMessageDelivered(a){this._setOnMessageDelivered(a)},
get onMessageArrived(){return this._getOnMessageArrived()},set onMessageArrived(a){this._setOnMessageArrived(a)},get trace(){return this._getTrace()},set trace(a){this._setTrace(a)}};var x=function(a){var b;if("string"===typeof a||a instanceof ArrayBuffer||a instanceof Int8Array||a instanceof Uint8Array||a instanceof Int16Array||a instanceof Uint16Array||a instanceof Int32Array||a instanceof Uint32Array||a instanceof Float32Array||a instanceof Float64Array)b=a;else throw f(g.INVALID_ARGUMENT,[a,"newPayload"]);
this._getPayloadString=function(){return"string"===typeof b?b:G(b,0,b.length)};this._getPayloadBytes=function(){if("string"===typeof b){var a=new ArrayBuffer(m(b)),a=new Uint8Array(a);F(b,a,0);return a}return b};var c=void 0;this._getDestinationName=function(){return c};this._setDestinationName=function(a){if("string"===typeof a)c=a;else throw Error(f(g.INVALID_ARGUMENT,[a,"newDestinationName"]));};var h=0;this._getQos=function(){return h};this._setQos=function(a){if(0===a||1===a||2===a)h=a;else throw Error("Invalid argument:"+
a);};var e=!1;this._getRetained=function(){return e};this._setRetained=function(a){if("boolean"===typeof a)e=a;else throw Error(f(g.INVALID_ARGUMENT,[a,"newRetained"]));};var d=!1;this._getDuplicate=function(){return d};this._setDuplicate=function(a){d=a}};x.prototype={get payloadString(){return this._getPayloadString()},get payloadBytes(){return this._getPayloadBytes()},get destinationName(){return this._getDestinationName()},set destinationName(a){this._setDestinationName(a)},get qos(){return this._getQos()},
set qos(a){this._setQos(a)},get retained(){return this._getRetained()},set retained(a){this._setRetained(a)},get duplicate(){return this._getDuplicate()},set duplicate(a){this._setDuplicate(a)}};return{Client:I,Message:x}}(window);
================================================
FILE: jmqtt-example/src/main/java/org/jmqtt/websocket/paho-mqtt.js
================================================
/*******************************************************************************
* Copyright (c) 2013 IBM Corp.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v1.0 which accompany this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Andrew Banks - initial API and implementation and initial documentation
*******************************************************************************/
// Only expose a single object name in the global namespace.
// Everything must go through this module. Global Paho.MQTT module
// only has a single public function, client, which returns
// a Paho.MQTT client object given connection details.
/**
* Send and receive messages using web browsers.
*
* This programming interface lets a JavaScript client application use the MQTT V3.1 or
* V3.1.1 protocol to connect to an MQTT-supporting messaging server.
*
* The function supported includes:
*
*
Connecting to and disconnecting from a server. The server is identified by its host name and port number.
*
Specifying options that relate to the communications link with the server,
* for example the frequency of keep-alive heartbeats, and whether SSL/TLS is required.
*
Subscribing to and receiving messages from MQTT Topics.
*
Publishing messages to MQTT Topics.
*
*
* The API consists of two main objects:
*
*
{@link Paho.MQTT.Client}
*
This contains methods that provide the functionality of the API,
* including provision of callbacks that notify the application when a message
* arrives from or is delivered to the messaging server,
* or when the status of its connection to the messaging server changes.
*
{@link Paho.MQTT.Message}
*
This encapsulates the payload of the message along with various attributes
* associated with its delivery, in particular the destination to which it has
* been (or is about to be) sent.
*
*
* The programming interface validates parameters passed to it, and will throw
* an Error containing an error message intended for developer use, if it detects
* an error with any parameter.
*
* Example:
*
*
client = new Paho.MQTT.Client(location.hostname, Number(location.port), "clientId");
client.onConnectionLost = onConnectionLost;
client.onMessageArrived = onMessageArrived;
client.connect({onSuccess:onConnect});
function onConnect() {
// Once a connection has been made, make a subscription and send a message.
console.log("onConnect");
client.subscribe("/World");
message = new Paho.MQTT.Message("Hello");
message.destinationName = "/World";
client.send(message);
};
function onConnectionLost(responseObject) {
if (responseObject.errorCode !== 0)
console.log("onConnectionLost:"+responseObject.errorMessage);
};
function onMessageArrived(message) {
console.log("onMessageArrived:"+message.payloadString);
client.disconnect();
};
*
* @namespace Paho.MQTT
*/
if (typeof Paho === "undefined") {
Paho = {};
}
Paho.MQTT = (function (global) {
// Private variables below, these are only visible inside the function closure
// which is used to define the module.
var version = "@VERSION@";
var buildLevel = "@BUILDLEVEL@";
/**
* Unique message type identifiers, with associated
* associated integer values.
* @private
*/
var MESSAGE_TYPE = {
CONNECT: 1,
CONNACK: 2,
PUBLISH: 3,
PUBACK: 4,
PUBREC: 5,
PUBREL: 6,
PUBCOMP: 7,
SUBSCRIBE: 8,
SUBACK: 9,
UNSUBSCRIBE: 10,
UNSUBACK: 11,
PINGREQ: 12,
PINGRESP: 13,
DISCONNECT: 14
};
// Collection of utility methods used to simplify module code
// and promote the DRY pattern.
/**
* Validate an object's parameter names to ensure they
* match a list of expected variables name for this option
* type. Used to ensure option object passed into the API don't
* contain erroneous parameters.
* @param {Object} obj - User options object
* @param {Object} keys - valid keys and types that may exist in obj.
* @throws {Error} Invalid option parameter found.
* @private
*/
var validate = function(obj, keys) {
for (var key in obj) {
if (obj.hasOwnProperty(key)) {
if (keys.hasOwnProperty(key)) {
if (typeof obj[key] !== keys[key])
throw new Error(format(ERROR.INVALID_TYPE, [typeof obj[key], key]));
} else {
var errorStr = "Unknown property, " + key + ". Valid properties are:";
for (var key in keys)
if (keys.hasOwnProperty(key))
errorStr = errorStr+" "+key;
throw new Error(errorStr);
}
}
}
};
/**
* Return a new function which runs the user function bound
* to a fixed scope.
* @param {function} User function
* @param {object} Function scope
* @return {function} User function bound to another scope
* @private
*/
var scope = function (f, scope) {
return function () {
return f.apply(scope, arguments);
};
};
/**
* Unique message type identifiers, with associated
* associated integer values.
* @private
*/
var ERROR = {
OK: {code:0, text:"AMQJSC0000I OK."},
CONNECT_TIMEOUT: {code:1, text:"AMQJSC0001E Connect timed out."},
SUBSCRIBE_TIMEOUT: {code:2, text:"AMQJS0002E Subscribe timed out."},
UNSUBSCRIBE_TIMEOUT: {code:3, text:"AMQJS0003E Unsubscribe timed out."},
PING_TIMEOUT: {code:4, text:"AMQJS0004E Ping timed out."},
INTERNAL_ERROR: {code:5, text:"AMQJS0005E Internal error. Error Message: {0}, Stack trace: {1}"},
CONNACK_RETURNCODE: {code:6, text:"AMQJS0006E Bad Connack return code:{0} {1}."},
SOCKET_ERROR: {code:7, text:"AMQJS0007E Socket error:{0}."},
SOCKET_CLOSE: {code:8, text:"AMQJS0008I Socket closed."},
MALFORMED_UTF: {code:9, text:"AMQJS0009E Malformed UTF data:{0} {1} {2}."},
UNSUPPORTED: {code:10, text:"AMQJS0010E {0} is not supported by this browser."},
INVALID_STATE: {code:11, text:"AMQJS0011E Invalid state {0}."},
INVALID_TYPE: {code:12, text:"AMQJS0012E Invalid type {0} for {1}."},
INVALID_ARGUMENT: {code:13, text:"AMQJS0013E Invalid argument {0} for {1}."},
UNSUPPORTED_OPERATION: {code:14, text:"AMQJS0014E Unsupported operation."},
INVALID_STORED_DATA: {code:15, text:"AMQJS0015E Invalid data in local storage key={0} value={1}."},
INVALID_MQTT_MESSAGE_TYPE: {code:16, text:"AMQJS0016E Invalid MQTT message type {0}."},
MALFORMED_UNICODE: {code:17, text:"AMQJS0017E Malformed Unicode string:{0} {1}."},
};
/** CONNACK RC Meaning. */
var CONNACK_RC = {
0:"Connection Accepted",
1:"Connection Refused: unacceptable protocol version",
2:"Connection Refused: identifier rejected",
3:"Connection Refused: server unavailable",
4:"Connection Refused: bad user name or password",
5:"Connection Refused: not authorized"
};
/**
* Format an error message text.
* @private
* @param {error} ERROR.KEY value above.
* @param {substitutions} [array] substituted into the text.
* @return the text with the substitutions made.
*/
var format = function(error, substitutions) {
var text = error.text;
if (substitutions) {
var field,start;
for (var i=0; i 0) {
var part1 = text.substring(0,start);
var part2 = text.substring(start+field.length);
text = part1+substitutions[i]+part2;
}
}
}
return text;
};
//MQTT protocol and version 6 M Q I s d p 3
var MqttProtoIdentifierv3 = [0x00,0x06,0x4d,0x51,0x49,0x73,0x64,0x70,0x03];
//MQTT proto/version for 311 4 M Q T T 4
var MqttProtoIdentifierv4 = [0x00,0x04,0x4d,0x51,0x54,0x54,0x04];
/**
* Construct an MQTT wire protocol message.
* @param type MQTT packet type.
* @param options optional wire message attributes.
*
* Optional properties
*
* messageIdentifier: message ID in the range [0..65535]
* payloadMessage: Application Message - PUBLISH only
* connectStrings: array of 0 or more Strings to be put into the CONNECT payload
* topics: array of strings (SUBSCRIBE, UNSUBSCRIBE)
* requestQoS: array of QoS values [0..2]
*
* "Flag" properties
* cleanSession: true if present / false if absent (CONNECT)
* willMessage: true if present / false if absent (CONNECT)
* isRetained: true if present / false if absent (CONNECT)
* userName: true if present / false if absent (CONNECT)
* password: true if present / false if absent (CONNECT)
* keepAliveInterval: integer [0..65535] (CONNECT)
*
* @private
* @ignore
*/
var WireMessage = function (type, options) {
this.type = type;
for (var name in options) {
if (options.hasOwnProperty(name)) {
this[name] = options[name];
}
}
};
WireMessage.prototype.encode = function() {
// Compute the first byte of the fixed header
var first = ((this.type & 0x0f) << 4);
/*
* Now calculate the length of the variable header + payload by adding up the lengths
* of all the component parts
*/
var remLength = 0;
var topicStrLength = new Array();
var destinationNameLength = 0;
// if the message contains a messageIdentifier then we need two bytes for that
if (this.messageIdentifier != undefined)
remLength += 2;
switch(this.type) {
// If this a Connect then we need to include 12 bytes for its header
case MESSAGE_TYPE.CONNECT:
switch(this.mqttVersion) {
case 3:
remLength += MqttProtoIdentifierv3.length + 3;
break;
case 4:
remLength += MqttProtoIdentifierv4.length + 3;
break;
}
remLength += UTF8Length(this.clientId) + 2;
if (this.willMessage != undefined) {
remLength += UTF8Length(this.willMessage.destinationName) + 2;
// Will message is always a string, sent as UTF-8 characters with a preceding length.
var willMessagePayloadBytes = this.willMessage.payloadBytes;
if (!(willMessagePayloadBytes instanceof Uint8Array))
willMessagePayloadBytes = new Uint8Array(payloadBytes);
remLength += willMessagePayloadBytes.byteLength +2;
}
if (this.userName != undefined)
remLength += UTF8Length(this.userName) + 2;
if (this.password != undefined)
remLength += UTF8Length(this.password) + 2;
break;
// Subscribe, Unsubscribe can both contain topic strings
case MESSAGE_TYPE.SUBSCRIBE:
first |= 0x02; // Qos = 1;
for ( var i = 0; i < this.topics.length; i++) {
topicStrLength[i] = UTF8Length(this.topics[i]);
remLength += topicStrLength[i] + 2;
}
remLength += this.requestedQos.length; // 1 byte for each topic's Qos
// QoS on Subscribe only
break;
case MESSAGE_TYPE.UNSUBSCRIBE:
first |= 0x02; // Qos = 1;
for ( var i = 0; i < this.topics.length; i++) {
topicStrLength[i] = UTF8Length(this.topics[i]);
remLength += topicStrLength[i] + 2;
}
break;
case MESSAGE_TYPE.PUBREL:
first |= 0x02; // Qos = 1;
break;
case MESSAGE_TYPE.PUBLISH:
if (this.payloadMessage.duplicate) first |= 0x08;
first = first |= (this.payloadMessage.qos << 1);
if (this.payloadMessage.retained) first |= 0x01;
destinationNameLength = UTF8Length(this.payloadMessage.destinationName);
remLength += destinationNameLength + 2;
var payloadBytes = this.payloadMessage.payloadBytes;
remLength += payloadBytes.byteLength;
if (payloadBytes instanceof ArrayBuffer)
payloadBytes = new Uint8Array(payloadBytes);
else if (!(payloadBytes instanceof Uint8Array))
payloadBytes = new Uint8Array(payloadBytes.buffer);
break;
case MESSAGE_TYPE.DISCONNECT:
break;
default:
;
}
// Now we can allocate a buffer for the message
var mbi = encodeMBI(remLength); // Convert the length to MQTT MBI format
var pos = mbi.length + 1; // Offset of start of variable header
var buffer = new ArrayBuffer(remLength + pos);
var byteStream = new Uint8Array(buffer); // view it as a sequence of bytes
//Write the fixed header into the buffer
byteStream[0] = first;
byteStream.set(mbi,1);
// If this is a PUBLISH then the variable header starts with a topic
if (this.type == MESSAGE_TYPE.PUBLISH)
pos = writeString(this.payloadMessage.destinationName, destinationNameLength, byteStream, pos);
// If this is a CONNECT then the variable header contains the protocol name/version, flags and keepalive time
else if (this.type == MESSAGE_TYPE.CONNECT) {
switch (this.mqttVersion) {
case 3:
byteStream.set(MqttProtoIdentifierv3, pos);
pos += MqttProtoIdentifierv3.length;
break;
case 4:
byteStream.set(MqttProtoIdentifierv4, pos);
pos += MqttProtoIdentifierv4.length;
break;
}
var connectFlags = 0;
if (this.cleanSession)
connectFlags = 0x02;
if (this.willMessage != undefined ) {
connectFlags |= 0x04;
connectFlags |= (this.willMessage.qos<<3);
if (this.willMessage.retained) {
connectFlags |= 0x20;
}
}
if (this.userName != undefined)
connectFlags |= 0x80;
if (this.password != undefined)
connectFlags |= 0x40;
byteStream[pos++] = connectFlags;
pos = writeUint16 (this.keepAliveInterval, byteStream, pos);
}
// Output the messageIdentifier - if there is one
if (this.messageIdentifier != undefined)
pos = writeUint16 (this.messageIdentifier, byteStream, pos);
switch(this.type) {
case MESSAGE_TYPE.CONNECT:
pos = writeString(this.clientId, UTF8Length(this.clientId), byteStream, pos);
if (this.willMessage != undefined) {
pos = writeString(this.willMessage.destinationName, UTF8Length(this.willMessage.destinationName), byteStream, pos);
pos = writeUint16(willMessagePayloadBytes.byteLength, byteStream, pos);
byteStream.set(willMessagePayloadBytes, pos);
pos += willMessagePayloadBytes.byteLength;
}
if (this.userName != undefined)
pos = writeString(this.userName, UTF8Length(this.userName), byteStream, pos);
if (this.password != undefined)
pos = writeString(this.password, UTF8Length(this.password), byteStream, pos);
break;
case MESSAGE_TYPE.PUBLISH:
// PUBLISH has a text or binary payload, if text do not add a 2 byte length field, just the UTF characters.
byteStream.set(payloadBytes, pos);
break;
// case MESSAGE_TYPE.PUBREC:
// case MESSAGE_TYPE.PUBREL:
// case MESSAGE_TYPE.PUBCOMP:
// break;
case MESSAGE_TYPE.SUBSCRIBE:
// SUBSCRIBE has a list of topic strings and request QoS
for (var i=0; i> 4;
var messageInfo = first &= 0x0f;
pos += 1;
// Decode the remaining length (MBI format)
var digit;
var remLength = 0;
var multiplier = 1;
do {
if (pos == input.length) {
return [null,startingPos];
}
digit = input[pos++];
remLength += ((digit & 0x7F) * multiplier);
multiplier *= 128;
} while ((digit & 0x80) != 0);
var endPos = pos+remLength;
if (endPos > input.length) {
return [null,startingPos];
}
var wireMessage = new WireMessage(type);
switch(type) {
case MESSAGE_TYPE.CONNACK:
var connectAcknowledgeFlags = input[pos++];
if (connectAcknowledgeFlags & 0x01)
wireMessage.sessionPresent = true;
wireMessage.returnCode = input[pos++];
break;
case MESSAGE_TYPE.PUBLISH:
var qos = (messageInfo >> 1) & 0x03;
var len = readUint16(input, pos);
pos += 2;
var topicName = parseUTF8(input, pos, len);
pos += len;
// If QoS 1 or 2 there will be a messageIdentifier
if (qos > 0) {
wireMessage.messageIdentifier = readUint16(input, pos);
pos += 2;
}
var message = new Paho.MQTT.Message(input.subarray(pos, endPos));
if ((messageInfo & 0x01) == 0x01)
message.retained = true;
if ((messageInfo & 0x08) == 0x08)
message.duplicate = true;
message.qos = qos;
message.destinationName = topicName;
wireMessage.payloadMessage = message;
break;
case MESSAGE_TYPE.PUBACK:
case MESSAGE_TYPE.PUBREC:
case MESSAGE_TYPE.PUBREL:
case MESSAGE_TYPE.PUBCOMP:
case MESSAGE_TYPE.UNSUBACK:
wireMessage.messageIdentifier = readUint16(input, pos);
break;
case MESSAGE_TYPE.SUBACK:
wireMessage.messageIdentifier = readUint16(input, pos);
pos += 2;
wireMessage.returnCode = input.subarray(pos, endPos);
break;
default:
;
}
return [wireMessage,endPos];
}
function writeUint16(input, buffer, offset) {
buffer[offset++] = input >> 8; //MSB
buffer[offset++] = input % 256; //LSB
return offset;
}
function writeString(input, utf8Length, buffer, offset) {
offset = writeUint16(utf8Length, buffer, offset);
stringToUTF8(input, buffer, offset);
return offset + utf8Length;
}
function readUint16(buffer, offset) {
return 256*buffer[offset] + buffer[offset+1];
}
/**
* Encodes an MQTT Multi-Byte Integer
* @private
*/
function encodeMBI(number) {
var output = new Array(1);
var numBytes = 0;
do {
var digit = number % 128;
number = number >> 7;
if (number > 0) {
digit |= 0x80;
}
output[numBytes++] = digit;
} while ( (number > 0) && (numBytes<4) );
return output;
}
/**
* Takes a String and calculates its length in bytes when encoded in UTF8.
* @private
*/
function UTF8Length(input) {
var output = 0;
for (var i = 0; i 0x7FF)
{
// Surrogate pair means its a 4 byte character
if (0xD800 <= charCode && charCode <= 0xDBFF)
{
i++;
output++;
}
output +=3;
}
else if (charCode > 0x7F)
output +=2;
else
output++;
}
return output;
}
/**
* Takes a String and writes it into an array as UTF8 encoded bytes.
* @private
*/
function stringToUTF8(input, output, start) {
var pos = start;
for (var i = 0; i>6 & 0x1F | 0xC0;
output[pos++] = charCode & 0x3F | 0x80;
} else if (charCode <= 0xFFFF) {
output[pos++] = charCode>>12 & 0x0F | 0xE0;
output[pos++] = charCode>>6 & 0x3F | 0x80;
output[pos++] = charCode & 0x3F | 0x80;
} else {
output[pos++] = charCode>>18 & 0x07 | 0xF0;
output[pos++] = charCode>>12 & 0x3F | 0x80;
output[pos++] = charCode>>6 & 0x3F | 0x80;
output[pos++] = charCode & 0x3F | 0x80;
};
}
return output;
}
function parseUTF8(input, offset, length) {
var output = "";
var utf16;
var pos = offset;
while (pos < offset+length)
{
var byte1 = input[pos++];
if (byte1 < 128)
utf16 = byte1;
else
{
var byte2 = input[pos++]-128;
if (byte2 < 0)
throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16),""]));
if (byte1 < 0xE0) // 2 byte character
utf16 = 64*(byte1-0xC0) + byte2;
else
{
var byte3 = input[pos++]-128;
if (byte3 < 0)
throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16)]));
if (byte1 < 0xF0) // 3 byte character
utf16 = 4096*(byte1-0xE0) + 64*byte2 + byte3;
else
{
var byte4 = input[pos++]-128;
if (byte4 < 0)
throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
if (byte1 < 0xF8) // 4 byte character
utf16 = 262144*(byte1-0xF0) + 4096*byte2 + 64*byte3 + byte4;
else // longer encodings are not supported
throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
}
}
}
if (utf16 > 0xFFFF) // 4 byte character - express as a surrogate pair
{
utf16 -= 0x10000;
output += String.fromCharCode(0xD800 + (utf16 >> 10)); // lead character
utf16 = 0xDC00 + (utf16 & 0x3FF); // trail character
}
output += String.fromCharCode(utf16);
}
return output;
}
/**
* Repeat keepalive requests, monitor responses.
* @ignore
*/
var Pinger = function(client, window, keepAliveInterval) {
this._client = client;
this._window = window;
this._keepAliveInterval = keepAliveInterval*1000;
this.isReset = false;
var pingReq = new WireMessage(MESSAGE_TYPE.PINGREQ).encode();
var doTimeout = function (pinger) {
return function () {
return doPing.apply(pinger);
};
};
/** @ignore */
var doPing = function() {
if (!this.isReset) {
this._client._trace("Pinger.doPing", "Timed out");
this._client._disconnected( ERROR.PING_TIMEOUT.code , format(ERROR.PING_TIMEOUT));
} else {
this.isReset = false;
this._client._trace("Pinger.doPing", "send PINGREQ");
this._client.socket.send(pingReq);
this.timeout = this._window.setTimeout(doTimeout(this), this._keepAliveInterval);
}
}
this.reset = function() {
this.isReset = true;
this._window.clearTimeout(this.timeout);
if (this._keepAliveInterval > 0)
this.timeout = setTimeout(doTimeout(this), this._keepAliveInterval);
}
this.cancel = function() {
this._window.clearTimeout(this.timeout);
}
};
/**
* Monitor request completion.
* @ignore
*/
var Timeout = function(client, window, timeoutSeconds, action, args) {
this._window = window;
if (!timeoutSeconds)
timeoutSeconds = 30;
var doTimeout = function (action, client, args) {
return function () {
return action.apply(client, args);
};
};
this.timeout = setTimeout(doTimeout(action, client, args), timeoutSeconds * 1000);
this.cancel = function() {
this._window.clearTimeout(this.timeout);
}
};
/*
* Internal implementation of the Websockets MQTT V3.1 client.
*
* @name Paho.MQTT.ClientImpl @constructor
* @param {String} host the DNS nameof the webSocket host.
* @param {Number} port the port number for that host.
* @param {String} clientId the MQ client identifier.
*/
var ClientImpl = function (uri, host, port, path, clientId) {
// Check dependencies are satisfied in this browser.
if (!("WebSocket" in global && global["WebSocket"] !== null)) {
throw new Error(format(ERROR.UNSUPPORTED, ["WebSocket"]));
}
if (!("localStorage" in global && global["localStorage"] !== null)) {
throw new Error(format(ERROR.UNSUPPORTED, ["localStorage"]));
}
if (!("ArrayBuffer" in global && global["ArrayBuffer"] !== null)) {
throw new Error(format(ERROR.UNSUPPORTED, ["ArrayBuffer"]));
}
this._trace("Paho.MQTT.Client", uri, host, port, path, clientId);
this.host = host;
this.port = port;
this.path = path;
this.uri = uri;
this.clientId = clientId;
// Local storagekeys are qualified with the following string.
// The conditional inclusion of path in the key is for backward
// compatibility to when the path was not configurable and assumed to
// be /mqtt
this._localKey=host+":"+port+(path!="/mqtt"?":"+path:"")+":"+clientId+":";
// Create private instance-only message queue
// Internal queue of messages to be sent, in sending order.
this._msg_queue = [];
// Messages we have sent and are expecting a response for, indexed by their respective message ids.
this._sentMessages = {};
// Messages we have received and acknowleged and are expecting a confirm message for
// indexed by their respective message ids.
this._receivedMessages = {};
// Internal list of callbacks to be executed when messages
// have been successfully sent over web socket, e.g. disconnect
// when it doesn't have to wait for ACK, just message is dispatched.
this._notify_msg_sent = {};
// Unique identifier for SEND messages, incrementing
// counter as messages are sent.
this._message_identifier = 1;
// Used to determine the transmission sequence of stored sent messages.
this._sequence = 0;
// Load the local state, if any, from the saved version, only restore state relevant to this client.
for (var key in localStorage)
if ( key.indexOf("Sent:"+this._localKey) == 0
|| key.indexOf("Received:"+this._localKey) == 0)
this.restore(key);
};
// Messaging Client public instance members.
ClientImpl.prototype.host;
ClientImpl.prototype.port;
ClientImpl.prototype.path;
ClientImpl.prototype.uri;
ClientImpl.prototype.clientId;
// Messaging Client private instance members.
ClientImpl.prototype.socket;
/* true once we have received an acknowledgement to a CONNECT packet. */
ClientImpl.prototype.connected = false;
/* The largest message identifier allowed, may not be larger than 2**16 but
* if set smaller reduces the maximum number of outbound messages allowed.
*/
ClientImpl.prototype.maxMessageIdentifier = 65536;
ClientImpl.prototype.connectOptions;
ClientImpl.prototype.hostIndex;
ClientImpl.prototype.onConnectionLost;
ClientImpl.prototype.onMessageDelivered;
ClientImpl.prototype.onMessageArrived;
ClientImpl.prototype.traceFunction;
ClientImpl.prototype._msg_queue = null;
ClientImpl.prototype._connectTimeout;
/* The sendPinger monitors how long we allow before we send data to prove to the server that we are alive. */
ClientImpl.prototype.sendPinger = null;
/* The receivePinger monitors how long we allow before we require evidence that the server is alive. */
ClientImpl.prototype.receivePinger = null;
ClientImpl.prototype.receiveBuffer = null;
ClientImpl.prototype._traceBuffer = null;
ClientImpl.prototype._MAX_TRACE_ENTRIES = 100;
ClientImpl.prototype.connect = function (connectOptions) {
var connectOptionsMasked = this._traceMask(connectOptions, "password");
this._trace("Client.connect", connectOptionsMasked, this.socket, this.connected);
if (this.connected)
throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
if (this.socket)
throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
this.connectOptions = connectOptions;
if (connectOptions.uris) {
this.hostIndex = 0;
this._doConnect(connectOptions.uris[0]);
} else {
this._doConnect(this.uri);
}
};
ClientImpl.prototype.subscribe = function (filter, subscribeOptions) {
this._trace("Client.subscribe", filter, subscribeOptions);
if (!this.connected)
throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
var wireMessage = new WireMessage(MESSAGE_TYPE.SUBSCRIBE);
wireMessage.topics=[filter];
if (subscribeOptions.qos != undefined)
wireMessage.requestedQos = [subscribeOptions.qos];
else
wireMessage.requestedQos = [0];
if (subscribeOptions.onSuccess) {
wireMessage.onSuccess = function(grantedQos) {subscribeOptions.onSuccess({invocationContext:subscribeOptions.invocationContext,grantedQos:grantedQos});};
}
if (subscribeOptions.onFailure) {
wireMessage.onFailure = function(errorCode) {subscribeOptions.onFailure({invocationContext:subscribeOptions.invocationContext,errorCode:errorCode});};
}
if (subscribeOptions.timeout) {
wireMessage.timeOut = new Timeout(this, window, subscribeOptions.timeout, subscribeOptions.onFailure
, [{invocationContext:subscribeOptions.invocationContext,
errorCode:ERROR.SUBSCRIBE_TIMEOUT.code,
errorMessage:format(ERROR.SUBSCRIBE_TIMEOUT)}]);
}
// All subscriptions return a SUBACK.
this._requires_ack(wireMessage);
this._schedule_message(wireMessage);
};
/** @ignore */
ClientImpl.prototype.unsubscribe = function(filter, unsubscribeOptions) {
this._trace("Client.unsubscribe", filter, unsubscribeOptions);
if (!this.connected)
throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
var wireMessage = new WireMessage(MESSAGE_TYPE.UNSUBSCRIBE);
wireMessage.topics = [filter];
if (unsubscribeOptions.onSuccess) {
wireMessage.callback = function() {unsubscribeOptions.onSuccess({invocationContext:unsubscribeOptions.invocationContext});};
}
if (unsubscribeOptions.timeout) {
wireMessage.timeOut = new Timeout(this, window, unsubscribeOptions.timeout, unsubscribeOptions.onFailure
, [{invocationContext:unsubscribeOptions.invocationContext,
errorCode:ERROR.UNSUBSCRIBE_TIMEOUT.code,
errorMessage:format(ERROR.UNSUBSCRIBE_TIMEOUT)}]);
}
// All unsubscribes return a SUBACK.
this._requires_ack(wireMessage);
this._schedule_message(wireMessage);
};
ClientImpl.prototype.send = function (message) {
this._trace("Client.send", message);
if (!this.connected)
throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
wireMessage = new WireMessage(MESSAGE_TYPE.PUBLISH);
wireMessage.payloadMessage = message;
if (message.qos > 0)
this._requires_ack(wireMessage);
else if (this.onMessageDelivered)
this._notify_msg_sent[wireMessage] = this.onMessageDelivered(wireMessage.payloadMessage);
this._schedule_message(wireMessage);
};
ClientImpl.prototype.disconnect = function () {
this._trace("Client.disconnect");
if (!this.socket)
throw new Error(format(ERROR.INVALID_STATE, ["not connecting or connected"]));
wireMessage = new WireMessage(MESSAGE_TYPE.DISCONNECT);
// Run the disconnected call back as soon as the message has been sent,
// in case of a failure later on in the disconnect processing.
// as a consequence, the _disconected call back may be run several times.
this._notify_msg_sent[wireMessage] = scope(this._disconnected, this);
this._schedule_message(wireMessage);
};
ClientImpl.prototype.getTraceLog = function () {
if ( this._traceBuffer !== null ) {
this._trace("Client.getTraceLog", new Date());
this._trace("Client.getTraceLog in flight messages", this._sentMessages.length);
for (var key in this._sentMessages)
this._trace("_sentMessages ",key, this._sentMessages[key]);
for (var key in this._receivedMessages)
this._trace("_receivedMessages ",key, this._receivedMessages[key]);
return this._traceBuffer;
}
};
ClientImpl.prototype.startTrace = function () {
if ( this._traceBuffer === null ) {
this._traceBuffer = [];
}
this._trace("Client.startTrace", new Date(), version);
};
ClientImpl.prototype.stopTrace = function () {
delete this._traceBuffer;
};
ClientImpl.prototype._doConnect = function (wsurl) {
// When the socket is open, this client will send the CONNECT WireMessage using the saved parameters.
if (this.connectOptions.useSSL) {
var uriParts = wsurl.split(":");
uriParts[0] = "wss";
wsurl = uriParts.join(":");
}
this.connected = false;
if (this.connectOptions.mqttVersion < 4) {
this.socket = new WebSocket(wsurl, ["mqttv3.1"]);
} else {
this.socket = new WebSocket(wsurl, ["mqtt"]);
}
this.socket.binaryType = 'arraybuffer';
this.socket.onopen = scope(this._on_socket_open, this);
this.socket.onmessage = scope(this._on_socket_message, this);
this.socket.onerror = scope(this._on_socket_error, this);
this.socket.onclose = scope(this._on_socket_close, this);
this.sendPinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
this.receivePinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
this._connectTimeout = new Timeout(this, window, this.connectOptions.timeout, this._disconnected, [ERROR.CONNECT_TIMEOUT.code, format(ERROR.CONNECT_TIMEOUT)]);
};
// Schedule a new message to be sent over the WebSockets
// connection. CONNECT messages cause WebSocket connection
// to be started. All other messages are queued internally
// until this has happened. When WS connection starts, process
// all outstanding messages.
ClientImpl.prototype._schedule_message = function (message) {
this._msg_queue.push(message);
// Process outstanding messages in the queue if we have an open socket, and have received CONNACK.
if (this.connected) {
this._process_queue();
}
};
ClientImpl.prototype.store = function(prefix, wireMessage) {
var storedMessage = {type:wireMessage.type, messageIdentifier:wireMessage.messageIdentifier, version:1};
switch(wireMessage.type) {
case MESSAGE_TYPE.PUBLISH:
if(wireMessage.pubRecReceived)
storedMessage.pubRecReceived = true;
// Convert the payload to a hex string.
storedMessage.payloadMessage = {};
var hex = "";
var messageBytes = wireMessage.payloadMessage.payloadBytes;
for (var i=0; i= 2) {
var x = parseInt(hex.substring(0, 2), 16);
hex = hex.substring(2, hex.length);
byteStream[i++] = x;
}
var payloadMessage = new Paho.MQTT.Message(byteStream);
payloadMessage.qos = storedMessage.payloadMessage.qos;
payloadMessage.destinationName = storedMessage.payloadMessage.destinationName;
if (storedMessage.payloadMessage.duplicate)
payloadMessage.duplicate = true;
if (storedMessage.payloadMessage.retained)
payloadMessage.retained = true;
wireMessage.payloadMessage = payloadMessage;
break;
default:
throw Error(format(ERROR.INVALID_STORED_DATA, [key, value]));
}
if (key.indexOf("Sent:"+this._localKey) == 0) {
wireMessage.payloadMessage.duplicate = true;
this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
} else if (key.indexOf("Received:"+this._localKey) == 0) {
this._receivedMessages[wireMessage.messageIdentifier] = wireMessage;
}
};
ClientImpl.prototype._process_queue = function () {
var message = null;
// Process messages in order they were added
var fifo = this._msg_queue.reverse();
// Send all queued messages down socket connection
while ((message = fifo.pop())) {
this._socket_send(message);
// Notify listeners that message was successfully sent
if (this._notify_msg_sent[message]) {
this._notify_msg_sent[message]();
delete this._notify_msg_sent[message];
}
}
};
/**
* Expect an ACK response for this message. Add message to the set of in progress
* messages and set an unused identifier in this message.
* @ignore
*/
ClientImpl.prototype._requires_ack = function (wireMessage) {
var messageCount = Object.keys(this._sentMessages).length;
if (messageCount > this.maxMessageIdentifier)
throw Error ("Too many messages:"+messageCount);
while(this._sentMessages[this._message_identifier] !== undefined) {
this._message_identifier++;
}
wireMessage.messageIdentifier = this._message_identifier;
this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
if (wireMessage.type === MESSAGE_TYPE.PUBLISH) {
this.store("Sent:", wireMessage);
}
if (this._message_identifier === this.maxMessageIdentifier) {
this._message_identifier = 1;
}
};
/**
* Called when the underlying websocket has been opened.
* @ignore
*/
ClientImpl.prototype._on_socket_open = function () {
// Create the CONNECT message object.
var wireMessage = new WireMessage(MESSAGE_TYPE.CONNECT, this.connectOptions);
wireMessage.clientId = this.clientId;
this._socket_send(wireMessage);
};
/**
* Called when the underlying websocket has received a complete packet.
* @ignore
*/
ClientImpl.prototype._on_socket_message = function (event) {
this._trace("Client._on_socket_message", event.data);
// Reset the receive ping timer, we now have evidence the server is alive.
this.receivePinger.reset();
var messages = this._deframeMessages(event.data);
for (var i = 0; i < messages.length; i+=1) {
this._handleMessage(messages[i]);
}
}
ClientImpl.prototype._deframeMessages = function(data) {
var byteArray = new Uint8Array(data);
if (this.receiveBuffer) {
var newData = new Uint8Array(this.receiveBuffer.length+byteArray.length);
newData.set(this.receiveBuffer);
newData.set(byteArray,this.receiveBuffer.length);
byteArray = newData;
delete this.receiveBuffer;
}
try {
var offset = 0;
var messages = [];
while(offset < byteArray.length) {
var result = decodeMessage(byteArray,offset);
var wireMessage = result[0];
offset = result[1];
if (wireMessage !== null) {
messages.push(wireMessage);
} else {
break;
}
}
if (offset < byteArray.length) {
this.receiveBuffer = byteArray.subarray(offset);
}
} catch (error) {
this._disconnected(ERROR.INTERNAL_ERROR.code , format(ERROR.INTERNAL_ERROR, [error.message,error.stack.toString()]));
return;
}
return messages;
}
ClientImpl.prototype._handleMessage = function(wireMessage) {
this._trace("Client._handleMessage", wireMessage);
try {
switch(wireMessage.type) {
case MESSAGE_TYPE.CONNACK:
this._connectTimeout.cancel();
// If we have started using clean session then clear up the local state.
if (this.connectOptions.cleanSession) {
for (var key in this._sentMessages) {
var sentMessage = this._sentMessages[key];
localStorage.removeItem("Sent:"+this._localKey+sentMessage.messageIdentifier);
}
this._sentMessages = {};
for (var key in this._receivedMessages) {
var receivedMessage = this._receivedMessages[key];
localStorage.removeItem("Received:"+this._localKey+receivedMessage.messageIdentifier);
}
this._receivedMessages = {};
}
// Client connected and ready for business.
if (wireMessage.returnCode === 0) {
this.connected = true;
// Jump to the end of the list of uris and stop looking for a good host.
if (this.connectOptions.uris)
this.hostIndex = this.connectOptions.uris.length;
} else {
this._disconnected(ERROR.CONNACK_RETURNCODE.code , format(ERROR.CONNACK_RETURNCODE, [wireMessage.returnCode, CONNACK_RC[wireMessage.returnCode]]));
break;
}
// Resend messages.
var sequencedMessages = new Array();
for (var msgId in this._sentMessages) {
if (this._sentMessages.hasOwnProperty(msgId))
sequencedMessages.push(this._sentMessages[msgId]);
}
// Sort sentMessages into the original sent order.
var sequencedMessages = sequencedMessages.sort(function(a,b) {return a.sequence - b.sequence;} );
for (var i=0, len=sequencedMessages.length; i
* Most applications will create just one Client object and then call its connect() method,
* however applications can create more than one Client object if they wish.
* In this case the combination of host, port and clientId attributes must be different for each Client object.
*
* The send, subscribe and unsubscribe methods are implemented as asynchronous JavaScript methods
* (even though the underlying protocol exchange might be synchronous in nature).
* This means they signal their completion by calling back to the application,
* via Success or Failure callback functions provided by the application on the method in question.
* Such callbacks are called at most once per method invocation and do not persist beyond the lifetime
* of the script that made the invocation.
*
* In contrast there are some callback functions, most notably onMessageArrived,
* that are defined on the {@link Paho.MQTT.Client} object.
* These may get called multiple times, and aren't directly related to specific method invocations made by the client.
*
* @name Paho.MQTT.Client
*
* @constructor
*
* @param {string} host - the address of the messaging server, as a fully qualified WebSocket URI, as a DNS name or dotted decimal IP address.
* @param {number} port - the port number to connect to - only required if host is not a URI
* @param {string} path - the path on the host to connect to - only used if host is not a URI. Default: '/mqtt'.
* @param {string} clientId - the Messaging client identifier, between 1 and 23 characters in length.
*
* @property {string} host - read only the server's DNS hostname or dotted decimal IP address.
* @property {number} port - read only the server's port.
* @property {string} path - read only the server's path.
* @property {string} clientId - read only used when connecting to the server.
* @property {function} onConnectionLost - called when a connection has been lost.
* after a connect() method has succeeded.
* Establish the call back used when a connection has been lost. The connection may be
* lost because the client initiates a disconnect or because the server or transfer
* cause the client to be disconnected. The disconnect call back may be called without
* the connectionComplete call back being invoked if, for example the client fails to
* connect.
* A single response object parameter is passed to the onConnectionLost callback containing the following fields:
*
*
errorCode
*
errorMessage
*
* @property {function} onMessageDelivered called when a message has been delivered.
* All processing that this Client will ever do has been completed. So, for example,
* in the case of a Qos=2 message sent by this client, the PubComp flow has been received from the server
* and the message has been removed from persistent storage before this callback is invoked.
* Parameters passed to the onMessageDelivered callback are:
*
*
{@link Paho.MQTT.Message} that was delivered.
*
* @property {function} onMessageArrived called when a message has arrived in this Paho.MQTT.client.
* Parameters passed to the onMessageArrived callback are:
*
*
{@link Paho.MQTT.Message} that has arrived.
*
*/
var Client = function (host, port, path, clientId) {
var uri;
if (typeof host !== "string")
throw new Error(format(ERROR.INVALID_TYPE, [typeof host, "host"]));
if (arguments.length == 2) {
// host: must be full ws:// uri
// port: clientId
clientId = port;
uri = host;
var match = uri.match(/^(wss?):\/\/((\[(.+)\])|([^\/]+?))(:(\d+))?(\/.*)$/);
if (match) {
host = match[4]||match[2];
port = parseInt(match[7]);
path = match[8];
} else {
throw new Error(format(ERROR.INVALID_ARGUMENT,[host,"host"]));
}
} else {
if (arguments.length == 3) {
clientId = path;
path = "/mqtt";
}
if (typeof port !== "number" || port < 0)
throw new Error(format(ERROR.INVALID_TYPE, [typeof port, "port"]));
if (typeof path !== "string")
throw new Error(format(ERROR.INVALID_TYPE, [typeof path, "path"]));
var ipv6AddSBracket = (host.indexOf(":") != -1 && host.slice(0,1) != "[" && host.slice(-1) != "]");
uri = "ws://"+(ipv6AddSBracket?"["+host+"]":host)+":"+port+path;
}
var clientIdLength = 0;
for (var i = 0; i 65535)
throw new Error(format(ERROR.INVALID_ARGUMENT, [clientId, "clientId"]));
var client = new ClientImpl(uri, host, port, path, clientId);
this._getHost = function() { return host; };
this._setHost = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
this._getPort = function() { return port; };
this._setPort = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
this._getPath = function() { return path; };
this._setPath = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
this._getURI = function() { return uri; };
this._setURI = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
this._getClientId = function() { return client.clientId; };
this._setClientId = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
this._getOnConnectionLost = function() { return client.onConnectionLost; };
this._setOnConnectionLost = function(newOnConnectionLost) {
if (typeof newOnConnectionLost === "function")
client.onConnectionLost = newOnConnectionLost;
else
throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnConnectionLost, "onConnectionLost"]));
};
this._getOnMessageDelivered = function() { return client.onMessageDelivered; };
this._setOnMessageDelivered = function(newOnMessageDelivered) {
if (typeof newOnMessageDelivered === "function")
client.onMessageDelivered = newOnMessageDelivered;
else
throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageDelivered, "onMessageDelivered"]));
};
this._getOnMessageArrived = function() { return client.onMessageArrived; };
this._setOnMessageArrived = function(newOnMessageArrived) {
if (typeof newOnMessageArrived === "function")
client.onMessageArrived = newOnMessageArrived;
else
throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageArrived, "onMessageArrived"]));
};
this._getTrace = function() { return client.traceFunction; };
this._setTrace = function(trace) {
if(typeof trace === "function"){
client.traceFunction = trace;
}else{
throw new Error(format(ERROR.INVALID_TYPE, [typeof trace, "onTrace"]));
}
};
/**
* Connect this Messaging client to its server.
*
* @name Paho.MQTT.Client#connect
* @function
* @param {Object} connectOptions - attributes used with the connection.
* @param {number} connectOptions.timeout - If the connect has not succeeded within this
* number of seconds, it is deemed to have failed.
* The default is 30 seconds.
* @param {string} connectOptions.userName - Authentication username for this connection.
* @param {string} connectOptions.password - Authentication password for this connection.
* @param {Paho.MQTT.Message} connectOptions.willMessage - sent by the server when the client
* disconnects abnormally.
* @param {Number} connectOptions.keepAliveInterval - the server disconnects this client if
* there is no activity for this number of seconds.
* The default value of 60 seconds is assumed if not set.
* @param {boolean} connectOptions.cleanSession - if true(default) the client and server
* persistent state is deleted on successful connect.
* @param {boolean} connectOptions.useSSL - if present and true, use an SSL Websocket connection.
* @param {object} connectOptions.invocationContext - passed to the onSuccess callback or onFailure callback.
* @param {function} connectOptions.onSuccess - called when the connect acknowledgement
* has been received from the server.
* A single response object parameter is passed to the onSuccess callback containing the following fields:
*
*
invocationContext as passed in to the onSuccess method in the connectOptions.
*
* @config {function} [onFailure] called when the connect request has failed or timed out.
* A single response object parameter is passed to the onFailure callback containing the following fields:
*
*
invocationContext as passed in to the onFailure method in the connectOptions.
*
errorCode a number indicating the nature of the error.
*
errorMessage text describing the error.
*
* @config {Array} [hosts] If present this contains either a set of hostnames or fully qualified
* WebSocket URIs (ws://example.com:1883/mqtt), that are tried in order in place
* of the host and port paramater on the construtor. The hosts are tried one at at time in order until
* one of then succeeds.
* @config {Array} [ports] If present the set of ports matching the hosts. If hosts contains URIs, this property
* is not used.
* @throws {InvalidState} if the client is not in disconnected state. The client must have received connectionLost
* or disconnected before calling connect for a second or subsequent time.
*/
this.connect = function (connectOptions) {
connectOptions = connectOptions || {} ;
validate(connectOptions, {timeout:"number",
userName:"string",
password:"string",
willMessage:"object",
keepAliveInterval:"number",
cleanSession:"boolean",
useSSL:"boolean",
invocationContext:"object",
onSuccess:"function",
onFailure:"function",
hosts:"object",
ports:"object",
mqttVersion:"number"});
// If no keep alive interval is set, assume 60 seconds.
if (connectOptions.keepAliveInterval === undefined)
connectOptions.keepAliveInterval = 60;
if (connectOptions.mqttVersion > 4 || connectOptions.mqttVersion < 3) {
throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.mqttVersion, "connectOptions.mqttVersion"]));
}
if (connectOptions.mqttVersion === undefined) {
connectOptions.mqttVersionExplicit = false;
connectOptions.mqttVersion = 4;
} else {
connectOptions.mqttVersionExplicit = true;
}
//Check that if password is set, so is username
if (connectOptions.password === undefined && connectOptions.userName !== undefined)
throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.password, "connectOptions.password"]))
if (connectOptions.willMessage) {
if (!(connectOptions.willMessage instanceof Message))
throw new Error(format(ERROR.INVALID_TYPE, [connectOptions.willMessage, "connectOptions.willMessage"]));
// The will message must have a payload that can be represented as a string.
// Cause the willMessage to throw an exception if this is not the case.
connectOptions.willMessage.stringPayload;
if (typeof connectOptions.willMessage.destinationName === "undefined")
throw new Error(format(ERROR.INVALID_TYPE, [typeof connectOptions.willMessage.destinationName, "connectOptions.willMessage.destinationName"]));
}
if (typeof connectOptions.cleanSession === "undefined")
connectOptions.cleanSession = true;
if (connectOptions.hosts) {
if (!(connectOptions.hosts instanceof Array) )
throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
if (connectOptions.hosts.length <1 )
throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
var usingURIs = false;
for (var i = 0; i
* @param {object} subscribeOptions - used to control the subscription
*
* @param {number} subscribeOptions.qos - the maiximum qos of any publications sent
* as a result of making this subscription.
* @param {object} subscribeOptions.invocationContext - passed to the onSuccess callback
* or onFailure callback.
* @param {function} subscribeOptions.onSuccess - called when the subscribe acknowledgement
* has been received from the server.
* A single response object parameter is passed to the onSuccess callback containing the following fields:
*
*
invocationContext if set in the subscribeOptions.
*
* @param {function} subscribeOptions.onFailure - called when the subscribe request has failed or timed out.
* A single response object parameter is passed to the onFailure callback containing the following fields:
*
*
invocationContext - if set in the subscribeOptions.
*
errorCode - a number indicating the nature of the error.
*
errorMessage - text describing the error.
*
* @param {number} subscribeOptions.timeout - which, if present, determines the number of
* seconds after which the onFailure calback is called.
* The presence of a timeout does not prevent the onSuccess
* callback from being called when the subscribe completes.
* @throws {InvalidState} if the client is not in connected state.
*/
this.subscribe = function (filter, subscribeOptions) {
if (typeof filter !== "string")
throw new Error("Invalid argument:"+filter);
subscribeOptions = subscribeOptions || {} ;
validate(subscribeOptions, {qos:"number",
invocationContext:"object",
onSuccess:"function",
onFailure:"function",
timeout:"number"
});
if (subscribeOptions.timeout && !subscribeOptions.onFailure)
throw new Error("subscribeOptions.timeout specified with no onFailure callback.");
if (typeof subscribeOptions.qos !== "undefined"
&& !(subscribeOptions.qos === 0 || subscribeOptions.qos === 1 || subscribeOptions.qos === 2 ))
throw new Error(format(ERROR.INVALID_ARGUMENT, [subscribeOptions.qos, "subscribeOptions.qos"]));
client.subscribe(filter, subscribeOptions);
};
/**
* Unsubscribe for messages, stop receiving messages sent to destinations described by the filter.
*
* @name Paho.MQTT.Client#unsubscribe
* @function
* @param {string} filter - describing the destinations to receive messages from.
* @param {object} unsubscribeOptions - used to control the subscription
* @param {object} unsubscribeOptions.invocationContext - passed to the onSuccess callback
or onFailure callback.
* @param {function} unsubscribeOptions.onSuccess - called when the unsubscribe acknowledgement has been received from the server.
* A single response object parameter is passed to the
* onSuccess callback containing the following fields:
*
*
invocationContext - if set in the unsubscribeOptions.
*
* @param {function} unsubscribeOptions.onFailure called when the unsubscribe request has failed or timed out.
* A single response object parameter is passed to the onFailure callback containing the following fields:
*
*
invocationContext - if set in the unsubscribeOptions.
*
errorCode - a number indicating the nature of the error.
*
errorMessage - text describing the error.
*
* @param {number} unsubscribeOptions.timeout - which, if present, determines the number of seconds
* after which the onFailure callback is called. The presence of
* a timeout does not prevent the onSuccess callback from being
* called when the unsubscribe completes
* @throws {InvalidState} if the client is not in connected state.
*/
this.unsubscribe = function (filter, unsubscribeOptions) {
if (typeof filter !== "string")
throw new Error("Invalid argument:"+filter);
unsubscribeOptions = unsubscribeOptions || {} ;
validate(unsubscribeOptions, {invocationContext:"object",
onSuccess:"function",
onFailure:"function",
timeout:"number"
});
if (unsubscribeOptions.timeout && !unsubscribeOptions.onFailure)
throw new Error("unsubscribeOptions.timeout specified with no onFailure callback.");
client.unsubscribe(filter, unsubscribeOptions);
};
/**
* Send a message to the consumers of the destination in the Message.
*
* @name Paho.MQTT.Client#send
* @function
* @param {string|Paho.MQTT.Message} topic - mandatory The name of the destination to which the message is to be sent.
* - If it is the only parameter, used as Paho.MQTT.Message object.
* @param {String|ArrayBuffer} payload - The message data to be sent.
* @param {number} qos The Quality of Service used to deliver the message.
*
*
0 Best effort (default).
*
1 At least once.
*
2 Exactly once.
*
* @param {Boolean} retained If true, the message is to be retained by the server and delivered
* to both current and future subscriptions.
* If false the server only delivers the message to current subscribers, this is the default for new Messages.
* A received message has the retained boolean set to true if the message was published
* with the retained boolean set to true
* and the subscrption was made after the message has been published.
* @throws {InvalidState} if the client is not connected.
*/
this.send = function (topic,payload,qos,retained) {
var message ;
if(arguments.length == 0){
throw new Error("Invalid argument."+"length");
}else if(arguments.length == 1) {
if (!(topic instanceof Message) && (typeof topic !== "string"))
throw new Error("Invalid argument:"+ typeof topic);
message = topic;
if (typeof message.destinationName === "undefined")
throw new Error(format(ERROR.INVALID_ARGUMENT,[message.destinationName,"Message.destinationName"]));
client.send(message);
}else {
//parameter checking in Message object
message = new Message(payload);
message.destinationName = topic;
if(arguments.length >= 3)
message.qos = qos;
if(arguments.length >= 4)
message.retained = retained;
client.send(message);
}
};
/**
* Normal disconnect of this Messaging client from its server.
*
* @name Paho.MQTT.Client#disconnect
* @function
* @throws {InvalidState} if the client is already disconnected.
*/
this.disconnect = function () {
client.disconnect();
};
/**
* Get the contents of the trace log.
*
* @name Paho.MQTT.Client#getTraceLog
* @function
* @return {Object[]} tracebuffer containing the time ordered trace records.
*/
this.getTraceLog = function () {
return client.getTraceLog();
}
/**
* Start tracing.
*
* @name Paho.MQTT.Client#startTrace
* @function
*/
this.startTrace = function () {
client.startTrace();
};
/**
* Stop tracing.
*
* @name Paho.MQTT.Client#stopTrace
* @function
*/
this.stopTrace = function () {
client.stopTrace();
};
this.isConnected = function() {
return client.connected;
};
};
Client.prototype = {
get host() { return this._getHost(); },
set host(newHost) { this._setHost(newHost); },
get port() { return this._getPort(); },
set port(newPort) { this._setPort(newPort); },
get path() { return this._getPath(); },
set path(newPath) { this._setPath(newPath); },
get clientId() { return this._getClientId(); },
set clientId(newClientId) { this._setClientId(newClientId); },
get onConnectionLost() { return this._getOnConnectionLost(); },
set onConnectionLost(newOnConnectionLost) { this._setOnConnectionLost(newOnConnectionLost); },
get onMessageDelivered() { return this._getOnMessageDelivered(); },
set onMessageDelivered(newOnMessageDelivered) { this._setOnMessageDelivered(newOnMessageDelivered); },
get onMessageArrived() { return this._getOnMessageArrived(); },
set onMessageArrived(newOnMessageArrived) { this._setOnMessageArrived(newOnMessageArrived); },
get trace() { return this._getTrace(); },
set trace(newTraceFunction) { this._setTrace(newTraceFunction); }
};
/**
* An application message, sent or received.
*
* All attributes may be null, which implies the default values.
*
* @name Paho.MQTT.Message
* @constructor
* @param {String|ArrayBuffer} payload The message data to be sent.
*
* @property {string} payloadString read only The payload as a string if the payload consists of valid UTF-8 characters.
* @property {ArrayBuffer} payloadBytes read only The payload as an ArrayBuffer.
*
* @property {string} destinationName mandatory The name of the destination to which the message is to be sent
* (for messages about to be sent) or the name of the destination from which the message has been received.
* (for messages received by the onMessage function).
*
* @property {number} qos The Quality of Service used to deliver the message.
*
*
0 Best effort (default).
*
1 At least once.
*
2 Exactly once.
*
*
* @property {Boolean} retained If true, the message is to be retained by the server and delivered
* to both current and future subscriptions.
* If false the server only delivers the message to current subscribers, this is the default for new Messages.
* A received message has the retained boolean set to true if the message was published
* with the retained boolean set to true
* and the subscrption was made after the message has been published.
*
* @property {Boolean} duplicate read only If true, this message might be a duplicate of one which has already been received.
* This is only set on messages received from the server.
*
*/
var Message = function (newPayload) {
var payload;
if ( typeof newPayload === "string"
|| newPayload instanceof ArrayBuffer
|| newPayload instanceof Int8Array
|| newPayload instanceof Uint8Array
|| newPayload instanceof Int16Array
|| newPayload instanceof Uint16Array
|| newPayload instanceof Int32Array
|| newPayload instanceof Uint32Array
|| newPayload instanceof Float32Array
|| newPayload instanceof Float64Array
) {
payload = newPayload;
} else {
throw (format(ERROR.INVALID_ARGUMENT, [newPayload, "newPayload"]));
}
this._getPayloadString = function () {
if (typeof payload === "string")
return payload;
else
return parseUTF8(payload, 0, payload.length);
};
this._getPayloadBytes = function() {
if (typeof payload === "string") {
var buffer = new ArrayBuffer(UTF8Length(payload));
var byteStream = new Uint8Array(buffer);
stringToUTF8(payload, byteStream, 0);
return byteStream;
} else {
return payload;
};
};
var destinationName = undefined;
this._getDestinationName = function() { return destinationName; };
this._setDestinationName = function(newDestinationName) {
if (typeof newDestinationName === "string")
destinationName = newDestinationName;
else
throw new Error(format(ERROR.INVALID_ARGUMENT, [newDestinationName, "newDestinationName"]));
};
var qos = 0;
this._getQos = function() { return qos; };
this._setQos = function(newQos) {
if (newQos === 0 || newQos === 1 || newQos === 2 )
qos = newQos;
else
throw new Error("Invalid argument:"+newQos);
};
var retained = false;
this._getRetained = function() { return retained; };
this._setRetained = function(newRetained) {
if (typeof newRetained === "boolean")
retained = newRetained;
else
throw new Error(format(ERROR.INVALID_ARGUMENT, [newRetained, "newRetained"]));
};
var duplicate = false;
this._getDuplicate = function() { return duplicate; };
this._setDuplicate = function(newDuplicate) { duplicate = newDuplicate; };
};
Message.prototype = {
get payloadString() { return this._getPayloadString(); },
get payloadBytes() { return this._getPayloadBytes(); },
get destinationName() { return this._getDestinationName(); },
set destinationName(newDestinationName) { this._setDestinationName(newDestinationName); },
get qos() { return this._getQos(); },
set qos(newQos) { this._setQos(newQos); },
get retained() { return this._getRetained(); },
set retained(newRetained) { this._setRetained(newRetained); },
get duplicate() { return this._getDuplicate(); },
set duplicate(newDuplicate) { this._setDuplicate(newDuplicate); }
};
// Module contents.
return {
Client: Client,
Message: Message
};
})(window);
================================================
FILE: jmqtt-example/src/main/java/org/jmqtt/websocket/webSocket.html
================================================
webSocket test
Test WebSocket function
server ip:
webSocket port:
clientId:
Pub Topic:
Message:
Sub Topic:
================================================
FILE: jmqtt-manager
================================================
================================================
FILE: jmqtt-mqtt/README.md
================================================
Support mqtt gateway
================================================
FILE: jmqtt-mqtt/pom.xml
================================================
jmqttorg.jmqtt3.0.04.0.0jmqtt-mqttjarjmqtt-mqttorg.jmqttjmqtt-busio.nettynetty-allorg.apache.logging.log4jlog4j-apiorg.apache.logging.log4jlog4j-core
================================================
FILE: jmqtt-mqtt/src/main/java/org/jmqtt/mqtt/ConnectManager.java
================================================
package org.jmqtt.mqtt;
import java.util.Collection;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* 客户端连接管理器
*/
public class ConnectManager {
private Map clientCache = new ConcurrentHashMap<>();
private static final ConnectManager INSTANCE = new ConnectManager();
private ConnectManager(){}
public static ConnectManager getInstance(){
return INSTANCE;
}
public Collection getAllConnections(){
return this.clientCache.values();
}
public MQTTConnection getClient(String clientId){
return this.clientCache.get(clientId);
}
public MQTTConnection putClient(String clientId,MQTTConnection clientSession){
return this.clientCache.put(clientId,clientSession);
}
public boolean containClient(String clientId){
return this.clientCache.containsKey(clientId);
}
public MQTTConnection removeClient(String clientId){
if (clientId != null) {
return this.clientCache.remove(clientId);
}
return null;
}
}
================================================
FILE: jmqtt-mqtt/src/main/java/org/jmqtt/mqtt/MQTTConnection.java
================================================
package org.jmqtt.mqtt;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.mqtt.*;
import io.netty.handler.timeout.IdleStateHandler;
import org.jmqtt.bus.*;
import org.jmqtt.bus.enums.*;
import org.jmqtt.bus.model.ClusterEvent;
import org.jmqtt.bus.model.DeviceMessage;
import org.jmqtt.bus.model.DeviceSession;
import org.jmqtt.bus.model.DeviceSubscription;
import org.jmqtt.mqtt.model.MqttTopic;
import org.jmqtt.mqtt.netty.MqttNettyUtils;
import org.jmqtt.mqtt.protocol.RequestProcessor;
import org.jmqtt.mqtt.retain.RetainMessageHandler;
import org.jmqtt.mqtt.session.MqttSession;
import org.jmqtt.mqtt.utils.MqttMessageUtil;
import org.jmqtt.mqtt.utils.MqttMsgHeader;
import org.jmqtt.support.config.BrokerConfig;
import org.jmqtt.support.helper.Pair;
import org.jmqtt.support.log.JmqttLogger;
import org.jmqtt.support.log.LogUtil;
import org.jmqtt.support.remoting.RemotingHelper;
import org.slf4j.Logger;
import java.util.*;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.RejectedExecutionException;
import static io.netty.channel.ChannelFutureListener.CLOSE_ON_FAILURE;
import static io.netty.channel.ChannelFutureListener.FIRE_EXCEPTION_ON_FAILURE;
/**
* handle mqtt connection and process mqtt protocol
*/
public class MQTTConnection {
private static final Logger log = JmqttLogger.mqttLog;
private Channel channel;
private Map> processorTable;
private BrokerConfig brokerConfig;
private MqttSession bindedSession;
private Authenticator authenticator;
private DeviceSessionManager deviceSessionManager;
private DeviceSubscriptionManager deviceSubscriptionManager;
private DeviceMessageManager deviceMessageManager;
private RetainMessageHandler retainMessageHandler;
private ClusterEventManager clusterEventManager;
private String clientId;
public MQTTConnection(Channel channel, Map> processorTable,
BrokerConfig brokerConfig, BusController busController,RetainMessageHandler retainMessageHandler) {
this.channel = channel;
this.processorTable = processorTable;
this.brokerConfig = brokerConfig;
this.authenticator = busController.getAuthenticator();
this.deviceSessionManager = busController.getDeviceSessionManager();
this.deviceMessageManager = busController.getDeviceMessageManager();
this.deviceSubscriptionManager = busController.getDeviceSubscriptionManager();
this.retainMessageHandler = retainMessageHandler;
this.clusterEventManager = busController.getClusterEventManager();
}
public void processProtocol(ChannelHandlerContext ctx, MqttMessage mqttMessage) {
int protocolType = mqttMessage.fixedHeader().messageType().value();
Runnable runnable = () -> processorTable.get(protocolType).getObject1().processRequest(ctx, mqttMessage);
try {
processorTable.get(protocolType).getObject2().submit(runnable);
} catch (RejectedExecutionException ex) {
LogUtil.warn(log, "Reject mqtt request,cause={}", ex.getMessage());
}
}
public void processPubComp(MqttMessage mqttMessage) {
String clientId = getClientId();
int packetId = MqttMessageUtil.getMessageId(mqttMessage);
boolean flag = bindedSession.releaseQos2SecFlow(packetId);
LogUtil.debug(log,"[PubComp] -> Receive PubCom and remove the flow message,clientId={},msgId={}",clientId,packetId);
if(!flag){
LogUtil.warn(log,"[PubComp] -> The message is not in Flow cache,clientId={},msgId={}",clientId,packetId);
}
}
public void processPubRec(MqttMessage mqttMessage){
String clientId = getClientId();
int packetId = MqttMessageUtil.getMessageId(mqttMessage);
DeviceMessage stayAckMsg = bindedSession.releaseOutboundFlowMessage(packetId);
if (stayAckMsg == null) {
LogUtil.warn(log,"[PUBREC] Stay release message is not exist,packetId:{},clientId:{}",packetId,getClientId());
} else {
this.deviceMessageManager.ackMessage(getClientId(),stayAckMsg.getId());
}
bindedSession.receivePubRec(packetId);
LogUtil.debug(log,"[PubRec] -> Receive PubRec message,clientId={},msgId={}",clientId,packetId);
MqttMessage pubRelMessage = MqttMessageUtil.getPubRelMessage(packetId);
this.channel.writeAndFlush(pubRelMessage);
}
public void processPubAck(MqttMessage mqttMessage){
int packetId = MqttMessageUtil.getMessageId(mqttMessage);
LogUtil.info(log, "[PubAck] -> Receive PubAck message,clientId={},msgId={}", getClientId(),packetId);
DeviceMessage deviceMessage = bindedSession.releaseOutboundFlowMessage(packetId);
if (deviceMessage == null) {
LogUtil.warn(log,"[PUBACK] Stay release message is not exist,packetId:{},clientId:{}",packetId,getClientId());
return;
}
this.deviceMessageManager.ackMessage(getClientId(),deviceMessage.getId());
}
public void processUnSubscribe(MqttUnsubscribeMessage mqttUnsubscribeMessage){
String clientId = getClientId();
MqttUnsubscribePayload unsubscribePayload = mqttUnsubscribeMessage.payload();
List topics = unsubscribePayload.topics();
topics.forEach( topic -> {
this.bindedSession.removeSubscription(topic);
deviceSubscriptionManager.unSubscribe(clientId,topic);
});
MqttUnsubAckMessage unsubAckMessage = MqttMessageUtil.getUnSubAckMessage(MqttMessageUtil.getMessageId(mqttUnsubscribeMessage));
this.channel.writeAndFlush(unsubAckMessage);
}
public void processSubscribe(MqttSubscribeMessage subscribeMessage) {
int packetId = subscribeMessage.variableHeader().messageId();
List validTopicList = validTopics(subscribeMessage.payload().topicSubscriptions());
if (validTopicList == null || validTopicList.size() == 0) {
LogUtil.warn(log, "[Subscribe] -> Valid all subscribe topic failure,clientId:{},packetId:{}", getClientId(),packetId);
return;
}
// subscribe
List ackQos = new ArrayList<>(validTopicList.size());
for (MqttTopic topic : validTopicList) {
DeviceSubscription deviceSubscription = new DeviceSubscription();
deviceSubscription.setTopic(topic.getTopicName());
deviceSubscription.setClientId(getClientId());
deviceSubscription.setSubscribeTime(new Date());
Map properties = new HashMap<>();
properties.put(MqttMsgHeader.QOS,topic.getQos());
deviceSubscription.setProperties(properties);
this.bindedSession.addSubscription(deviceSubscription);
boolean succ = this.deviceSubscriptionManager.subscribe(deviceSubscription);
if (succ) {
ackQos.add(topic.getQos());
} else {
LogUtil.error(log,"[SUBSCRIBE] subscribe error.");
}
}
MqttMessage subAckMessage = MqttMessageUtil.getSubAckMessage(packetId, ackQos);
this.channel.writeAndFlush(subAckMessage).addListener(new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture future) throws Exception {
if (future.isSuccess()) {
// dispatcher retain message
List retainMessages = retainMessageHandler.getAllRetatinMessage();
if (retainMessages != null) {
retainMessages.forEach(message -> {
message.setSource(MessageSourceEnum.DEVICE);
// match
for (MqttTopic topic : validTopicList) {
if (deviceSubscriptionManager.isMatch(message.getTopic(), topic.getTopicName())) {
// 1. store stay message
Long msgId = deviceMessageManager.storeMessage(message);
deviceMessageManager.addClientInBoxMsg(getClientId(),msgId, MessageAckEnum.UN_ACK);
// 2. ack message
bindedSession.sendMessage(message);
}
}
});
}
} else {
LogUtil.error(log, "[SUBSCRIBE] suback response error.");
}
}
});
}
public void publishMessage(MqttPublishMessage mqttPublishMessage){
this.channel.writeAndFlush(mqttPublishMessage);
}
/**
* 返回校验合法的topic
*/
private List validTopics(List topics) {
List topicList = new ArrayList<>();
for (MqttTopicSubscription subscription : topics) {
if (!authenticator.subscribeVerify(getClientId(), subscription.topicName())) {
LogUtil.warn(log, "[SubPermission] this clientId:{} have no permission to subscribe this topic:{}", getClientId(),
subscription.topicName());
continue;
}
MqttTopic topic = new MqttTopic(subscription.topicName(), subscription.qualityOfService().value());
topicList.add(topic);
}
return topicList;
}
public void processPublishMessage(MqttPublishMessage mqttPublishMessage) {
MqttQoS qos = mqttPublishMessage.fixedHeader().qosLevel();
switch (qos) {
case AT_MOST_ONCE:
dispatcherMessage(mqttPublishMessage);
break;
case AT_LEAST_ONCE:
processQos1(mqttPublishMessage);
break;
case EXACTLY_ONCE:
processQos2(mqttPublishMessage);
break;
default:
LogUtil.warn(log, "[PubMessage] -> Wrong mqtt message,clientId={}", getClientId());
break;
}
}
private void processQos2(MqttPublishMessage mqttPublishMessage) {
int originMessageId = mqttPublishMessage.variableHeader().packetId();
LogUtil.debug(log, "[PubMessage] -> Process qos2 message,clientId={}", getClientId());
DeviceMessage deviceMessage = MqttMsgHeader.buildDeviceMessage(mqttPublishMessage);
bindedSession.receivedPublishQos2(originMessageId, deviceMessage);
MqttMessage pubRecMessage = MqttMessageUtil.getPubRecMessage(originMessageId);
this.channel.writeAndFlush(pubRecMessage);
}
private void processQos1(MqttPublishMessage mqttPublishMessage) {
int originMessageId = mqttPublishMessage.variableHeader().packetId();
dispatcherMessage(mqttPublishMessage);
LogUtil.info(log, "[PubMessage] -> Process qos1 message,clientId={}", getClientId());
MqttPubAckMessage pubAckMessage = MqttMessageUtil.getPubAckMessage(originMessageId);
this.channel.writeAndFlush(pubAckMessage);
}
public void processPubRelMessage(MqttMessage mqttMessage) {
int packetId = MqttMessageUtil.getMessageId(mqttMessage);
DeviceMessage deviceMessage = bindedSession.receivedPubRelQos2(packetId);
if (deviceMessage == null) {
LogUtil.error(log, "[PUBREL] receivedPubRelQos2 cached message is not exist,message lost !!!!!,packetId:{},clientId:{}",
packetId, getClientId());
} else {
dispatcherMessage(deviceMessage);
}
MqttMessage pubComMessage = MqttMessageUtil.getPubComMessage(packetId);
this.channel.writeAndFlush(pubComMessage);
}
private void dispatcherMessage(DeviceMessage deviceMessage) {
// 1. retain消息逻辑
boolean retain = deviceMessage.getProperty(MqttMsgHeader.RETAIN);
int qos = deviceMessage.getProperty(MqttMsgHeader.QOS);
if (retain) {
//qos == 0 or payload is none,then clear previous retain message
if (qos == 0 || deviceMessage.getContent() == null || deviceMessage.getContent().length == 0) {
this.retainMessageHandler.clearRetainMessage(deviceMessage.getTopic());
} else {
this.retainMessageHandler.storeRetainMessage(deviceMessage);
}
}
// 2. 向集群中分发消息：第一阶段
this.deviceMessageManager.dispatcher(deviceMessage);
}
private void dispatcherMessage(MqttPublishMessage mqttPublishMessage) {
boolean retain = mqttPublishMessage.fixedHeader().isRetain();
int qos = mqttPublishMessage.fixedHeader().qosLevel().value();
byte[] payload = MqttMessageUtil.readBytesFromByteBuf(mqttPublishMessage.payload());
String topic = mqttPublishMessage.variableHeader().topicName();
DeviceMessage deviceMessage = MqttMsgHeader.buildDeviceMessage(retain, qos, topic, payload);
deviceMessage.setSource(MessageSourceEnum.DEVICE);
deviceMessage.setFromClientId(clientId);
dispatcherMessage(deviceMessage);
}
public void handleConnectionLost() {
String clientID = MqttNettyUtils.clientID(channel);
if (clientID == null || clientID.isEmpty()) {
return;
}
if (bindedSession.hasWill()) {
dispatcherMessage(bindedSession.getWill());
}
if (bindedSession.isCleanSession()) {
clearSession();
}
offline();
LogUtil.info(log, "[CONNECT INACTIVE] connect lost");
}
public boolean createOrReopenSession(MqttConnectMessage mqttConnectMessage) {
int mqttVersion = mqttConnectMessage.variableHeader().version();
String clientId = mqttConnectMessage.payload().clientIdentifier();
this.clientId = clientId;
boolean cleanSession = mqttConnectMessage.variableHeader().isCleanSession();
this.bindedSession = new MqttSession();
this.bindedSession.setClientId(clientId);
this.bindedSession.setCleanSession(cleanSession);
this.bindedSession.setMqttVersion(mqttVersion);
this.bindedSession.setClientIp(RemotingHelper.getRemoteAddr(this.channel));
this.bindedSession.setServerIp(RemotingHelper.getLocalAddr());
this.bindedSession.setMqttConnection(this);
boolean sessionPresent = false;
boolean notifyClearOtherSession = true;
// 1. 从集群/本服务器中查询是否存在该clientId的设备消息
DeviceSession deviceSession = deviceSessionManager.getSession(clientId);
if (deviceSession != null && deviceSession.getOnline() == DeviceOnlineStateEnum.ONLINE) {
MQTTConnection previousClient = ConnectManager.getInstance().getClient(clientId);
if (previousClient != null) {
//clear old session in this node
previousClient.abortConnection(MqttConnectReturnCode.CONNECTION_REFUSED_IDENTIFIER_REJECTED);
ConnectManager.getInstance().removeClient(clientId);
notifyClearOtherSession = false;
}
}
if (deviceSession == null) {
sessionPresent = false;
notifyClearOtherSession = false;
} else {
if (cleanSession) {
sessionPresent = false;
clearSession();
} else {
sessionPresent = true;
reloadSubscriptions();
}
}
// 2. 清理连接到其它节点的连接
if (notifyClearOtherSession) {
ClusterEvent clusterEvent = new ClusterEvent();
clusterEvent.setClusterEventCode(ClusterEventCodeEnum.MQTT_CLEAR_SESSION);
clusterEvent.setContent(getClientId());
clusterEvent.setGmtCreate(new Date());
clusterEvent.setNodeIp(bindedSession.getServerIp());
clusterEventManager.sendEvent(clusterEvent);
}
// 3. 处理will 消息
boolean willFlag = mqttConnectMessage.variableHeader().isWillFlag();
if (willFlag) {
boolean willRetain = mqttConnectMessage.variableHeader().isWillRetain();
int willQos = mqttConnectMessage.variableHeader().willQos();
String willTopic = mqttConnectMessage.payload().willTopic();
byte[] willPayload = mqttConnectMessage.payload().willMessageInBytes();
DeviceMessage deviceMessage = MqttMsgHeader.buildDeviceMessage(willRetain, willQos, willTopic, willPayload);
deviceMessage.setSource(MessageSourceEnum.DEVICE);
deviceMessage.setFromClientId(clientId);
bindedSession.setWill(deviceMessage);
}
return sessionPresent;
}
public void storeSession() {
ConnectManager.getInstance().putClient(getClientId(),this);
DeviceSession deviceSession = new DeviceSession();
deviceSession.setTransportProtocol(TransportProtocolEnum.MQTT);
deviceSession.setServerIp(bindedSession.getServerIp());
deviceSession.setClientIp(bindedSession.getClientIp());
deviceSession.setOnlineTime(new Date());
deviceSession.setClientId(getClientId());
deviceSession.setOnline(DeviceOnlineStateEnum.ONLINE);
Map properties = new HashMap<>();
properties.put(MqttMsgHeader.CLEAN_SESSION,bindedSession.isCleanSession());
deviceSession.setProperties(properties);
deviceSessionManager.storeSession(deviceSession);
}
public void reSendMessage2Client() {
int limit = 100; // per 100
boolean hasUnAckMessages = true;
while (hasUnAckMessages) {
List deviceInboxMessageList = this.deviceMessageManager.queryUnAckMessages(getClientId(),limit);
if (deviceInboxMessageList == null) {
return;
}
if (deviceInboxMessageList.size() < 100) {
hasUnAckMessages = false;
}
// resendMessage
deviceInboxMessageList.forEach(deviceMessage -> {
bindedSession.sendMessage(deviceMessage);
});
}
}
public boolean keepAlive(int heatbeatSec) {
int keepAlive = (int) (heatbeatSec * 1.5f);
if (this.channel.pipeline().names().contains("idleStateHandler")) {
this.channel.pipeline().remove("idleStateHandler");
}
this.channel.pipeline().addFirst("idleStateHandler", new IdleStateHandler(keepAlive, 0, 0));
return true;
}
public boolean login(String clientId, String username, byte[] password) {
return this.authenticator.login(clientId, username, password);
}
public boolean onBlackList(String remoteAddr, String clientId) {
return this.authenticator.onBlackList(clientId, remoteAddr);
}
public boolean clientIdVerify(String clientId) {
return this.authenticator.clientIdVerify(clientId);
}
public void abortConnection(MqttConnectReturnCode returnCode) {
MqttConnAckMessage badProto = MqttMessageBuilders.connAck()
.returnCode(returnCode)
.sessionPresent(false).build();
this.channel.writeAndFlush(badProto).addListener(FIRE_EXCEPTION_ON_FAILURE);
this.channel.close().addListener(CLOSE_ON_FAILURE);
}
public void processDisconnect() {
// 1. 清理will消息
bindedSession.clearWill();
// 2. 下线
offline();
}
private void clearSession() {
deviceSubscriptionManager.deleteAllSubscription(getClientId());
deviceMessageManager.clearUnAckMessage(getClientId());
}
private void reloadSubscriptions() {
Set deviceSubscriptions = deviceSubscriptionManager.getAllSubscription(getClientId());
if (deviceSubscriptions != null) {
deviceSubscriptions.forEach(item -> {
deviceSubscriptionManager.onlySubscribe2Tree(item);
});
}
}
private void offline() {
this.deviceSessionManager.offline(getClientId());
ConnectManager.getInstance().removeClient(getClientId());
}
public String getClientId() {
return this.clientId;
}
public Channel getChannel() {
return channel;
}
public Map> getProcessorTable() {
return processorTable;
}
public BrokerConfig getBrokerConfig() {
return brokerConfig;
}
public MqttSession getBindedSession() {
return bindedSession;
}
public Authenticator getAuthenticator() {
return authenticator;
}
public DeviceSessionManager getDeviceSessionManager() {
return deviceSessionManager;
}
public DeviceSubscriptionManager getDeviceSubscriptionManager() {
return deviceSubscriptionManager;
}
public DeviceMessageManager getDeviceMessageManager() {
return deviceMessageManager;
}
public RetainMessageHandler getRetainMessageHandler() {
return retainMessageHandler;
}
public ClusterEventManager getClusterEventManager() {
return clusterEventManager;
}
}
================================================
FILE: jmqtt-mqtt/src/main/java/org/jmqtt/mqtt/MQTTConnectionFactory.java
================================================
package org.jmqtt.mqtt;
import io.netty.channel.Channel;
import io.netty.handler.codec.mqtt.MqttMessageType;
import org.jmqtt.bus.BusController;
import org.jmqtt.mqtt.protocol.RequestProcessor;
import org.jmqtt.mqtt.protocol.impl.*;
import org.jmqtt.mqtt.retain.RetainMessageHandler;
import org.jmqtt.mqtt.retain.impl.RetainMessageHandlerImpl;
import org.jmqtt.support.config.BrokerConfig;
import org.jmqtt.support.helper.Pair;
import org.jmqtt.support.helper.RejectHandler;
import org.jmqtt.support.helper.ThreadFactoryImpl;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
/**
* mqtt connection factory
*/
public class MQTTConnectionFactory {
private BrokerConfig brokerConfig;
/** mqtt protocol processor */
private ExecutorService connectExecutor;
private ExecutorService pubExecutor;
private ExecutorService subExecutor;
private ExecutorService pingExecutor;
private LinkedBlockingQueue connectQueue;
private LinkedBlockingQueue pubQueue;
private LinkedBlockingQueue subQueue;
private LinkedBlockingQueue pingQueue;
private Map> processorTable;
private RetainMessageHandler retainMessageHandler;
/** bus dependency */
private BusController busController;
public MQTTConnectionFactory(BrokerConfig brokerConfig, BusController busController) {
this.brokerConfig = brokerConfig;
this.busController = busController;
this.retainMessageHandler = new RetainMessageHandlerImpl();
this.connectQueue = new LinkedBlockingQueue<>(100000);
this.pubQueue = new LinkedBlockingQueue<>(100000);
this.subQueue = new LinkedBlockingQueue<>(100000);
this.pingQueue = new LinkedBlockingQueue<>(10000);
int coreThreadNum = Runtime.getRuntime().availableProcessors();
this.connectExecutor = new ThreadPoolExecutor(coreThreadNum * 2,
coreThreadNum * 2,
60000,
TimeUnit.MILLISECONDS,
connectQueue,
new ThreadFactoryImpl("ConnectThread"),
new RejectHandler("connect", 100000));
this.pubExecutor = new ThreadPoolExecutor(coreThreadNum * 2,
coreThreadNum * 2,
60000,
TimeUnit.MILLISECONDS,
pubQueue,
new ThreadFactoryImpl("PubThread"),
new RejectHandler("pub", 100000));
this.subExecutor = new ThreadPoolExecutor(coreThreadNum * 2,
coreThreadNum * 2,
60000,
TimeUnit.MILLISECONDS,
subQueue,
new ThreadFactoryImpl("SubThread"),
new RejectHandler("sub", 100000));
this.pingExecutor = new ThreadPoolExecutor(coreThreadNum,
coreThreadNum,
60000,
TimeUnit.MILLISECONDS,
pingQueue,
new ThreadFactoryImpl("PingThread"),
new RejectHandler("heartbeat", 100000));
RequestProcessor connectProcessor = new ConnectProcessor();
RequestProcessor disconnectProcessor = new DisconnectProcessor();
RequestProcessor pingProcessor = new PingProcessor();
RequestProcessor publishProcessor = new PublishProcessor();
RequestProcessor pubRelProcessor = new PubRelProcessor();
RequestProcessor subscribeProcessor = new SubscribeProcessor();
RequestProcessor unSubscribeProcessor = new UnSubscribeProcessor();
RequestProcessor pubRecProcessor = new PubRecProcessor();
RequestProcessor pubAckProcessor = new PubAckProcessor();
RequestProcessor pubCompProcessor = new PubCompProcessor();
processorTable = new HashMap<>();
registerProcessor(MqttMessageType.CONNECT.value(), connectProcessor, connectExecutor);
registerProcessor(MqttMessageType.DISCONNECT.value(), disconnectProcessor,
connectExecutor);
registerProcessor(MqttMessageType.PINGREQ.value(), pingProcessor, pingExecutor);
registerProcessor(MqttMessageType.PUBLISH.value(), publishProcessor, pubExecutor);
registerProcessor(MqttMessageType.PUBACK.value(), pubAckProcessor, pubExecutor);
registerProcessor(MqttMessageType.PUBREL.value(), pubRelProcessor, pubExecutor);
registerProcessor(MqttMessageType.SUBSCRIBE.value(), subscribeProcessor, subExecutor);
registerProcessor(MqttMessageType.UNSUBSCRIBE.value(), unSubscribeProcessor, subExecutor);
registerProcessor(MqttMessageType.PUBREC.value(), pubRecProcessor, subExecutor);
registerProcessor(MqttMessageType.PUBCOMP.value(), pubCompProcessor, subExecutor);
}
public void registerProcessor(int mqttMessageType, RequestProcessor requestProcessor, ExecutorService executorService){
processorTable.put(mqttMessageType,new Pair<>(requestProcessor,executorService));
}
public MQTTConnection create(Channel channel){
MQTTConnection mqttConnection = new MQTTConnection(channel,processorTable,brokerConfig,busController,retainMessageHandler);
return mqttConnection;
}
public void shutdown(){
this.connectExecutor.shutdown();
this.pubExecutor.shutdown();
this.subExecutor.shutdown();
this.pingExecutor.shutdown();
}
}
================================================
FILE: jmqtt-mqtt/src/main/java/org/jmqtt/mqtt/MQTTServer.java
================================================
package org.jmqtt.mqtt;
import io.netty.handler.codec.mqtt.MqttConnectReturnCode;
import org.jmqtt.bus.BusController;
import org.jmqtt.mqtt.event.MqttEventListener;
import org.jmqtt.mqtt.netty.MqttRemotingServer;
import org.jmqtt.support.config.BrokerConfig;
import org.jmqtt.support.config.NettyConfig;
import org.jmqtt.support.helper.MixAll;
import org.jmqtt.support.log.JmqttLogger;
import org.jmqtt.support.log.LogUtil;
import org.slf4j.Logger;
import java.util.Collection;
/**
* mqtt服务
*/
public class MQTTServer {
private static final Logger log = JmqttLogger.mqttLog;
private BusController busController;
private BrokerConfig brokerConfig;
private NettyConfig nettyConfig;
private MqttRemotingServer mqttRemotingServer;
private MqttEventListener mqttEventListener;
public MQTTServer(BusController busController, BrokerConfig brokerConfig, NettyConfig nettyConfig){
this.busController = busController;
this.brokerConfig = brokerConfig;
this.nettyConfig = nettyConfig;
this.mqttRemotingServer = new MqttRemotingServer(brokerConfig,nettyConfig,busController);
this.mqttEventListener = new MqttEventListener(busController.getDeviceMessageManager());
}
public void start(){
this.busController.getClusterEventManager().registerEventListener(mqttEventListener);
this.mqttRemotingServer.start();
LogUtil.info(log,"MQTT server start success.");
}
public void shutdown(){
this.mqttRemotingServer.shutdown();
Collection mqttConnections = ConnectManager.getInstance().getAllConnections();
if (!MixAll.isEmpty(mqttConnections)) {
for (MQTTConnection mqttConnection : mqttConnections) {
mqttConnection.abortConnection(MqttConnectReturnCode.CONNECTION_REFUSED_SERVER_UNAVAILABLE);
}
}
}
}
================================================
FILE: jmqtt-mqtt/src/main/java/org/jmqtt/mqtt/codec/ByteBuf2WebSocketEncoder.java
================================================
package org.jmqtt.mqtt.codec;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToMessageEncoder;
import io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame;
import java.util.List;
public class ByteBuf2WebSocketEncoder extends MessageToMessageEncoder {
@Override
protected void encode(ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf, List