em-mqtt 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/COPYING ADDED
@@ -0,0 +1,56 @@
1
+ ruby-em-mqtt is copyrighted free software by Nicholas J Humfrey <njh@aelius.com>.
2
+ You can redistribute it and/or modify it under either the terms of the GPL
3
+ version 2 (see the file GPL), or the conditions below:
4
+
5
+ 1. You may make and give away verbatim copies of the source form of the
6
+ software without restriction, provided that you duplicate all of the
7
+ original copyright notices and associated disclaimers.
8
+
9
+ 2. You may modify your copy of the software in any way, provided that
10
+ you do at least ONE of the following:
11
+
12
+ a) place your modifications in the Public Domain or otherwise
13
+ make them Freely Available, such as by posting said
14
+ modifications to Usenet or an equivalent medium, or by allowing
15
+ the author to include your modifications in the software.
16
+
17
+ b) use the modified software only within your corporation or
18
+ organization.
19
+
20
+ c) give non-standard binaries non-standard names, with
21
+ instructions on where to get the original software distribution.
22
+
23
+ d) make other distribution arrangements with the author.
24
+
25
+ 3. You may distribute the software in object code or binary form,
26
+ provided that you do at least ONE of the following:
27
+
28
+ a) distribute the binaries and library files of the software,
29
+ together with instructions (in the manual page or equivalent)
30
+ on where to get the original distribution.
31
+
32
+ b) accompany the distribution with the machine-readable source of
33
+ the software.
34
+
35
+ c) give non-standard binaries non-standard names, with
36
+ instructions on where to get the original software distribution.
37
+
38
+ d) make other distribution arrangements with the author.
39
+
40
+ 4. You may modify and include the part of the software into any other
41
+ software (possibly commercial). But some files in the distribution
42
+ are not written by the author, so that they are not under these terms.
43
+
44
+ For the list of those files and their copying conditions, see the
45
+ file LEGAL.
46
+
47
+ 5. The scripts and library files supplied as input to or produced as
48
+ output from the software do not automatically fall under the
49
+ copyright of the software, but belong to whomever generated them,
50
+ and may be sold commercially, and may be aggregated with this
51
+ software.
52
+
53
+ 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
54
+ IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
55
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
56
+ PURPOSE.
data/GPL ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) 19yy <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) 19yy name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/NEWS ADDED
@@ -0,0 +1,8 @@
1
+ EventMachine MQTT NEWS
2
+ ======================
3
+
4
+
5
+ EventMachine MQTT Version 0.0.1 (2012-02-04)
6
+ --------------------------------------------
7
+
8
+ * Initial Release.
data/README ADDED
@@ -0,0 +1,62 @@
1
+ ruby-em-mqtt
2
+ ============
3
+
4
+ This gem adds MQTT (Message Queue Telemetry Transport) protocol support to EventMachine,
5
+ an event-processing library for Ruby.
6
+
7
+
8
+ Installing
9
+ ----------
10
+
11
+ You may get the latest stable version from rubygems.org:
12
+
13
+ $ gem install em-mqtt
14
+
15
+ It depends upon the mqtt gem to perform packet parsing and serialising.
16
+
17
+
18
+ Synopsis
19
+ --------
20
+
21
+ require 'rubygems'
22
+ require 'em-mqtt'
23
+
24
+ # Publish example
25
+ EventMachine.run do
26
+ c = ClientConnection.connect('test.mosquitto.org')
27
+ EventMachine::PeriodicTimer.new(1.0) do
28
+ puts "-- Publishing time"
29
+ c.publish('test', "The time is #{Time.now}")
30
+ end
31
+ end
32
+
33
+
34
+ # Subscribe example
35
+ class MyConnection < EventMachine::MQTT::ClientConnection
36
+ def receive_msg(packet)
37
+ p packet
38
+ end
39
+ end
40
+
41
+ EventMachine.run do
42
+ MyConnection.connect('test.mosquitto.org') do |c|
43
+ c.subscribe('test')
44
+ end
45
+ end
46
+
47
+
48
+ Resources
49
+ ---------
50
+
51
+ * MQTT Homepage: http://www.mqtt.org/
52
+ * GitHub Project: http://github.com/njh/ruby-em-mqtt
53
+ * Documentation: http://rubydoc.info/gems/em-mqtt/frames
54
+
55
+
56
+ Contact
57
+ -------
58
+
59
+ * Author: Nicholas J Humfrey
60
+ * Email: njh@aelius.com
61
+ * Home Page: http://www.aelius.com/njh/
62
+ * License: Distributes under the same terms as Ruby
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ $:.unshift File.dirname(__FILE__)+'/../lib'
4
+
5
+ require 'rubygems'
6
+ require 'em-mqtt'
7
+
8
+ EventMachine::MQTT::Server.new(ARGV).run
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'eventmachine'
4
+ require 'logger'
5
+ require 'mqtt'
6
+
7
+ require "em-mqtt/version"
8
+
9
+ module EventMachine::MQTT
10
+
11
+ autoload :ClientConnection, 'em-mqtt/client_connection'
12
+ autoload :Connection, 'em-mqtt/connection'
13
+ autoload :Server, 'em-mqtt/server'
14
+ autoload :ServerConnection, 'em-mqtt/server_connection'
15
+
16
+ end
@@ -0,0 +1,96 @@
1
+ # Client class for talking to an MQTT broker
2
+ class MQTT::Client
3
+ attr_reader :remote_host # Hostname of the remote broker
4
+ attr_reader :remote_port # Port number of the remote broker
5
+ attr_accessor :keep_alive # Time (in seconds) between pings to remote broker
6
+ attr_accessor :clean_start # Set the 'Clean Start' flag when connecting?
7
+ attr_accessor :client_id # Client Identifier
8
+ attr_accessor :ack_timeout # Number of seconds to wait for acknowledgement packets
9
+
10
+ # Create a new MQTT Client instance
11
+ def initialize(remote_host=MQTT::DEFAULT_HOST, remote_port=MQTT::DEFAULT_PORT)
12
+ @remote_host = remote_host
13
+ @remote_port = remote_port
14
+ @keep_alive = 10
15
+ @clean_start = true
16
+ @client_id = nil
17
+ @ack_timeout = 5
18
+ @connection = nil
19
+ end
20
+
21
+ def self.connect(*args, &blk)
22
+ self.new(*args).connect(&blk)
23
+ end
24
+
25
+ # Connect to the MQTT broker
26
+ # A block must be given
27
+ def connect
28
+ #trap("INT") {EM.stop}
29
+
30
+ EventMachine.run do
31
+ @connection = MQTT::ClientConnection.connect(@remote_host, @remote_port)
32
+
33
+ # Stuff happens here
34
+ yield(self)
35
+
36
+ # Disconnect once all the other deferred callbacks
37
+ @connection.callback do
38
+ disconnect
39
+ end
40
+
41
+ puts "Finished initing run"
42
+ end
43
+ end
44
+
45
+ # Disconnect from the MQTT broker.
46
+ # If you don't want to say goodbye to the broker, set send_msg to false.
47
+ def disconnect(send_msg=true)
48
+ @connection.disconnect(send_msg) unless @connection.nil?
49
+ end
50
+
51
+ # Checks whether the client is connected to the broker.
52
+ def connected?
53
+ # FIXME: check if connection is connected
54
+ not @connection.nil?
55
+ end
56
+
57
+ # Publish a message on a particular topic to the MQTT broker.
58
+ def publish(topic, payload, retain=false, qos=0)
59
+ # FIXME: make sure @connection isn't nil
60
+ @connection.publish(topic, payload, retain, qos=0)
61
+ end
62
+
63
+ # Send a subscribe message for one or more topics on the MQTT broker.
64
+ # The topics parameter should be one of the following:
65
+ # * String: subscribe to one topic with QOS 0
66
+ # * Array: subscribe to multiple topics with QOS 0
67
+ # * Hash: subscribe to multiple topics where the key is the topic and the value is the QOS level
68
+ #
69
+ # For example:
70
+ # client.subscribe( 'a/b' )
71
+ # client.subscribe( 'a/b', 'c/d' )
72
+ # client.subscribe( ['a/b',0], ['c/d',1] )
73
+ # client.subscribe( 'a/b' => 0, 'c/d' => 1 )
74
+ #
75
+ def subscribe(*topics)
76
+ # FIXME: make sure @connection isn't nil
77
+ @connection.subscribe(*topics)
78
+ end
79
+
80
+ # Return the next message recieved from the MQTT broker.
81
+ # This method blocks until a message is available.
82
+ #
83
+ # The method returns the topic and message as an array:
84
+ # topic,message = client.get
85
+ #
86
+ def get(*topics)
87
+ # FIXME: implement this
88
+ end
89
+
90
+ # Send a unsubscribe message for one or more topics on the MQTT broker
91
+ def unsubscribe(*topics)
92
+ # FIXME: make sure @connection isn't nil
93
+ @connection.unsubscribe(*topics)
94
+ end
95
+
96
+ end
@@ -0,0 +1,145 @@
1
+
2
+ class EventMachine::MQTT::ClientConnection < EventMachine::MQTT::Connection
3
+ include EventMachine::Deferrable
4
+
5
+ attr_reader :client_id
6
+ attr_reader :keep_alive
7
+ attr_reader :clean_start
8
+ attr_reader :message_id
9
+ attr_reader :ack_timeout
10
+ attr_reader :timer
11
+
12
+ # FIXME: change this to optionally take hash of options
13
+ def self.connect(host=MQTT::DEFAULT_HOST, port=MQTT::DEFAULT_PORT, *args, &blk)
14
+ EventMachine.connect( host, port, self, *args, &blk )
15
+ end
16
+
17
+ def post_init
18
+ super
19
+ @state = :connecting
20
+ @client_id = MQTT::Client.generate_client_id
21
+ @keep_alive = 10
22
+ @clean_start = true
23
+ @message_id = 0
24
+ @ack_timeout = 5
25
+ @timer = nil
26
+ end
27
+
28
+ def connection_completed
29
+ # Protocol name and version
30
+ packet = MQTT::Packet::Connect.new(
31
+ :clean_start => @clean_start,
32
+ :keep_alive => @keep_alive,
33
+ :client_id => @client_id
34
+ )
35
+
36
+ send_packet(packet)
37
+
38
+ @state = :connect_sent
39
+ end
40
+
41
+ # Disconnect from the MQTT broker.
42
+ # If you don't want to say goodbye to the broker, set send_msg to false.
43
+ def disconnect(send_msg=true)
44
+ # FIXME: only close if we aren't waiting for any acknowledgements
45
+ if connected?
46
+ send_packet(MQTT::Packet::Disconnect.new) if send_msg
47
+ end
48
+ @state = :disconnecting
49
+ end
50
+
51
+ def receive_msg(message)
52
+ # Subclass this method
53
+ end
54
+
55
+ def unbind
56
+ timer.cancel if timer
57
+ unless state == :disconnecting
58
+ raise MQTT::NotConnectedException.new("Connection to server lost")
59
+ end
60
+ @state = :disconnected
61
+ end
62
+
63
+ # Publish a message on a particular topic to the MQTT broker.
64
+ def publish(topic, payload, retain=false, qos=0)
65
+ # Defer publishing until we are connected
66
+ callback do
67
+ send_packet(
68
+ MQTT::Packet::Publish.new(
69
+ :qos => qos,
70
+ :retain => retain,
71
+ :topic => topic,
72
+ :payload => payload,
73
+ :message_id => @message_id.next
74
+ )
75
+ )
76
+ end
77
+ end
78
+
79
+ # Send a subscribe message for one or more topics on the MQTT broker.
80
+ def subscribe(*topics)
81
+ # Defer subscribing until we are connected
82
+ callback do
83
+ send_packet(
84
+ MQTT::Packet::Subscribe.new(
85
+ :topics => topics,
86
+ :message_id => @message_id.next
87
+ )
88
+ )
89
+ end
90
+ end
91
+
92
+ # Send a unsubscribe message for one or more topics on the MQTT broker
93
+ def unsubscribe(*topics)
94
+ # Defer unsubscribing until we are connected
95
+ callback do
96
+ send_packet(
97
+ MQTT::Packet::Unsubscribe.new(
98
+ :topics => topics,
99
+ :message_id => @message_id.next
100
+ )
101
+ )
102
+ end
103
+ end
104
+
105
+
106
+
107
+ private
108
+
109
+ def process_packet(packet)
110
+ if state == :connect_sent and packet.class == MQTT::Packet::Connack
111
+ connect_ack(packet)
112
+ elsif state == :connected and packet.class == MQTT::Packet::Pingresp
113
+ # Pong!
114
+ elsif state == :connected and packet.class == MQTT::Packet::Publish
115
+ receive_msg(packet)
116
+ elsif state == :connected and packet.class == MQTT::Packet::Suback
117
+ # Subscribed!
118
+ else
119
+ # FIXME: deal with other packet types
120
+ raise MQTT::ProtocolException.new(
121
+ "Wasn't expecting packet of type #{packet.class} when in state #{state}"
122
+ )
123
+ disconnect
124
+ end
125
+ end
126
+
127
+ def connect_ack(packet)
128
+ if packet.return_code != 0x00
129
+ raise MQTT::ProtocolException.new(packet.return_msg)
130
+ else
131
+ @state = :connected
132
+ end
133
+
134
+ # Send a ping packet every X seconds
135
+ if keep_alive > 0
136
+ @timer = EventMachine::PeriodicTimer.new(keep_alive) do
137
+ send_packet MQTT::Packet::Pingreq.new
138
+ end
139
+ end
140
+
141
+ # We are now connected - can now execute deferred calls
142
+ set_deferred_success
143
+ end
144
+
145
+ end
@@ -0,0 +1,56 @@
1
+
2
+ class EventMachine::MQTT::Connection < EventMachine::Connection
3
+
4
+ attr_reader :state
5
+ attr_reader :last_sent
6
+ attr_reader :last_received
7
+
8
+ def post_init
9
+ @state = :connecting
10
+ @last_sent = 0
11
+ @last_received = 0
12
+ @packet = nil
13
+ @data = ''
14
+ end
15
+
16
+ # Checks whether a connection is full established
17
+ def connected?
18
+ state == :connected
19
+ end
20
+
21
+ def receive_data(data)
22
+ @data << data
23
+
24
+ # FIXME: limit maximum data / packet size
25
+
26
+ # Are we at the start of a new packet?
27
+ if @packet.nil? and @data.length >= 2
28
+ @packet = MQTT::Packet.parse_header(@data)
29
+ end
30
+
31
+ # Do we have the the full packet body now?
32
+ if @packet and @data.length >= @packet.body_length
33
+ @packet.parse_body(
34
+ @data.slice!(0...@packet.body_length)
35
+ )
36
+ @last_received = Time.now
37
+ process_packet(@packet)
38
+ @packet = nil
39
+ end
40
+ end
41
+
42
+ # The function needs to be sub-classed
43
+ def process_packet(packet)
44
+ end
45
+
46
+ def send_packet(packet)
47
+ # FIXME: Throw exception if we aren't connected?
48
+ #unless packet.class == MQTT::Packet::Connect
49
+ # raise MQTT::NotConnectedException if not connected?
50
+ #end
51
+
52
+ send_data(packet.to_s)
53
+ @last_sent = Time.now
54
+ end
55
+
56
+ end
@@ -0,0 +1,61 @@
1
+ require 'optparse'
2
+
3
+ class EventMachine::MQTT::Server
4
+ attr_accessor :address
5
+ attr_accessor :port
6
+ attr_accessor :logger
7
+
8
+ def initialize(args=[])
9
+ # Set defaults
10
+ self.address = "0.0.0.0"
11
+ self.port = MQTT::DEFAULT_PORT
12
+ self.logger = Logger.new(STDOUT)
13
+ self.logger.level = Logger::INFO
14
+ parse(args) unless args.empty?
15
+ end
16
+
17
+ def parse(args)
18
+ OptionParser.new("", 24, ' ') do |opts|
19
+ opts.banner = "Usage: #{File.basename $0} [options]"
20
+
21
+ opts.separator ""
22
+ opts.separator "Options:"
23
+
24
+ opts.on("-D", "--debug", "turn on debug logging") do
25
+ self.logger.level = Logger::DEBUG
26
+ end
27
+
28
+ opts.on("-a", "--address [HOST]", "bind to HOST address (default: #{address})") do |address|
29
+ self.address = address
30
+ end
31
+
32
+ opts.on("-p", "--port [PORT]", "port number to run on (default: #{port})") do |port|
33
+ self.port = port
34
+ end
35
+
36
+ opts.on_tail("-h", "--help", "show this message") do
37
+ puts opts
38
+ exit
39
+ end
40
+
41
+ opts.on_tail("--version", "show version") do
42
+ puts EventMachine::MQTT::VERSION
43
+ exit
44
+ end
45
+
46
+ opts.parse!(args)
47
+ end
48
+ end
49
+
50
+ def run
51
+ EventMachine.run do
52
+ # hit Control + C to stop
53
+ Signal.trap("INT") { EventMachine.stop }
54
+ Signal.trap("TERM") { EventMachine.stop }
55
+
56
+ logger.info("Starting MQTT server on #{address}:#{port}")
57
+ EventMachine.start_server(address, port, EventMachine::MQTT::ServerConnection, logger)
58
+ end
59
+ end
60
+
61
+ end
@@ -0,0 +1,110 @@
1
+
2
+ class EventMachine::MQTT::ServerConnection < EventMachine::MQTT::Connection
3
+
4
+ @@clients = Array.new
5
+
6
+ attr_accessor :client_id
7
+ attr_accessor :last_packet
8
+ attr_accessor :keep_alive
9
+ attr_accessor :message_id
10
+ attr_accessor :subscriptions
11
+
12
+ attr_reader :timer
13
+ attr_reader :logger
14
+
15
+ def initialize(logger)
16
+ @logger = logger
17
+ end
18
+
19
+ def post_init
20
+ super
21
+ @state = :wait_connect
22
+ @client_id = nil
23
+ @keep_alive = 0
24
+ @message_id = 0
25
+ @subscriptions = []
26
+ @timer = nil
27
+ logger.debug("TCP connection opened")
28
+ end
29
+
30
+ def unbind
31
+ @@clients.delete(self)
32
+ @timer.cancel if @timer
33
+ logger.debug("TCP connection closed")
34
+ end
35
+
36
+ def process_packet(packet)
37
+ logger.debug("#{client_id}: #{packet.inspect}")
38
+
39
+ if state == :wait_connect and packet.class == MQTT::Packet::Connect
40
+ connect(packet)
41
+ elsif state == :connected and packet.class == MQTT::Packet::Pingreq
42
+ ping(packet)
43
+ elsif state == :connected and packet.class == MQTT::Packet::Subscribe
44
+ subscribe(packet)
45
+ elsif state == :connected and packet.class == MQTT::Packet::Publish
46
+ publish(packet)
47
+ elsif packet.class == MQTT::Packet::Disconnect
48
+ logger.info("#{client_id} has disconnected")
49
+ disconnect
50
+ else
51
+ # FIXME: deal with other packet types
52
+ raise MQTT::ProtocolException.new(
53
+ "Wasn't expecting packet of type #{packet.class} when in state #{state}"
54
+ )
55
+ disconnect
56
+ end
57
+ end
58
+
59
+ def connect(packet)
60
+ # FIXME: check the protocol name and version
61
+ # FIXME: check the client id is between 1 and 23 charcters
62
+ self.client_id = packet.client_id
63
+
64
+ ## FIXME: disconnect old client with the same ID
65
+ send_packet MQTT::Packet::Connack.new
66
+ @state = :connected
67
+ @@clients << self
68
+ logger.info("#{client_id} is now connected")
69
+
70
+ # Setup a keep-alive timer
71
+ if packet.keep_alive
72
+ @keep_alive = packet.keep_alive
73
+ logger.debug("#{client_id}: Setting keep alive timer to #{@keep_alive} seconds")
74
+ @timer = EventMachine::PeriodicTimer.new(@keep_alive / 2) do
75
+ last_seen = Time.now - @last_received
76
+ if last_seen > @keep_alive * 1.5
77
+ logger.info("Disconnecting '#{client_id}' because it hasn't been seen for #{last_seen} seconds")
78
+ disconnect
79
+ end
80
+ end
81
+ end
82
+ end
83
+
84
+ def disconnect
85
+ logger.debug("Closing connection to #{client_id}")
86
+ @state = :disconnected
87
+ close_connection
88
+ end
89
+
90
+ def ping(packet)
91
+ send_packet MQTT::Packet::Pingresp.new
92
+ end
93
+
94
+ def subscribe(packet)
95
+ packet.topics.each do |topic,qos|
96
+ self.subscriptions << topic
97
+ end
98
+ logger.info("#{client_id} has subscriptions: #{self.subscriptions}")
99
+ # FIXME: send subscribe acknowledgement?
100
+ end
101
+
102
+ def publish(packet)
103
+ @@clients.each do |client|
104
+ if client.subscriptions.include?(packet.topic) or client.subscriptions.include?('#')
105
+ client.send_packet(packet)
106
+ end
107
+ end
108
+ end
109
+
110
+ end
@@ -0,0 +1,5 @@
1
+ module EventMachine
2
+ module MQTT
3
+ VERSION = "0.0.1"
4
+ end
5
+ end
@@ -0,0 +1,23 @@
1
+ $:.unshift(File.dirname(__FILE__))
2
+
3
+ require 'spec_helper'
4
+ require 'em-mqtt'
5
+
6
+ describe EventMachine::MQTT do
7
+
8
+ describe "version number" do
9
+ it "should be defined as a constant" do
10
+ defined?(EventMachine::MQTT::VERSION).should == 'constant'
11
+ end
12
+
13
+ it "should be a string" do
14
+ EventMachine::MQTT::VERSION.should be_a(String)
15
+ end
16
+
17
+ it "should be in the format x.y.z" do
18
+ EventMachine::MQTT::VERSION.should =~ /^\d{1,2}\.\d{1,2}\.\d{1,2}$/
19
+ end
20
+
21
+ end
22
+
23
+ end
metadata ADDED
@@ -0,0 +1,204 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: em-mqtt
3
+ version: !ruby/object:Gem::Version
4
+ hash: 29
5
+ prerelease: false
6
+ segments:
7
+ - 0
8
+ - 0
9
+ - 1
10
+ version: 0.0.1
11
+ platform: ruby
12
+ authors:
13
+ - Nicholas J Humfrey
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2012-02-04 00:00:00 +00:00
19
+ default_executable:
20
+ dependencies:
21
+ - !ruby/object:Gem::Dependency
22
+ requirement: &id001 !ruby/object:Gem::Requirement
23
+ none: false
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ hash: 3
28
+ segments:
29
+ - 0
30
+ version: "0"
31
+ type: :runtime
32
+ name: eventmachine
33
+ prerelease: false
34
+ version_requirements: *id001
35
+ - !ruby/object:Gem::Dependency
36
+ requirement: &id002 !ruby/object:Gem::Requirement
37
+ none: false
38
+ requirements:
39
+ - - ">="
40
+ - !ruby/object:Gem::Version
41
+ hash: 15
42
+ segments:
43
+ - 0
44
+ - 0
45
+ - 8
46
+ version: 0.0.8
47
+ type: :runtime
48
+ name: mqtt
49
+ prerelease: false
50
+ version_requirements: *id002
51
+ - !ruby/object:Gem::Dependency
52
+ requirement: &id003 !ruby/object:Gem::Requirement
53
+ none: false
54
+ requirements:
55
+ - - ">="
56
+ - !ruby/object:Gem::Version
57
+ hash: 25
58
+ segments:
59
+ - 1
60
+ - 0
61
+ - 7
62
+ version: 1.0.7
63
+ type: :development
64
+ name: bundler
65
+ prerelease: false
66
+ version_requirements: *id003
67
+ - !ruby/object:Gem::Dependency
68
+ requirement: &id004 !ruby/object:Gem::Requirement
69
+ none: false
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ hash: 7
74
+ segments:
75
+ - 0
76
+ - 7
77
+ - 2
78
+ version: 0.7.2
79
+ type: :development
80
+ name: yard
81
+ prerelease: false
82
+ version_requirements: *id004
83
+ - !ruby/object:Gem::Dependency
84
+ requirement: &id005 !ruby/object:Gem::Requirement
85
+ none: false
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ hash: 49
90
+ segments:
91
+ - 0
92
+ - 8
93
+ - 7
94
+ version: 0.8.7
95
+ type: :development
96
+ name: rake
97
+ prerelease: false
98
+ version_requirements: *id005
99
+ - !ruby/object:Gem::Dependency
100
+ requirement: &id006 !ruby/object:Gem::Requirement
101
+ none: false
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ hash: 23
106
+ segments:
107
+ - 2
108
+ - 6
109
+ - 0
110
+ version: 2.6.0
111
+ type: :development
112
+ name: rspec
113
+ prerelease: false
114
+ version_requirements: *id006
115
+ - !ruby/object:Gem::Dependency
116
+ requirement: &id007 !ruby/object:Gem::Requirement
117
+ none: false
118
+ requirements:
119
+ - - ">="
120
+ - !ruby/object:Gem::Version
121
+ hash: 55
122
+ segments:
123
+ - 0
124
+ - 10
125
+ - 0
126
+ version: 0.10.0
127
+ type: :development
128
+ name: mocha
129
+ prerelease: false
130
+ version_requirements: *id007
131
+ - !ruby/object:Gem::Dependency
132
+ requirement: &id008 !ruby/object:Gem::Requirement
133
+ none: false
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ hash: 59
138
+ segments:
139
+ - 0
140
+ - 9
141
+ - 0
142
+ version: 0.9.0
143
+ type: :development
144
+ name: rcov
145
+ prerelease: false
146
+ version_requirements: *id008
147
+ description: This gem adds MQTT (Message Queue Telemetry Transport) protocol support to EventMachine.
148
+ email: njh@aelius.com
149
+ executables:
150
+ - em-mqtt
151
+ extensions: []
152
+
153
+ extra_rdoc_files: []
154
+
155
+ files:
156
+ - README
157
+ - COPYING
158
+ - GPL
159
+ - NEWS
160
+ - lib/em-mqtt/version.rb
161
+ - lib/em-mqtt/client_connection.rb
162
+ - lib/em-mqtt/server.rb
163
+ - lib/em-mqtt/server_connection.rb
164
+ - lib/em-mqtt/client.rb.new.rb
165
+ - lib/em-mqtt/connection.rb
166
+ - lib/em-mqtt.rb
167
+ - spec/em_mqtt_version_spec.rb
168
+ - bin/em-mqtt
169
+ has_rdoc: true
170
+ homepage: http://github.com/njh/ruby-em-mqtt
171
+ licenses:
172
+ - Ruby
173
+ post_install_message:
174
+ rdoc_options: []
175
+
176
+ require_paths:
177
+ - lib
178
+ required_ruby_version: !ruby/object:Gem::Requirement
179
+ none: false
180
+ requirements:
181
+ - - ">="
182
+ - !ruby/object:Gem::Version
183
+ hash: 3
184
+ segments:
185
+ - 0
186
+ version: "0"
187
+ required_rubygems_version: !ruby/object:Gem::Requirement
188
+ none: false
189
+ requirements:
190
+ - - ">="
191
+ - !ruby/object:Gem::Version
192
+ hash: 3
193
+ segments:
194
+ - 0
195
+ version: "0"
196
+ requirements: []
197
+
198
+ rubyforge_project:
199
+ rubygems_version: 1.3.7
200
+ signing_key:
201
+ specification_version: 3
202
+ summary: MQTT for EventMachine
203
+ test_files:
204
+ - spec/em_mqtt_version_spec.rb