14 |
15 |
16 |
--------------------------------------------------------------------------------
/priv/main.css:
--------------------------------------------------------------------------------
1 | body {
2 | font-family: "Arial";
3 | color: #444;
4 | }
5 |
6 | h1, h2 {
7 | color: #f60;
8 | font-weight: normal;
9 | }
10 |
11 | h1 {
12 | font-size: 1.5em;
13 | }
14 |
15 | h2 {
16 | font-size: 1.2em;
17 | margin: 0;
18 | }
19 |
20 | a {
21 | color: #f60;
22 | border: 1px solid #fda;
23 | background: #fff0e0;
24 | border-radius: 3px; -moz-border-radius: 3px;
25 | padding: 2px;
26 | text-decoration: none;
27 | /* font-weight: bold; */
28 | }
29 |
30 | ul.menu {
31 | list-style-type: none;
32 | padding: 0;
33 | margin: 0;
34 | }
35 |
36 | ul.menu li {
37 | padding: 5px 0;
38 | }
39 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | PROJECT = rabbitmq_web_mqtt_examples
2 | PROJECT_DESCRIPTION = Rabbit WEB-MQTT - examples
3 | PROJECT_MOD = rabbit_web_mqtt_examples_app
4 |
5 | define PROJECT_ENV
6 | [
7 | {listener, [{port, 15670}]}
8 | ]
9 | endef
10 |
11 | DEPS = rabbit_common rabbit rabbitmq_web_dispatch rabbitmq_web_mqtt
12 |
13 | DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk
14 | DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk
15 |
16 | # FIXME: Use erlang.mk patched for RabbitMQ, while waiting for PRs to be
17 | # reviewed and merged.
18 |
19 | ERLANG_MK_REPO = https://github.com/rabbitmq/erlang.mk.git
20 | ERLANG_MK_COMMIT = rabbitmq-tmp
21 |
22 | include rabbitmq-components.mk
23 | include erlang.mk
24 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # RabbitMQ Web MQTT Examples
2 |
3 | ## This was migrated to https://github.com/rabbitmq/rabbitmq-server
4 |
5 | This repository has been moved to the main unified RabbitMQ "monorepo", including all open issues. You can find the source under [/deps/rabbitmq_web_mqtt_examples](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_web_mqtt_examples).
6 | All issues have been transferred.
7 |
8 | ## Introduction
9 |
10 | This RabbitMQ plugin contains few basic examples of [RabbitMQ Web MQTT plugin](https://github.com/rabbitmq/rabbitmq-web-mqtt)
11 | usage.
12 |
13 | It starts a server that binds to port 15670 and serves a few static
14 | HTML files on port 15670 (e.g. [http://127.0.0.1:15670](http://127.0.0.1:15670/)).
15 | Note that Web STOMP examples use the same port, so these plugins cannot be enabled
16 | at the same time unless they are configured to use different ports.
17 |
18 | ## Installation
19 |
20 | This plugin ships with RabbitMQ. Enabled it using [CLI tools](https://www.rabbitmq.com/cli.html):
21 |
22 | rabbitmq-plugins enable rabbitmq_web_mqtt_examples
23 |
--------------------------------------------------------------------------------
/src/rabbit_web_mqtt_examples_app.erl:
--------------------------------------------------------------------------------
1 | %% This Source Code Form is subject to the terms of the Mozilla Public
2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this
3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/.
4 | %%
5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved.
6 | %%
7 |
8 | -module(rabbit_web_mqtt_examples_app).
9 |
10 | -behaviour(application).
11 | -export([start/2,stop/1]).
12 |
13 | %% Dummy supervisor - see Ulf Wiger's comment at
14 | %% http://erlang.2086793.n4.nabble.com/initializing-library-applications-without-processes-td2094473.html
15 | -behaviour(supervisor).
16 | -export([init/1]).
17 |
18 | start(_Type, _StartArgs) ->
19 | {ok, Listener} = application:get_env(rabbitmq_web_mqtt_examples, listener),
20 | {ok, _} = rabbit_web_dispatch:register_static_context(
21 | web_mqtt_examples, Listener, "web-mqtt-examples", ?MODULE,
22 | "priv", "WEB-MQTT: examples"),
23 | supervisor:start_link({local, ?MODULE}, ?MODULE, []).
24 |
25 | stop(_State) ->
26 | rabbit_web_dispatch:unregister_context(web_mqtt_examples),
27 | ok.
28 |
29 | init([]) -> {ok, {{one_for_one, 3, 10}, []}}.
30 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | ## Overview
2 |
3 | RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions.
4 | Pull requests is the primary place of discussing code changes.
5 |
6 | ## How to Contribute
7 |
8 | The process is fairly standard:
9 |
10 | * Fork the repository or repositories you plan on contributing to
11 | * Clone [RabbitMQ umbrella repository](https://github.com/rabbitmq/rabbitmq-public-umbrella)
12 | * `cd umbrella`, `make co`
13 | * Create a branch with a descriptive name in the relevant repositories
14 | * Make your changes, run tests, commit with a [descriptive message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), push to your fork
15 | * Submit pull requests with an explanation what has been changed and **why**
16 | * Submit a filled out and signed [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) if needed (see below)
17 | * Be patient. We will get to your pull request eventually
18 |
19 | If what you are going to work on is a substantial change, please first ask the core team
20 | of their opinion on [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).
21 |
22 |
23 | ## Code of Conduct
24 |
25 | See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
26 |
27 |
28 | ## Contributor Agreement
29 |
30 | If you want to contribute a non-trivial change, please submit a signed copy of our
31 | [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) around the time
32 | you submit your pull request. This will make it much easier (in some cases, possible)
33 | for the RabbitMQ team at Pivotal to merge your contribution.
34 |
35 |
36 | ## Where to Ask Questions
37 |
38 | If something isn't clear, feel free to ask on our [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users).
39 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Code of Conduct
2 |
3 | As contributors and maintainers of this project, and in the interest of fostering an open
4 | and welcoming community, we pledge to respect all people who contribute through reporting
5 | issues, posting feature requests, updating documentation, submitting pull requests or
6 | patches, and other activities.
7 |
8 | We are committed to making participation in this project a harassment-free experience for
9 | everyone, regardless of level of experience, gender, gender identity and expression,
10 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
11 | religion, or nationality.
12 |
13 | Examples of unacceptable behavior by participants include:
14 |
15 | * The use of sexualized language or imagery
16 | * Personal attacks
17 | * Trolling or insulting/derogatory comments
18 | * Public or private harassment
19 | * Publishing other's private information, such as physical or electronic addresses,
20 | without explicit permission
21 | * Other unethical or unprofessional conduct
22 |
23 | Project maintainers have the right and responsibility to remove, edit, or reject comments,
24 | commits, code, wiki edits, issues, and other contributions that are not aligned to this
25 | Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors
26 | that they deem inappropriate, threatening, offensive, or harmful.
27 |
28 | By adopting this Code of Conduct, project maintainers commit themselves to fairly and
29 | consistently applying these principles to every aspect of managing this project. Project
30 | maintainers who do not follow or enforce the Code of Conduct may be permanently removed
31 | from the project team.
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an
34 | individual is representing the project or its community.
35 |
36 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
37 | contacting a project maintainer at [info@rabbitmq.com](mailto:info@rabbitmq.com). All complaints will
38 | be reviewed and investigated and will result in a response that is deemed necessary and
39 | appropriate to the circumstances. Maintainers are obligated to maintain confidentiality
40 | with regard to the reporter of an incident.
41 |
42 | This Code of Conduct is adapted from the
43 | [Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at
44 | [contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/)
45 |
--------------------------------------------------------------------------------
/priv/echo.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | RabbitMQ Web MQTT Example
6 |
7 |
8 |
45 |
46 |
47 |
48 |
27 |
28 |
169 |
170 |
--------------------------------------------------------------------------------
/LICENSE-MPL-RabbitMQ:
--------------------------------------------------------------------------------
1 | Mozilla Public License Version 2.0
2 | ==================================
3 |
4 | 1. Definitions
5 | --------------
6 |
7 | 1.1. "Contributor"
8 | means each individual or legal entity that creates, contributes to
9 | the creation of, or owns Covered Software.
10 |
11 | 1.2. "Contributor Version"
12 | means the combination of the Contributions of others (if any) used
13 | by a Contributor and that particular Contributor's Contribution.
14 |
15 | 1.3. "Contribution"
16 | means Covered Software of a particular Contributor.
17 |
18 | 1.4. "Covered Software"
19 | means Source Code Form to which the initial Contributor has attached
20 | the notice in Exhibit A, the Executable Form of such Source Code
21 | Form, and Modifications of such Source Code Form, in each case
22 | including portions thereof.
23 |
24 | 1.5. "Incompatible With Secondary Licenses"
25 | means
26 |
27 | (a) that the initial Contributor has attached the notice described
28 | in Exhibit B to the Covered Software; or
29 |
30 | (b) that the Covered Software was made available under the terms of
31 | version 1.1 or earlier of the License, but not also under the
32 | terms of a Secondary License.
33 |
34 | 1.6. "Executable Form"
35 | means any form of the work other than Source Code Form.
36 |
37 | 1.7. "Larger Work"
38 | means a work that combines Covered Software with other material, in
39 | a separate file or files, that is not Covered Software.
40 |
41 | 1.8. "License"
42 | means this document.
43 |
44 | 1.9. "Licensable"
45 | means having the right to grant, to the maximum extent possible,
46 | whether at the time of the initial grant or subsequently, any and
47 | all of the rights conveyed by this License.
48 |
49 | 1.10. "Modifications"
50 | means any of the following:
51 |
52 | (a) any file in Source Code Form that results from an addition to,
53 | deletion from, or modification of the contents of Covered
54 | Software; or
55 |
56 | (b) any new file in Source Code Form that contains any Covered
57 | Software.
58 |
59 | 1.11. "Patent Claims" of a Contributor
60 | means any patent claim(s), including without limitation, method,
61 | process, and apparatus claims, in any patent Licensable by such
62 | Contributor that would be infringed, but for the grant of the
63 | License, by the making, using, selling, offering for sale, having
64 | made, import, or transfer of either its Contributions or its
65 | Contributor Version.
66 |
67 | 1.12. "Secondary License"
68 | means either the GNU General Public License, Version 2.0, the GNU
69 | Lesser General Public License, Version 2.1, the GNU Affero General
70 | Public License, Version 3.0, or any later versions of those
71 | licenses.
72 |
73 | 1.13. "Source Code Form"
74 | means the form of the work preferred for making modifications.
75 |
76 | 1.14. "You" (or "Your")
77 | means an individual or a legal entity exercising rights under this
78 | License. For legal entities, "You" includes any entity that
79 | controls, is controlled by, or is under common control with You. For
80 | purposes of this definition, "control" means (a) the power, direct
81 | or indirect, to cause the direction or management of such entity,
82 | whether by contract or otherwise, or (b) ownership of more than
83 | fifty percent (50%) of the outstanding shares or beneficial
84 | ownership of such entity.
85 |
86 | 2. License Grants and Conditions
87 | --------------------------------
88 |
89 | 2.1. Grants
90 |
91 | Each Contributor hereby grants You a world-wide, royalty-free,
92 | non-exclusive license:
93 |
94 | (a) under intellectual property rights (other than patent or trademark)
95 | Licensable by such Contributor to use, reproduce, make available,
96 | modify, display, perform, distribute, and otherwise exploit its
97 | Contributions, either on an unmodified basis, with Modifications, or
98 | as part of a Larger Work; and
99 |
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 | for sale, have made, import, and otherwise transfer either its
102 | Contributions or its Contributor Version.
103 |
104 | 2.2. Effective Date
105 |
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 |
110 | 2.3. Limitations on Grant Scope
111 |
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 |
118 | (a) for any code that a Contributor has removed from Covered Software;
119 | or
120 |
121 | (b) for infringements caused by: (i) Your and any other third party's
122 | modifications of Covered Software, or (ii) the combination of its
123 | Contributions with other software (except as part of its Contributor
124 | Version); or
125 |
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 | its Contributions.
128 |
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 |
133 | 2.4. Subsequent Licenses
134 |
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 |
140 | 2.5. Representation
141 |
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 |
146 | 2.6. Fair Use
147 |
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 |
152 | 2.7. Conditions
153 |
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 |
157 | 3. Responsibilities
158 | -------------------
159 |
160 | 3.1. Distribution of Source Form
161 |
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 |
170 | 3.2. Distribution of Executable Form
171 |
172 | If You distribute Covered Software in Executable Form then:
173 |
174 | (a) such Covered Software must also be made available in Source Code
175 | Form, as described in Section 3.1, and You must inform recipients of
176 | the Executable Form how they can obtain a copy of such Source Code
177 | Form by reasonable means in a timely manner, at a charge no more
178 | than the cost of distribution to the recipient; and
179 |
180 | (b) You may distribute such Executable Form under the terms of this
181 | License, or sublicense it under different terms, provided that the
182 | license for the Executable Form does not attempt to limit or alter
183 | the recipients' rights in the Source Code Form under this License.
184 |
185 | 3.3. Distribution of a Larger Work
186 |
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 |
198 | 3.4. Notices
199 |
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 |
206 | 3.5. Application of Additional Terms
207 |
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 |
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 |
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 |
232 | 5. Termination
233 | --------------
234 |
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 |
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 |
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 |
261 | ************************************************************************
262 | * *
263 | * 6. Disclaimer of Warranty *
264 | * ------------------------- *
265 | * *
266 | * Covered Software is provided under this License on an "as is" *
267 | * basis, without warranty of any kind, either expressed, implied, or *
268 | * statutory, including, without limitation, warranties that the *
269 | * Covered Software is free of defects, merchantable, fit for a *
270 | * particular purpose or non-infringing. The entire risk as to the *
271 | * quality and performance of the Covered Software is with You. *
272 | * Should any Covered Software prove defective in any respect, You *
273 | * (not any Contributor) assume the cost of any necessary servicing, *
274 | * repair, or correction. This disclaimer of warranty constitutes an *
275 | * essential part of this License. No use of any Covered Software is *
276 | * authorized under this License except under this disclaimer. *
277 | * *
278 | ************************************************************************
279 |
280 | ************************************************************************
281 | * *
282 | * 7. Limitation of Liability *
283 | * -------------------------- *
284 | * *
285 | * Under no circumstances and under no legal theory, whether tort *
286 | * (including negligence), contract, or otherwise, shall any *
287 | * Contributor, or anyone who distributes Covered Software as *
288 | * permitted above, be liable to You for any direct, indirect, *
289 | * special, incidental, or consequential damages of any character *
290 | * including, without limitation, damages for lost profits, loss of *
291 | * goodwill, work stoppage, computer failure or malfunction, or any *
292 | * and all other commercial damages or losses, even if such party *
293 | * shall have been informed of the possibility of such damages. This *
294 | * limitation of liability shall not apply to liability for death or *
295 | * personal injury resulting from such party's negligence to the *
296 | * extent applicable law prohibits such limitation. Some *
297 | * jurisdictions do not allow the exclusion or limitation of *
298 | * incidental or consequential damages, so this exclusion and *
299 | * limitation may not apply to You. *
300 | * *
301 | ************************************************************************
302 |
303 | 8. Litigation
304 | -------------
305 |
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 |
313 | 9. Miscellaneous
314 | ----------------
315 |
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 |
323 | 10. Versions of the License
324 | ---------------------------
325 |
326 | 10.1. New Versions
327 |
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 |
333 | 10.2. Effect of New Versions
334 |
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 |
340 | 10.3. Modified Versions
341 |
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 |
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 |
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 |
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 |
358 | This Source Code Form is subject to the terms of the Mozilla Public
359 | License, v. 2.0. If a copy of the MPL was not distributed with this
360 | file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 |
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 |
367 | You may add additional accurate notices of copyright ownership.
368 |
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 |
372 | This Source Code Form is "Incompatible With Secondary Licenses", as
373 | defined by the Mozilla Public License, v. 2.0.
374 |
--------------------------------------------------------------------------------
/rabbitmq-components.mk:
--------------------------------------------------------------------------------
1 | ifeq ($(.DEFAULT_GOAL),)
2 | # Define default goal to `all` because this file defines some targets
3 | # before the inclusion of erlang.mk leading to the wrong target becoming
4 | # the default.
5 | .DEFAULT_GOAL = all
6 | endif
7 |
8 | # PROJECT_VERSION defaults to:
9 | # 1. the version exported by rabbitmq-server-release;
10 | # 2. the version stored in `git-revisions.txt`, if it exists;
11 | # 3. a version based on git-describe(1), if it is a Git clone;
12 | # 4. 0.0.0
13 |
14 | PROJECT_VERSION := $(RABBITMQ_VERSION)
15 |
16 | ifeq ($(PROJECT_VERSION),)
17 | PROJECT_VERSION := $(shell \
18 | if test -f git-revisions.txt; then \
19 | head -n1 git-revisions.txt | \
20 | awk '{print $$$(words $(PROJECT_DESCRIPTION) version);}'; \
21 | else \
22 | (git describe --dirty --abbrev=7 --tags --always --first-parent \
23 | 2>/dev/null || echo rabbitmq_v0_0_0) | \
24 | sed -e 's/^rabbitmq_v//' -e 's/^v//' -e 's/_/./g' -e 's/-/+/' \
25 | -e 's/-/./g'; \
26 | fi)
27 | endif
28 |
29 | # --------------------------------------------------------------------
30 | # RabbitMQ components.
31 | # --------------------------------------------------------------------
32 |
33 | # For RabbitMQ repositories, we want to checkout branches which match
34 | # the parent project. For instance, if the parent project is on a
35 | # release tag, dependencies must be on the same release tag. If the
36 | # parent project is on a topic branch, dependencies must be on the same
37 | # topic branch or fallback to `stable` or `master` whichever was the
38 | # base of the topic branch.
39 |
40 | dep_amqp_client = git_rmq rabbitmq-erlang-client $(current_rmq_ref) $(base_rmq_ref) master
41 | dep_amqp10_client = git_rmq rabbitmq-amqp1.0-client $(current_rmq_ref) $(base_rmq_ref) master
42 | dep_amqp10_common = git_rmq rabbitmq-amqp1.0-common $(current_rmq_ref) $(base_rmq_ref) master
43 | dep_rabbit = git_rmq rabbitmq-server $(current_rmq_ref) $(base_rmq_ref) master
44 | dep_rabbit_common = git_rmq rabbitmq-common $(current_rmq_ref) $(base_rmq_ref) master
45 | dep_rabbitmq_amqp1_0 = git_rmq rabbitmq-amqp1.0 $(current_rmq_ref) $(base_rmq_ref) master
46 | dep_rabbitmq_auth_backend_amqp = git_rmq rabbitmq-auth-backend-amqp $(current_rmq_ref) $(base_rmq_ref) master
47 | dep_rabbitmq_auth_backend_cache = git_rmq rabbitmq-auth-backend-cache $(current_rmq_ref) $(base_rmq_ref) master
48 | dep_rabbitmq_auth_backend_http = git_rmq rabbitmq-auth-backend-http $(current_rmq_ref) $(base_rmq_ref) master
49 | dep_rabbitmq_auth_backend_ldap = git_rmq rabbitmq-auth-backend-ldap $(current_rmq_ref) $(base_rmq_ref) master
50 | dep_rabbitmq_auth_backend_oauth2 = git_rmq rabbitmq-auth-backend-oauth2 $(current_rmq_ref) $(base_rmq_ref) master
51 | dep_rabbitmq_auth_mechanism_ssl = git_rmq rabbitmq-auth-mechanism-ssl $(current_rmq_ref) $(base_rmq_ref) master
52 | dep_rabbitmq_aws = git_rmq rabbitmq-aws $(current_rmq_ref) $(base_rmq_ref) master
53 | dep_rabbitmq_boot_steps_visualiser = git_rmq rabbitmq-boot-steps-visualiser $(current_rmq_ref) $(base_rmq_ref) master
54 | dep_rabbitmq_cli = git_rmq rabbitmq-cli $(current_rmq_ref) $(base_rmq_ref) master
55 | dep_rabbitmq_codegen = git_rmq rabbitmq-codegen $(current_rmq_ref) $(base_rmq_ref) master
56 | dep_rabbitmq_consistent_hash_exchange = git_rmq rabbitmq-consistent-hash-exchange $(current_rmq_ref) $(base_rmq_ref) master
57 | dep_rabbitmq_ct_client_helpers = git_rmq rabbitmq-ct-client-helpers $(current_rmq_ref) $(base_rmq_ref) master
58 | dep_rabbitmq_ct_helpers = git_rmq rabbitmq-ct-helpers $(current_rmq_ref) $(base_rmq_ref) master
59 | dep_rabbitmq_delayed_message_exchange = git_rmq rabbitmq-delayed-message-exchange $(current_rmq_ref) $(base_rmq_ref) master
60 | dep_rabbitmq_dotnet_client = git_rmq rabbitmq-dotnet-client $(current_rmq_ref) $(base_rmq_ref) master
61 | dep_rabbitmq_event_exchange = git_rmq rabbitmq-event-exchange $(current_rmq_ref) $(base_rmq_ref) master
62 | dep_rabbitmq_federation = git_rmq rabbitmq-federation $(current_rmq_ref) $(base_rmq_ref) master
63 | dep_rabbitmq_federation_management = git_rmq rabbitmq-federation-management $(current_rmq_ref) $(base_rmq_ref) master
64 | dep_rabbitmq_java_client = git_rmq rabbitmq-java-client $(current_rmq_ref) $(base_rmq_ref) master
65 | dep_rabbitmq_jms_client = git_rmq rabbitmq-jms-client $(current_rmq_ref) $(base_rmq_ref) master
66 | dep_rabbitmq_jms_cts = git_rmq rabbitmq-jms-cts $(current_rmq_ref) $(base_rmq_ref) master
67 | dep_rabbitmq_jms_topic_exchange = git_rmq rabbitmq-jms-topic-exchange $(current_rmq_ref) $(base_rmq_ref) master
68 | dep_rabbitmq_lvc_exchange = git_rmq rabbitmq-lvc-exchange $(current_rmq_ref) $(base_rmq_ref) master
69 | dep_rabbitmq_management = git_rmq rabbitmq-management $(current_rmq_ref) $(base_rmq_ref) master
70 | dep_rabbitmq_management_agent = git_rmq rabbitmq-management-agent $(current_rmq_ref) $(base_rmq_ref) master
71 | dep_rabbitmq_management_exchange = git_rmq rabbitmq-management-exchange $(current_rmq_ref) $(base_rmq_ref) master
72 | dep_rabbitmq_management_themes = git_rmq rabbitmq-management-themes $(current_rmq_ref) $(base_rmq_ref) master
73 | dep_rabbitmq_message_timestamp = git_rmq rabbitmq-message-timestamp $(current_rmq_ref) $(base_rmq_ref) master
74 | dep_rabbitmq_metronome = git_rmq rabbitmq-metronome $(current_rmq_ref) $(base_rmq_ref) master
75 | dep_rabbitmq_mqtt = git_rmq rabbitmq-mqtt $(current_rmq_ref) $(base_rmq_ref) master
76 | dep_rabbitmq_objc_client = git_rmq rabbitmq-objc-client $(current_rmq_ref) $(base_rmq_ref) master
77 | dep_rabbitmq_peer_discovery_aws = git_rmq rabbitmq-peer-discovery-aws $(current_rmq_ref) $(base_rmq_ref) master
78 | dep_rabbitmq_peer_discovery_common = git_rmq rabbitmq-peer-discovery-common $(current_rmq_ref) $(base_rmq_ref) master
79 | dep_rabbitmq_peer_discovery_consul = git_rmq rabbitmq-peer-discovery-consul $(current_rmq_ref) $(base_rmq_ref) master
80 | dep_rabbitmq_peer_discovery_etcd = git_rmq rabbitmq-peer-discovery-etcd $(current_rmq_ref) $(base_rmq_ref) master
81 | dep_rabbitmq_peer_discovery_k8s = git_rmq rabbitmq-peer-discovery-k8s $(current_rmq_ref) $(base_rmq_ref) master
82 | dep_rabbitmq_prometheus = git_rmq rabbitmq-prometheus $(current_rmq_ref) $(base_rmq_ref) master
83 | dep_rabbitmq_random_exchange = git_rmq rabbitmq-random-exchange $(current_rmq_ref) $(base_rmq_ref) master
84 | dep_rabbitmq_recent_history_exchange = git_rmq rabbitmq-recent-history-exchange $(current_rmq_ref) $(base_rmq_ref) master
85 | dep_rabbitmq_routing_node_stamp = git_rmq rabbitmq-routing-node-stamp $(current_rmq_ref) $(base_rmq_ref) master
86 | dep_rabbitmq_rtopic_exchange = git_rmq rabbitmq-rtopic-exchange $(current_rmq_ref) $(base_rmq_ref) master
87 | dep_rabbitmq_server_release = git_rmq rabbitmq-server-release $(current_rmq_ref) $(base_rmq_ref) master
88 | dep_rabbitmq_sharding = git_rmq rabbitmq-sharding $(current_rmq_ref) $(base_rmq_ref) master
89 | dep_rabbitmq_shovel = git_rmq rabbitmq-shovel $(current_rmq_ref) $(base_rmq_ref) master
90 | dep_rabbitmq_shovel_management = git_rmq rabbitmq-shovel-management $(current_rmq_ref) $(base_rmq_ref) master
91 | dep_rabbitmq_stomp = git_rmq rabbitmq-stomp $(current_rmq_ref) $(base_rmq_ref) master
92 | dep_rabbitmq_stream = git_rmq rabbitmq-stream $(current_rmq_ref) $(base_rmq_ref) master
93 | dep_rabbitmq_toke = git_rmq rabbitmq-toke $(current_rmq_ref) $(base_rmq_ref) master
94 | dep_rabbitmq_top = git_rmq rabbitmq-top $(current_rmq_ref) $(base_rmq_ref) master
95 | dep_rabbitmq_tracing = git_rmq rabbitmq-tracing $(current_rmq_ref) $(base_rmq_ref) master
96 | dep_rabbitmq_trust_store = git_rmq rabbitmq-trust-store $(current_rmq_ref) $(base_rmq_ref) master
97 | dep_rabbitmq_test = git_rmq rabbitmq-test $(current_rmq_ref) $(base_rmq_ref) master
98 | dep_rabbitmq_web_dispatch = git_rmq rabbitmq-web-dispatch $(current_rmq_ref) $(base_rmq_ref) master
99 | dep_rabbitmq_web_stomp = git_rmq rabbitmq-web-stomp $(current_rmq_ref) $(base_rmq_ref) master
100 | dep_rabbitmq_web_stomp_examples = git_rmq rabbitmq-web-stomp-examples $(current_rmq_ref) $(base_rmq_ref) master
101 | dep_rabbitmq_web_mqtt = git_rmq rabbitmq-web-mqtt $(current_rmq_ref) $(base_rmq_ref) master
102 | dep_rabbitmq_web_mqtt_examples = git_rmq rabbitmq-web-mqtt-examples $(current_rmq_ref) $(base_rmq_ref) master
103 | dep_rabbitmq_website = git_rmq rabbitmq-website $(current_rmq_ref) $(base_rmq_ref) live master
104 | dep_toke = git_rmq toke $(current_rmq_ref) $(base_rmq_ref) master
105 |
106 | dep_rabbitmq_public_umbrella = git_rmq rabbitmq-public-umbrella $(current_rmq_ref) $(base_rmq_ref) master
107 |
108 | # Third-party dependencies version pinning.
109 | #
110 | # We do that in this file, which is copied in all projects, to ensure
111 | # all projects use the same versions. It avoids conflicts and makes it
112 | # possible to work with rabbitmq-public-umbrella.
113 |
114 | dep_accept = hex 0.3.5
115 | dep_cowboy = hex 2.8.0
116 | dep_cowlib = hex 2.9.1
117 | dep_jsx = hex 2.11.0
118 | dep_lager = hex 3.8.0
119 | dep_prometheus = git https://github.com/deadtrickster/prometheus.erl.git master
120 | dep_ra = git https://github.com/rabbitmq/ra.git master
121 | dep_ranch = hex 1.7.1
122 | dep_recon = hex 2.5.1
123 | dep_observer_cli = hex 1.5.4
124 | dep_stdout_formatter = hex 0.2.4
125 | dep_sysmon_handler = hex 1.3.0
126 |
127 | RABBITMQ_COMPONENTS = amqp_client \
128 | amqp10_common \
129 | amqp10_client \
130 | rabbit \
131 | rabbit_common \
132 | rabbitmq_amqp1_0 \
133 | rabbitmq_auth_backend_amqp \
134 | rabbitmq_auth_backend_cache \
135 | rabbitmq_auth_backend_http \
136 | rabbitmq_auth_backend_ldap \
137 | rabbitmq_auth_backend_oauth2 \
138 | rabbitmq_auth_mechanism_ssl \
139 | rabbitmq_aws \
140 | rabbitmq_boot_steps_visualiser \
141 | rabbitmq_cli \
142 | rabbitmq_codegen \
143 | rabbitmq_consistent_hash_exchange \
144 | rabbitmq_ct_client_helpers \
145 | rabbitmq_ct_helpers \
146 | rabbitmq_delayed_message_exchange \
147 | rabbitmq_dotnet_client \
148 | rabbitmq_event_exchange \
149 | rabbitmq_federation \
150 | rabbitmq_federation_management \
151 | rabbitmq_java_client \
152 | rabbitmq_jms_client \
153 | rabbitmq_jms_cts \
154 | rabbitmq_jms_topic_exchange \
155 | rabbitmq_lvc_exchange \
156 | rabbitmq_management \
157 | rabbitmq_management_agent \
158 | rabbitmq_management_exchange \
159 | rabbitmq_management_themes \
160 | rabbitmq_message_timestamp \
161 | rabbitmq_metronome \
162 | rabbitmq_mqtt \
163 | rabbitmq_objc_client \
164 | rabbitmq_peer_discovery_aws \
165 | rabbitmq_peer_discovery_common \
166 | rabbitmq_peer_discovery_consul \
167 | rabbitmq_peer_discovery_etcd \
168 | rabbitmq_peer_discovery_k8s \
169 | rabbitmq_prometheus \
170 | rabbitmq_random_exchange \
171 | rabbitmq_recent_history_exchange \
172 | rabbitmq_routing_node_stamp \
173 | rabbitmq_rtopic_exchange \
174 | rabbitmq_server_release \
175 | rabbitmq_sharding \
176 | rabbitmq_shovel \
177 | rabbitmq_shovel_management \
178 | rabbitmq_stomp \
179 | rabbitmq_stream \
180 | rabbitmq_toke \
181 | rabbitmq_top \
182 | rabbitmq_tracing \
183 | rabbitmq_trust_store \
184 | rabbitmq_web_dispatch \
185 | rabbitmq_web_mqtt \
186 | rabbitmq_web_mqtt_examples \
187 | rabbitmq_web_stomp \
188 | rabbitmq_web_stomp_examples \
189 | rabbitmq_website
190 |
191 | # Erlang.mk does not rebuild dependencies by default, once they were
192 | # compiled once, except for those listed in the `$(FORCE_REBUILD)`
193 | # variable.
194 | #
195 | # We want all RabbitMQ components to always be rebuilt: this eases
196 | # the work on several components at the same time.
197 |
198 | FORCE_REBUILD = $(RABBITMQ_COMPONENTS)
199 |
200 | # Several components have a custom erlang.mk/build.config, mainly
201 | # to disable eunit. Therefore, we can't use the top-level project's
202 | # erlang.mk copy.
203 | NO_AUTOPATCH += $(RABBITMQ_COMPONENTS)
204 |
205 | ifeq ($(origin current_rmq_ref),undefined)
206 | ifneq ($(wildcard .git),)
207 | current_rmq_ref := $(shell (\
208 | ref=$$(LANG=C git branch --list | awk '/^\* \(.*detached / {ref=$$0; sub(/.*detached [^ ]+ /, "", ref); sub(/\)$$/, "", ref); print ref; exit;} /^\* / {ref=$$0; sub(/^\* /, "", ref); print ref; exit}');\
209 | if test "$$(git rev-parse --short HEAD)" != "$$ref"; then echo "$$ref"; fi))
210 | else
211 | current_rmq_ref := master
212 | endif
213 | endif
214 | export current_rmq_ref
215 |
216 | ifeq ($(origin base_rmq_ref),undefined)
217 | ifneq ($(wildcard .git),)
218 | possible_base_rmq_ref := master
219 | ifeq ($(possible_base_rmq_ref),$(current_rmq_ref))
220 | base_rmq_ref := $(current_rmq_ref)
221 | else
222 | base_rmq_ref := $(shell \
223 | (git rev-parse --verify -q master >/dev/null && \
224 | git rev-parse --verify -q $(possible_base_rmq_ref) >/dev/null && \
225 | git merge-base --is-ancestor $$(git merge-base master HEAD) $(possible_base_rmq_ref) && \
226 | echo $(possible_base_rmq_ref)) || \
227 | echo master)
228 | endif
229 | else
230 | base_rmq_ref := master
231 | endif
232 | endif
233 | export base_rmq_ref
234 |
235 | # Repository URL selection.
236 | #
237 | # First, we infer other components' location from the current project
238 | # repository URL, if it's a Git repository:
239 | # - We take the "origin" remote URL as the base
240 | # - The current project name and repository name is replaced by the
241 | # target's properties:
242 | # eg. rabbitmq-common is replaced by rabbitmq-codegen
243 | # eg. rabbit_common is replaced by rabbitmq_codegen
244 | #
245 | # If cloning from this computed location fails, we fallback to RabbitMQ
246 | # upstream which is GitHub.
247 |
248 | # Macro to transform eg. "rabbit_common" to "rabbitmq-common".
249 | rmq_cmp_repo_name = $(word 2,$(dep_$(1)))
250 |
251 | # Upstream URL for the current project.
252 | RABBITMQ_COMPONENT_REPO_NAME := $(call rmq_cmp_repo_name,$(PROJECT))
253 | RABBITMQ_UPSTREAM_FETCH_URL ?= https://github.com/rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git
254 | RABBITMQ_UPSTREAM_PUSH_URL ?= git@github.com:rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git
255 |
256 | # Current URL for the current project. If this is not a Git clone,
257 | # default to the upstream Git repository.
258 | ifneq ($(wildcard .git),)
259 | git_origin_fetch_url := $(shell git config remote.origin.url)
260 | git_origin_push_url := $(shell git config remote.origin.pushurl || git config remote.origin.url)
261 | RABBITMQ_CURRENT_FETCH_URL ?= $(git_origin_fetch_url)
262 | RABBITMQ_CURRENT_PUSH_URL ?= $(git_origin_push_url)
263 | else
264 | RABBITMQ_CURRENT_FETCH_URL ?= $(RABBITMQ_UPSTREAM_FETCH_URL)
265 | RABBITMQ_CURRENT_PUSH_URL ?= $(RABBITMQ_UPSTREAM_PUSH_URL)
266 | endif
267 |
268 | # Macro to replace the following pattern:
269 | # 1. /foo.git -> /bar.git
270 | # 2. /foo -> /bar
271 | # 3. /foo/ -> /bar/
272 | subst_repo_name = $(patsubst %/$(1)/%,%/$(2)/%,$(patsubst %/$(1),%/$(2),$(patsubst %/$(1).git,%/$(2).git,$(3))))
273 |
274 | # Macro to replace both the project's name (eg. "rabbit_common") and
275 | # repository name (eg. "rabbitmq-common") by the target's equivalent.
276 | #
277 | # This macro is kept on one line because we don't want whitespaces in
278 | # the returned value, as it's used in $(dep_fetch_git_rmq) in a shell
279 | # single-quoted string.
280 | dep_rmq_repo = $(if $(dep_$(2)),$(call subst_repo_name,$(PROJECT),$(2),$(call subst_repo_name,$(RABBITMQ_COMPONENT_REPO_NAME),$(call rmq_cmp_repo_name,$(2)),$(1))),$(pkg_$(1)_repo))
281 |
282 | dep_rmq_commits = $(if $(dep_$(1)), \
283 | $(wordlist 3,$(words $(dep_$(1))),$(dep_$(1))), \
284 | $(pkg_$(1)_commit))
285 |
286 | define dep_fetch_git_rmq
287 | fetch_url1='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_FETCH_URL),$(1))'; \
288 | fetch_url2='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_FETCH_URL),$(1))'; \
289 | if test "$$$$fetch_url1" != '$(RABBITMQ_CURRENT_FETCH_URL)' && \
290 | git clone -q -n -- "$$$$fetch_url1" $(DEPS_DIR)/$(call dep_name,$(1)); then \
291 | fetch_url="$$$$fetch_url1"; \
292 | push_url='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_PUSH_URL),$(1))'; \
293 | elif git clone -q -n -- "$$$$fetch_url2" $(DEPS_DIR)/$(call dep_name,$(1)); then \
294 | fetch_url="$$$$fetch_url2"; \
295 | push_url='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_PUSH_URL),$(1))'; \
296 | fi; \
297 | cd $(DEPS_DIR)/$(call dep_name,$(1)) && ( \
298 | $(foreach ref,$(call dep_rmq_commits,$(1)), \
299 | git checkout -q $(ref) >/dev/null 2>&1 || \
300 | ) \
301 | (echo "error: no valid pathspec among: $(call dep_rmq_commits,$(1))" \
302 | 1>&2 && false) ) && \
303 | (test "$$$$fetch_url" = "$$$$push_url" || \
304 | git remote set-url --push origin "$$$$push_url")
305 | endef
306 |
307 | # --------------------------------------------------------------------
308 | # Component distribution.
309 | # --------------------------------------------------------------------
310 |
311 | list-dist-deps::
312 | @:
313 |
314 | prepare-dist::
315 | @:
316 |
317 | # --------------------------------------------------------------------
318 | # Umbrella-specific settings.
319 | # --------------------------------------------------------------------
320 |
321 | # If the top-level project is a RabbitMQ component, we override
322 | # $(DEPS_DIR) for this project to point to the top-level's one.
323 | #
324 | # We also verify that the guessed DEPS_DIR is actually named `deps`,
325 | # to rule out any situation where it is a coincidence that we found a
326 | # `rabbitmq-components.mk` up upper directories.
327 |
328 | possible_deps_dir_1 = $(abspath ..)
329 | possible_deps_dir_2 = $(abspath ../../..)
330 |
331 | ifeq ($(notdir $(possible_deps_dir_1)),deps)
332 | ifneq ($(wildcard $(possible_deps_dir_1)/../rabbitmq-components.mk),)
333 | deps_dir_overriden = 1
334 | DEPS_DIR ?= $(possible_deps_dir_1)
335 | DISABLE_DISTCLEAN = 1
336 | endif
337 | endif
338 |
339 | ifeq ($(deps_dir_overriden),)
340 | ifeq ($(notdir $(possible_deps_dir_2)),deps)
341 | ifneq ($(wildcard $(possible_deps_dir_2)/../rabbitmq-components.mk),)
342 | deps_dir_overriden = 1
343 | DEPS_DIR ?= $(possible_deps_dir_2)
344 | DISABLE_DISTCLEAN = 1
345 | endif
346 | endif
347 | endif
348 |
349 | ifneq ($(wildcard UMBRELLA.md),)
350 | DISABLE_DISTCLEAN = 1
351 | endif
352 |
353 | # We disable `make distclean` so $(DEPS_DIR) is not accidentally removed.
354 |
355 | ifeq ($(DISABLE_DISTCLEAN),1)
356 | ifneq ($(filter distclean distclean-deps,$(MAKECMDGOALS)),)
357 | SKIP_DEPS = 1
358 | endif
359 | endif
360 |
--------------------------------------------------------------------------------
/priv/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 | * https://www.eclipse.org/legal/epl-v10.html
10 | * and the Eclipse Distribution License is available at
11 | * https://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 Paho.MQTT module
20 | // only has a single public function, client, which returns
21 | // a Paho.MQTT client object given connection details.
22 |
23 | /**
24 | * Send and receive messages using web browsers.
25 | *
26 | * This programming interface lets a JavaScript client application use the MQTT V3.1 or
27 | * V3.1.1 protocol to connect to an MQTT-supporting messaging server.
28 | *
29 | * The function supported includes:
30 | *
31 | *
Connecting to and disconnecting from a server. The server is identified by its host name and port number.
32 | *
Specifying options that relate to the communications link with the server,
33 | * for example the frequency of keep-alive heartbeats, and whether SSL/TLS is required.
34 | *
Subscribing to and receiving messages from MQTT Topics.
35 | *
Publishing messages to MQTT Topics.
36 | *
37 | *
38 | * The API consists of two main objects:
39 | *
40 | *
{@link Paho.MQTT.Client}
41 | *
This contains methods that provide the functionality of the API,
42 | * including provision of callbacks that notify the application when a message
43 | * arrives from or is delivered to the messaging server,
44 | * or when the status of its connection to the messaging server changes.
45 | *
{@link Paho.MQTT.Message}
46 | *
This encapsulates the payload of the message along with various attributes
47 | * associated with its delivery, in particular the destination to which it has
48 | * been (or is about to be) sent.
49 | *
50 | *
51 | * The programming interface validates parameters passed to it, and will throw
52 | * an Error containing an error message intended for developer use, if it detects
53 | * an error with any parameter.
54 | *
55 | * Example:
56 | *
57 | *
58 | client = new Paho.MQTT.Client(location.hostname, Number(location.port), "clientId");
59 | client.onConnectionLost = onConnectionLost;
60 | client.onMessageArrived = onMessageArrived;
61 | client.connect({onSuccess:onConnect});
62 |
63 | function onConnect() {
64 | // Once a connection has been made, make a subscription and send a message.
65 | console.log("onConnect");
66 | client.subscribe("/World");
67 | message = new Paho.MQTT.Message("Hello");
68 | message.destinationName = "/World";
69 | client.send(message);
70 | };
71 | function onConnectionLost(responseObject) {
72 | if (responseObject.errorCode !== 0)
73 | console.log("onConnectionLost:"+responseObject.errorMessage);
74 | };
75 | function onMessageArrived(message) {
76 | console.log("onMessageArrived:"+message.payloadString);
77 | client.disconnect();
78 | };
79 | *
80 | * @namespace Paho.MQTT
81 | */
82 |
83 | if (typeof Paho === "undefined") {
84 | Paho = {};
85 | }
86 |
87 | Paho.MQTT = (function (global) {
88 |
89 | // Private variables below, these are only visible inside the function closure
90 | // which is used to define the module.
91 |
92 | var version = "@VERSION@";
93 | var buildLevel = "@BUILDLEVEL@";
94 |
95 | /**
96 | * Unique message type identifiers, with associated
97 | * associated integer values.
98 | * @private
99 | */
100 | var MESSAGE_TYPE = {
101 | CONNECT: 1,
102 | CONNACK: 2,
103 | PUBLISH: 3,
104 | PUBACK: 4,
105 | PUBREC: 5,
106 | PUBREL: 6,
107 | PUBCOMP: 7,
108 | SUBSCRIBE: 8,
109 | SUBACK: 9,
110 | UNSUBSCRIBE: 10,
111 | UNSUBACK: 11,
112 | PINGREQ: 12,
113 | PINGRESP: 13,
114 | DISCONNECT: 14
115 | };
116 |
117 | // Collection of utility methods used to simplify module code
118 | // and promote the DRY pattern.
119 |
120 | /**
121 | * Validate an object's parameter names to ensure they
122 | * match a list of expected variables name for this option
123 | * type. Used to ensure option object passed into the API don't
124 | * contain erroneous parameters.
125 | * @param {Object} obj - User options object
126 | * @param {Object} keys - valid keys and types that may exist in obj.
127 | * @throws {Error} Invalid option parameter found.
128 | * @private
129 | */
130 | var validate = function(obj, keys) {
131 | for (var key in obj) {
132 | if (obj.hasOwnProperty(key)) {
133 | if (keys.hasOwnProperty(key)) {
134 | if (typeof obj[key] !== keys[key])
135 | throw new Error(format(ERROR.INVALID_TYPE, [typeof obj[key], key]));
136 | } else {
137 | var errorStr = "Unknown property, " + key + ". Valid properties are:";
138 | for (var key in keys)
139 | if (keys.hasOwnProperty(key))
140 | errorStr = errorStr+" "+key;
141 | throw new Error(errorStr);
142 | }
143 | }
144 | }
145 | };
146 |
147 | /**
148 | * Return a new function which runs the user function bound
149 | * to a fixed scope.
150 | * @param {function} User function
151 | * @param {object} Function scope
152 | * @return {function} User function bound to another scope
153 | * @private
154 | */
155 | var scope = function (f, scope) {
156 | return function () {
157 | return f.apply(scope, arguments);
158 | };
159 | };
160 |
161 | /**
162 | * Unique message type identifiers, with associated
163 | * associated integer values.
164 | * @private
165 | */
166 | var ERROR = {
167 | OK: {code:0, text:"AMQJSC0000I OK."},
168 | CONNECT_TIMEOUT: {code:1, text:"AMQJSC0001E Connect timed out."},
169 | SUBSCRIBE_TIMEOUT: {code:2, text:"AMQJS0002E Subscribe timed out."},
170 | UNSUBSCRIBE_TIMEOUT: {code:3, text:"AMQJS0003E Unsubscribe timed out."},
171 | PING_TIMEOUT: {code:4, text:"AMQJS0004E Ping timed out."},
172 | INTERNAL_ERROR: {code:5, text:"AMQJS0005E Internal error. Error Message: {0}, Stack trace: {1}"},
173 | CONNACK_RETURNCODE: {code:6, text:"AMQJS0006E Bad Connack return code:{0} {1}."},
174 | SOCKET_ERROR: {code:7, text:"AMQJS0007E Socket error:{0}."},
175 | SOCKET_CLOSE: {code:8, text:"AMQJS0008I Socket closed."},
176 | MALFORMED_UTF: {code:9, text:"AMQJS0009E Malformed UTF data:{0} {1} {2}."},
177 | UNSUPPORTED: {code:10, text:"AMQJS0010E {0} is not supported by this browser."},
178 | INVALID_STATE: {code:11, text:"AMQJS0011E Invalid state {0}."},
179 | INVALID_TYPE: {code:12, text:"AMQJS0012E Invalid type {0} for {1}."},
180 | INVALID_ARGUMENT: {code:13, text:"AMQJS0013E Invalid argument {0} for {1}."},
181 | UNSUPPORTED_OPERATION: {code:14, text:"AMQJS0014E Unsupported operation."},
182 | INVALID_STORED_DATA: {code:15, text:"AMQJS0015E Invalid data in local storage key={0} value={1}."},
183 | INVALID_MQTT_MESSAGE_TYPE: {code:16, text:"AMQJS0016E Invalid MQTT message type {0}."},
184 | MALFORMED_UNICODE: {code:17, text:"AMQJS0017E Malformed Unicode string:{0} {1}."},
185 | };
186 |
187 | /** CONNACK RC Meaning. */
188 | var CONNACK_RC = {
189 | 0:"Connection Accepted",
190 | 1:"Connection Refused: unacceptable protocol version",
191 | 2:"Connection Refused: identifier rejected",
192 | 3:"Connection Refused: server unavailable",
193 | 4:"Connection Refused: bad user name or password",
194 | 5:"Connection Refused: not authorized"
195 | };
196 |
197 | /**
198 | * Format an error message text.
199 | * @private
200 | * @param {error} ERROR.KEY value above.
201 | * @param {substitutions} [array] substituted into the text.
202 | * @return the text with the substitutions made.
203 | */
204 | var format = function(error, substitutions) {
205 | var text = error.text;
206 | if (substitutions) {
207 | var field,start;
208 | for (var i=0; i 0) {
212 | var part1 = text.substring(0,start);
213 | var part2 = text.substring(start+field.length);
214 | text = part1+substitutions[i]+part2;
215 | }
216 | }
217 | }
218 | return text;
219 | };
220 |
221 | //MQTT protocol and version 6 M Q I s d p 3
222 | var MqttProtoIdentifierv3 = [0x00,0x06,0x4d,0x51,0x49,0x73,0x64,0x70,0x03];
223 | //MQTT proto/version for 311 4 M Q T T 4
224 | var MqttProtoIdentifierv4 = [0x00,0x04,0x4d,0x51,0x54,0x54,0x04];
225 |
226 | /**
227 | * Construct an MQTT wire protocol message.
228 | * @param type MQTT packet type.
229 | * @param options optional wire message attributes.
230 | *
231 | * Optional properties
232 | *
233 | * messageIdentifier: message ID in the range [0..65535]
234 | * payloadMessage: Application Message - PUBLISH only
235 | * connectStrings: array of 0 or more Strings to be put into the CONNECT payload
236 | * topics: array of strings (SUBSCRIBE, UNSUBSCRIBE)
237 | * requestQoS: array of QoS values [0..2]
238 | *
239 | * "Flag" properties
240 | * cleanSession: true if present / false if absent (CONNECT)
241 | * willMessage: true if present / false if absent (CONNECT)
242 | * isRetained: true if present / false if absent (CONNECT)
243 | * userName: true if present / false if absent (CONNECT)
244 | * password: true if present / false if absent (CONNECT)
245 | * keepAliveInterval: integer [0..65535] (CONNECT)
246 | *
247 | * @private
248 | * @ignore
249 | */
250 | var WireMessage = function (type, options) {
251 | this.type = type;
252 | for (var name in options) {
253 | if (options.hasOwnProperty(name)) {
254 | this[name] = options[name];
255 | }
256 | }
257 | };
258 |
259 | WireMessage.prototype.encode = function() {
260 | // Compute the first byte of the fixed header
261 | var first = ((this.type & 0x0f) << 4);
262 |
263 | /*
264 | * Now calculate the length of the variable header + payload by adding up the lengths
265 | * of all the component parts
266 | */
267 |
268 | var remLength = 0;
269 | var topicStrLength = new Array();
270 | var destinationNameLength = 0;
271 |
272 | // if the message contains a messageIdentifier then we need two bytes for that
273 | if (this.messageIdentifier != undefined)
274 | remLength += 2;
275 |
276 | switch(this.type) {
277 | // If this a Connect then we need to include 12 bytes for its header
278 | case MESSAGE_TYPE.CONNECT:
279 | switch(this.mqttVersion) {
280 | case 3:
281 | remLength += MqttProtoIdentifierv3.length + 3;
282 | break;
283 | case 4:
284 | remLength += MqttProtoIdentifierv4.length + 3;
285 | break;
286 | }
287 |
288 | remLength += UTF8Length(this.clientId) + 2;
289 | if (this.willMessage != undefined) {
290 | remLength += UTF8Length(this.willMessage.destinationName) + 2;
291 | // Will message is always a string, sent as UTF-8 characters with a preceding length.
292 | var willMessagePayloadBytes = this.willMessage.payloadBytes;
293 | if (!(willMessagePayloadBytes instanceof Uint8Array))
294 | willMessagePayloadBytes = new Uint8Array(payloadBytes);
295 | remLength += willMessagePayloadBytes.byteLength +2;
296 | }
297 | if (this.userName != undefined)
298 | remLength += UTF8Length(this.userName) + 2;
299 | if (this.password != undefined)
300 | remLength += UTF8Length(this.password) + 2;
301 | break;
302 |
303 | // Subscribe, Unsubscribe can both contain topic strings
304 | case MESSAGE_TYPE.SUBSCRIBE:
305 | first |= 0x02; // Qos = 1;
306 | for ( var i = 0; i < this.topics.length; i++) {
307 | topicStrLength[i] = UTF8Length(this.topics[i]);
308 | remLength += topicStrLength[i] + 2;
309 | }
310 | remLength += this.requestedQos.length; // 1 byte for each topic's Qos
311 | // QoS on Subscribe only
312 | break;
313 |
314 | case MESSAGE_TYPE.UNSUBSCRIBE:
315 | first |= 0x02; // Qos = 1;
316 | for ( var i = 0; i < this.topics.length; i++) {
317 | topicStrLength[i] = UTF8Length(this.topics[i]);
318 | remLength += topicStrLength[i] + 2;
319 | }
320 | break;
321 |
322 | case MESSAGE_TYPE.PUBREL:
323 | first |= 0x02; // Qos = 1;
324 | break;
325 |
326 | case MESSAGE_TYPE.PUBLISH:
327 | if (this.payloadMessage.duplicate) first |= 0x08;
328 | first = first |= (this.payloadMessage.qos << 1);
329 | if (this.payloadMessage.retained) first |= 0x01;
330 | destinationNameLength = UTF8Length(this.payloadMessage.destinationName);
331 | remLength += destinationNameLength + 2;
332 | var payloadBytes = this.payloadMessage.payloadBytes;
333 | remLength += payloadBytes.byteLength;
334 | if (payloadBytes instanceof ArrayBuffer)
335 | payloadBytes = new Uint8Array(payloadBytes);
336 | else if (!(payloadBytes instanceof Uint8Array))
337 | payloadBytes = new Uint8Array(payloadBytes.buffer);
338 | break;
339 |
340 | case MESSAGE_TYPE.DISCONNECT:
341 | break;
342 |
343 | default:
344 | ;
345 | }
346 |
347 | // Now we can allocate a buffer for the message
348 |
349 | var mbi = encodeMBI(remLength); // Convert the length to MQTT MBI format
350 | var pos = mbi.length + 1; // Offset of start of variable header
351 | var buffer = new ArrayBuffer(remLength + pos);
352 | var byteStream = new Uint8Array(buffer); // view it as a sequence of bytes
353 |
354 | //Write the fixed header into the buffer
355 | byteStream[0] = first;
356 | byteStream.set(mbi,1);
357 |
358 | // If this is a PUBLISH then the variable header starts with a topic
359 | if (this.type == MESSAGE_TYPE.PUBLISH)
360 | pos = writeString(this.payloadMessage.destinationName, destinationNameLength, byteStream, pos);
361 | // If this is a CONNECT then the variable header contains the protocol name/version, flags and keepalive time
362 |
363 | else if (this.type == MESSAGE_TYPE.CONNECT) {
364 | switch (this.mqttVersion) {
365 | case 3:
366 | byteStream.set(MqttProtoIdentifierv3, pos);
367 | pos += MqttProtoIdentifierv3.length;
368 | break;
369 | case 4:
370 | byteStream.set(MqttProtoIdentifierv4, pos);
371 | pos += MqttProtoIdentifierv4.length;
372 | break;
373 | }
374 | var connectFlags = 0;
375 | if (this.cleanSession)
376 | connectFlags = 0x02;
377 | if (this.willMessage != undefined ) {
378 | connectFlags |= 0x04;
379 | connectFlags |= (this.willMessage.qos<<3);
380 | if (this.willMessage.retained) {
381 | connectFlags |= 0x20;
382 | }
383 | }
384 | if (this.userName != undefined)
385 | connectFlags |= 0x80;
386 | if (this.password != undefined)
387 | connectFlags |= 0x40;
388 | byteStream[pos++] = connectFlags;
389 | pos = writeUint16 (this.keepAliveInterval, byteStream, pos);
390 | }
391 |
392 | // Output the messageIdentifier - if there is one
393 | if (this.messageIdentifier != undefined)
394 | pos = writeUint16 (this.messageIdentifier, byteStream, pos);
395 |
396 | switch(this.type) {
397 | case MESSAGE_TYPE.CONNECT:
398 | pos = writeString(this.clientId, UTF8Length(this.clientId), byteStream, pos);
399 | if (this.willMessage != undefined) {
400 | pos = writeString(this.willMessage.destinationName, UTF8Length(this.willMessage.destinationName), byteStream, pos);
401 | pos = writeUint16(willMessagePayloadBytes.byteLength, byteStream, pos);
402 | byteStream.set(willMessagePayloadBytes, pos);
403 | pos += willMessagePayloadBytes.byteLength;
404 |
405 | }
406 | if (this.userName != undefined)
407 | pos = writeString(this.userName, UTF8Length(this.userName), byteStream, pos);
408 | if (this.password != undefined)
409 | pos = writeString(this.password, UTF8Length(this.password), byteStream, pos);
410 | break;
411 |
412 | case MESSAGE_TYPE.PUBLISH:
413 | // PUBLISH has a text or binary payload, if text do not add a 2 byte length field, just the UTF characters.
414 | byteStream.set(payloadBytes, pos);
415 |
416 | break;
417 |
418 | // case MESSAGE_TYPE.PUBREC:
419 | // case MESSAGE_TYPE.PUBREL:
420 | // case MESSAGE_TYPE.PUBCOMP:
421 | // break;
422 |
423 | case MESSAGE_TYPE.SUBSCRIBE:
424 | // SUBSCRIBE has a list of topic strings and request QoS
425 | for (var i=0; i> 4;
448 | var messageInfo = first &= 0x0f;
449 | pos += 1;
450 |
451 |
452 | // Decode the remaining length (MBI format)
453 |
454 | var digit;
455 | var remLength = 0;
456 | var multiplier = 1;
457 | do {
458 | if (pos == input.length) {
459 | return [null,startingPos];
460 | }
461 | digit = input[pos++];
462 | remLength += ((digit & 0x7F) * multiplier);
463 | multiplier *= 128;
464 | } while ((digit & 0x80) != 0);
465 |
466 | var endPos = pos+remLength;
467 | if (endPos > input.length) {
468 | return [null,startingPos];
469 | }
470 |
471 | var wireMessage = new WireMessage(type);
472 | switch(type) {
473 | case MESSAGE_TYPE.CONNACK:
474 | var connectAcknowledgeFlags = input[pos++];
475 | if (connectAcknowledgeFlags & 0x01)
476 | wireMessage.sessionPresent = true;
477 | wireMessage.returnCode = input[pos++];
478 | break;
479 |
480 | case MESSAGE_TYPE.PUBLISH:
481 | var qos = (messageInfo >> 1) & 0x03;
482 |
483 | var len = readUint16(input, pos);
484 | pos += 2;
485 | var topicName = parseUTF8(input, pos, len);
486 | pos += len;
487 | // If QoS 1 or 2 there will be a messageIdentifier
488 | if (qos > 0) {
489 | wireMessage.messageIdentifier = readUint16(input, pos);
490 | pos += 2;
491 | }
492 |
493 | var message = new Paho.MQTT.Message(input.subarray(pos, endPos));
494 | if ((messageInfo & 0x01) == 0x01)
495 | message.retained = true;
496 | if ((messageInfo & 0x08) == 0x08)
497 | message.duplicate = true;
498 | message.qos = qos;
499 | message.destinationName = topicName;
500 | wireMessage.payloadMessage = message;
501 | break;
502 |
503 | case MESSAGE_TYPE.PUBACK:
504 | case MESSAGE_TYPE.PUBREC:
505 | case MESSAGE_TYPE.PUBREL:
506 | case MESSAGE_TYPE.PUBCOMP:
507 | case MESSAGE_TYPE.UNSUBACK:
508 | wireMessage.messageIdentifier = readUint16(input, pos);
509 | break;
510 |
511 | case MESSAGE_TYPE.SUBACK:
512 | wireMessage.messageIdentifier = readUint16(input, pos);
513 | pos += 2;
514 | wireMessage.returnCode = input.subarray(pos, endPos);
515 | break;
516 |
517 | default:
518 | ;
519 | }
520 |
521 | return [wireMessage,endPos];
522 | }
523 |
524 | function writeUint16(input, buffer, offset) {
525 | buffer[offset++] = input >> 8; //MSB
526 | buffer[offset++] = input % 256; //LSB
527 | return offset;
528 | }
529 |
530 | function writeString(input, utf8Length, buffer, offset) {
531 | offset = writeUint16(utf8Length, buffer, offset);
532 | stringToUTF8(input, buffer, offset);
533 | return offset + utf8Length;
534 | }
535 |
536 | function readUint16(buffer, offset) {
537 | return 256*buffer[offset] + buffer[offset+1];
538 | }
539 |
540 | /**
541 | * Encodes an MQTT Multi-Byte Integer
542 | * @private
543 | */
544 | function encodeMBI(number) {
545 | var output = new Array(1);
546 | var numBytes = 0;
547 |
548 | do {
549 | var digit = number % 128;
550 | number = number >> 7;
551 | if (number > 0) {
552 | digit |= 0x80;
553 | }
554 | output[numBytes++] = digit;
555 | } while ( (number > 0) && (numBytes<4) );
556 |
557 | return output;
558 | }
559 |
560 | /**
561 | * Takes a String and calculates its length in bytes when encoded in UTF8.
562 | * @private
563 | */
564 | function UTF8Length(input) {
565 | var output = 0;
566 | for (var i = 0; i 0x7FF)
570 | {
571 | // Surrogate pair means its a 4 byte character
572 | if (0xD800 <= charCode && charCode <= 0xDBFF)
573 | {
574 | i++;
575 | output++;
576 | }
577 | output +=3;
578 | }
579 | else if (charCode > 0x7F)
580 | output +=2;
581 | else
582 | output++;
583 | }
584 | return output;
585 | }
586 |
587 | /**
588 | * Takes a String and writes it into an array as UTF8 encoded bytes.
589 | * @private
590 | */
591 | function stringToUTF8(input, output, start) {
592 | var pos = start;
593 | for (var i = 0; i>6 & 0x1F | 0xC0;
610 | output[pos++] = charCode & 0x3F | 0x80;
611 | } else if (charCode <= 0xFFFF) {
612 | output[pos++] = charCode>>12 & 0x0F | 0xE0;
613 | output[pos++] = charCode>>6 & 0x3F | 0x80;
614 | output[pos++] = charCode & 0x3F | 0x80;
615 | } else {
616 | output[pos++] = charCode>>18 & 0x07 | 0xF0;
617 | output[pos++] = charCode>>12 & 0x3F | 0x80;
618 | output[pos++] = charCode>>6 & 0x3F | 0x80;
619 | output[pos++] = charCode & 0x3F | 0x80;
620 | };
621 | }
622 | return output;
623 | }
624 |
625 | function parseUTF8(input, offset, length) {
626 | var output = "";
627 | var utf16;
628 | var pos = offset;
629 |
630 | while (pos < offset+length)
631 | {
632 | var byte1 = input[pos++];
633 | if (byte1 < 128)
634 | utf16 = byte1;
635 | else
636 | {
637 | var byte2 = input[pos++]-128;
638 | if (byte2 < 0)
639 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16),""]));
640 | if (byte1 < 0xE0) // 2 byte character
641 | utf16 = 64*(byte1-0xC0) + byte2;
642 | else
643 | {
644 | var byte3 = input[pos++]-128;
645 | if (byte3 < 0)
646 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16)]));
647 | if (byte1 < 0xF0) // 3 byte character
648 | utf16 = 4096*(byte1-0xE0) + 64*byte2 + byte3;
649 | else
650 | {
651 | var byte4 = input[pos++]-128;
652 | if (byte4 < 0)
653 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
654 | if (byte1 < 0xF8) // 4 byte character
655 | utf16 = 262144*(byte1-0xF0) + 4096*byte2 + 64*byte3 + byte4;
656 | else // longer encodings are not supported
657 | throw new Error(format(ERROR.MALFORMED_UTF, [byte1.toString(16), byte2.toString(16), byte3.toString(16), byte4.toString(16)]));
658 | }
659 | }
660 | }
661 |
662 | if (utf16 > 0xFFFF) // 4 byte character - express as a surrogate pair
663 | {
664 | utf16 -= 0x10000;
665 | output += String.fromCharCode(0xD800 + (utf16 >> 10)); // lead character
666 | utf16 = 0xDC00 + (utf16 & 0x3FF); // trail character
667 | }
668 | output += String.fromCharCode(utf16);
669 | }
670 | return output;
671 | }
672 |
673 | /**
674 | * Repeat keepalive requests, monitor responses.
675 | * @ignore
676 | */
677 | var Pinger = function(client, window, keepAliveInterval) {
678 | this._client = client;
679 | this._window = window;
680 | this._keepAliveInterval = keepAliveInterval*1000;
681 | this.isReset = false;
682 |
683 | var pingReq = new WireMessage(MESSAGE_TYPE.PINGREQ).encode();
684 |
685 | var doTimeout = function (pinger) {
686 | return function () {
687 | return doPing.apply(pinger);
688 | };
689 | };
690 |
691 | /** @ignore */
692 | var doPing = function() {
693 | if (!this.isReset) {
694 | this._client._trace("Pinger.doPing", "Timed out");
695 | this._client._disconnected( ERROR.PING_TIMEOUT.code , format(ERROR.PING_TIMEOUT));
696 | } else {
697 | this.isReset = false;
698 | this._client._trace("Pinger.doPing", "send PINGREQ");
699 | this._client.socket.send(pingReq);
700 | this.timeout = this._window.setTimeout(doTimeout(this), this._keepAliveInterval);
701 | }
702 | }
703 |
704 | this.reset = function() {
705 | this.isReset = true;
706 | this._window.clearTimeout(this.timeout);
707 | if (this._keepAliveInterval > 0)
708 | this.timeout = setTimeout(doTimeout(this), this._keepAliveInterval);
709 | }
710 |
711 | this.cancel = function() {
712 | this._window.clearTimeout(this.timeout);
713 | }
714 | };
715 |
716 | /**
717 | * Monitor request completion.
718 | * @ignore
719 | */
720 | var Timeout = function(client, window, timeoutSeconds, action, args) {
721 | this._window = window;
722 | if (!timeoutSeconds)
723 | timeoutSeconds = 30;
724 |
725 | var doTimeout = function (action, client, args) {
726 | return function () {
727 | return action.apply(client, args);
728 | };
729 | };
730 | this.timeout = setTimeout(doTimeout(action, client, args), timeoutSeconds * 1000);
731 |
732 | this.cancel = function() {
733 | this._window.clearTimeout(this.timeout);
734 | }
735 | };
736 |
737 | /*
738 | * Internal implementation of the Websockets MQTT V3.1 client.
739 | *
740 | * @name Paho.MQTT.ClientImpl @constructor
741 | * @param {String} host the DNS nameof the webSocket host.
742 | * @param {Number} port the port number for that host.
743 | * @param {String} clientId the MQ client identifier.
744 | */
745 | var ClientImpl = function (uri, host, port, path, clientId) {
746 | // Check dependencies are satisfied in this browser.
747 | if (!("WebSocket" in global && global["WebSocket"] !== null)) {
748 | throw new Error(format(ERROR.UNSUPPORTED, ["WebSocket"]));
749 | }
750 | if (!("localStorage" in global && global["localStorage"] !== null)) {
751 | throw new Error(format(ERROR.UNSUPPORTED, ["localStorage"]));
752 | }
753 | if (!("ArrayBuffer" in global && global["ArrayBuffer"] !== null)) {
754 | throw new Error(format(ERROR.UNSUPPORTED, ["ArrayBuffer"]));
755 | }
756 | this._trace("Paho.MQTT.Client", uri, host, port, path, clientId);
757 |
758 | this.host = host;
759 | this.port = port;
760 | this.path = path;
761 | this.uri = uri;
762 | this.clientId = clientId;
763 |
764 | // Local storagekeys are qualified with the following string.
765 | // The conditional inclusion of path in the key is for backward
766 | // compatibility to when the path was not configurable and assumed to
767 | // be /mqtt
768 | this._localKey=host+":"+port+(path!="/mqtt"?":"+path:"")+":"+clientId+":";
769 |
770 | // Create private instance-only message queue
771 | // Internal queue of messages to be sent, in sending order.
772 | this._msg_queue = [];
773 |
774 | // Messages we have sent and are expecting a response for, indexed by their respective message ids.
775 | this._sentMessages = {};
776 |
777 | // Messages we have received and acknowleged and are expecting a confirm message for
778 | // indexed by their respective message ids.
779 | this._receivedMessages = {};
780 |
781 | // Internal list of callbacks to be executed when messages
782 | // have been successfully sent over web socket, e.g. disconnect
783 | // when it doesn't have to wait for ACK, just message is dispatched.
784 | this._notify_msg_sent = {};
785 |
786 | // Unique identifier for SEND messages, incrementing
787 | // counter as messages are sent.
788 | this._message_identifier = 1;
789 |
790 | // Used to determine the transmission sequence of stored sent messages.
791 | this._sequence = 0;
792 |
793 |
794 | // Load the local state, if any, from the saved version, only restore state relevant to this client.
795 | for (var key in localStorage)
796 | if ( key.indexOf("Sent:"+this._localKey) == 0
797 | || key.indexOf("Received:"+this._localKey) == 0)
798 | this.restore(key);
799 | };
800 |
801 | // Messaging Client public instance members.
802 | ClientImpl.prototype.host;
803 | ClientImpl.prototype.port;
804 | ClientImpl.prototype.path;
805 | ClientImpl.prototype.uri;
806 | ClientImpl.prototype.clientId;
807 |
808 | // Messaging Client private instance members.
809 | ClientImpl.prototype.socket;
810 | /* true once we have received an acknowledgement to a CONNECT packet. */
811 | ClientImpl.prototype.connected = false;
812 | /* The largest message identifier allowed, may not be larger than 2**16 but
813 | * if set smaller reduces the maximum number of outbound messages allowed.
814 | */
815 | ClientImpl.prototype.maxMessageIdentifier = 65536;
816 | ClientImpl.prototype.connectOptions;
817 | ClientImpl.prototype.hostIndex;
818 | ClientImpl.prototype.onConnectionLost;
819 | ClientImpl.prototype.onMessageDelivered;
820 | ClientImpl.prototype.onMessageArrived;
821 | ClientImpl.prototype.traceFunction;
822 | ClientImpl.prototype._msg_queue = null;
823 | ClientImpl.prototype._connectTimeout;
824 | /* The sendPinger monitors how long we allow before we send data to prove to the server that we are alive. */
825 | ClientImpl.prototype.sendPinger = null;
826 | /* The receivePinger monitors how long we allow before we require evidence that the server is alive. */
827 | ClientImpl.prototype.receivePinger = null;
828 |
829 | ClientImpl.prototype.receiveBuffer = null;
830 |
831 | ClientImpl.prototype._traceBuffer = null;
832 | ClientImpl.prototype._MAX_TRACE_ENTRIES = 100;
833 |
834 | ClientImpl.prototype.connect = function (connectOptions) {
835 | var connectOptionsMasked = this._traceMask(connectOptions, "password");
836 | this._trace("Client.connect", connectOptionsMasked, this.socket, this.connected);
837 |
838 | if (this.connected)
839 | throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
840 | if (this.socket)
841 | throw new Error(format(ERROR.INVALID_STATE, ["already connected"]));
842 |
843 | this.connectOptions = connectOptions;
844 |
845 | if (connectOptions.uris) {
846 | this.hostIndex = 0;
847 | this._doConnect(connectOptions.uris[0]);
848 | } else {
849 | this._doConnect(this.uri);
850 | }
851 |
852 | };
853 |
854 | ClientImpl.prototype.subscribe = function (filter, subscribeOptions) {
855 | this._trace("Client.subscribe", filter, subscribeOptions);
856 |
857 | if (!this.connected)
858 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
859 |
860 | var wireMessage = new WireMessage(MESSAGE_TYPE.SUBSCRIBE);
861 | wireMessage.topics=[filter];
862 | if (subscribeOptions.qos != undefined)
863 | wireMessage.requestedQos = [subscribeOptions.qos];
864 | else
865 | wireMessage.requestedQos = [0];
866 |
867 | if (subscribeOptions.onSuccess) {
868 | wireMessage.onSuccess = function(grantedQos) {subscribeOptions.onSuccess({invocationContext:subscribeOptions.invocationContext,grantedQos:grantedQos});};
869 | }
870 |
871 | if (subscribeOptions.onFailure) {
872 | wireMessage.onFailure = function(errorCode) {subscribeOptions.onFailure({invocationContext:subscribeOptions.invocationContext,errorCode:errorCode});};
873 | }
874 |
875 | if (subscribeOptions.timeout) {
876 | wireMessage.timeOut = new Timeout(this, window, subscribeOptions.timeout, subscribeOptions.onFailure
877 | , [{invocationContext:subscribeOptions.invocationContext,
878 | errorCode:ERROR.SUBSCRIBE_TIMEOUT.code,
879 | errorMessage:format(ERROR.SUBSCRIBE_TIMEOUT)}]);
880 | }
881 |
882 | // All subscriptions return a SUBACK.
883 | this._requires_ack(wireMessage);
884 | this._schedule_message(wireMessage);
885 | };
886 |
887 | /** @ignore */
888 | ClientImpl.prototype.unsubscribe = function(filter, unsubscribeOptions) {
889 | this._trace("Client.unsubscribe", filter, unsubscribeOptions);
890 |
891 | if (!this.connected)
892 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
893 |
894 | var wireMessage = new WireMessage(MESSAGE_TYPE.UNSUBSCRIBE);
895 | wireMessage.topics = [filter];
896 |
897 | if (unsubscribeOptions.onSuccess) {
898 | wireMessage.callback = function() {unsubscribeOptions.onSuccess({invocationContext:unsubscribeOptions.invocationContext});};
899 | }
900 | if (unsubscribeOptions.timeout) {
901 | wireMessage.timeOut = new Timeout(this, window, unsubscribeOptions.timeout, unsubscribeOptions.onFailure
902 | , [{invocationContext:unsubscribeOptions.invocationContext,
903 | errorCode:ERROR.UNSUBSCRIBE_TIMEOUT.code,
904 | errorMessage:format(ERROR.UNSUBSCRIBE_TIMEOUT)}]);
905 | }
906 |
907 | // All unsubscribes return a SUBACK.
908 | this._requires_ack(wireMessage);
909 | this._schedule_message(wireMessage);
910 | };
911 |
912 | ClientImpl.prototype.send = function (message) {
913 | this._trace("Client.send", message);
914 |
915 | if (!this.connected)
916 | throw new Error(format(ERROR.INVALID_STATE, ["not connected"]));
917 |
918 | wireMessage = new WireMessage(MESSAGE_TYPE.PUBLISH);
919 | wireMessage.payloadMessage = message;
920 |
921 | if (message.qos > 0)
922 | this._requires_ack(wireMessage);
923 | else if (this.onMessageDelivered)
924 | this._notify_msg_sent[wireMessage] = this.onMessageDelivered(wireMessage.payloadMessage);
925 | this._schedule_message(wireMessage);
926 | };
927 |
928 | ClientImpl.prototype.disconnect = function () {
929 | this._trace("Client.disconnect");
930 |
931 | if (!this.socket)
932 | throw new Error(format(ERROR.INVALID_STATE, ["not connecting or connected"]));
933 |
934 | wireMessage = new WireMessage(MESSAGE_TYPE.DISCONNECT);
935 |
936 | // Run the disconnected call back as soon as the message has been sent,
937 | // in case of a failure later on in the disconnect processing.
938 | // as a consequence, the _disconected call back may be run several times.
939 | this._notify_msg_sent[wireMessage] = scope(this._disconnected, this);
940 |
941 | this._schedule_message(wireMessage);
942 | };
943 |
944 | ClientImpl.prototype.getTraceLog = function () {
945 | if ( this._traceBuffer !== null ) {
946 | this._trace("Client.getTraceLog", new Date());
947 | this._trace("Client.getTraceLog in flight messages", this._sentMessages.length);
948 | for (var key in this._sentMessages)
949 | this._trace("_sentMessages ",key, this._sentMessages[key]);
950 | for (var key in this._receivedMessages)
951 | this._trace("_receivedMessages ",key, this._receivedMessages[key]);
952 |
953 | return this._traceBuffer;
954 | }
955 | };
956 |
957 | ClientImpl.prototype.startTrace = function () {
958 | if ( this._traceBuffer === null ) {
959 | this._traceBuffer = [];
960 | }
961 | this._trace("Client.startTrace", new Date(), version);
962 | };
963 |
964 | ClientImpl.prototype.stopTrace = function () {
965 | delete this._traceBuffer;
966 | };
967 |
968 | ClientImpl.prototype._doConnect = function (wsurl) {
969 | // When the socket is open, this client will send the CONNECT WireMessage using the saved parameters.
970 | if (this.connectOptions.useSSL) {
971 | var uriParts = wsurl.split(":");
972 | uriParts[0] = "wss";
973 | wsurl = uriParts.join(":");
974 | }
975 | this.connected = false;
976 | if (this.connectOptions.mqttVersion < 4) {
977 | this.socket = new WebSocket(wsurl, ["mqttv3.1"]);
978 | } else {
979 | this.socket = new WebSocket(wsurl, ["mqtt"]);
980 | }
981 | this.socket.binaryType = 'arraybuffer';
982 |
983 | this.socket.onopen = scope(this._on_socket_open, this);
984 | this.socket.onmessage = scope(this._on_socket_message, this);
985 | this.socket.onerror = scope(this._on_socket_error, this);
986 | this.socket.onclose = scope(this._on_socket_close, this);
987 |
988 | this.sendPinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
989 | this.receivePinger = new Pinger(this, window, this.connectOptions.keepAliveInterval);
990 |
991 | this._connectTimeout = new Timeout(this, window, this.connectOptions.timeout, this._disconnected, [ERROR.CONNECT_TIMEOUT.code, format(ERROR.CONNECT_TIMEOUT)]);
992 | };
993 |
994 |
995 | // Schedule a new message to be sent over the WebSockets
996 | // connection. CONNECT messages cause WebSocket connection
997 | // to be started. All other messages are queued internally
998 | // until this has happened. When WS connection starts, process
999 | // all outstanding messages.
1000 | ClientImpl.prototype._schedule_message = function (message) {
1001 | this._msg_queue.push(message);
1002 | // Process outstanding messages in the queue if we have an open socket, and have received CONNACK.
1003 | if (this.connected) {
1004 | this._process_queue();
1005 | }
1006 | };
1007 |
1008 | ClientImpl.prototype.store = function(prefix, wireMessage) {
1009 | var storedMessage = {type:wireMessage.type, messageIdentifier:wireMessage.messageIdentifier, version:1};
1010 |
1011 | switch(wireMessage.type) {
1012 | case MESSAGE_TYPE.PUBLISH:
1013 | if(wireMessage.pubRecReceived)
1014 | storedMessage.pubRecReceived = true;
1015 |
1016 | // Convert the payload to a hex string.
1017 | storedMessage.payloadMessage = {};
1018 | var hex = "";
1019 | var messageBytes = wireMessage.payloadMessage.payloadBytes;
1020 | for (var i=0; i= 2) {
1063 | var x = parseInt(hex.substring(0, 2), 16);
1064 | hex = hex.substring(2, hex.length);
1065 | byteStream[i++] = x;
1066 | }
1067 | var payloadMessage = new Paho.MQTT.Message(byteStream);
1068 |
1069 | payloadMessage.qos = storedMessage.payloadMessage.qos;
1070 | payloadMessage.destinationName = storedMessage.payloadMessage.destinationName;
1071 | if (storedMessage.payloadMessage.duplicate)
1072 | payloadMessage.duplicate = true;
1073 | if (storedMessage.payloadMessage.retained)
1074 | payloadMessage.retained = true;
1075 | wireMessage.payloadMessage = payloadMessage;
1076 |
1077 | break;
1078 |
1079 | default:
1080 | throw Error(format(ERROR.INVALID_STORED_DATA, [key, value]));
1081 | }
1082 |
1083 | if (key.indexOf("Sent:"+this._localKey) == 0) {
1084 | wireMessage.payloadMessage.duplicate = true;
1085 | this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
1086 | } else if (key.indexOf("Received:"+this._localKey) == 0) {
1087 | this._receivedMessages[wireMessage.messageIdentifier] = wireMessage;
1088 | }
1089 | };
1090 |
1091 | ClientImpl.prototype._process_queue = function () {
1092 | var message = null;
1093 | // Process messages in order they were added
1094 | var fifo = this._msg_queue.reverse();
1095 |
1096 | // Send all queued messages down socket connection
1097 | while ((message = fifo.pop())) {
1098 | this._socket_send(message);
1099 | // Notify listeners that message was successfully sent
1100 | if (this._notify_msg_sent[message]) {
1101 | this._notify_msg_sent[message]();
1102 | delete this._notify_msg_sent[message];
1103 | }
1104 | }
1105 | };
1106 |
1107 | /**
1108 | * Expect an ACK response for this message. Add message to the set of in progress
1109 | * messages and set an unused identifier in this message.
1110 | * @ignore
1111 | */
1112 | ClientImpl.prototype._requires_ack = function (wireMessage) {
1113 | var messageCount = Object.keys(this._sentMessages).length;
1114 | if (messageCount > this.maxMessageIdentifier)
1115 | throw Error ("Too many messages:"+messageCount);
1116 |
1117 | while(this._sentMessages[this._message_identifier] !== undefined) {
1118 | this._message_identifier++;
1119 | }
1120 | wireMessage.messageIdentifier = this._message_identifier;
1121 | this._sentMessages[wireMessage.messageIdentifier] = wireMessage;
1122 | if (wireMessage.type === MESSAGE_TYPE.PUBLISH) {
1123 | this.store("Sent:", wireMessage);
1124 | }
1125 | if (this._message_identifier === this.maxMessageIdentifier) {
1126 | this._message_identifier = 1;
1127 | }
1128 | };
1129 |
1130 | /**
1131 | * Called when the underlying websocket has been opened.
1132 | * @ignore
1133 | */
1134 | ClientImpl.prototype._on_socket_open = function () {
1135 | // Create the CONNECT message object.
1136 | var wireMessage = new WireMessage(MESSAGE_TYPE.CONNECT, this.connectOptions);
1137 | wireMessage.clientId = this.clientId;
1138 | this._socket_send(wireMessage);
1139 | };
1140 |
1141 | /**
1142 | * Called when the underlying websocket has received a complete packet.
1143 | * @ignore
1144 | */
1145 | ClientImpl.prototype._on_socket_message = function (event) {
1146 | this._trace("Client._on_socket_message", event.data);
1147 | // Reset the receive ping timer, we now have evidence the server is alive.
1148 | this.receivePinger.reset();
1149 | var messages = this._deframeMessages(event.data);
1150 | for (var i = 0; i < messages.length; i+=1) {
1151 | this._handleMessage(messages[i]);
1152 | }
1153 | }
1154 |
1155 | ClientImpl.prototype._deframeMessages = function(data) {
1156 | var byteArray = new Uint8Array(data);
1157 | if (this.receiveBuffer) {
1158 | var newData = new Uint8Array(this.receiveBuffer.length+byteArray.length);
1159 | newData.set(this.receiveBuffer);
1160 | newData.set(byteArray,this.receiveBuffer.length);
1161 | byteArray = newData;
1162 | delete this.receiveBuffer;
1163 | }
1164 | try {
1165 | var offset = 0;
1166 | var messages = [];
1167 | while(offset < byteArray.length) {
1168 | var result = decodeMessage(byteArray,offset);
1169 | var wireMessage = result[0];
1170 | offset = result[1];
1171 | if (wireMessage !== null) {
1172 | messages.push(wireMessage);
1173 | } else {
1174 | break;
1175 | }
1176 | }
1177 | if (offset < byteArray.length) {
1178 | this.receiveBuffer = byteArray.subarray(offset);
1179 | }
1180 | } catch (error) {
1181 | this._disconnected(ERROR.INTERNAL_ERROR.code , format(ERROR.INTERNAL_ERROR, [error.message,error.stack.toString()]));
1182 | return;
1183 | }
1184 | return messages;
1185 | }
1186 |
1187 | ClientImpl.prototype._handleMessage = function(wireMessage) {
1188 |
1189 | this._trace("Client._handleMessage", wireMessage);
1190 |
1191 | try {
1192 | switch(wireMessage.type) {
1193 | case MESSAGE_TYPE.CONNACK:
1194 | this._connectTimeout.cancel();
1195 |
1196 | // If we have started using clean session then clear up the local state.
1197 | if (this.connectOptions.cleanSession) {
1198 | for (var key in this._sentMessages) {
1199 | var sentMessage = this._sentMessages[key];
1200 | localStorage.removeItem("Sent:"+this._localKey+sentMessage.messageIdentifier);
1201 | }
1202 | this._sentMessages = {};
1203 |
1204 | for (var key in this._receivedMessages) {
1205 | var receivedMessage = this._receivedMessages[key];
1206 | localStorage.removeItem("Received:"+this._localKey+receivedMessage.messageIdentifier);
1207 | }
1208 | this._receivedMessages = {};
1209 | }
1210 | // Client connected and ready for business.
1211 | if (wireMessage.returnCode === 0) {
1212 | this.connected = true;
1213 | // Jump to the end of the list of uris and stop looking for a good host.
1214 | if (this.connectOptions.uris)
1215 | this.hostIndex = this.connectOptions.uris.length;
1216 | } else {
1217 | this._disconnected(ERROR.CONNACK_RETURNCODE.code , format(ERROR.CONNACK_RETURNCODE, [wireMessage.returnCode, CONNACK_RC[wireMessage.returnCode]]));
1218 | break;
1219 | }
1220 |
1221 | // Resend messages.
1222 | var sequencedMessages = new Array();
1223 | for (var msgId in this._sentMessages) {
1224 | if (this._sentMessages.hasOwnProperty(msgId))
1225 | sequencedMessages.push(this._sentMessages[msgId]);
1226 | }
1227 |
1228 | // Sort sentMessages into the original sent order.
1229 | var sequencedMessages = sequencedMessages.sort(function(a,b) {return a.sequence - b.sequence;} );
1230 | for (var i=0, len=sequencedMessages.length; i
1515 | * Most applications will create just one Client object and then call its connect() method,
1516 | * however applications can create more than one Client object if they wish.
1517 | * In this case the combination of host, port and clientId attributes must be different for each Client object.
1518 | *
1519 | * The send, subscribe and unsubscribe methods are implemented as asynchronous JavaScript methods
1520 | * (even though the underlying protocol exchange might be synchronous in nature).
1521 | * This means they signal their completion by calling back to the application,
1522 | * via Success or Failure callback functions provided by the application on the method in question.
1523 | * Such callbacks are called at most once per method invocation and do not persist beyond the lifetime
1524 | * of the script that made the invocation.
1525 | *
1526 | * In contrast there are some callback functions, most notably onMessageArrived,
1527 | * that are defined on the {@link Paho.MQTT.Client} object.
1528 | * These may get called multiple times, and aren't directly related to specific method invocations made by the client.
1529 | *
1530 | * @name Paho.MQTT.Client
1531 | *
1532 | * @constructor
1533 | *
1534 | * @param {string} host - the address of the messaging server, as a fully qualified WebSocket URI, as a DNS name or dotted decimal IP address.
1535 | * @param {number} port - the port number to connect to - only required if host is not a URI
1536 | * @param {string} path - the path on the host to connect to - only used if host is not a URI. Default: '/mqtt'.
1537 | * @param {string} clientId - the Messaging client identifier, between 1 and 23 characters in length.
1538 | *
1539 | * @property {string} host - read only the server's DNS hostname or dotted decimal IP address.
1540 | * @property {number} port - read only the server's port.
1541 | * @property {string} path - read only the server's path.
1542 | * @property {string} clientId - read only used when connecting to the server.
1543 | * @property {function} onConnectionLost - called when a connection has been lost.
1544 | * after a connect() method has succeeded.
1545 | * Establish the call back used when a connection has been lost. The connection may be
1546 | * lost because the client initiates a disconnect or because the server or network
1547 | * cause the client to be disconnected. The disconnect call back may be called without
1548 | * the connectionComplete call back being invoked if, for example the client fails to
1549 | * connect.
1550 | * A single response object parameter is passed to the onConnectionLost callback containing the following fields:
1551 | *
1552 | *
errorCode
1553 | *
errorMessage
1554 | *
1555 | * @property {function} onMessageDelivered called when a message has been delivered.
1556 | * All processing that this Client will ever do has been completed. So, for example,
1557 | * in the case of a Qos=2 message sent by this client, the PubComp flow has been received from the server
1558 | * and the message has been removed from persistent storage before this callback is invoked.
1559 | * Parameters passed to the onMessageDelivered callback are:
1560 | *
1561 | *
{@link Paho.MQTT.Message} that was delivered.
1562 | *
1563 | * @property {function} onMessageArrived called when a message has arrived in this Paho.MQTT.client.
1564 | * Parameters passed to the onMessageArrived callback are:
1565 | *
1566 | *
{@link Paho.MQTT.Message} that has arrived.
1567 | *
1568 | */
1569 | var Client = function (host, port, path, clientId) {
1570 |
1571 | var uri;
1572 |
1573 | if (typeof host !== "string")
1574 | throw new Error(format(ERROR.INVALID_TYPE, [typeof host, "host"]));
1575 |
1576 | if (arguments.length == 2) {
1577 | // host: must be full ws:// uri
1578 | // port: clientId
1579 | clientId = port;
1580 | uri = host;
1581 | var match = uri.match(/^(wss?):\/\/((\[(.+)\])|([^\/]+?))(:(\d+))?(\/.*)$/);
1582 | if (match) {
1583 | host = match[4]||match[2];
1584 | port = parseInt(match[7]);
1585 | path = match[8];
1586 | } else {
1587 | throw new Error(format(ERROR.INVALID_ARGUMENT,[host,"host"]));
1588 | }
1589 | } else {
1590 | if (arguments.length == 3) {
1591 | clientId = path;
1592 | path = "/mqtt";
1593 | }
1594 | if (typeof port !== "number" || port < 0)
1595 | throw new Error(format(ERROR.INVALID_TYPE, [typeof port, "port"]));
1596 | if (typeof path !== "string")
1597 | throw new Error(format(ERROR.INVALID_TYPE, [typeof path, "path"]));
1598 |
1599 | var ipv6AddSBracket = (host.indexOf(":") != -1 && host.slice(0,1) != "[" && host.slice(-1) != "]");
1600 | uri = "ws://"+(ipv6AddSBracket?"["+host+"]":host)+":"+port+path;
1601 | }
1602 |
1603 | var clientIdLength = 0;
1604 | for (var i = 0; i 65535)
1612 | throw new Error(format(ERROR.INVALID_ARGUMENT, [clientId, "clientId"]));
1613 |
1614 | var client = new ClientImpl(uri, host, port, path, clientId);
1615 | this._getHost = function() { return host; };
1616 | this._setHost = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
1617 |
1618 | this._getPort = function() { return port; };
1619 | this._setPort = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
1620 |
1621 | this._getPath = function() { return path; };
1622 | this._setPath = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
1623 |
1624 | this._getURI = function() { return uri; };
1625 | this._setURI = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
1626 |
1627 | this._getClientId = function() { return client.clientId; };
1628 | this._setClientId = function() { throw new Error(format(ERROR.UNSUPPORTED_OPERATION)); };
1629 |
1630 | this._getOnConnectionLost = function() { return client.onConnectionLost; };
1631 | this._setOnConnectionLost = function(newOnConnectionLost) {
1632 | if (typeof newOnConnectionLost === "function")
1633 | client.onConnectionLost = newOnConnectionLost;
1634 | else
1635 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnConnectionLost, "onConnectionLost"]));
1636 | };
1637 |
1638 | this._getOnMessageDelivered = function() { return client.onMessageDelivered; };
1639 | this._setOnMessageDelivered = function(newOnMessageDelivered) {
1640 | if (typeof newOnMessageDelivered === "function")
1641 | client.onMessageDelivered = newOnMessageDelivered;
1642 | else
1643 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageDelivered, "onMessageDelivered"]));
1644 | };
1645 |
1646 | this._getOnMessageArrived = function() { return client.onMessageArrived; };
1647 | this._setOnMessageArrived = function(newOnMessageArrived) {
1648 | if (typeof newOnMessageArrived === "function")
1649 | client.onMessageArrived = newOnMessageArrived;
1650 | else
1651 | throw new Error(format(ERROR.INVALID_TYPE, [typeof newOnMessageArrived, "onMessageArrived"]));
1652 | };
1653 |
1654 | this._getTrace = function() { return client.traceFunction; };
1655 | this._setTrace = function(trace) {
1656 | if(typeof trace === "function"){
1657 | client.traceFunction = trace;
1658 | }else{
1659 | throw new Error(format(ERROR.INVALID_TYPE, [typeof trace, "onTrace"]));
1660 | }
1661 | };
1662 |
1663 | /**
1664 | * Connect this Messaging client to its server.
1665 | *
1666 | * @name Paho.MQTT.Client#connect
1667 | * @function
1668 | * @param {Object} connectOptions - attributes used with the connection.
1669 | * @param {number} connectOptions.timeout - If the connect has not succeeded within this
1670 | * number of seconds, it is deemed to have failed.
1671 | * The default is 30 seconds.
1672 | * @param {string} connectOptions.userName - Authentication username for this connection.
1673 | * @param {string} connectOptions.password - Authentication password for this connection.
1674 | * @param {Paho.MQTT.Message} connectOptions.willMessage - sent by the server when the client
1675 | * disconnects abnormally.
1676 | * @param {Number} connectOptions.keepAliveInterval - the server disconnects this client if
1677 | * there is no activity for this number of seconds.
1678 | * The default value of 60 seconds is assumed if not set.
1679 | * @param {boolean} connectOptions.cleanSession - if true(default) the client and server
1680 | * persistent state is deleted on successful connect.
1681 | * @param {boolean} connectOptions.useSSL - if present and true, use an SSL Websocket connection.
1682 | * @param {object} connectOptions.invocationContext - passed to the onSuccess callback or onFailure callback.
1683 | * @param {function} connectOptions.onSuccess - called when the connect acknowledgement
1684 | * has been received from the server.
1685 | * A single response object parameter is passed to the onSuccess callback containing the following fields:
1686 | *
1687 | *
invocationContext as passed in to the onSuccess method in the connectOptions.
1688 | *
1689 | * @config {function} [onFailure] called when the connect request has failed or timed out.
1690 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1691 | *
1692 | *
invocationContext as passed in to the onFailure method in the connectOptions.
1693 | *
errorCode a number indicating the nature of the error.
1694 | *
errorMessage text describing the error.
1695 | *
1696 | * @config {Array} [hosts] If present this contains either a set of hostnames or fully qualified
1697 | * WebSocket URIs (ws://example.com:1883/mqtt), that are tried in order in place
1698 | * of the host and port paramater on the construtor. The hosts are tried one at at time in order until
1699 | * one of then succeeds.
1700 | * @config {Array} [ports] If present the set of ports matching the hosts. If hosts contains URIs, this property
1701 | * is not used.
1702 | * @throws {InvalidState} if the client is not in disconnected state. The client must have received connectionLost
1703 | * or disconnected before calling connect for a second or subsequent time.
1704 | */
1705 | this.connect = function (connectOptions) {
1706 | connectOptions = connectOptions || {} ;
1707 | validate(connectOptions, {timeout:"number",
1708 | userName:"string",
1709 | password:"string",
1710 | willMessage:"object",
1711 | keepAliveInterval:"number",
1712 | cleanSession:"boolean",
1713 | useSSL:"boolean",
1714 | invocationContext:"object",
1715 | onSuccess:"function",
1716 | onFailure:"function",
1717 | hosts:"object",
1718 | ports:"object",
1719 | mqttVersion:"number"});
1720 |
1721 | // If no keep alive interval is set, assume 60 seconds.
1722 | if (connectOptions.keepAliveInterval === undefined)
1723 | connectOptions.keepAliveInterval = 60;
1724 |
1725 | if (connectOptions.mqttVersion > 4 || connectOptions.mqttVersion < 3) {
1726 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.mqttVersion, "connectOptions.mqttVersion"]));
1727 | }
1728 |
1729 | if (connectOptions.mqttVersion === undefined) {
1730 | connectOptions.mqttVersionExplicit = false;
1731 | connectOptions.mqttVersion = 4;
1732 | } else {
1733 | connectOptions.mqttVersionExplicit = true;
1734 | }
1735 |
1736 | //Check that if password is set, so is username
1737 | if (connectOptions.password === undefined && connectOptions.userName !== undefined)
1738 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.password, "connectOptions.password"]))
1739 |
1740 | if (connectOptions.willMessage) {
1741 | if (!(connectOptions.willMessage instanceof Message))
1742 | throw new Error(format(ERROR.INVALID_TYPE, [connectOptions.willMessage, "connectOptions.willMessage"]));
1743 | // The will message must have a payload that can be represented as a string.
1744 | // Cause the willMessage to throw an exception if this is not the case.
1745 | connectOptions.willMessage.stringPayload;
1746 |
1747 | if (typeof connectOptions.willMessage.destinationName === "undefined")
1748 | throw new Error(format(ERROR.INVALID_TYPE, [typeof connectOptions.willMessage.destinationName, "connectOptions.willMessage.destinationName"]));
1749 | }
1750 | if (typeof connectOptions.cleanSession === "undefined")
1751 | connectOptions.cleanSession = true;
1752 | if (connectOptions.hosts) {
1753 |
1754 | if (!(connectOptions.hosts instanceof Array) )
1755 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
1756 | if (connectOptions.hosts.length <1 )
1757 | throw new Error(format(ERROR.INVALID_ARGUMENT, [connectOptions.hosts, "connectOptions.hosts"]));
1758 |
1759 | var usingURIs = false;
1760 | for (var i = 0; i
1809 | * @param {object} subscribeOptions - used to control the subscription
1810 | *
1811 | * @param {number} subscribeOptions.qos - the maiximum qos of any publications sent
1812 | * as a result of making this subscription.
1813 | * @param {object} subscribeOptions.invocationContext - passed to the onSuccess callback
1814 | * or onFailure callback.
1815 | * @param {function} subscribeOptions.onSuccess - called when the subscribe acknowledgement
1816 | * has been received from the server.
1817 | * A single response object parameter is passed to the onSuccess callback containing the following fields:
1818 | *
1819 | *
invocationContext if set in the subscribeOptions.
1820 | *
1821 | * @param {function} subscribeOptions.onFailure - called when the subscribe request has failed or timed out.
1822 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1823 | *
1824 | *
invocationContext - if set in the subscribeOptions.
1825 | *
errorCode - a number indicating the nature of the error.
1826 | *
errorMessage - text describing the error.
1827 | *
1828 | * @param {number} subscribeOptions.timeout - which, if present, determines the number of
1829 | * seconds after which the onFailure calback is called.
1830 | * The presence of a timeout does not prevent the onSuccess
1831 | * callback from being called when the subscribe completes.
1832 | * @throws {InvalidState} if the client is not in connected state.
1833 | */
1834 | this.subscribe = function (filter, subscribeOptions) {
1835 | if (typeof filter !== "string")
1836 | throw new Error("Invalid argument:"+filter);
1837 | subscribeOptions = subscribeOptions || {} ;
1838 | validate(subscribeOptions, {qos:"number",
1839 | invocationContext:"object",
1840 | onSuccess:"function",
1841 | onFailure:"function",
1842 | timeout:"number"
1843 | });
1844 | if (subscribeOptions.timeout && !subscribeOptions.onFailure)
1845 | throw new Error("subscribeOptions.timeout specified with no onFailure callback.");
1846 | if (typeof subscribeOptions.qos !== "undefined"
1847 | && !(subscribeOptions.qos === 0 || subscribeOptions.qos === 1 || subscribeOptions.qos === 2 ))
1848 | throw new Error(format(ERROR.INVALID_ARGUMENT, [subscribeOptions.qos, "subscribeOptions.qos"]));
1849 | client.subscribe(filter, subscribeOptions);
1850 | };
1851 |
1852 | /**
1853 | * Unsubscribe for messages, stop receiving messages sent to destinations described by the filter.
1854 | *
1855 | * @name Paho.MQTT.Client#unsubscribe
1856 | * @function
1857 | * @param {string} filter - describing the destinations to receive messages from.
1858 | * @param {object} unsubscribeOptions - used to control the subscription
1859 | * @param {object} unsubscribeOptions.invocationContext - passed to the onSuccess callback
1860 | or onFailure callback.
1861 | * @param {function} unsubscribeOptions.onSuccess - called when the unsubscribe acknowledgement has been received from the server.
1862 | * A single response object parameter is passed to the
1863 | * onSuccess callback containing the following fields:
1864 | *
1865 | *
invocationContext - if set in the unsubscribeOptions.
1866 | *
1867 | * @param {function} unsubscribeOptions.onFailure called when the unsubscribe request has failed or timed out.
1868 | * A single response object parameter is passed to the onFailure callback containing the following fields:
1869 | *
1870 | *
invocationContext - if set in the unsubscribeOptions.
1871 | *
errorCode - a number indicating the nature of the error.
1872 | *
errorMessage - text describing the error.
1873 | *
1874 | * @param {number} unsubscribeOptions.timeout - which, if present, determines the number of seconds
1875 | * after which the onFailure callback is called. The presence of
1876 | * a timeout does not prevent the onSuccess callback from being
1877 | * called when the unsubscribe completes
1878 | * @throws {InvalidState} if the client is not in connected state.
1879 | */
1880 | this.unsubscribe = function (filter, unsubscribeOptions) {
1881 | if (typeof filter !== "string")
1882 | throw new Error("Invalid argument:"+filter);
1883 | unsubscribeOptions = unsubscribeOptions || {} ;
1884 | validate(unsubscribeOptions, {invocationContext:"object",
1885 | onSuccess:"function",
1886 | onFailure:"function",
1887 | timeout:"number"
1888 | });
1889 | if (unsubscribeOptions.timeout && !unsubscribeOptions.onFailure)
1890 | throw new Error("unsubscribeOptions.timeout specified with no onFailure callback.");
1891 | client.unsubscribe(filter, unsubscribeOptions);
1892 | };
1893 |
1894 | /**
1895 | * Send a message to the consumers of the destination in the Message.
1896 | *
1897 | * @name Paho.MQTT.Client#send
1898 | * @function
1899 | * @param {string|Paho.MQTT.Message} topic - mandatory The name of the destination to which the message is to be sent.
1900 | * - If it is the only parameter, used as Paho.MQTT.Message object.
1901 | * @param {String|ArrayBuffer} payload - The message data to be sent.
1902 | * @param {number} qos The Quality of Service used to deliver the message.
1903 | *
1904 | *
0 Best effort (default).
1905 | *
1 At least once.
1906 | *
2 Exactly once.
1907 | *
1908 | * @param {Boolean} retained If true, the message is to be retained by the server and delivered
1909 | * to both current and future subscriptions.
1910 | * If false the server only delivers the message to current subscribers, this is the default for new Messages.
1911 | * A received message has the retained boolean set to true if the message was published
1912 | * with the retained boolean set to true
1913 | * and the subscrption was made after the message has been published.
1914 | * @throws {InvalidState} if the client is not connected.
1915 | */
1916 | this.send = function (topic,payload,qos,retained) {
1917 | var message ;
1918 |
1919 | if(arguments.length == 0){
1920 | throw new Error("Invalid argument."+"length");
1921 |
1922 | }else if(arguments.length == 1) {
1923 |
1924 | if (!(topic instanceof Message) && (typeof topic !== "string"))
1925 | throw new Error("Invalid argument:"+ typeof topic);
1926 |
1927 | message = topic;
1928 | if (typeof message.destinationName === "undefined")
1929 | throw new Error(format(ERROR.INVALID_ARGUMENT,[message.destinationName,"Message.destinationName"]));
1930 | client.send(message);
1931 |
1932 | }else {
1933 | //parameter checking in Message object
1934 | message = new Message(payload);
1935 | message.destinationName = topic;
1936 | if(arguments.length >= 3)
1937 | message.qos = qos;
1938 | if(arguments.length >= 4)
1939 | message.retained = retained;
1940 | client.send(message);
1941 | }
1942 | };
1943 |
1944 | /**
1945 | * Normal disconnect of this Messaging client from its server.
1946 | *
1947 | * @name Paho.MQTT.Client#disconnect
1948 | * @function
1949 | * @throws {InvalidState} if the client is already disconnected.
1950 | */
1951 | this.disconnect = function () {
1952 | client.disconnect();
1953 | };
1954 |
1955 | /**
1956 | * Get the contents of the trace log.
1957 | *
1958 | * @name Paho.MQTT.Client#getTraceLog
1959 | * @function
1960 | * @return {Object[]} tracebuffer containing the time ordered trace records.
1961 | */
1962 | this.getTraceLog = function () {
1963 | return client.getTraceLog();
1964 | }
1965 |
1966 | /**
1967 | * Start tracing.
1968 | *
1969 | * @name Paho.MQTT.Client#startTrace
1970 | * @function
1971 | */
1972 | this.startTrace = function () {
1973 | client.startTrace();
1974 | };
1975 |
1976 | /**
1977 | * Stop tracing.
1978 | *
1979 | * @name Paho.MQTT.Client#stopTrace
1980 | * @function
1981 | */
1982 | this.stopTrace = function () {
1983 | client.stopTrace();
1984 | };
1985 |
1986 | this.isConnected = function() {
1987 | return client.connected;
1988 | };
1989 | };
1990 |
1991 | Client.prototype = {
1992 | get host() { return this._getHost(); },
1993 | set host(newHost) { this._setHost(newHost); },
1994 |
1995 | get port() { return this._getPort(); },
1996 | set port(newPort) { this._setPort(newPort); },
1997 |
1998 | get path() { return this._getPath(); },
1999 | set path(newPath) { this._setPath(newPath); },
2000 |
2001 | get clientId() { return this._getClientId(); },
2002 | set clientId(newClientId) { this._setClientId(newClientId); },
2003 |
2004 | get onConnectionLost() { return this._getOnConnectionLost(); },
2005 | set onConnectionLost(newOnConnectionLost) { this._setOnConnectionLost(newOnConnectionLost); },
2006 |
2007 | get onMessageDelivered() { return this._getOnMessageDelivered(); },
2008 | set onMessageDelivered(newOnMessageDelivered) { this._setOnMessageDelivered(newOnMessageDelivered); },
2009 |
2010 | get onMessageArrived() { return this._getOnMessageArrived(); },
2011 | set onMessageArrived(newOnMessageArrived) { this._setOnMessageArrived(newOnMessageArrived); },
2012 |
2013 | get trace() { return this._getTrace(); },
2014 | set trace(newTraceFunction) { this._setTrace(newTraceFunction); }
2015 |
2016 | };
2017 |
2018 | /**
2019 | * An application message, sent or received.
2020 | *
2021 | * All attributes may be null, which implies the default values.
2022 | *
2023 | * @name Paho.MQTT.Message
2024 | * @constructor
2025 | * @param {String|ArrayBuffer} payload The message data to be sent.
2026 | *
2027 | * @property {string} payloadString read only The payload as a string if the payload consists of valid UTF-8 characters.
2028 | * @property {ArrayBuffer} payloadBytes read only The payload as an ArrayBuffer.
2029 | *
2030 | * @property {string} destinationName mandatory The name of the destination to which the message is to be sent
2031 | * (for messages about to be sent) or the name of the destination from which the message has been received.
2032 | * (for messages received by the onMessage function).
2033 | *
2034 | * @property {number} qos The Quality of Service used to deliver the message.
2035 | *
2036 | *
0 Best effort (default).
2037 | *
1 At least once.
2038 | *
2 Exactly once.
2039 | *
2040 | *
2041 | * @property {Boolean} retained If true, the message is to be retained by the server and delivered
2042 | * to both current and future subscriptions.
2043 | * If false the server only delivers the message to current subscribers, this is the default for new Messages.
2044 | * A received message has the retained boolean set to true if the message was published
2045 | * with the retained boolean set to true
2046 | * and the subscrption was made after the message has been published.
2047 | *