n&&(e=n);return e}function d(e){var t={},n=Math.round(e.h),r=Math.round(e.s*255/100),i=Math.round(e.b*255/100);if(r===0)t.r=t.g=t.b=i;else{var s=i,o=(255-r)*i/255,u=(s-o)*(n%60)/60;n===360&&(n=0);if(n<60){t.r=s;t.b=o;t.g=o+u}else if(n<120){t.g=s;t.b=o;t.r=s-u}else if(n<180){t.g=s;t.r=o;t.b=o+u}else if(n<240){t.b=s;t.r=o;t.g=s-u}else if(n<300){t.b=s;t.g=o;t.r=o+u}else if(n<360){t.r=s;t.g=o;t.b=s-u}else{t.r=0;t.g=0;t.b=0}}return{r:Math.round(t.r),g:Math.round(t.g),b:Math.round(t.b)}}function v(t){var n=[t.r.toString(16),t.g.toString(16),t.b.toString(16)];e.each(n,function(e,t){t.length===1&&(n[e]="0"+t)});return"#"+n.join("")}function m(e){return v(d(e))}function g(e){var t=y(b(e));t.s===0&&(t.h=360);return t}function y(e){var t={h:0,s:0,b:0},n=Math.min(e.r,e.g,e.b),r=Math.max(e.r,e.g,e.b),i=r-n;t.b=r;t.s=r!==0?255*i/r:0;t.s!==0?e.r===r?t.h=(e.g-e.b)/i:e.g===r?t.h=2+(e.b-e.r)/i:t.h=4+(e.r-e.g)/i:t.h=-1;t.h*=60;t.h<0&&(t.h+=360);t.s*=100/255;t.b*=100/255;return t}function b(e){e=parseInt(e.indexOf("#")>-1?e.substring(1):e,16);return{r:e>>16,g:(e&65280)>>8,b:e&255}}e.minicolors={defaults:{animationSpeed:50,animationEasing:"swing",change:null,changeDelay:0,control:"hue",defaultValue:"",hide:null,hideSpeed:100,inline:!1,letterCase:"lowercase",opacity:!1,position:"bottom left",show:null,showSpeed:100,theme:"default"}};e.extend(e.fn,{minicolors:function(s,o){switch(s){case"destroy":e(this).each(function(){n(e(this))});return e(this);case"hide":i();return e(this);case"opacity":if(o===undefined)return e(this).attr("data-opacity");e(this).each(function(){u(e(this).attr("data-opacity",o))});return e(this);case"rgbObject":return f(e(this),s==="rgbaObject");case"rgbString":case"rgbaString":return l(e(this),s==="rgbaString");case"settings":if(o===undefined)return e(this).data("minicolors-settings");e(this).each(function(){var t=e(this).data("minicolors-settings")||{};n(e(this));e(this).minicolors(e.extend(!0,t,o))});return e(this);case"show":r(e(this).eq(0));return e(this);case"value":if(o===undefined)return e(this).val();e(this).each(function(){u(e(this).val(o))});return e(this);default:s!=="create"&&(o=s);e(this).each(function(){t(e(this),o)});return e(this)}}});e(document).on("mousedown.minicolors touchstart.minicolors",function(t){e(t.target).parents().add(t.target).hasClass("minicolors")||i()}).on("mousedown.minicolors touchstart.minicolors",".minicolors-grid, .minicolors-slider, .minicolors-opacity-slider",function(t){var n=e(this);t.preventDefault();e(document).data("minicolors-target",n);s(n,t,!0)}).on("mousemove.minicolors touchmove.minicolors",function(t){var n=e(document).data("minicolors-target");n&&s(n,t)}).on("mouseup.minicolors touchend.minicolors",function(){e(this).removeData("minicolors-target")}).on("mousedown.minicolors touchstart.minicolors",".minicolors-swatch",function(t){var n=e(this).parent().find(".minicolors-input");t.preventDefault();r(n)}).on("focus.minicolors",".minicolors-input",function(){var t=e(this);if(!t.data("minicolors-initialized"))return;r(t)}).on("blur.minicolors",".minicolors-input",function(){var t=e(this),n=t.data("minicolors-settings");if(!t.data("minicolors-initialized"))return;t.val(h(t.val(),!0));t.val()===""&&t.val(h(n.defaultValue,!0));t.val(c(t.val(),n.letterCase))}).on("keydown.minicolors",".minicolors-input",function(t){var n=e(this);if(!n.data("minicolors-initialized"))return;switch(t.keyCode){case 9:i();break;case 13:case 27:i();n.blur()}}).on("keyup.minicolors",".minicolors-input",function(){var t=e(this);if(!t.data("minicolors-initialized"))return;u(t,!0)}).on("paste.minicolors",".minicolors-input",function(){var t=e(this);if(!t.data("minicolors-initialized"))return;setTimeout(function(){u(t,!0)},1)})}(jQuery);
--------------------------------------------------------------------------------
/js/mqttws31.js:
--------------------------------------------------------------------------------
1 | /*******************************************************************************
2 | * Copyright (c) 2013 IBM Corp.
3 | *
4 | * All rights reserved. This program and the accompanying materials
5 | * are made available under the terms of the Eclipse Public License v1.0
6 | * and Eclipse Distribution License v1.0 which accompany this distribution.
7 | *
8 | * The Eclipse Public License is available at
9 | * http://www.eclipse.org/legal/epl-v10.html
10 | * and the Eclipse Distribution License is available at
11 | * http://www.eclipse.org/org/documents/edl-v10.php.
12 | *
13 | * Contributors:
14 | * Andrew Banks - initial API and implementation and initial documentation
15 | *******************************************************************************/
16 |
17 |
18 | // Only expose a single object name in the global namespace.
19 | // Everything must go through this module. Global Messaging module
20 | // only has a single public function, client, which returns
21 | // a Messaging client object given connection details.
22 |
23 | /**
24 | * @namespace Messaging
25 | * Send and receive messages using web browsers.
26 | *
27 | * This programming interface lets a JavaScript client application use the MQTT V3.1 protocol to
28 | * connect to an MQTT-supporting messaging server.
29 | *
30 | * The function supported includes:
31 | *
32 | * - Connecting to and disconnecting from a server. The server is identified by its host name and port number.
33 | *
- Specifying options that relate to the communications link with the server,
34 | * for example the frequency of keep-alive heartbeats, and whether SSL/TLS is required.
35 | *
- Subscribing to and receiving messages from MQTT Topics.
36 | *
- Publishing messages to MQTT Topics.
37 | *
38 | *
39 | *
The API consists of two main objects:
40 | * The Messaging.Client object. This contains methods that provide the functionality of the API,
41 | * including provision of callbacks that notify the application when a message arrives from or is delivered to the messaging server,
42 | * or when the status of its connection to the messaging server changes.
43 | *
44 | * The Messaging.Message object. This encapsulates the payload of the message along with various attributes
45 | * associated with its delivery, in particular the destination to which it has been (or is about to be) sent.
46 | *
47 | * The programming interface validates parameters passed to it, and will throw an Error containing an error message
48 | * intended for developer use, if it detects an error with any parameter.
49 | *
50 | * Example:
51 | *
52 | *
53 | client = new Messaging.Client(location.hostname, Number(location.port), "clientId");
54 | client.onConnectionLost = onConnectionLost;
55 | client.onMessageArrived = onMessageArrived;
56 | client.connect({onSuccess:onConnect});
57 |
58 | function onConnect() {
59 | // Once a connection has been made, make a subscription and send a message.
60 | console.log("onConnect");
61 | client.subscribe("/World");
62 | message = new Messaging.Message("Hello");
63 | message.destinationName = "/World";
64 | client.send(message);
65 | };
66 | function onConnectionLost(responseObject) {
67 | if (responseObject.errorCode !== 0)
68 | console.log("onConnectionLost:"+responseObject.errorMessage);
69 | };
70 | function onMessageArrived(message) {
71 | console.log("onMessageArrived:"+message.payloadString);
72 | client.disconnect();
73 | };
74 | *
76 | * Other programming languages,
77 | * Java,
78 | * C.
79 | */
80 | Messaging = (function (global) {
81 |
82 | // Private variables below, these are only visible inside the function closure
83 | // which is used to define the module.
84 |
85 | var version = "0.0.0.0";
86 | var buildLevel = "@BUILDLEVEL@";
87 |
88 | /**
89 | * Unique message type identifiers, with associated
90 | * associated integer values.
91 | * @private
92 | */
93 | var MESSAGE_TYPE = {
94 | CONNECT: 1,
95 | CONNACK: 2,
96 | PUBLISH: 3,
97 | PUBACK: 4,
98 | PUBREC: 5,
99 | PUBREL: 6,
100 | PUBCOMP: 7,
101 | SUBSCRIBE: 8,
102 | SUBACK: 9,
103 | UNSUBSCRIBE: 10,
104 | UNSUBACK: 11,
105 | PINGREQ: 12,
106 | PINGRESP: 13,
107 | DISCONNECT: 14
108 | };
109 |
110 | // Collection of utility methods used to simplify module code
111 | // and promote the DRY pattern.
112 |
113 | /**
114 | * Validate an object's parameter names to ensure they
115 | * match a list of expected variables name for this option
116 | * type. Used to ensure option object passed into the API don't
117 | * contain erroneous parameters.
118 | * @param {Object} obj User options object
119 | * @param {key:type, key2:type, ...} valid keys and types that may exist in obj.
120 | * @throws {Error} Invalid option parameter found.
121 | * @private
122 | */
123 | var validate = function (obj, keys) {
124 | for (key in obj) {
125 | if (obj.hasOwnProperty(key)) {
126 | if (keys.hasOwnProperty(key)) {
127 | if (typeof obj[key] !== keys[key])
128 | throw new Error(format(ERROR.INVALID_TYPE, [typeof obj[key], key]));
129 | } else {
130 | var errorStr = "Unknown property, " + key + ". Valid properties are:";
131 | for (key in keys)
132 | if (keys.hasOwnProperty(key))
133 | errorStr = errorStr + " " + key;
134 | throw new Error(errorStr);
135 | }
136 | }
137 | }
138 | };
139 |
140 | /**
141 | * Return a new function which runs the user function bound
142 | * to a fixed scope.
143 | * @param {function} User function
144 | * @param {object} Function scope
145 | * @return {function} User function bound to another scope
146 | * @private
147 | */
148 | var scope = function (f, scope) {
149 | return function () {
150 | return f.apply(scope, arguments);
151 | };
152 | };
153 |
154 | /**
155 | * Unique message type identifiers, with associated
156 | * associated integer values.
157 | * @private
158 | */
159 | var ERROR = {
160 | OK: {code: 0, text: "AMQJSC0000I OK."},
161 | CONNECT_TIMEOUT: {code: 1, text: "AMQJSC0001E Connect timed out."},
162 | SUBSCRIBE_TIMEOUT: {code: 2, text: "AMQJS0002E Subscribe timed out."},
163 | UNSUBSCRIBE_TIMEOUT: {code: 3, text: "AMQJS0003E Unsubscribe timed out."},
164 | PING_TIMEOUT: {code: 4, text: "AMQJS0004E Ping timed out."},
165 | INTERNAL_ERROR: {code: 5, text: "AMQJS0005E Internal error."},
166 | CONNACK_RETURNCODE: {code: 6, text: "AMQJS0006E Bad Connack return code:{0} {1}."},
167 | SOCKET_ERROR: {code: 7, text: "AMQJS0007E Socket error:{0}."},
168 | SOCKET_CLOSE: {code: 8, text: "AMQJS0008I Socket closed."},
169 | MALFORMED_UTF: {code: 9, text: "AMQJS0009E Malformed UTF data:{0} {1} {2}."},
170 | UNSUPPORTED: {code: 10, text: "AMQJS0010E {0} is not supported by this browser."},
171 | INVALID_STATE: {code: 11, text: "AMQJS0011E Invalid state {0}."},
172 | INVALID_TYPE: {code: 12, text: "AMQJS0012E Invalid type {0} for {1}."},
173 | INVALID_ARGUMENT: {code: 13, text: "AMQJS0013E Invalid argument {0} for {1}."},
174 | UNSUPPORTED_OPERATION: {code: 14, text: "AMQJS0014E Unsupported operation."},
175 | INVALID_STORED_DATA: {code: 15, text: "AMQJS0015E Invalid data in local storage key={0} value={1}."},
176 | INVALID_MQTT_MESSAGE_TYPE: {code: 16, text: "AMQJS0016E Invalid MQTT message type {0}."},
177 | MALFORMED_UNICODE: {code: 17, text: "AMQJS0017E Malformed Unicode string:{0} {1}."},
178 | };
179 |
180 | /** CONNACK RC Meaning. */
181 | var CONNACK_RC = {
182 | 0: "Connection Accepted",
183 | 1: "Connection Refused: unacceptable protocol version",
184 | 2: "Connection Refused: identifier rejected",
185 | 3: "Connection Refused: server unavailable",
186 | 4: "Connection Refused: bad user name or password",
187 | 5: "Connection Refused: not authorized"
188 | };
189 |
190 | /**
191 | * Format an error message text.
192 | * @private
193 | * @param {error} ERROR.KEY value above.
194 | * @param {substitutions} [array] substituted into the text.
195 | * @return the text with the substitutions made.
196 | */
197 | var format = function (error, substitutions) {
198 | var text = error.text;
199 | if (substitutions) {
200 | for (var i = 0; i < substitutions.length; i++) {
201 | field = "{" + i + "}";
202 | start = text.indexOf(field);
203 | if (start > 0) {
204 | var part1 = text.substring(0, start);
205 | var part2 = text.substring(start + field.length);
206 | text = part1 + substitutions[i] + part2;
207 | }
208 | }
209 | }
210 | return text;
211 | };
212 |
213 | //MQTT protocol and version 6 M Q I s d p 3
214 | var MqttProtoIdentifier = [0x00, 0x06, 0x4d, 0x51, 0x49, 0x73, 0x64, 0x70, 0x03];
215 |
216 | /**
217 | * @ignore
218 | * Construct an MQTT wire protocol message.
219 | * @param type MQTT packet type.
220 | * @param options optional wire message attributes.
221 | *
222 | * Optional properties
223 | *
224 | * messageIdentifier: message ID in the range [0..65535]
225 | * payloadMessage: Application Message - PUBLISH only
226 | * connectStrings: array of 0 or more Strings to be put into the CONNECT payload
227 | * topics: array of strings (SUBSCRIBE, UNSUBSCRIBE)
228 | * requestQoS: array of QoS values [0..2]
229 | *
230 | * "Flag" properties
231 | * cleanSession: true if present / false if absent (CONNECT)
232 | * willMessage: true if present / false if absent (CONNECT)
233 | * isRetained: true if present / false if absent (CONNECT)
234 | * userName: true if present / false if absent (CONNECT)
235 | * password: true if present / false if absent (CONNECT)
236 | * keepAliveInterval: integer [0..65535] (CONNECT)
237 | *
238 | * @private
239 | */
240 | var WireMessage = function (type, options) {
241 | this.type = type;
242 | for (name in options) {
243 | if (options.hasOwnProperty(name)) {
244 | this[name] = options[name];
245 | }
246 | }
247 | };
248 |
249 | WireMessage.prototype.encode = function () {
250 | // Compute the first byte of the fixed header
251 | var first = ((this.type & 0x0f) << 4);
252 |
253 | /*
254 | * Now calculate the length of the variable header + payload by adding up the lengths
255 | * of all the component parts
256 | */
257 |
258 | remLength = 0;
259 | topicStrLength = new Array();
260 |
261 | // if the message contains a messageIdentifier then we need two bytes for that
262 | if (this.messageIdentifier != undefined)
263 | remLength += 2;
264 |
265 | switch (this.type) {
266 | // If this a Connect then we need to include 12 bytes for its header
267 | case MESSAGE_TYPE.CONNECT:
268 | remLength += MqttProtoIdentifier.length + 3;
269 | remLength += UTF8Length(this.clientId) + 2;
270 | if (this.willMessage != undefined) {
271 | remLength += UTF8Length(this.willMessage.destinationName) + 2;
272 | // Will message is always a string, sent as UTF-8 characters with a preceding length.
273 | var willMessagePayloadBytes = this.willMessage.payloadBytes;
274 | if (!(willMessagePayloadBytes instanceof Uint8Array))
275 | willMessagePayloadBytes = new Uint8Array(payloadBytes);
276 | remLength += willMessagePayloadBytes.byteLength + 2;
277 | }
278 | if (this.userName != undefined)
279 | remLength += UTF8Length(this.userName) + 2;
280 | if (this.password != undefined)
281 | remLength += UTF8Length(this.password) + 2;
282 | break;
283 |
284 | // Subscribe, Unsubscribe can both contain topic strings
285 | case MESSAGE_TYPE.SUBSCRIBE:
286 | first |= 0x02; // Qos = 1;
287 | for (var i = 0; i < this.topics.length; i++) {
288 | topicStrLength[i] = UTF8Length(this.topics[i]);
289 | remLength += topicStrLength[i] + 2;
290 | }
291 | remLength += this.requestedQos.length; // 1 byte for each topic's Qos
292 | // QoS on Subscribe only
293 | break;
294 |
295 | case MESSAGE_TYPE.UNSUBSCRIBE:
296 | first |= 0x02; // Qos = 1;
297 | for (var i = 0; i < this.topics.length; i++) {
298 | topicStrLength[i] = UTF8Length(this.topics[i]);
299 | remLength += topicStrLength[i] + 2;
300 | }
301 | break;
302 |
303 | case MESSAGE_TYPE.PUBLISH:
304 | if (this.payloadMessage.duplicate) first |= 0x08;
305 | first = first |= (this.payloadMessage.qos << 1);
306 | if (this.payloadMessage.retained) first |= 0x01;
307 | destinationNameLength = UTF8Length(this.payloadMessage.destinationName);
308 | remLength += destinationNameLength + 2;
309 | var payloadBytes = this.payloadMessage.payloadBytes;
310 | remLength += payloadBytes.byteLength;
311 | if (payloadBytes instanceof ArrayBuffer)
312 | payloadBytes = new Uint8Array(payloadBytes);
313 | else if (!(payloadBytes instanceof Uint8Array))
314 | payloadBytes = new Uint8Array(payloadBytes.buffer);
315 | break;
316 |
317 | case MESSAGE_TYPE.DISCONNECT:
318 | break;
319 |
320 | default:
321 | ;
322 | }
323 |
324 | // Now we can allocate a buffer for the message
325 |
326 | var mbi = encodeMBI(remLength); // Convert the length to MQTT MBI format
327 | var pos = mbi.length + 1; // Offset of start of variable header
328 | var buffer = new ArrayBuffer(remLength + pos);
329 | var byteStream = new Uint8Array(buffer); // view it as a sequence of bytes
330 |
331 | //Write the fixed header into the buffer
332 | byteStream[0] = first;
333 | byteStream.set(mbi, 1);
334 |
335 | // If this is a PUBLISH then the variable header starts with a topic
336 | if (this.type == MESSAGE_TYPE.PUBLISH)
337 | pos = writeString(this.payloadMessage.destinationName, destinationNameLength, byteStream, pos);
338 | // If this is a CONNECT then the variable header contains the protocol name/version, flags and keepalive time
339 |
340 | else if (this.type == MESSAGE_TYPE.CONNECT) {
341 | byteStream.set(MqttProtoIdentifier, pos);
342 | pos += MqttProtoIdentifier.length;
343 | var connectFlags = 0;
344 | if (this.cleanSession)
345 | connectFlags = 0x02;
346 | if (this.willMessage != undefined) {
347 | connectFlags |= 0x04;
348 | connectFlags |= (this.willMessage.qos << 3);
349 | if (this.willMessage.retained) {
350 | connectFlags |= 0x20;
351 | }
352 | }
353 | if (this.userName != undefined)
354 | connectFlags |= 0x80;
355 | if (this.password != undefined)
356 | connectFlags |= 0x40;
357 | byteStream[pos++] = connectFlags;
358 | pos = writeUint16(this.keepAliveInterval, byteStream, pos);
359 | }
360 |
361 | // Output the messageIdentifier - if there is one
362 | if (this.messageIdentifier != undefined)
363 | pos = writeUint16(this.messageIdentifier, byteStream, pos);
364 |
365 | switch (this.type) {
366 | case MESSAGE_TYPE.CONNECT:
367 | pos = writeString(this.clientId, UTF8Length(this.clientId), byteStream, pos);
368 | if (this.willMessage != undefined) {
369 | pos = writeString(this.willMessage.destinationName, UTF8Length(this.willMessage.destinationName), byteStream, pos);
370 | pos = writeUint16(willMessagePayloadBytes.byteLength, byteStream, pos);
371 | byteStream.set(willMessagePayloadBytes, pos);
372 | pos += willMessagePayloadBytes.byteLength;
373 |
374 | }
375 | if (this.userName != undefined)
376 | pos = writeString(this.userName, UTF8Length(this.userName), byteStream, pos);
377 | if (this.password != undefined)
378 | pos = writeString(this.password, UTF8Length(this.password), byteStream, pos);
379 | break;
380 |
381 | case MESSAGE_TYPE.PUBLISH:
382 | // PUBLISH has a text or binary payload, if text do not add a 2 byte length field, just the UTF characters.
383 | byteStream.set(payloadBytes, pos);
384 |
385 | break;
386 |
387 | // case MESSAGE_TYPE.PUBREC:
388 | // case MESSAGE_TYPE.PUBREL:
389 | // case MESSAGE_TYPE.PUBCOMP:
390 | // break;
391 |
392 | case MESSAGE_TYPE.SUBSCRIBE:
393 | // SUBSCRIBE has a list of topic strings and request QoS
394 | for (var i = 0; i < this.topics.length; i++) {
395 | pos = writeString(this.topics[i], topicStrLength[i], byteStream, pos);
396 | byteStream[pos++] = this.requestedQos[i];
397 | }
398 | break;
399 |
400 | case MESSAGE_TYPE.UNSUBSCRIBE:
401 | // UNSUBSCRIBE has a list of topic strings
402 | for (var i = 0; i < this.topics.length; i++)
403 | pos = writeString(this.topics[i], topicStrLength[i], byteStream, pos);
404 | break;
405 |
406 | default:
407 | // Do nothing.
408 | }
409 |
410 | return buffer;
411 | }
412 |
413 | function decodeMessage(input) {
414 | //var msg = new Object(); // message to be constructed
415 | var first = input[0];
416 | var type = first >> 4;
417 | var messageInfo = first &= 0x0f;
418 | var pos = 1;
419 |
420 |
421 | // Decode the remaining length (MBI format)
422 |
423 | var digit;
424 | var remLength = 0;
425 | var multiplier = 1;
426 | do {
427 | digit = input[pos++];
428 | remLength += ((digit & 0x7F) * multiplier);
429 | multiplier *= 128;
430 | } while ((digit & 0x80) != 0);
431 |
432 | var wireMessage = new WireMessage(type);
433 | switch (type) {
434 | case MESSAGE_TYPE.CONNACK:
435 | wireMessage.topicNameCompressionResponse = input[pos++];
436 | wireMessage.returnCode = input[pos++];
437 | break;
438 |
439 | case MESSAGE_TYPE.PUBLISH:
440 | var qos = (messageInfo >> 1) & 0x03;
441 |
442 | var len = readUint16(input, pos);
443 | pos += 2;
444 | var topicName = parseUTF8(input, pos, len);
445 | pos += len;
446 | // If QoS 1 or 2 there will be a messageIdentifier
447 | if (qos > 0) {
448 | wireMessage.messageIdentifier = readUint16(input, pos);
449 | pos += 2;
450 | }
451 |
452 | var message = new Messaging.Message(input.subarray(pos));
453 | if ((messageInfo & 0x01) == 0x01)
454 | message.retained = true;
455 | if ((messageInfo & 0x08) == 0x08)
456 | message.duplicate = true;
457 | message.qos = qos;
458 | message.destinationName = topicName;
459 | wireMessage.payloadMessage = message;
460 | break;
461 |
462 | case MESSAGE_TYPE.PUBACK:
463 | case MESSAGE_TYPE.PUBREC:
464 | case MESSAGE_TYPE.PUBREL:
465 | case MESSAGE_TYPE.PUBCOMP:
466 | case MESSAGE_TYPE.UNSUBACK:
467 | wireMessage.messageIdentifier = readUint16(input, pos);
468 | break;
469 |
470 | case MESSAGE_TYPE.SUBACK:
471 | wireMessage.messageIdentifier = readUint16(input, pos);
472 | pos += 2;
473 | wireMessage.grantedQos = input.subarray(pos);
474 | break;
475 |
476 | default:
477 | ;
478 | }
479 |
480 | return wireMessage;
481 | }
482 |
483 | function writeUint16(input, buffer, offset) {
484 | buffer[offset++] = input >> 8; //MSB
485 | buffer[offset++] = input % 256; //LSB
486 | return offset;
487 | }
488 |
489 | function writeString(input, utf8Length, buffer, offset) {
490 | offset = writeUint16(utf8Length, buffer, offset);
491 | stringToUTF8(input, buffer, offset);
492 | return offset + utf8Length;
493 | }
494 |
495 | function readUint16(buffer, offset) {
496 | return 256 * buffer[offset] + buffer[offset + 1];
497 | }
498 |
499 | /**
500 | * Encodes an MQTT Multi-Byte Integer
501 | * @private
502 | */
503 | function encodeMBI(number) {
504 | var output = new Array(1);
505 | var numBytes = 0;
506 |
507 | do {
508 | var digit = number % 128;
509 | number = number >> 7;
510 | if (number > 0) {
511 | digit |= 0x80;
512 | }
513 | output[numBytes++] = digit;
514 | } while ((number > 0) && (numBytes < 4));
515 |
516 | return output;
517 | }
518 |
519 | /**
520 | * Takes a String and calculates its length in bytes when encoded in UTF8.
521 | * @private
522 | */
523 | function UTF8Length(input) {
524 | var output = 0;
525 | for (var i = 0; i < input.length; i++) {
526 | var charCode = input.charCodeAt(i);
527 | if (charCode > 0x7FF) {
528 | // Surrogate pair means its a 4 byte character
529 | if (0xD800 <= charCode && charCode <= 0xDBFF) {
530 | i++;
531 | output++;
532 | }
533 | output += 3;
534 | }
535 | else if (charCode > 0x7F)
536 | output += 2;
537 | else
538 | output++;
539 | }
540 | return output;
541 | }
542 |
543 | /**
544 | * Takes a String and writes it into an array as UTF8 encoded bytes.
545 | * @private
546 | */
547 | function stringToUTF8(input, output, start) {
548 | var pos = start;
549 | for (var i = 0; i < input.length; i++) {
550 | var charCode = input.charCodeAt(i);
551 |
552 | // Check for a surrogate pair.
553 | if (0xD800 <= charCode && charCode <= 0xDBFF) {
554 | lowCharCode = input.charCodeAt(++i);
555 | if (isNaN(lowCharCode)) {
556 | throw new Error(format(ERROR.MALFORMED_UNICODE, [charCode, lowCharCode]));
557 | }
558 | charCode = ((charCode - 0xD800) << 10) + (lowCharCode - 0xDC00) + 0x10000;
559 |
560 | }
561 |
562 | if (charCode <= 0x7F) {
563 | output[pos++] = charCode;
564 | } else if (charCode <= 0x7FF) {
565 | output[pos++] = charCode >> 6 & 0x1F | 0xC0;
566 | output[pos++] = charCode & 0x3F | 0x80;
567 | } else if (charCode <= 0xFFFF) {
568 | output[pos++] = charCode >> 12 & 0x0F | 0xE0;
569 | output[pos++] = charCode >> 6 & 0x3F | 0x80;
570 | output[pos++] = charCode & 0x3F | 0x80;
571 | } else {
572 | output[pos++] = charCode >> 18 & 0x07 | 0xF0;
573 | output[pos++] = charCode >> 12 & 0x3F | 0x80;
574 | output[pos++] = charCode >> 6 & 0x3F | 0x80;
575 | output[pos++] = charCode & 0x3F | 0x80;
576 | }
577 | ;
578 | }
579 | return output;
580 | }
581 |
582 | function parseUTF8(input, offset, length) {
583 | var output = "";
584 | var utf16;
585 | var pos = offset;
586 |
587 | while (pos < offset + length) {
588 | var byte1 = input[pos++];
589 | if (byte1 < 128)
590 | utf16 = byte1;
591 | else {
592 | var byte2 = input[pos++] - 128;
593 | if (byte2 < 0)
594 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), ""]));
595 | if (byte1 < 0xE0) // 2 byte character
596 | utf16 = 64 * (byte1 - 0xC0) + byte2;
597 | else {
598 | var byte3 = input[pos++] - 128;
599 | if (byte3 < 0)
600 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16)]));
601 | if (byte1 < 0xF0) // 3 byte character
602 | utf16 = 4096 * (byte1 - 0xE0) + 64 * byte2 + byte3;
603 | else {
604 | var byte4 = input[pos++] - 128;
605 | if (byte4 < 0)
606 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
607 | if (byte1 < 0xF8) // 4 byte character
608 | utf16 = 262144 * (byte1 - 0xF0) + 4096 * byte2 + 64 * byte3 + byte4;
609 | else // longer encodings are not supported
610 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
611 | }
612 | }
613 | }
614 |
615 | if (utf16 > 0xFFFF) // 4 byte character - express as a surrogate pair
616 | {
617 | utf16 -= 0x10000;
618 | output += String.fromCharCode(0xD800 + (utf16 >> 10)); // lead character
619 | utf16 = 0xDC00 + (utf16 & 0x3FF); // trail character
620 | }
621 | output += String.fromCharCode(utf16);
622 | }
623 | return output;
624 | }
625 |
626 | /** @ignore Repeat keepalive requests, monitor responses.*/
627 | var Pinger = function (client, window, keepAliveInterval) {
628 | this._client = client;
629 | this._window = window;
630 | this._keepAliveInterval = keepAliveInterval * 1000;
631 | this.isReset = false;
632 |
633 | var pingReq = new WireMessage(MESSAGE_TYPE.PINGREQ).encode();
634 |
635 | var doTimeout = function (pinger) {
636 | return function () {
637 | return doPing.apply(pinger);
638 | };
639 | };
640 |
641 | /** @ignore */
642 | var doPing = function () {
643 | if (!this.isReset) {
644 | this._client._trace("Pinger.doPing", "Timed out");
645 | this._client._disconnected(ERROR.PING_TIMEOUT.code, format(ERROR.PING_TIMEOUT));
646 | } else {
647 | this.isReset = false;
648 | this._client._trace("Pinger.doPing", "send PINGREQ");
649 | this._client.socket.send(pingReq);
650 | this.timeout = this._window.setTimeout(doTimeout(this), this._keepAliveInterval);
651 | }
652 | }
653 |
654 | this.reset = function () {
655 | this.isReset = true;
656 | this._window.clearTimeout(this.timeout);
657 | if (this._keepAliveInterval > 0)
658 | this.timeout = setTimeout(doTimeout(this), this._keepAliveInterval);
659 | }
660 |
661 | this.cancel = function () {
662 | this._window.clearTimeout(this.timeout);
663 | }
664 | };
665 |
666 | /** @ignore Monitor request completion. */
667 | var Timeout = function (client, window, timeoutSeconds, action, args) {
668 | this._window = window;
669 | if (!timeoutSeconds)
670 | timeoutSeconds = 30;
671 |
672 | var doTimeout = function (action, client, args) {
673 | return function () {
674 | return action.apply(client, args);
675 | };
676 | };
677 | this.timeout = setTimeout(doTimeout(action, client, args), timeoutSeconds * 1000);
678 |
679 | this.cancel = function () {
680 | this._window.clearTimeout(this.timeout);
681 | }
682 | };
683 |
684 | /*
685 | * Internal implementation of the Websockets MQTT V3.1 client.
686 | *
687 | * @name Messaging.ClientImpl @constructor
688 | * @param {String} host the DNS nameof the webSocket host.
689 | * @param {Number} port the port number for that host.
690 | * @param {String} clientId the MQ client identifier.
691 | */
692 | var ClientImpl = function (host, port, clientId) {
693 | // Check dependencies are satisfied in this browser.
694 | if (!("WebSocket" in global && global["WebSocket"] !== null)) {
695 | throw new Error(format(ERROR.UNSUPPORTED, ["WebSocket"]));
696 | }
697 | if (!("localStorage" in global && global["localStorage"] !== null)) {
698 | throw new Error(format(ERROR.UNSUPPORTED, ["localStorage"]));
699 | }
700 | if (!("ArrayBuffer" in global && global["ArrayBuffer"] !== null)) {
701 | throw new Error(format(ERROR.UNSUPPORTED, ["ArrayBuffer"]));
702 | }
703 |
704 | this._trace("Messaging.Client", host, port, clientId);
705 |
706 | this.host = host;
707 | this.port = port;
708 | this.clientId = clientId;
709 |
710 | // Local storagekeys are qualified with the following string.
711 | this._localKey = host + ":" + port + ":" + clientId + ":";
712 |
713 | // Create private instance-only message queue
714 | // Internal queue of messages to be sent, in sending order.
715 | this._msg_queue = [];
716 |
717 | // Messages we have sent and are expecting a response for, indexed by their respective message ids.
718 | this._sentMessages = {};
719 |
720 | // Messages we have received and acknowleged and are expecting a confirm message for
721 | // indexed by their respective message ids.
722 | this._receivedMessages = {};
723 |
724 | // Internal list of callbacks to be executed when messages
725 | // have been successfully sent over web socket, e.g. disconnect
726 | // when it doesn't have to wait for ACK, just message is dispatched.
727 | this._notify_msg_sent = {};
728 |
729 | // Unique identifier for SEND messages, incrementing
730 | // counter as messages are sent.
731 | this._message_identifier = 1;
732 |
733 | // Used to determine the transmission sequence of stored sent messages.
734 | this._sequence = 0;
735 |
736 |
737 | // Load the local state, if any, from the saved version, only restore state relevant to this client.
738 | for (key in localStorage)
739 | if (key.indexOf("Sent:" + this._localKey) == 0
740 | || key.indexOf("Received:" + this._localKey) == 0)
741 | this.restore(key);
742 | };
743 |
744 | // Messaging Client public instance members.
745 | ClientImpl.prototype.host;
746 | ClientImpl.prototype.port;
747 | ClientImpl.prototype.clientId;
748 |
749 | // Messaging Client private instance members.
750 | ClientImpl.prototype.socket;
751 | /* true once we have received an acknowledgement to a CONNECT packet. */
752 | ClientImpl.prototype.connected = false;
753 | /* The largest message identifier allowed, may not be larger than 2**16 but
754 | * if set smaller reduces the maximum number of outbound messages allowed.
755 | */
756 | ClientImpl.prototype.maxMessageIdentifier = 65536;
757 | ClientImpl.prototype.connectOptions;
758 | ClientImpl.prototype.hostIndex;
759 | ClientImpl.prototype.onConnectionLost;
760 | ClientImpl.prototype.onMessageDelivered;
761 | ClientImpl.prototype.onMessageArrived;
762 | ClientImpl.prototype._msg_queue = null;
763 | ClientImpl.prototype._connectTimeout;
764 | /* The sendPinger monitors how long we allow before we send data to prove to the server that we are alive. */
765 | ClientImpl.prototype.sendPinger = null;
766 | /* The receivePinger monitors how long we allow before we require evidence that the server is alive. */
767 | ClientImpl.prototype.receivePinger = null;
768 |
769 | ClientImpl.prototype._traceBuffer = null;
770 | ClientImpl.prototype._MAX_TRACE_ENTRIES = 100;
771 |
772 | ClientImpl.prototype.connect = function (connectOptions) {
773 | var connectOptionsMasked = this._traceMask(connectOptions, "password");
774 | this._trace("Client.connect", connectOptionsMasked, this.socket, this.connected);
775 |
776 | if (this.connected)
777 | throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
778 | if (this.socket)
779 | throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
780 |
781 | this.connectOptions = connectOptions;
782 |
783 | if (connectOptions.hosts) {
784 | this.hostIndex = 0;
785 | this._doConnect(connectOptions.hosts[0], connectOptions.ports[0]);
786 | } else {
787 | this._doConnect(this.host, this.port);
788 | }
789 |
790 | };
791 |
792 | ClientImpl.prototype.subscribe = function (filter, subscribeOptions) {
793 | this._trace("Client.subscribe", filter, subscribeOptions);
794 |
795 | if (!this.connected)
796 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
797 |
798 | var wireMessage = new WireMessage(MESSAGE_TYPE.SUBSCRIBE);
799 | wireMessage.topics = [filter];
800 | if (subscribeOptions.qos != undefined)
801 | wireMessage.requestedQos = [subscribeOptions.qos];
802 | else
803 | wireMessage.requestedQos = [0];
804 |
805 | if (subscribeOptions.onSuccess) {
806 | wireMessage.callback = function () {
807 | subscribeOptions.onSuccess({invocationContext: subscribeOptions.invocationContext});
808 | };
809 | }
810 | if (subscribeOptions.timeout) {
811 | wireMessage.timeOut = new Timeout(this, window, subscribeOptions.timeout, subscribeOptions.onFailure
812 | , [
813 | {invocationContext: subscribeOptions.invocationContext,
814 | errorCode: ERROR.SUBSCRIBE_TIMEOUT.code,
815 | errorMessage: format(ERROR.SUBSCRIBE_TIMEOUT)}
816 | ]);
817 | }
818 |
819 | // All subscriptions return a SUBACK.
820 | this._requires_ack(wireMessage);
821 | this._schedule_message(wireMessage);
822 | };
823 |
824 | /** @ignore */
825 | ClientImpl.prototype.unsubscribe = function (filter, unsubscribeOptions) {
826 | this._trace("Client.unsubscribe", filter, unsubscribeOptions);
827 |
828 | if (!this.connected)
829 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
830 |
831 | var wireMessage = new WireMessage(MESSAGE_TYPE.UNSUBSCRIBE);
832 | wireMessage.topics = [filter];
833 |
834 | if (unsubscribeOptions.onSuccess) {
835 | wireMessage.callback = function () {
836 | unsubscribeOptions.onSuccess({invocationContext: unsubscribeOptions.invocationContext});
837 | };
838 | }
839 | if (unsubscribeOptions.timeout) {
840 | wireMessage.timeOut = new Timeout(this, window, unsubscribeOptions.timeout, unsubscribeOptions.onFailure
841 | , [
842 | {invocationContext: unsubscribeOptions.invocationContext,
843 | errorCode: ERROR.UNSUBSCRIBE_TIMEOUT.code,
844 | errorMessage: format(ERROR.UNSUBSCRIBE_TIMEOUT)}
845 | ]);
846 | }
847 |
848 | // All unsubscribes return a SUBACK.
849 | this._requires_ack(wireMessage);
850 | this._schedule_message(wireMessage);
851 | };
852 |
853 | ClientImpl.prototype.send = function (message) {
854 | this._trace("Client.send", message);
855 |
856 | if (!this.connected)
857 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
858 |
859 | wireMessage = new WireMessage(MESSAGE_TYPE.PUBLISH);
860 | wireMessage.payloadMessage = message;
861 |
862 | if (message.qos > 0)
863 | this._requires_ack(wireMessage);
864 | else if (this.onMessageDelivered)
865 | this._notify_msg_sent[wireMessage] = this.onMessageDelivered(wireMessage.payloadMessage);
866 | this._schedule_message(wireMessage);
867 | };
868 |
869 | ClientImpl.prototype.disconnect = function () {
870 | this._trace("Client.disconnect");
871 |
872 | if (!this.socket)
873 | throw new Error(format(ERROR.INVALID_STATE, ["not connecting or connected"]));
874 |
875 | wireMessage = new WireMessage(MESSAGE_TYPE.DISCONNECT);
876 |
877 | // Run the disconnected call back as soon as the message has been sent,
878 | // in case of a failure later on in the disconnect processing.
879 | // as a consequence, the _disconected call back may be run several times.
880 | this._notify_msg_sent[wireMessage] = scope(this._disconnected, this);
881 |
882 | this._schedule_message(wireMessage);
883 | };
884 |
885 | ClientImpl.prototype.getTraceLog = function () {
886 | if (this._traceBuffer !== null) {
887 | this._trace("Client.getTraceLog", new Date());
888 | this._trace("Client.getTraceLog in flight messages", this._sentMessages.length);
889 | for (key in this._sentMessages)
890 | this._trace("_sentMessages ", key, this._sentMessages[key]);
891 | for (key in this._receivedMessages)
892 | this._trace("_receivedMessages ", key, this._receivedMessages[key]);
893 |
894 | return this._traceBuffer;
895 | }
896 | };
897 |
898 | ClientImpl.prototype.startTrace = function () {
899 | if (this._traceBuffer === null) {
900 | this._traceBuffer = [];
901 | }
902 | this._trace("Client.startTrace", new Date(), version);
903 | };
904 |
905 | ClientImpl.prototype.stopTrace = function () {
906 | delete this._traceBuffer;
907 | };
908 |
909 | ClientImpl.prototype._doConnect = function (host, port) {
910 | // When the socket is open, this client will send the CONNECT WireMessage using the saved parameters.
911 | if (this.connectOptions.useSSL)
912 | wsurl = ["wss://", host, ":", port, "/mqtt"].join("");
913 | else
914 | wsurl = ["ws://", host, ":", port, "/mqtt"].join("");
915 | this.connected = false;
916 | this.socket = new WebSocket(wsurl, 'mqttv3.1');
917 | this.socket.binaryType = 'arraybuffer';
918 | this.socket.onopen = scope(this._on_socket_open, this);
919 | this.socket.onmessage = scope(this._on_socket_message, this);
920 | this.socket.onerror = scope(this._on_socket_error, this);
921 | this.socket.onclose = scope(this._on_socket_close, this);
922 |
923 | this.sendPinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
924 | this.receivePinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
925 |
926 | this._connectTimeout = new Timeout(this, window, this.connectOptions.timeout, this._disconnected, [ERROR.CONNECT_TIMEOUT.code, format(ERROR.CONNECT_TIMEOUT)]);
927 | };
928 |
929 |
930 | // Schedule a new message to be sent over the WebSockets
931 | // connection. CONNECT messages cause WebSocket connection
932 | // to be started. All other messages are queued internally
933 | // until this has happened. When WS connection starts, process
934 | // all outstanding messages.
935 | ClientImpl.prototype._schedule_message = function (message) {
936 | this._msg_queue.push(message);
937 | // Process outstanding messages in the queue if we have an open socket, and have received CONNACK.
938 | if (this.connected) {
939 | this._process_queue();
940 | }
941 | };
942 |
943 | ClientImpl.prototype.store = function (prefix, wireMessage) {
944 | storedMessage = {type: wireMessage.type, messageIdentifier: wireMessage.messageIdentifier, version: 1};
945 |
946 | switch (wireMessage.type) {
947 | case MESSAGE_TYPE.PUBLISH:
948 | if (wireMessage.pubRecReceived)
949 | storedMessage.pubRecReceived = true;
950 |
951 | // Convert the payload to a hex string.
952 | storedMessage.payloadMessage = {};
953 | var hex = "";
954 | var messageBytes = wireMessage.payloadMessage.payloadBytes;
955 | for (var i = 0; i < messageBytes.length; i++) {
956 | if (messageBytes[i] <= 0xF)
957 | hex = hex + "0" + messageBytes[i].toString(16);
958 | else
959 | hex = hex + messageBytes[i].toString(16);
960 | }
961 | storedMessage.payloadMessage.payloadHex = hex;
962 |
963 | storedMessage.payloadMessage.qos = wireMessage.payloadMessage.qos;
964 | storedMessage.payloadMessage.destinationName = wireMessage.payloadMessage.destinationName;
965 | if (wireMessage.payloadMessage.duplicate)
966 | storedMessage.payloadMessage.duplicate = true;
967 | if (wireMessage.payloadMessage.retained)
968 | storedMessage.payloadMessage.retained = true;
969 |
970 | // Add a sequence number to sent messages.
971 | if (prefix.indexOf("Sent:") == 0) {
972 | if (wireMessage.sequence === undefined)
973 | wireMessage.sequence = ++this._sequence;
974 | storedMessage.sequence = wireMessage.sequence;
975 | }
976 | break;
977 |
978 | default:
979 | throw Error(format(ERROR.INVALID_STORED_DATA, [key, storedMessage]));
980 | }
981 | localStorage.setItem(prefix + this._localKey + wireMessage.messageIdentifier, JSON.stringify(storedMessage));
982 | };
983 |
984 | ClientImpl.prototype.restore = function (key) {
985 | var value = localStorage.getItem(key);
986 | var storedMessage = JSON.parse(value);
987 |
988 | var wireMessage = new WireMessage(storedMessage.type, storedMessage);
989 |
990 | switch (storedMessage.type) {
991 | case MESSAGE_TYPE.PUBLISH:
992 | // Replace the payload message with a Message object.
993 | var hex = storedMessage.payloadMessage.payloadHex;
994 | var buffer = new ArrayBuffer((hex.length) / 2);
995 | var byteStream = new Uint8Array(buffer);
996 | var i = 0;
997 | while (hex.length >= 2) {
998 | var x = parseInt(hex.substring(0, 2), 16);
999 | hex = hex.substring(2, hex.length);
1000 | byteStream[i++] = x;
1001 | }
1002 | var payloadMessage = new Messaging.Message(byteStream);
1003 |
1004 | payloadMessage.qos = storedMessage.payloadMessage.qos;
1005 | payloadMessage.destinationName = storedMessage.payloadMessage.destinationName;
1006 | if (storedMessage.payloadMessage.duplicate)
1007 | payloadMessage.duplicate = true;
1008 | if (storedMessage.payloadMessage.retained)
1009 | payloadMessage.retained = true;
1010 | wireMessage.payloadMessage = payloadMessage;
1011 |
1012 | break;
1013 |
1014 | default:
1015 | throw Error(format(ERROR.INVALID_STORED_DATA, [key, value]));
1016 | }
1017 |
1018 | if (key.indexOf("Sent:" + this._localKey) == 0) {
1019 | this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
1020 | } else if (key.indexOf("Received:" + this._localKey) == 0) {
1021 | this._receivedMessages[wireMessage.messageIdentifier] = wireMessage;
1022 | }
1023 | };
1024 |
1025 | ClientImpl.prototype._process_queue = function () {
1026 | var message = null;
1027 | // Process messages in order they were added
1028 | var fifo = this._msg_queue.reverse();
1029 |
1030 | // Send all queued messages down socket connection
1031 | while ((message = fifo.pop())) {
1032 | this._socket_send(message);
1033 | // Notify listeners that message was successfully sent
1034 | if (this._notify_msg_sent[message]) {
1035 | this._notify_msg_sent[message]();
1036 | delete this._notify_msg_sent[message];
1037 | }
1038 | }
1039 | };
1040 |
1041 | /**
1042 | * @ignore
1043 | * Expect an ACK response for this message. Add message to the set of in progress
1044 | * messages and set an unused identifier in this message.
1045 | */
1046 | ClientImpl.prototype._requires_ack = function (wireMessage) {
1047 | var messageCount = Object.keys(this._sentMessages).length;
1048 | if (messageCount > this.maxMessageIdentifier)
1049 | throw Error("Too many messages:" + messageCount);
1050 |
1051 | while (this._sentMessages[this._message_identifier] !== undefined) {
1052 | this._message_identifier++;
1053 | }
1054 | wireMessage.messageIdentifier = this._message_identifier;
1055 | this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
1056 | if (wireMessage.type === MESSAGE_TYPE.PUBLISH) {
1057 | this.store("Sent:", wireMessage);
1058 | }
1059 | if (this._message_identifier === this.maxMessagIdentifier) {
1060 | this._message_identifier = 1;
1061 | }
1062 | };
1063 |
1064 | /**
1065 | * @ignore
1066 | * Called when the underlying websocket has been opened.
1067 | */
1068 | ClientImpl.prototype._on_socket_open = function () {
1069 | // Create the CONNECT message object.
1070 | var wireMessage = new WireMessage(MESSAGE_TYPE.CONNECT, this.connectOptions);
1071 | wireMessage.clientId = this.clientId;
1072 | this._socket_send(wireMessage);
1073 | };
1074 |
1075 | /**
1076 | * @ignore
1077 | * Called when the underlying websocket has received a complete packet.
1078 | */
1079 | ClientImpl.prototype._on_socket_message = function (event) {
1080 | this._trace("Client._on_socket_message", event.data);
1081 |
1082 | // Reset the receive ping timer, we now have evidence the server is alive.
1083 | this.receivePinger.reset();
1084 | var byteArray = new Uint8Array(event.data);
1085 | try {
1086 | var wireMessage = decodeMessage(byteArray);
1087 | } catch (error) {
1088 | this._disconnected(ERROR.INTERNAL_ERROR.code, format(ERROR.INTERNAL_ERROR, [error.message]));
1089 | return;
1090 | }
1091 | this._trace("Client._on_socket_message", wireMessage);
1092 |
1093 | switch (wireMessage.type) {
1094 | case MESSAGE_TYPE.CONNACK:
1095 | this._connectTimeout.cancel();
1096 |
1097 | // If we have started using clean session then clear up the local state.
1098 | if (this.connectOptions.cleanSession) {
1099 | for (key in this._sentMessages) {
1100 | var sentMessage = this._sentMessages[key];
1101 | localStorage.removeItem("Sent:" + this._localKey + sentMessage.messageIdentifier);
1102 | }
1103 | this._sentMessages = {};
1104 |
1105 | for (key in this._receivedMessages) {
1106 | var receivedMessage = this._receivedMessages[key];
1107 | localStorage.removeItem("Received:" + this._localKey + receivedMessage.messageIdentifier);
1108 | }
1109 | this._receivedMessages = {};
1110 | }
1111 | // Client connected and ready for business.
1112 | if (wireMessage.returnCode === 0) {
1113 | this.connected = true;
1114 | // Jump to the end of the list of hosts and stop looking for a good host.
1115 | if (this.connectOptions.hosts)
1116 | this.hostIndex = this.connectOptions.hosts.length;
1117 | } else {
1118 | this._disconnected(ERROR.CONNACK_RETURNCODE.code, format(ERROR.CONNACK_RETURNCODE, [wireMessage.returnCode, CONNACK_RC[wireMessage.returnCode]]));
1119 | break;
1120 | }
1121 |
1122 | // Resend messages.
1123 | var sequencedMessages = new Array();
1124 | for (var msgId in this._sentMessages) {
1125 | if (this._sentMessages.hasOwnProperty(msgId))
1126 | sequencedMessages.push(this._sentMessages[msgId]);
1127 | }
1128 |
1129 | // Sort sentMessages into the original sent order.
1130 | var sequencedMessages = sequencedMessages.sort(function (a, b) {
1131 | return a.sequence - b.sequence;
1132 | });
1133 | for (var i = 0, len = sequencedMessages.length; i < len; i++) {
1134 | var sentMessage = sequencedMessages[i];
1135 | if (sentMessage.type == MESSAGE_TYPE.PUBLISH && sentMessage.pubRecReceived) {
1136 | var pubRelMessage = new WireMessage(MESSAGE_TYPE.PUBREL, {messageIdentifier: sentMessage.messageIdentifier});
1137 | this._schedule_message(pubRelMessage);
1138 | } else {
1139 | this._schedule_message(sentMessage);
1140 | }
1141 | ;
1142 | }
1143 |
1144 | // Execute the connectOptions.onSuccess callback if there is one.
1145 | if (this.connectOptions.onSuccess) {
1146 | this.connectOptions.onSuccess({invocationContext: this.connectOptions.invocationContext});
1147 | }
1148 |
1149 | // Process all queued messages now that the connection is established.
1150 | this._process_queue();
1151 | break;
1152 |
1153 | case MESSAGE_TYPE.PUBLISH:
1154 | this._receivePublish(wireMessage);
1155 | break;
1156 |
1157 | case MESSAGE_TYPE.PUBACK:
1158 | var sentMessage = this._sentMessages[wireMessage.messageIdentifier];
1159 | // If this is a re flow of a PUBACK after we have restarted receivedMessage will not exist.
1160 | if (sentMessage) {
1161 | delete this._sentMessages[wireMessage.messageIdentifier];
1162 | localStorage.removeItem("Sent:" + this._localKey + wireMessage.messageIdentifier);
1163 | if (this.onMessageDelivered)
1164 | this.onMessageDelivered(sentMessage.payloadMessage);
1165 | }
1166 | break;
1167 |
1168 | case MESSAGE_TYPE.PUBREC:
1169 | var sentMessage = this._sentMessages[wireMessage.messageIdentifier];
1170 | // If this is a re flow of a PUBREC after we have restarted receivedMessage will not exist.
1171 | if (sentMessage) {
1172 | sentMessage.pubRecReceived = true;
1173 | var pubRelMessage = new WireMessage(MESSAGE_TYPE.PUBREL, {messageIdentifier: wireMessage.messageIdentifier});
1174 | this.store("Sent:", sentMessage);
1175 | this._schedule_message(pubRelMessage);
1176 | }
1177 | break;
1178 |
1179 | case MESSAGE_TYPE.PUBREL:
1180 | var receivedMessage = this._receivedMessages[wireMessage.messageIdentifier];
1181 | localStorage.removeItem("Received:" + this._localKey + wireMessage.messageIdentifier);
1182 | // If this is a re flow of a PUBREL after we have restarted receivedMessage will not exist.
1183 | if (receivedMessage) {
1184 | this._receiveMessage(receivedMessage);
1185 | delete this._receivedMessages[wireMessage.messageIdentifier];
1186 | }
1187 | // Always flow PubComp, we may have previously flowed PubComp but the server lost it and restarted.
1188 | pubCompMessage = new WireMessage(MESSAGE_TYPE.PUBCOMP, {messageIdentifier: wireMessage.messageIdentifier});
1189 | this._schedule_message(pubCompMessage);
1190 |
1191 |
1192 | break;
1193 |
1194 | case MESSAGE_TYPE.PUBCOMP:
1195 | var sentMessage = this._sentMessages[wireMessage.messageIdentifier];
1196 | delete this._sentMessages[wireMessage.messageIdentifier];
1197 | localStorage.removeItem("Sent:" + this._localKey + wireMessage.messageIdentifier);
1198 | if (this.onMessageDelivered)
1199 | this.onMessageDelivered(sentMessage.payloadMessage);
1200 | break;
1201 |
1202 | case MESSAGE_TYPE.SUBACK:
1203 | var sentMessage = this._sentMessages[wireMessage.messageIdentifier];
1204 | if (sentMessage) {
1205 | if (sentMessage.timeOut)
1206 | sentMessage.timeOut.cancel();
1207 | if (sentMessage.callback) {
1208 | sentMessage.callback();
1209 | }
1210 | delete this._sentMessages[wireMessage.messageIdentifier];
1211 | }
1212 | break;
1213 |
1214 | case MESSAGE_TYPE.UNSUBACK:
1215 | var sentMessage = this._sentMessages[wireMessage.messageIdentifier];
1216 | if (sentMessage) {
1217 | if (sentMessage.timeOut)
1218 | sentMessage.timeOut.cancel();
1219 | if (sentMessage.callback) {
1220 | sentMessage.callback();
1221 | }
1222 | delete this._sentMessages[wireMessage.messageIdentifier];
1223 | }
1224 |
1225 | break;
1226 |
1227 | case MESSAGE_TYPE.PINGRESP:
1228 | /* The sendPinger or receivePinger may have sent a ping, the receivePinger has already been reset. */
1229 | this.sendPinger.reset();
1230 | break;
1231 |
1232 | case MESSAGE_TYPE.DISCONNECT:
1233 | // Clients do not expect to receive disconnect packets.
1234 | this._disconnected(ERROR.INVALID_MQTT_MESSAGE_TYPE.code, format(ERROR.INVALID_MQTT_MESSAGE_TYPE, [wireMessage.type]));
1235 | break;
1236 |
1237 | default:
1238 | this._disconnected(ERROR.INVALID_MQTT_MESSAGE_TYPE.code, format(ERROR.INVALID_MQTT_MESSAGE_TYPE, [wireMessage.type]));
1239 | }
1240 | ;
1241 | };
1242 |
1243 | /** @ignore */
1244 | ClientImpl.prototype._on_socket_error = function (error) {
1245 | this._disconnected(ERROR.SOCKET_ERROR.code, format(ERROR.SOCKET_ERROR, [error.data]));
1246 | };
1247 |
1248 | /** @ignore */
1249 | ClientImpl.prototype._on_socket_close = function () {
1250 | this._disconnected(ERROR.SOCKET_CLOSE.code, format(ERROR.SOCKET_CLOSE));
1251 | };
1252 |
1253 | /** @ignore */
1254 | ClientImpl.prototype._socket_send = function (wireMessage) {
1255 | if (wireMessage.type == 1) {
1256 | var wireMessageMasked = this._traceMask(wireMessage, "password");
1257 | this._trace("Client._socket_send", wireMessageMasked);
1258 | }
1259 | else this._trace("Client._socket_send", wireMessage);
1260 |
1261 | this.socket.send(wireMessage.encode());
1262 | /* We have proved to the server we are alive. */
1263 | this.sendPinger.reset();
1264 | };
1265 |
1266 | /** @ignore */
1267 | ClientImpl.prototype._receivePublish = function (wireMessage) {
1268 | switch (wireMessage.payloadMessage.qos) {
1269 | case "undefined":
1270 | case 0:
1271 | this._receiveMessage(wireMessage);
1272 | break;
1273 |
1274 | case 1:
1275 | var pubAckMessage = new WireMessage(MESSAGE_TYPE.PUBACK, {messageIdentifier: wireMessage.messageIdentifier});
1276 | this._schedule_message(pubAckMessage);
1277 | this._receiveMessage(wireMessage);
1278 | break;
1279 |
1280 | case 2:
1281 | this._receivedMessages[wireMessage.messageIdentifier] = wireMessage;
1282 | this.store("Received:", wireMessage);
1283 | var pubRecMessage = new WireMessage(MESSAGE_TYPE.PUBREC, {messageIdentifier: wireMessage.messageIdentifier});
1284 | this._schedule_message(pubRecMessage);
1285 |
1286 | break;
1287 |
1288 | default:
1289 | throw Error("Invaild qos=" + wireMmessage.payloadMessage.qos);
1290 | }
1291 | ;
1292 | };
1293 |
1294 | /** @ignore */
1295 | ClientImpl.prototype._receiveMessage = function (wireMessage) {
1296 | if (this.onMessageArrived) {
1297 | this.onMessageArrived(wireMessage.payloadMessage);
1298 | }
1299 | };
1300 |
1301 | /**
1302 | * @ignore
1303 | * Client has disconnected either at its own request or because the server
1304 | * or network disconnected it. Remove all non-durable state.
1305 | * @param {errorCode} [number] the error number.
1306 | * @param {errorText} [string] the error text.
1307 | */
1308 | ClientImpl.prototype._disconnected = function (errorCode, errorText) {
1309 | this._trace("Client._disconnected", errorCode, errorText);
1310 |
1311 | this.sendPinger.cancel();
1312 | this.receivePinger.cancel();
1313 | if (this._connectTimeout)
1314 | this._connectTimeout.cancel();
1315 | // Clear message buffers.
1316 | this._msg_queue = [];
1317 | this._notify_msg_sent = {};
1318 |
1319 | if (this.socket) {
1320 | // Cancel all socket callbacks so that they cannot be driven again by this socket.
1321 | this.socket.onopen = null;
1322 | this.socket.onmessage = null;
1323 | this.socket.onerror = null;
1324 | this.socket.onclose = null;
1325 | if (this.socket.readyState === 1)
1326 | this.socket.close();
1327 | delete this.socket;
1328 | }
1329 |
1330 | if (this.connectOptions.hosts && this.hostIndex < this.connectOptions.hosts.length - 1) {
1331 | // Try the next host.
1332 | this.hostIndex++;
1333 | this._doConnect(this.connectOptions.hosts[this.hostIndex], this.connectOptions.ports[this.hostIndex]);
1334 |
1335 | } else {
1336 |
1337 | if (errorCode === undefined) {
1338 | errorCode = ERROR.OK.code;
1339 | errorText = format(ERROR.OK);
1340 | }
1341 |
1342 | // Run any application callbacks last as they may attempt to reconnect and hence create a new socket.
1343 | if (this.connected) {
1344 | this.connected = false;
1345 | // Execute the connectionLostCallback if there is one, and we were connected.
1346 | if (this.onConnectionLost)
1347 | this.onConnectionLost({errorCode: errorCode, errorMessage: errorText});
1348 | } else {
1349 | // Otherwise we never had a connection, so indicate that the connect has failed.
1350 | if (this.connectOptions.onFailure)
1351 | this.connectOptions.onFailure({invocationContext: this.connectOptions.invocationContext, errorCode: errorCode, errorMessage: errorText});
1352 | }
1353 | }
1354 | };
1355 |
1356 | /** @ignore */
1357 | ClientImpl.prototype._trace = function () {
1358 | if (this._traceBuffer !== null) {
1359 | for (var i = 0, max = arguments.length; i < max; i++) {
1360 | if (this._traceBuffer.length == this._MAX_TRACE_ENTRIES) {
1361 | this._traceBuffer.shift();
1362 | }
1363 | if (i === 0) this._traceBuffer.push(arguments[i]);
1364 | else if (typeof arguments[i] === "undefined") this._traceBuffer.push(arguments[i]);
1365 | else this._traceBuffer.push(" " + JSON.stringify(arguments[i]));
1366 | }
1367 | ;
1368 | }
1369 | ;
1370 | };
1371 |
1372 | /** @ignore */
1373 | ClientImpl.prototype._traceMask = function (traceObject, masked) {
1374 | var traceObjectMasked = {};
1375 | for (var attr in traceObject) {
1376 | if (traceObject.hasOwnProperty(attr)) {
1377 | if (attr == masked)
1378 | traceObjectMasked[attr] = "******";
1379 | else
1380 | traceObjectMasked[attr] = traceObject[attr];
1381 | }
1382 | }
1383 | return traceObjectMasked;
1384 | };
1385 |
1386 | // ------------------------------------------------------------------------
1387 | // Public Programming interface.
1388 | // ------------------------------------------------------------------------
1389 |
1390 | /**
1391 | * The JavaScript application communicates to the server using a Messaging.Client object.
1392 | *
1393 | * Other programming languages,
1394 | * Java,
1395 | * C.
1396 | *
1397 | * Most applications will create just one Client object and then call its connect() method,
1398 | * however applications can create more than one Client object if they wish.
1399 | * In this case the combination of host, port and clientId attributes must be different for each Client object.
1400 | *
1401 | * The send, subscribe and unsubscribe methods are implemented as asynchronous JavaScript methods
1402 | * (even though the underlying protocol exchange might be synchronous in nature).
1403 | * This means they signal their completion by calling back to the application,
1404 | * via Success or Failure callback functions provided by the application on the method in question.
1405 | * Such callbacks are called at most once per method invocation and do not persist beyond the lifetime
1406 | * of the script that made the invocation.
1407 | *
1408 | * In contrast there are some callback functions most notably onMessageArrived
1409 | * that are defined on the Messaging.Client object.
1410 | * These may get called multiple times, and aren't directly related to specific method invocations made by the client.
1411 | *
1412 | * @name Messaging.Client
1413 | *
1414 | * @constructor
1415 | * Creates a Messaging.Client object that can be used to communicate with a Messaging server.
1416 | *
1417 | * @param {string} host the address of the messaging server, as a DNS name or dotted decimal IP address.
1418 | * @param {number} port the port number in the host to connect to.
1419 | * @param {string} clientId the Messaging client identifier, between 1 and 23 characters in length.
1420 | *
1421 | * @property {string} host read only the server's DNS hostname or dotted decimal IP address.
1422 | * @property {number} port read only the server's port.
1423 | * @property {string} clientId read only used when connecting to the server.
1424 | * @property {function} onConnectionLost called when a connection has been lost,
1425 | * after a connect() method has succeeded.
1426 | * Establish the call back used when a connection has been lost. The connection may be
1427 | * lost because the client initiates a disconnect or because the server or network
1428 | * cause the client to be disconnected. The disconnect call back may be called without
1429 | * the connectionComplete call back being invoked if, for example the client fails to
1430 | * connect.
1431 | * A single response object parameter is passed to the onConnectionLost callback containing the following fields:
1432 | *
1433 | * - errorCode
1434 | *
- errorMessage
1435 | *
1436 | * @property {function} onMessageDelivered called when a message has been delivered.
1437 | * All processing that this Client will ever do has been completed. So, for example,
1438 | * in the case of a Qos=2 message sent by this client, the PubComp flow has been received from the server
1439 | * and the message has been removed from persistent storage before this callback is invoked.
1440 | * Parameters passed to the onMessageDelivered callback are:
1441 | *
1442 | * - Messaging.Message that was delivered.
1443 | *
1444 | * @property {function} onMessageArrived called when a message has arrived in this Messaging.client.
1445 | * Parameters passed to the onMessageArrived callback are:
1446 | *
1447 | * - Messaging.Message that has arrived.
1448 | *
1449 | */
1450 | var Client = function (host, port, clientId) {
1451 | if (typeof host !== "string")
1452 | throw new Error(format(ERROR.INVALID_TYPE, [typeof host, "host"]));
1453 | if (typeof port !== "number" || port < 0)
1454 | throw new Error(format(ERROR.INVALID_TYPE, [typeof port, "port"]));
1455 |
1456 | var clientIdLength = 0;
1457 | for (var i = 0; i < clientId.length; i++) {
1458 | var charCode = clientId.charCodeAt(i);
1459 | if (0xD800 <= charCode && charCode <= 0xDBFF) {
1460 | i++; // Surrogate pair.
1461 | }
1462 | clientIdLength++;
1463 | }
1464 | if (typeof clientId !== "string" || clientIdLength < 1 | clientIdLength > 23)
1465 | throw new Error(format(ERROR.INVALID_ARGUMENT, [clientId, "clientId"]));
1466 |
1467 | var client = new ClientImpl(host, port, clientId);
1468 | this._getHost = function () {
1469 | return client.host;
1470 | };
1471 | this._setHost = function () {
1472 | throw new Error(format(ERROR.UNSUPPORTED_OPERATION));
1473 | };
1474 |
1475 | this._getPort = function () {
1476 | return client.port;
1477 | };
1478 | this._setPort = function () {
1479 | throw new Error(format(ERROR.UNSUPPORTED_OPERATION));
1480 | };
1481 |
1482 | this._getClientId = function () {
1483 | return client.clientId;
1484 | };
1485 | this._setClientId = function () {
1486 | throw new Error(format(ERROR.UNSUPPORTED_OPERATION));
1487 | };
1488 |
1489 | this._getOnConnectionLost = function () {
1490 | return client.onConnectionLost;
1491 | };
1492 | this._setOnConnectionLost = function (newOnConnectionLost) {
1493 | if (typeof newOnConnectionLost === "function")
1494 | client.onConnectionLost = newOnConnectionLost;
1495 | else
1496 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnConnectionLost, "onConnectionLost"]));
1497 | };
1498 |
1499 | this._getOnMessageDelivered = function () {
1500 | return client.onMessageDelivered;
1501 | };
1502 | this._setOnMessageDelivered = function (newOnMessageDelivered) {
1503 | if (typeof newOnMessageDelivered === "function")
1504 | client.onMessageDelivered = newOnMessageDelivered;
1505 | else
1506 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageDelivered, "onMessageDelivered"]));
1507 | };
1508 |
1509 | this._getOnMessageArrived = function () {
1510 | return client.onMessageArrived;
1511 | };
1512 | this._setOnMessageArrived = function (newOnMessageArrived) {
1513 | if (typeof newOnMessageArrived === "function")
1514 | client.onMessageArrived = newOnMessageArrived;
1515 | else
1516 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageArrived, "onMessageArrived"]));
1517 | };
1518 |
1519 | /**
1520 | * Connect this Messaging client to its server.
1521 | *
1522 | * @name Messaging.Client#connect
1523 | * @function
1524 | * @param {Object} [connectOptions] attributes used with the connection.
1525 | *
1526 | * Properties of the connect options are:
1527 | * @config {number} [timeout] If the connect has not succeeded within this number of seconds, it is deemed to have failed.
1528 | * The default is 30 seconds.
1529 | * @config {string} [userName] Authentication username for this connection.
1530 | * @config {string} [password] Authentication password for this connection.
1531 | * @config {Messaging.Message} [willMessage] sent by the server when the client disconnects abnormally.
1532 | * @config {Number} [keepAliveInterval] the server disconnects this client if there is no activity for this
1533 | * number of seconds. The default value of 60 seconds is assumed if not set.
1534 | * @config {boolean} [cleanSession] if true(default) the client and server persistent state is deleted on successful connect.
1535 | * @config {boolean} [useSSL] if present and true, use an SSL Websocket connection.
1536 | * @config {object} [invocationContext] passed to the onSuccess callback or onFailure callback.
1537 | * @config {function} [onSuccess] called when the connect acknowledgement has been received from the server.
1538 | * A single response object parameter is passed to the onSuccess callback containing the following fields:
1539 | *
1540 | * - invocationContext as passed in to the onSuccess method in the connectOptions.
1541 | *
1542 | * @config {function} [onFailure] called when the connect request has failed or timed out.
1543 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1544 | *
1545 | * - invocationContext as passed in to the onFailure method in the connectOptions.
1546 | *
- errorCode a number indicating the nature of the error.
1547 | *
- errorMessage text describing the error.
1548 | *
1549 | * @config {Array} [hosts] If present this set of hostnames is tried in order in place
1550 | * of the host and port paramater on the construtor. The hosts and the matching ports are tried one at at time in order until
1551 | * one of then succeeds.
1552 | * @config {Array} [ports] If present this set of ports matching the hosts.
1553 | * @throws {InvalidState} if the client is not in disconnected state. The client must have received connectionLost
1554 | * or disconnected before calling connect for a second or subsequent time.
1555 | */
1556 | this.connect = function (connectOptions) {
1557 | connectOptions = connectOptions || {};
1558 | validate(connectOptions, {timeout: "number",
1559 | userName: "string",
1560 | password: "string",
1561 | willMessage: "object",
1562 | keepAliveInterval: "number",
1563 | cleanSession: "boolean",
1564 | useSSL: "boolean",
1565 | invocationContext: "object",
1566 | onSuccess: "function",
1567 | onFailure: "function",
1568 | hosts: "object",
1569 | ports: "object"});
1570 |
1571 | // If no keep alive interval is set, assume 60 seconds.
1572 | if (connectOptions.keepAliveInterval === undefined)
1573 | connectOptions.keepAliveInterval = 60;
1574 |
1575 | if (connectOptions.willMessage) {
1576 | if (!(connectOptions.willMessage instanceof Message))
1577 | throw new Error(format(ERROR.INVALID_TYPE, [connectOptions.willMessage, "connectOptions.willMessage"]));
1578 | // The will message must have a payload that can be represented as a string.
1579 | // Cause the willMessage to throw an exception if this is not the case.
1580 | connectOptions.willMessage.stringPayload;
1581 |
1582 | if (typeof connectOptions.willMessage.destinationName === "undefined")
1583 | throw new Error(format(ERROR.INVALID_TYPE, [typeof connectOptions.willMessage.destinationName, "connectOptions.willMessage.destinationName"]));
1584 | }
1585 | if (typeof connectOptions.cleanSession === "undefined")
1586 | connectOptions.cleanSession = true;
1587 | if (connectOptions.hosts) {
1588 | if (!connectOptions.ports)
1589 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.ports, "connectOptions.ports"]));
1590 | if (!(connectOptions.hosts instanceof Array))
1591 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
1592 | if (!(connectOptions.ports instanceof Array))
1593 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.ports, "connectOptions.ports"]));
1594 | if (connectOptions.hosts.length < 1)
1595 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
1596 | if (connectOptions.hosts.length != connectOptions.ports.length)
1597 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.ports, "connectOptions.ports"]));
1598 | for (var i = 0; i < connectOptions.hosts.length; i++) {
1599 | if (typeof connectOptions.hosts[i] !== "string")
1600 | throw new Error(format(ERROR.INVALID_TYPE, [typeof connectOptions.hosts[i], "connectOptions.hosts[" + i + "]"]));
1601 | if (typeof connectOptions.ports[i] !== "number" || connectOptions.ports[i] < 0)
1602 | throw new Error(format(ERROR.INVALID_TYPE, [typeof connectOptions.ports[i], "connectOptions.ports[" + i + "]"]));
1603 | }
1604 | }
1605 |
1606 | client.connect(connectOptions);
1607 | };
1608 |
1609 | /**
1610 | * Subscribe for messages, request receipt of a copy of messages sent to the destinations described by the filter.
1611 | *
1612 | * @name Messaging.Client#subscribe
1613 | * @function
1614 | * @param {string} filter describing the destinations to receive messages from.
1615 | *
1616 | * @param {object} [subscribeOptions] used to control the subscription, as follows:
1617 | *
1618 | * @config {number} [qos] the maiximum qos of any publications sent as a result of making this subscription.
1619 | * @config {object} [invocationContext] passed to the onSuccess callback or onFailure callback.
1620 | * @config {function} [onSuccess] called when the subscribe acknowledgement has been received from the server.
1621 | * A single response object parameter is passed to the onSuccess callback containing the following fields:
1622 | *
1623 | * - invocationContext if set in the subscribeOptions.
1624 | *
1625 | * @config {function} [onFailure] called when the subscribe request has failed or timed out.
1626 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1627 | *
1628 | * - invocationContext if set in the subscribeOptions.
1629 | *
- errorCode a number indicating the nature of the error.
1630 | *
- errorMessage text describing the error.
1631 | *
1632 | * @config {number} [timeout] which if present determines the number of seconds after which the onFailure calback is called
1633 | * the presence of a timeout does not prevent the onSuccess callback from being called when the MQTT Suback is eventually received.
1634 | * @throws {InvalidState} if the client is not in connected state.
1635 | */
1636 | this.subscribe = function (filter, subscribeOptions) {
1637 | if (typeof filter !== "string")
1638 | throw new Error("Invalid argument:" + filter);
1639 | subscribeOptions = subscribeOptions || {};
1640 | validate(subscribeOptions, {qos: "number",
1641 | invocationContext: "object",
1642 | onSuccess: "function",
1643 | onFailure: "function",
1644 | timeout: "number"
1645 | });
1646 | if (subscribeOptions.timeout && !subscribeOptions.onFailure)
1647 | throw new Error("subscribeOptions.timeout specified with no onFailure callback.");
1648 | if (typeof subscribeOptions.qos !== "undefined"
1649 | && !(subscribeOptions.qos === 0 || subscribeOptions.qos === 1 || subscribeOptions.qos === 2 ))
1650 | throw new Error(format(ERROR.INVALID_ARGUMENT, [subscribeOptions.qos, "subscribeOptions.qos"]));
1651 | client.subscribe(filter, subscribeOptions);
1652 | };
1653 |
1654 | /**
1655 | * Unsubscribe for messages, stop receiving messages sent to destinations described by the filter.
1656 | *
1657 | * @name Messaging.Client#unsubscribe
1658 | * @function
1659 | * @param {string} filter describing the destinations to receive messages from.
1660 | * @param {object} [unsubscribeOptions] used to control the subscription, as follows:
1661 | *
1662 | * @config {object} [invocationContext] passed to the onSuccess callback or onFailure callback.
1663 | * @config {function} [onSuccess] called when the unsubscribe acknowledgement has been receive dfrom the server.
1664 | * A single response object parameter is passed to the onSuccess callback containing the following fields:
1665 | *
1666 | * - invocationContext if set in the unsubscribeOptions.
1667 | *
1668 | * @config {function} [onFailure] called when the unsubscribe request has failed or timed out.
1669 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1670 | *
1671 | * - invocationContext if set in the unsubscribeOptions.
1672 | *
- errorCode a number indicating the nature of the error.
1673 | *
- errorMessage text describing the error.
1674 | *
1675 | * @config {number} [timeout] which if present determines the number of seconds after which the onFailure callback is called, the
1676 | * presence of a timeout does not prevent the onSuccess callback from being called when the MQTT UnSuback is eventually received.
1677 | * @throws {InvalidState} if the client is not in connected state.
1678 | */
1679 | this.unsubscribe = function (filter, unsubscribeOptions) {
1680 | if (typeof filter !== "string")
1681 | throw new Error("Invalid argument:" + filter);
1682 | unsubscribeOptions = unsubscribeOptions || {};
1683 | validate(unsubscribeOptions, {invocationContext: "object",
1684 | onSuccess: "function",
1685 | onFailure: "function",
1686 | timeout: "number"
1687 | });
1688 | if (unsubscribeOptions.timeout && !unsubscribeOptions.onFailure)
1689 | throw new Error("unsubscribeOptions.timeout specified with no onFailure callback.");
1690 | client.unsubscribe(filter, unsubscribeOptions);
1691 | };
1692 |
1693 | /**
1694 | * Send a message to the consumers of the destination in the Message.
1695 | *
1696 | * @name Messaging.Client#send
1697 | * @function
1698 | * @param {Messaging.Message} message to send.
1699 |
1700 | * @throws {InvalidState} if the client is not in connected state.
1701 | */
1702 | this.send = function (message) {
1703 | if (!(message instanceof Message))
1704 | throw new Error("Invalid argument:" + typeof message);
1705 | if (typeof message.destinationName === "undefined")
1706 | throw new Error("Invalid parameter Message.destinationName:" + message.destinationName);
1707 |
1708 | client.send(message);
1709 | };
1710 |
1711 | /**
1712 | * Normal disconnect of this Messaging client from its server.
1713 | *
1714 | * @name Messaging.Client#disconnect
1715 | * @function
1716 | * @throws {InvalidState} if the client is not in connected or connecting state.
1717 | */
1718 | this.disconnect = function () {
1719 | client.disconnect();
1720 | };
1721 |
1722 | /**
1723 | * Get the contents of the trace log.
1724 | *
1725 | * @name Messaging.Client#getTraceLog
1726 | * @function
1727 | * @return {Object[]} tracebuffer containing the time ordered trace records.
1728 | */
1729 | this.getTraceLog = function () {
1730 | return client.getTraceLog();
1731 | }
1732 |
1733 | /**
1734 | * Start tracing.
1735 | *
1736 | * @name Messaging.Client#startTrace
1737 | * @function
1738 | */
1739 | this.startTrace = function () {
1740 | client.startTrace();
1741 | };
1742 |
1743 | /**
1744 | * Stop tracing.
1745 | *
1746 | * @name Messaging.Client#stopTrace
1747 | * @function
1748 | */
1749 | this.stopTrace = function () {
1750 | client.stopTrace();
1751 | };
1752 | };
1753 |
1754 | Client.prototype = {
1755 | get host() {
1756 | return this._getHost();
1757 | },
1758 | set host(newHost) {
1759 | this._setHost(newHost);
1760 | },
1761 |
1762 | get port() {
1763 | return this._getPort();
1764 | },
1765 | set port(newPort) {
1766 | this._setPort(newPort);
1767 | },
1768 |
1769 | get clientId() {
1770 | return this._getClientId();
1771 | },
1772 | set clientId(newClientId) {
1773 | this._setClientId(newClientId);
1774 | },
1775 |
1776 | get onConnectionLost() {
1777 | return this._getOnConnectionLost();
1778 | },
1779 | set onConnectionLost(newOnConnectionLost) {
1780 | this._setOnConnectionLost(newOnConnectionLost);
1781 | },
1782 |
1783 | get onMessageDelivered() {
1784 | return this._getOnMessageDelivered();
1785 | },
1786 | set onMessageDelivered(newOnMessageDelivered) {
1787 | this._setOnMessageDelivered(newOnMessageDelivered);
1788 | },
1789 |
1790 | get onMessageArrived() {
1791 | return this._getOnMessageArrived();
1792 | },
1793 | set onMessageArrived(newOnMessageArrived) {
1794 | this._setOnMessageArrived(newOnMessageArrived);
1795 | }
1796 | };
1797 |
1798 | /**
1799 | * An application message, sent or received.
1800 | *
1801 | * Other programming languages,
1802 | * Java,
1803 | * C.
1804 | *
1805 | * All attributes may be null, which implies the default values.
1806 | *
1807 | * @name Messaging.Message
1808 | * @constructor
1809 | * @param {String|ArrayBuffer} payload The message data to be sent.
1810 | *
1811 | * @property {string} payloadString read only The payload as a string if the payload consists of valid UTF-8 characters.
1812 | * @property {ArrayBuffer} payloadBytes read only The payload as an ArrayBuffer.
1813 | *
1814 | * @property {string} destinationName mandatory The name of the destination to which the message is to be sent
1815 | * (for messages about to be sent) or the name of the destination from which the message has been received.
1816 | * (for messages received by the onMessage function).
1817 | *
1818 | * @property {number} qos The Quality of Service used to deliver the message.
1819 | *
1820 | * - 0 Best effort (default).
1821 | *
- 1 At least once.
1822 | *
- 2 Exactly once.
1823 | *
1824 | *
1825 | * @property {Boolean} retained If true, the message is to be retained by the server and delivered
1826 | * to both current and future subscriptions.
1827 | * If false the server only delivers the message to current subscribers, this is the default for new Messages.
1828 | * A received message has the retained boolean set to true if the message was published
1829 | * with the retained boolean set to true
1830 | * and the subscrption was made after the message has been published.
1831 | *
1832 | * @property {Boolean} duplicate read only If true, this message might be a duplicate of one which has already been received.
1833 | * This is only set on messages received from the server.
1834 | *
1835 | */
1836 | var Message = function (newPayload) {
1837 | var payload;
1838 | if (typeof newPayload === "string"
1839 | || newPayload instanceof ArrayBuffer
1840 | || newPayload instanceof Int8Array
1841 | || newPayload instanceof Uint8Array
1842 | || newPayload instanceof Int16Array
1843 | || newPayload instanceof Uint16Array
1844 | || newPayload instanceof Int32Array
1845 | || newPayload instanceof Uint32Array
1846 | || newPayload instanceof Float32Array
1847 | || newPayload instanceof Float64Array
1848 | ) {
1849 | payload = newPayload;
1850 | } else {
1851 | throw (format(ERROR.INVALID_ARGUMENT, [newPayload, "newPayload"]));
1852 | }
1853 |
1854 | this._getPayloadString = function () {
1855 | if (typeof payload === "string")
1856 | return payload;
1857 | else
1858 | return parseUTF8(payload, 0, payload.length);
1859 | };
1860 |
1861 | this._getPayloadBytes = function () {
1862 | if (typeof payload === "string") {
1863 | var buffer = new ArrayBuffer(UTF8Length(payload));
1864 | var byteStream = new Uint8Array(buffer);
1865 | stringToUTF8(payload, byteStream, 0);
1866 |
1867 | return byteStream;
1868 | } else {
1869 | return payload;
1870 | }
1871 | ;
1872 | };
1873 |
1874 | var destinationName = undefined;
1875 | this._getDestinationName = function () {
1876 | return destinationName;
1877 | };
1878 | this._setDestinationName = function (newDestinationName) {
1879 | if (typeof newDestinationName === "string")
1880 | destinationName = newDestinationName;
1881 | else
1882 | throw new Error(format(ERROR.INVALID_ARGUMENT, [newDestinationName, "newDestinationName"]));
1883 | };
1884 |
1885 | var qos = 0;
1886 | this._getQos = function () {
1887 | return qos;
1888 | };
1889 | this._setQos = function (newQos) {
1890 | if (newQos === 0 || newQos === 1 || newQos === 2)
1891 | qos = newQos;
1892 | else
1893 | throw new Error("Invalid argument:" + newQos);
1894 | };
1895 |
1896 | var retained = false;
1897 | this._getRetained = function () {
1898 | return retained;
1899 | };
1900 | this._setRetained = function (newRetained) {
1901 | if (typeof newRetained === "boolean")
1902 | retained = newRetained;
1903 | else
1904 | throw new Error(format(ERROR.INVALID_ARGUMENT, [newRetained, "newRetained"]));
1905 | };
1906 |
1907 | var duplicate = false;
1908 | this._getDuplicate = function () {
1909 | return duplicate;
1910 | };
1911 | this._setDuplicate = function (newDuplicate) {
1912 | duplicate = newDuplicate;
1913 | };
1914 | };
1915 |
1916 | Message.prototype = {
1917 | get payloadString() {
1918 | return this._getPayloadString();
1919 | },
1920 | get payloadBytes() {
1921 | return this._getPayloadBytes();
1922 | },
1923 |
1924 | get destinationName() {
1925 | return this._getDestinationName();
1926 | },
1927 | set destinationName(newDestinationName) {
1928 | this._setDestinationName(newDestinationName);
1929 | },
1930 |
1931 | get qos() {
1932 | return this._getQos();
1933 | },
1934 | set qos(newQos) {
1935 | this._setQos(newQos);
1936 | },
1937 |
1938 | get retained() {
1939 | return this._getRetained();
1940 | },
1941 | set retained(newRetained) {
1942 | this._setRetained(newRetained);
1943 | },
1944 |
1945 | get duplicate() {
1946 | return this._getDuplicate();
1947 | },
1948 | set duplicate(newDuplicate) {
1949 | this._setDuplicate(newDuplicate);
1950 | }
1951 | };
1952 |
1953 | // Module contents.
1954 | return {
1955 | Client: Client,
1956 | Message: Message
1957 | };
1958 | })(window);
1959 |
--------------------------------------------------------------------------------
