yalgaar 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/doc/Encoding.html +250 -0
- data/doc/MQTT.html +119 -0
- data/doc/MQTT/Client.html +1520 -0
- data/doc/MQTT/Exception.html +104 -0
- data/doc/MQTT/MQTT.html +95 -0
- data/doc/MQTT/MQTT/MQTT.html +95 -0
- data/doc/MQTT/MQTT/MQTT/Packet.html +1263 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Connack.html +433 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Connect.html +596 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Disconnect.html +214 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Pingreq.html +212 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Pingresp.html +212 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Puback.html +235 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Pubcomp.html +235 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Publish.html +590 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Pubrec.html +235 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Pubrel.html +334 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Suback.html +441 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Subscribe.html +449 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Unsuback.html +284 -0
- data/doc/MQTT/MQTT/MQTT/Packet/Unsubscribe.html +403 -0
- data/doc/MQTT/NotConnectedException.html +106 -0
- data/doc/MQTT/ProtocolException.html +105 -0
- data/doc/MQTT/Proxy.html +400 -0
- data/doc/MQTT/SN.html +116 -0
- data/doc/MQTT/SN/Packet.html +802 -0
- data/doc/MQTT/SN/Packet/Advertise.html +236 -0
- data/doc/MQTT/SN/Packet/Connack.html +259 -0
- data/doc/MQTT/SN/Packet/Connect.html +246 -0
- data/doc/MQTT/SN/Packet/Disconnect.html +231 -0
- data/doc/MQTT/SN/Packet/Gwinfo.html +241 -0
- data/doc/MQTT/SN/Packet/Pingreq.html +102 -0
- data/doc/MQTT/SN/Packet/Pingresp.html +102 -0
- data/doc/MQTT/SN/Packet/Puback.html +257 -0
- data/doc/MQTT/SN/Packet/Pubcomp.html +227 -0
- data/doc/MQTT/SN/Packet/Publish.html +255 -0
- data/doc/MQTT/SN/Packet/Pubrec.html +227 -0
- data/doc/MQTT/SN/Packet/Pubrel.html +227 -0
- data/doc/MQTT/SN/Packet/Regack.html +257 -0
- data/doc/MQTT/SN/Packet/Register.html +257 -0
- data/doc/MQTT/SN/Packet/Searchgw.html +223 -0
- data/doc/MQTT/SN/Packet/Suback.html +255 -0
- data/doc/MQTT/SN/Packet/Subscribe.html +255 -0
- data/doc/MQTT/SN/Packet/Unsuback.html +227 -0
- data/doc/MQTT/SN/Packet/Unsubscribe.html +255 -0
- data/doc/MQTT/SN/Packet/Willmsg.html +209 -0
- data/doc/MQTT/SN/Packet/Willmsgreq.html +102 -0
- data/doc/MQTT/SN/Packet/Willmsgresp.html +227 -0
- data/doc/MQTT/SN/Packet/Willmsgupd.html +209 -0
- data/doc/MQTT/SN/Packet/Willtopic.html +233 -0
- data/doc/MQTT/SN/Packet/Willtopicreq.html +102 -0
- data/doc/MQTT/SN/Packet/Willtopicresp.html +227 -0
- data/doc/MQTT/SN/Packet/Willtopicupd.html +232 -0
- data/doc/MQTT/SN/ProtocolException.html +105 -0
- data/doc/MYalgaar.html +212 -0
- data/doc/Object.html +396 -0
- data/doc/SSLcomDVCA_2_crt.html +115 -0
- data/doc/String.html +227 -0
- data/doc/YALGAAR.html +110 -0
- data/doc/Yalgaar.html +189 -0
- data/doc/YalgaarApis.html +619 -0
- data/doc/YalgaarChannelList.html +228 -0
- data/doc/YalgaarConnect.html +439 -0
- data/doc/YalgaarHistory.html +174 -0
- data/doc/YalgaarInit.html +206 -0
- data/doc/YalgaarPublish.html +196 -0
- data/doc/YalgaarSubcribe.html +266 -0
- data/doc/ca_crt.html +97 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +590 -0
- data/doc/examples/SSLcomDVCA_2_crt.html +115 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +219 -0
- data/doc/js/darkfish.js +161 -0
- data/doc/js/jquery.js +4 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +109 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +228 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +1296 -0
- data/doc/yalgaar_gemspec.html +116 -0
- data/examples/SSLcomDVCA_2.crt +34 -0
- data/examples/channelList.rb +64 -0
- data/examples/connect.rb +37 -0
- data/examples/history.rb +37 -0
- data/examples/publish.rb +21 -0
- data/examples/subcribe.rb +53 -0
- data/examples/yalgaarUser.rb +92 -0
- data/lib/mqttbridge/YalgaarChannellist.rb +71 -0
- data/lib/mqttbridge/YalgaarConnect.rb +277 -0
- data/lib/mqttbridge/YalgaarHistory.rb +48 -0
- data/lib/mqttbridge/YalgaarInitModule.rb +333 -0
- data/lib/mqttbridge/YalgaarPublish.rb +39 -0
- data/lib/mqttbridge/YalgaarSubscribe.rb +99 -0
- data/lib/mqttbridge/client.rb +601 -0
- data/lib/mqttbridge/mqtt.rb +54 -0
- data/lib/mqttbridge/packet.rb +1113 -0
- data/lib/mqttbridge/patches/string_encoding.rb +34 -0
- data/lib/mqttbridge/proxy.rb +119 -0
- data/lib/mqttbridge/sn/packet.rb +763 -0
- data/lib/mqttbridge/version.rb +4 -0
- data/lib/yalgaar.rb +24 -0
- metadata +178 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: 6dd09d3069d064ace5193b955d3940d96d475b6d
|
|
4
|
+
data.tar.gz: 41f5bc9de06c68925e0248ca14b420c30774a5a7
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 9a0e71afa8cfd9e8836c0c2a62cb60e2e916ded07d10f3944df6b3b844fdb2ca8806756355f9b2e9055c87d431b83a7c1ff35b0dea0f7e417cceba66d4de5004
|
|
7
|
+
data.tar.gz: 6dbc43a669f04c5c500591ddec0dbf55930ecae3b088b89f9f00a7393996bb6e188eab395a5adb6f62d106c318bdacde4c10fd513e9b30059d9f3f1663e384a9
|
data/doc/Encoding.html
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class Encoding - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="./js/jquery.js"></script>
|
|
14
|
+
<script src="./js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="./index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="Object.html">Object</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<div id="method-list-section" class="nav-section">
|
|
69
|
+
<h3>Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list" role="directory">
|
|
72
|
+
|
|
73
|
+
<li ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-i-name">#name</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-i-to_s">#to_s</a>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
</div>
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
</nav>
|
|
84
|
+
|
|
85
|
+
<main role="main" aria-labelledby="class-Encoding">
|
|
86
|
+
<h1 id="class-Encoding" class="class">
|
|
87
|
+
class Encoding
|
|
88
|
+
</h1>
|
|
89
|
+
|
|
90
|
+
<section class="description">
|
|
91
|
+
|
|
92
|
+
</section>
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<section class="constants-list">
|
|
104
|
+
<header>
|
|
105
|
+
<h3>Constants</h3>
|
|
106
|
+
</header>
|
|
107
|
+
<dl>
|
|
108
|
+
|
|
109
|
+
<dt id="ASCII_8BIT">ASCII_8BIT
|
|
110
|
+
|
|
111
|
+
<dd>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<dt id="UTF_8">UTF_8
|
|
115
|
+
|
|
116
|
+
<dd>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
</dl>
|
|
120
|
+
</section>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
127
|
+
<header>
|
|
128
|
+
<h3>Public Class Methods</h3>
|
|
129
|
+
</header>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<div id="method-c-new" class="method-detail ">
|
|
133
|
+
|
|
134
|
+
<div class="method-heading">
|
|
135
|
+
<span class="method-name">new</span><span
|
|
136
|
+
class="method-args">(name)</span>
|
|
137
|
+
|
|
138
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
139
|
+
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<div class="method-description">
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<div class="method-source-code" id="new-source">
|
|
151
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/patches/string_encoding.rb, line 20</span>
|
|
152
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
|
|
153
|
+
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
|
|
154
|
+
<span class="ruby-keyword">end</span></pre>
|
|
155
|
+
</div>
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</section>
|
|
166
|
+
|
|
167
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
168
|
+
<header>
|
|
169
|
+
<h3>Public Instance Methods</h3>
|
|
170
|
+
</header>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<div id="method-i-name" class="method-detail ">
|
|
174
|
+
|
|
175
|
+
<div class="method-heading">
|
|
176
|
+
<span class="method-name">name</span><span
|
|
177
|
+
class="method-args">()</span>
|
|
178
|
+
|
|
179
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<div class="method-description">
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<div class="method-source-code" id="name-source">
|
|
192
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/patches/string_encoding.rb, line 28</span>
|
|
193
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">name</span>
|
|
194
|
+
<span class="ruby-ivar">@name</span>
|
|
195
|
+
<span class="ruby-keyword">end</span></pre>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<div id="method-i-to_s" class="method-detail ">
|
|
207
|
+
|
|
208
|
+
<div class="method-heading">
|
|
209
|
+
<span class="method-name">to_s</span><span
|
|
210
|
+
class="method-args">()</span>
|
|
211
|
+
|
|
212
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<div class="method-description">
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div class="method-source-code" id="to_s-source">
|
|
225
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/patches/string_encoding.rb, line 24</span>
|
|
226
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
|
|
227
|
+
<span class="ruby-ivar">@name</span>
|
|
228
|
+
<span class="ruby-keyword">end</span></pre>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</section>
|
|
240
|
+
|
|
241
|
+
</section>
|
|
242
|
+
</main>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<footer id="validator-badges" role="contentinfo">
|
|
246
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
247
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
248
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
249
|
+
</footer>
|
|
250
|
+
|
data/doc/MQTT.html
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>module MQTT - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="./js/jquery.js"></script>
|
|
14
|
+
<script src="./js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="module">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="./index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</div>
|
|
62
|
+
</nav>
|
|
63
|
+
|
|
64
|
+
<main role="main" aria-labelledby="module-MQTT">
|
|
65
|
+
<h1 id="module-MQTT" class="module">
|
|
66
|
+
module MQTT
|
|
67
|
+
</h1>
|
|
68
|
+
|
|
69
|
+
<section class="description">
|
|
70
|
+
|
|
71
|
+
</section>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<section class="constants-list">
|
|
83
|
+
<header>
|
|
84
|
+
<h3>Constants</h3>
|
|
85
|
+
</header>
|
|
86
|
+
<dl>
|
|
87
|
+
|
|
88
|
+
<dt id="DEFAULT_PORT">DEFAULT_PORT
|
|
89
|
+
|
|
90
|
+
<dd><p>Default port number for unencrypted connections</p>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<dt id="DEFAULT_SSL_PORT">DEFAULT_SSL_PORT
|
|
94
|
+
|
|
95
|
+
<dd><p>Default port number for TLS/SSL encrypted connections</p>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<dt id="PACKET_TYPES">PACKET_TYPES
|
|
99
|
+
|
|
100
|
+
<dd><p>An enumeration of the <a href="MQTT/MQTT.html">MQTT</a> packet types</p>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
</dl>
|
|
104
|
+
</section>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</section>
|
|
111
|
+
</main>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<footer id="validator-badges" role="contentinfo">
|
|
115
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
116
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
117
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
118
|
+
</footer>
|
|
119
|
+
|
|
@@ -0,0 +1,1520 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class MQTT::Client - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="../Object.html">Object</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
<div id="includes-section" class="nav-section">
|
|
66
|
+
<h3>Included Modules</h3>
|
|
67
|
+
|
|
68
|
+
<ul class="link-list">
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<li><a class="include" href="../YalgaarApis.html">YalgaarApis</a>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</ul>
|
|
75
|
+
</div>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<!-- Method Quickref -->
|
|
79
|
+
<div id="method-list-section" class="nav-section">
|
|
80
|
+
<h3>Methods</h3>
|
|
81
|
+
|
|
82
|
+
<ul class="link-list" role="directory">
|
|
83
|
+
|
|
84
|
+
<li ><a href="#method-c-connect">::connect</a>
|
|
85
|
+
|
|
86
|
+
<li ><a href="#method-c-generate_client_id">::generate_client_id</a>
|
|
87
|
+
|
|
88
|
+
<li ><a href="#method-c-new">::new</a>
|
|
89
|
+
|
|
90
|
+
<li ><a href="#method-i-ca_file-3D">#ca_file=</a>
|
|
91
|
+
|
|
92
|
+
<li ><a href="#method-i-cert-3D">#cert=</a>
|
|
93
|
+
|
|
94
|
+
<li ><a href="#method-i-cert_file-3D">#cert_file=</a>
|
|
95
|
+
|
|
96
|
+
<li ><a href="#method-i-connect">#connect</a>
|
|
97
|
+
|
|
98
|
+
<li ><a href="#method-i-connected-3F">#connected?</a>
|
|
99
|
+
|
|
100
|
+
<li ><a href="#method-i-disconnect">#disconnect</a>
|
|
101
|
+
|
|
102
|
+
<li ><a href="#method-i-get">#get</a>
|
|
103
|
+
|
|
104
|
+
<li ><a href="#method-i-get_packet">#get_packet</a>
|
|
105
|
+
|
|
106
|
+
<li ><a href="#method-i-key-3D">#key=</a>
|
|
107
|
+
|
|
108
|
+
<li ><a href="#method-i-key_file-3D">#key_file=</a>
|
|
109
|
+
|
|
110
|
+
<li ><a href="#method-i-publish">#publish</a>
|
|
111
|
+
|
|
112
|
+
<li ><a href="#method-i-queue_empty-3F">#queue_empty?</a>
|
|
113
|
+
|
|
114
|
+
<li ><a href="#method-i-queue_length">#queue_length</a>
|
|
115
|
+
|
|
116
|
+
<li ><a href="#method-i-remote_host">#remote_host</a>
|
|
117
|
+
|
|
118
|
+
<li ><a href="#method-i-remote_host-3D">#remote_host=</a>
|
|
119
|
+
|
|
120
|
+
<li ><a href="#method-i-remote_port">#remote_port</a>
|
|
121
|
+
|
|
122
|
+
<li ><a href="#method-i-remote_port-3D">#remote_port=</a>
|
|
123
|
+
|
|
124
|
+
<li ><a href="#method-i-set_will">#set_will</a>
|
|
125
|
+
|
|
126
|
+
<li ><a href="#method-i-ssl_context">#ssl_context</a>
|
|
127
|
+
|
|
128
|
+
<li ><a href="#method-i-subscribe">#subscribe</a>
|
|
129
|
+
|
|
130
|
+
<li ><a href="#method-i-unsubscribe">#unsubscribe</a>
|
|
131
|
+
|
|
132
|
+
</ul>
|
|
133
|
+
</div>
|
|
134
|
+
|
|
135
|
+
</div>
|
|
136
|
+
</nav>
|
|
137
|
+
|
|
138
|
+
<main role="main" aria-labelledby="class-MQTT::Client">
|
|
139
|
+
<h1 id="class-MQTT::Client" class="class">
|
|
140
|
+
class MQTT::Client
|
|
141
|
+
</h1>
|
|
142
|
+
|
|
143
|
+
<section class="description">
|
|
144
|
+
|
|
145
|
+
<p><a href="Client.html">Client</a> class for talking to an <a
|
|
146
|
+
href="../MQTT.html">MQTT</a> server</p>
|
|
147
|
+
|
|
148
|
+
</section>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<section class="constants-list">
|
|
160
|
+
<header>
|
|
161
|
+
<h3>Constants</h3>
|
|
162
|
+
</header>
|
|
163
|
+
<dl>
|
|
164
|
+
|
|
165
|
+
<dt id="ATTR_DEFAULTS">ATTR_DEFAULTS
|
|
166
|
+
|
|
167
|
+
<dd><p>Default attribute values</p>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<dt id="SELECT_TIMEOUT">SELECT_TIMEOUT
|
|
171
|
+
|
|
172
|
+
<dd><p>Timeout between select polls (in seconds)</p>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</dl>
|
|
176
|
+
</section>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<section class="attribute-method-details" class="method-section">
|
|
181
|
+
<header>
|
|
182
|
+
<h3>Attributes</h3>
|
|
183
|
+
</header>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<div id="attribute-i-ack_timeout" class="method-detail">
|
|
187
|
+
<div class="method-heading attribute-method-heading">
|
|
188
|
+
<span class="method-name">ack_timeout</span><span
|
|
189
|
+
class="attribute-access-type">[RW]</span>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div class="method-description">
|
|
193
|
+
|
|
194
|
+
<p>Number of seconds to wait for acknowledgement packets (default is 5
|
|
195
|
+
seconds)</p>
|
|
196
|
+
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
|
|
200
|
+
<div id="attribute-i-clean_session" class="method-detail">
|
|
201
|
+
<div class="method-heading attribute-method-heading">
|
|
202
|
+
<span class="method-name">clean_session</span><span
|
|
203
|
+
class="attribute-access-type">[RW]</span>
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
<div class="method-description">
|
|
207
|
+
|
|
208
|
+
<p>Set the 'Clean Session' flag when connecting? (default is true)</p>
|
|
209
|
+
|
|
210
|
+
</div>
|
|
211
|
+
</div>
|
|
212
|
+
|
|
213
|
+
<div id="attribute-i-client_id" class="method-detail">
|
|
214
|
+
<div class="method-heading attribute-method-heading">
|
|
215
|
+
<span class="method-name">client_id</span><span
|
|
216
|
+
class="attribute-access-type">[RW]</span>
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
<div class="method-description">
|
|
220
|
+
|
|
221
|
+
<p><a href="Client.html">Client</a> Identifier</p>
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
<div id="attribute-i-host" class="method-detail">
|
|
227
|
+
<div class="method-heading attribute-method-heading">
|
|
228
|
+
<span class="method-name">host</span><span
|
|
229
|
+
class="attribute-access-type">[RW]</span>
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
<div class="method-description">
|
|
233
|
+
|
|
234
|
+
<p>Hostname of the remote server</p>
|
|
235
|
+
|
|
236
|
+
</div>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
<div id="attribute-i-keep_alive" class="method-detail">
|
|
240
|
+
<div class="method-heading attribute-method-heading">
|
|
241
|
+
<span class="method-name">keep_alive</span><span
|
|
242
|
+
class="attribute-access-type">[RW]</span>
|
|
243
|
+
</div>
|
|
244
|
+
|
|
245
|
+
<div class="method-description">
|
|
246
|
+
|
|
247
|
+
<p>Time (in seconds) between pings to remote server (default is 15 seconds)</p>
|
|
248
|
+
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
251
|
+
|
|
252
|
+
<div id="attribute-i-last_ping_response" class="method-detail">
|
|
253
|
+
<div class="method-heading attribute-method-heading">
|
|
254
|
+
<span class="method-name">last_ping_response</span><span
|
|
255
|
+
class="attribute-access-type">[R]</span>
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
<div class="method-description">
|
|
259
|
+
|
|
260
|
+
<p>Last ping response time</p>
|
|
261
|
+
|
|
262
|
+
</div>
|
|
263
|
+
</div>
|
|
264
|
+
|
|
265
|
+
<div id="attribute-i-password" class="method-detail">
|
|
266
|
+
<div class="method-heading attribute-method-heading">
|
|
267
|
+
<span class="method-name">password</span><span
|
|
268
|
+
class="attribute-access-type">[RW]</span>
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
<div class="method-description">
|
|
272
|
+
|
|
273
|
+
<p>Password to authenticate to the server with</p>
|
|
274
|
+
|
|
275
|
+
</div>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
<div id="attribute-i-port" class="method-detail">
|
|
279
|
+
<div class="method-heading attribute-method-heading">
|
|
280
|
+
<span class="method-name">port</span><span
|
|
281
|
+
class="attribute-access-type">[RW]</span>
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
<div class="method-description">
|
|
285
|
+
|
|
286
|
+
<p>Port number of the remote server</p>
|
|
287
|
+
|
|
288
|
+
</div>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
<div id="attribute-i-ssl" class="method-detail">
|
|
292
|
+
<div class="method-heading attribute-method-heading">
|
|
293
|
+
<span class="method-name">ssl</span><span
|
|
294
|
+
class="attribute-access-type">[RW]</span>
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
<div class="method-description">
|
|
298
|
+
|
|
299
|
+
<p>Set to true to enable SSL/TLS encrypted communication</p>
|
|
300
|
+
|
|
301
|
+
<p>Set to a symbol to use a specific variant of SSL/TLS. Allowed values
|
|
302
|
+
include:</p>
|
|
303
|
+
|
|
304
|
+
<p>@example Using TLS 1.0</p>
|
|
305
|
+
|
|
306
|
+
<pre class="ruby"><span class="ruby-identifier">client</span> = <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'mqtt.example.com'</span>, :<span class="ruby-identifier">ssl</span> =<span class="ruby-operator">></span> :<span class="ruby-constant">TLSv1</span>)
|
|
307
|
+
</pre>
|
|
308
|
+
|
|
309
|
+
<p>@see OpenSSL::SSL::SSLContext::METHODS</p>
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
</div>
|
|
313
|
+
|
|
314
|
+
<div id="attribute-i-username" class="method-detail">
|
|
315
|
+
<div class="method-heading attribute-method-heading">
|
|
316
|
+
<span class="method-name">username</span><span
|
|
317
|
+
class="attribute-access-type">[RW]</span>
|
|
318
|
+
</div>
|
|
319
|
+
|
|
320
|
+
<div class="method-description">
|
|
321
|
+
|
|
322
|
+
<p>Username to authenticate to the server with</p>
|
|
323
|
+
|
|
324
|
+
</div>
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
<div id="attribute-i-version" class="method-detail">
|
|
328
|
+
<div class="method-heading attribute-method-heading">
|
|
329
|
+
<span class="method-name">version</span><span
|
|
330
|
+
class="attribute-access-type">[RW]</span>
|
|
331
|
+
</div>
|
|
332
|
+
|
|
333
|
+
<div class="method-description">
|
|
334
|
+
|
|
335
|
+
<p>The version number of the <a href="../MQTT.html">MQTT</a> protocol to use
|
|
336
|
+
(default 3.1.1)</p>
|
|
337
|
+
|
|
338
|
+
</div>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
<div id="attribute-i-will_payload" class="method-detail">
|
|
342
|
+
<div class="method-heading attribute-method-heading">
|
|
343
|
+
<span class="method-name">will_payload</span><span
|
|
344
|
+
class="attribute-access-type">[RW]</span>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
<div class="method-description">
|
|
348
|
+
|
|
349
|
+
<p>Contents of message that is sent by server when client disconnect</p>
|
|
350
|
+
|
|
351
|
+
</div>
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
<div id="attribute-i-will_qos" class="method-detail">
|
|
355
|
+
<div class="method-heading attribute-method-heading">
|
|
356
|
+
<span class="method-name">will_qos</span><span
|
|
357
|
+
class="attribute-access-type">[RW]</span>
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
<div class="method-description">
|
|
361
|
+
|
|
362
|
+
<p>The QoS level of the will message sent by the server</p>
|
|
363
|
+
|
|
364
|
+
</div>
|
|
365
|
+
</div>
|
|
366
|
+
|
|
367
|
+
<div id="attribute-i-will_retain" class="method-detail">
|
|
368
|
+
<div class="method-heading attribute-method-heading">
|
|
369
|
+
<span class="method-name">will_retain</span><span
|
|
370
|
+
class="attribute-access-type">[RW]</span>
|
|
371
|
+
</div>
|
|
372
|
+
|
|
373
|
+
<div class="method-description">
|
|
374
|
+
|
|
375
|
+
<p>If the Will message should be retain by the server after it is sent</p>
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
<div id="attribute-i-will_topic" class="method-detail">
|
|
381
|
+
<div class="method-heading attribute-method-heading">
|
|
382
|
+
<span class="method-name">will_topic</span><span
|
|
383
|
+
class="attribute-access-type">[RW]</span>
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
<div class="method-description">
|
|
387
|
+
|
|
388
|
+
<p>The topic that the Will message is published to</p>
|
|
389
|
+
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
</section>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
398
|
+
<header>
|
|
399
|
+
<h3>Public Class Methods</h3>
|
|
400
|
+
</header>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<div id="method-c-connect" class="method-detail ">
|
|
404
|
+
|
|
405
|
+
<div class="method-heading">
|
|
406
|
+
<span class="method-name">connect</span><span
|
|
407
|
+
class="method-args">(*args, &block)</span>
|
|
408
|
+
|
|
409
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<div class="method-description">
|
|
415
|
+
|
|
416
|
+
<p>Create and connect a new <a href="../MQTT.html">MQTT</a> <a
|
|
417
|
+
href="Client.html">Client</a></p>
|
|
418
|
+
|
|
419
|
+
<p>Accepts the same arguments as creating a new client. If a block is given,
|
|
420
|
+
then it will be executed before disconnecting again.</p>
|
|
421
|
+
|
|
422
|
+
<p>Example:</p>
|
|
423
|
+
|
|
424
|
+
<pre class="ruby"><span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">'myserver.example.com'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">client</span><span class="ruby-operator">|</span>
|
|
425
|
+
<span class="ruby-comment"># do stuff here</span>
|
|
426
|
+
<span class="ruby-keyword">end</span>
|
|
427
|
+
</pre>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<div class="method-source-code" id="connect-source">
|
|
433
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 92</span>
|
|
434
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
435
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
436
|
+
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
437
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">client</span>
|
|
438
|
+
<span class="ruby-keyword">end</span></pre>
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<div id="method-c-generate_client_id" class="method-detail ">
|
|
450
|
+
|
|
451
|
+
<div class="method-heading">
|
|
452
|
+
<span class="method-name">generate_client_id</span><span
|
|
453
|
+
class="method-args">(prefix='ruby', length=16)</span>
|
|
454
|
+
|
|
455
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
456
|
+
|
|
457
|
+
</div>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<div class="method-description">
|
|
461
|
+
|
|
462
|
+
<p>Generate a random client identifier (using the characters 0-9 and a-z)</p>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<div class="method-source-code" id="generate_client_id-source">
|
|
468
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 100</span>
|
|
469
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">generate_client_id</span>(<span class="ruby-identifier">prefix</span>=<span class="ruby-string">'ruby'</span>, <span class="ruby-identifier">length</span>=<span class="ruby-value">16</span>)
|
|
470
|
+
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">dup</span>
|
|
471
|
+
<span class="ruby-identifier">length</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
|
472
|
+
<span class="ruby-identifier">num</span> = <span class="ruby-identifier">rand</span>(<span class="ruby-value">36</span>)
|
|
473
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">num</span><span class="ruby-operator"><</span><span class="ruby-value">10</span>)
|
|
474
|
+
<span class="ruby-comment"># Number</span>
|
|
475
|
+
<span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">48</span>
|
|
476
|
+
<span class="ruby-keyword">else</span>
|
|
477
|
+
<span class="ruby-comment"># Letter</span>
|
|
478
|
+
<span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">87</span>
|
|
479
|
+
<span class="ruby-keyword">end</span>
|
|
480
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">num</span>.<span class="ruby-identifier">chr</span>
|
|
481
|
+
<span class="ruby-keyword">end</span>
|
|
482
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">str</span>
|
|
483
|
+
<span class="ruby-keyword">end</span></pre>
|
|
484
|
+
</div>
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<div id="method-c-new" class="method-detail ">
|
|
495
|
+
|
|
496
|
+
<div class="method-heading">
|
|
497
|
+
<span class="method-name">new</span><span
|
|
498
|
+
class="method-args">(*args)</span>
|
|
499
|
+
|
|
500
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<div class="method-description">
|
|
506
|
+
|
|
507
|
+
<p>Create a new <a href="../MQTT.html">MQTT</a> <a
|
|
508
|
+
href="Client.html">Client</a> instance</p>
|
|
509
|
+
|
|
510
|
+
<p>Accepts one of the following:</p>
|
|
511
|
+
<ul><li>
|
|
512
|
+
<p>a URI that uses the <a href="../MQTT.html">MQTT</a> scheme</p>
|
|
513
|
+
</li><li>
|
|
514
|
+
<p>a hostname and port</p>
|
|
515
|
+
</li><li>
|
|
516
|
+
<p>a Hash containing attributes to be set on the new instance</p>
|
|
517
|
+
</li></ul>
|
|
518
|
+
|
|
519
|
+
<p>If no arguments are given then the method will look for a URI in the
|
|
520
|
+
MQTT_SERVER environment variable.</p>
|
|
521
|
+
|
|
522
|
+
<p>Examples:</p>
|
|
523
|
+
|
|
524
|
+
<pre class="ruby"><span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>
|
|
525
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'mqtt://myserver.example.com'</span>)
|
|
526
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'mqtt://user:pass@myserver.example.com'</span>)
|
|
527
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'myserver.example.com'</span>)
|
|
528
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'myserver.example.com'</span>, <span class="ruby-value">18830</span>)
|
|
529
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">host</span> =<span class="ruby-operator">></span> <span class="ruby-string">'myserver.example.com'</span>)
|
|
530
|
+
<span class="ruby-identifier">client</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">host</span> =<span class="ruby-operator">></span> <span class="ruby-string">'myserver.example.com'</span>, :<span class="ruby-identifier">keep_alive</span> =<span class="ruby-operator">></span> <span class="ruby-value">30</span>)
|
|
531
|
+
</pre>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
<div class="method-source-code" id="new-source">
|
|
537
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 135</span>
|
|
538
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
539
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
|
540
|
+
<span class="ruby-identifier">attr</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span>
|
|
541
|
+
<span class="ruby-keyword">else</span>
|
|
542
|
+
<span class="ruby-identifier">attr</span> = {}
|
|
543
|
+
<span class="ruby-keyword">end</span>
|
|
544
|
+
|
|
545
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
|
546
|
+
<span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'MQTT_SERVER'</span>]
|
|
547
|
+
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">parse_uri</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'MQTT_SERVER'</span>]))
|
|
548
|
+
<span class="ruby-keyword">end</span>
|
|
549
|
+
<span class="ruby-keyword">end</span>
|
|
550
|
+
|
|
551
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">>=</span> <span class="ruby-value">1</span>
|
|
552
|
+
<span class="ruby-keyword">case</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
|
|
553
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">URI</span>
|
|
554
|
+
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">parse_uri</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]))
|
|
555
|
+
<span class="ruby-keyword">when</span> <span class="ruby-regexp">%r|^mqtts?://|</span>
|
|
556
|
+
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">parse_uri</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]))
|
|
557
|
+
<span class="ruby-keyword">else</span>
|
|
558
|
+
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-value">:host</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
|
|
559
|
+
<span class="ruby-keyword">end</span>
|
|
560
|
+
<span class="ruby-keyword">end</span>
|
|
561
|
+
|
|
562
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">>=</span> <span class="ruby-value">2</span>
|
|
563
|
+
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-value">:port</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">nil?</span>
|
|
564
|
+
<span class="ruby-keyword">end</span>
|
|
565
|
+
|
|
566
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">>=</span> <span class="ruby-value">3</span>
|
|
567
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Unsupported number of arguments"</span>
|
|
568
|
+
<span class="ruby-keyword">end</span>
|
|
569
|
+
|
|
570
|
+
<span class="ruby-comment"># Merge arguments with default values for attributes</span>
|
|
571
|
+
<span class="ruby-constant">ATTR_DEFAULTS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">attr</span>).<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
|
572
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">"#{k}="</span>, <span class="ruby-identifier">v</span>)
|
|
573
|
+
<span class="ruby-keyword">end</span>
|
|
574
|
+
|
|
575
|
+
<span class="ruby-comment"># Set a default port number</span>
|
|
576
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@port</span>.<span class="ruby-identifier">nil?</span>
|
|
577
|
+
<span class="ruby-ivar">@port</span> = <span class="ruby-ivar">@ssl</span> <span class="ruby-operator">?</span> <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_SSL_PORT</span> <span class="ruby-operator">:</span> <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_PORT</span>
|
|
578
|
+
<span class="ruby-keyword">end</span>
|
|
579
|
+
|
|
580
|
+
<span class="ruby-comment"># Initialise private instance variables</span>
|
|
581
|
+
<span class="ruby-ivar">@last_ping_request</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
|
|
582
|
+
<span class="ruby-ivar">@last_ping_response</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
|
|
583
|
+
<span class="ruby-ivar">@socket</span> = <span class="ruby-keyword">nil</span>
|
|
584
|
+
<span class="ruby-ivar">@read_queue</span> = <span class="ruby-constant">Queue</span>.<span class="ruby-identifier">new</span>
|
|
585
|
+
<span class="ruby-ivar">@pubacks</span> = {}
|
|
586
|
+
<span class="ruby-ivar">@read_thread</span> = <span class="ruby-keyword">nil</span>
|
|
587
|
+
<span class="ruby-ivar">@write_semaphore</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
|
588
|
+
<span class="ruby-ivar">@pubacks_semaphore</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
|
589
|
+
<span class="ruby-keyword">end</span></pre>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</div>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</section>
|
|
601
|
+
|
|
602
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
603
|
+
<header>
|
|
604
|
+
<h3>Public Instance Methods</h3>
|
|
605
|
+
</header>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
<div id="method-i-ca_file-3D" class="method-detail ">
|
|
609
|
+
|
|
610
|
+
<div class="method-heading">
|
|
611
|
+
<span class="method-name">ca_file=</span><span
|
|
612
|
+
class="method-args">(path)</span>
|
|
613
|
+
|
|
614
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
615
|
+
|
|
616
|
+
</div>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
<div class="method-description">
|
|
620
|
+
|
|
621
|
+
<p>Set a path to a file containing a PEM-format CA certificate and enable peer
|
|
622
|
+
verification</p>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<div class="method-source-code" id="ca_file-3D-source">
|
|
628
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 216</span>
|
|
629
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">ca_file=</span>(<span class="ruby-identifier">path</span>)
|
|
630
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">ca_file</span> = <span class="ruby-identifier">path</span>
|
|
631
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">nil?</span>
|
|
632
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
|
633
|
+
<span class="ruby-keyword">end</span>
|
|
634
|
+
<span class="ruby-keyword">end</span></pre>
|
|
635
|
+
</div>
|
|
636
|
+
|
|
637
|
+
</div>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<div id="method-i-cert-3D" class="method-detail ">
|
|
646
|
+
|
|
647
|
+
<div class="method-heading">
|
|
648
|
+
<span class="method-name">cert=</span><span
|
|
649
|
+
class="method-args">(cert)</span>
|
|
650
|
+
|
|
651
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
652
|
+
|
|
653
|
+
</div>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
<div class="method-description">
|
|
657
|
+
|
|
658
|
+
<p>PEM-format client certificate</p>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<div class="method-source-code" id="cert-3D-source">
|
|
664
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 199</span>
|
|
665
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">cert=</span>(<span class="ruby-identifier">cert</span>)
|
|
666
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cert</span>)
|
|
667
|
+
<span class="ruby-keyword">end</span></pre>
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
</div>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<div id="method-i-cert_file-3D" class="method-detail ">
|
|
679
|
+
|
|
680
|
+
<div class="method-heading">
|
|
681
|
+
<span class="method-name">cert_file=</span><span
|
|
682
|
+
class="method-args">(path)</span>
|
|
683
|
+
|
|
684
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
685
|
+
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
<div class="method-description">
|
|
690
|
+
|
|
691
|
+
<p>Set a path to a file containing a PEM-format client certificate</p>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
<div class="method-source-code" id="cert_file-3D-source">
|
|
697
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 194</span>
|
|
698
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">cert_file=</span>(<span class="ruby-identifier">path</span>)
|
|
699
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>)
|
|
700
|
+
<span class="ruby-keyword">end</span></pre>
|
|
701
|
+
</div>
|
|
702
|
+
|
|
703
|
+
</div>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
</div>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
<div id="method-i-connect" class="method-detail ">
|
|
712
|
+
|
|
713
|
+
<div class="method-heading">
|
|
714
|
+
<span class="method-name">connect</span><span
|
|
715
|
+
class="method-args">(clientid=nil) { |self| ... }</span>
|
|
716
|
+
|
|
717
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
718
|
+
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
<div class="method-description">
|
|
723
|
+
|
|
724
|
+
<p>Connect to the <a href="../MQTT.html">MQTT</a> server If a block is given,
|
|
725
|
+
then yield to that block and then disconnect again.</p>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<div class="method-source-code" id="connect-source">
|
|
731
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 236</span>
|
|
732
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connect</span>(<span class="ruby-identifier">clientid</span>=<span class="ruby-keyword">nil</span>)
|
|
733
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">clientid</span>.<span class="ruby-identifier">nil?</span>
|
|
734
|
+
<span class="ruby-ivar">@client_id</span> = <span class="ruby-identifier">clientid</span>
|
|
735
|
+
<span class="ruby-keyword">end</span>
|
|
736
|
+
|
|
737
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@client_id</span>.<span class="ruby-identifier">empty?</span>
|
|
738
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@clean_session</span>
|
|
739
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@version</span> <span class="ruby-operator">==</span> <span class="ruby-string">'3.1.0'</span>
|
|
740
|
+
<span class="ruby-comment"># Empty client id is not allowed for version 3.1.0</span>
|
|
741
|
+
<span class="ruby-ivar">@client_id</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">generate_client_id</span>
|
|
742
|
+
<span class="ruby-keyword">end</span>
|
|
743
|
+
<span class="ruby-keyword">else</span>
|
|
744
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Must provide a client_id if clean_session is set to false'</span>
|
|
745
|
+
<span class="ruby-keyword">end</span>
|
|
746
|
+
<span class="ruby-keyword">end</span>
|
|
747
|
+
|
|
748
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@host</span>.<span class="ruby-identifier">nil?</span>
|
|
749
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">'No MQTT server host set when attempting to connect'</span>
|
|
750
|
+
<span class="ruby-keyword">end</span>
|
|
751
|
+
|
|
752
|
+
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">connected?</span>
|
|
753
|
+
<span class="ruby-comment"># Create network socket</span>
|
|
754
|
+
<span class="ruby-identifier">tcp_socket</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@port</span>)
|
|
755
|
+
|
|
756
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@ssl</span>
|
|
757
|
+
<span class="ruby-comment"># Set the protocol version</span>
|
|
758
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@ssl</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
|
|
759
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">ssl_version</span> = <span class="ruby-ivar">@ssl</span>
|
|
760
|
+
<span class="ruby-keyword">end</span>
|
|
761
|
+
|
|
762
|
+
<span class="ruby-ivar">@socket</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tcp_socket</span>, <span class="ruby-identifier">ssl_context</span>)
|
|
763
|
+
<span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">sync_close</span> = <span class="ruby-keyword">true</span>
|
|
764
|
+
<span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">connect</span>
|
|
765
|
+
<span class="ruby-keyword">else</span>
|
|
766
|
+
<span class="ruby-ivar">@socket</span> = <span class="ruby-identifier">tcp_socket</span>
|
|
767
|
+
<span class="ruby-keyword">end</span>
|
|
768
|
+
|
|
769
|
+
<span class="ruby-comment"># Construct a connect packet</span>
|
|
770
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Packet</span><span class="ruby-operator">::</span><span class="ruby-constant">Connect</span>.<span class="ruby-identifier">new</span>(
|
|
771
|
+
<span class="ruby-value">:version</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@version</span>,
|
|
772
|
+
<span class="ruby-value">:clean_session</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@clean_session</span>,
|
|
773
|
+
<span class="ruby-value">:keep_alive</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@keep_alive</span>,
|
|
774
|
+
<span class="ruby-value">:client_id</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@client_id</span>,
|
|
775
|
+
<span class="ruby-value">:username</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@username</span>,
|
|
776
|
+
<span class="ruby-value">:password</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@password</span>,
|
|
777
|
+
<span class="ruby-value">:will_topic</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@will_topic</span>,
|
|
778
|
+
<span class="ruby-value">:will_payload</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@will_payload</span>,
|
|
779
|
+
<span class="ruby-value">:will_qos</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@will_qos</span>,
|
|
780
|
+
<span class="ruby-value">:will_retain</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@will_retain</span>
|
|
781
|
+
)
|
|
782
|
+
|
|
783
|
+
<span class="ruby-comment"># Send packet</span>
|
|
784
|
+
<span class="ruby-identifier">send_packet</span>(<span class="ruby-identifier">packet</span>)
|
|
785
|
+
|
|
786
|
+
<span class="ruby-comment"># Receive response</span>
|
|
787
|
+
<span class="ruby-identifier">receive_connack</span>
|
|
788
|
+
|
|
789
|
+
<span class="ruby-comment"># Start packet reading thread</span>
|
|
790
|
+
<span class="ruby-ivar">@read_thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">parent</span><span class="ruby-operator">|</span>
|
|
791
|
+
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-value">:parent</span>] = <span class="ruby-identifier">parent</span>
|
|
792
|
+
<span class="ruby-keyword">while</span> <span class="ruby-identifier">connected?</span> <span class="ruby-keyword">do</span>
|
|
793
|
+
<span class="ruby-identifier">receive_packet</span>
|
|
794
|
+
<span class="ruby-keyword">end</span>
|
|
795
|
+
<span class="ruby-keyword">end</span>
|
|
796
|
+
<span class="ruby-keyword">end</span>
|
|
797
|
+
|
|
798
|
+
<span class="ruby-comment"># If a block is given, then yield and disconnect</span>
|
|
799
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
800
|
+
<span class="ruby-keyword">begin</span>
|
|
801
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-keyword">self</span>)
|
|
802
|
+
<span class="ruby-keyword">ensure</span>
|
|
803
|
+
<span class="ruby-identifier">disconnect</span>
|
|
804
|
+
<span class="ruby-keyword">end</span>
|
|
805
|
+
<span class="ruby-keyword">end</span>
|
|
806
|
+
<span class="ruby-keyword">end</span></pre>
|
|
807
|
+
</div>
|
|
808
|
+
|
|
809
|
+
</div>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<div id="method-i-connected-3F" class="method-detail ">
|
|
818
|
+
|
|
819
|
+
<div class="method-heading">
|
|
820
|
+
<span class="method-name">connected?</span><span
|
|
821
|
+
class="method-args">()</span>
|
|
822
|
+
|
|
823
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
824
|
+
|
|
825
|
+
</div>
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
<div class="method-description">
|
|
829
|
+
|
|
830
|
+
<p>Checks whether the client is connected to the server.</p>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
<div class="method-source-code" id="connected-3F-source">
|
|
836
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 331</span>
|
|
837
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connected?</span>
|
|
838
|
+
(<span class="ruby-keyword">not</span> <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-keyword">and</span> (<span class="ruby-keyword">not</span> <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">closed?</span>)
|
|
839
|
+
<span class="ruby-keyword">end</span></pre>
|
|
840
|
+
</div>
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</div>
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
<div id="method-i-disconnect" class="method-detail ">
|
|
851
|
+
|
|
852
|
+
<div class="method-heading">
|
|
853
|
+
<span class="method-name">disconnect</span><span
|
|
854
|
+
class="method-args">(send_msg=true)</span>
|
|
855
|
+
|
|
856
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
857
|
+
|
|
858
|
+
</div>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
<div class="method-description">
|
|
862
|
+
|
|
863
|
+
<p>Disconnect from the <a href="../MQTT.html">MQTT</a> server. If you
|
|
864
|
+
don't want to say goodbye to the server, set send_msg to false.</p>
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<div class="method-source-code" id="disconnect-source">
|
|
870
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 314</span>
|
|
871
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">disconnect</span>(<span class="ruby-identifier">send_msg</span>=<span class="ruby-keyword">true</span>)
|
|
872
|
+
<span class="ruby-comment"># Stop reading packets from the socket first</span>
|
|
873
|
+
<span class="ruby-ivar">@read_thread</span>.<span class="ruby-identifier">kill</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@read_thread</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@read_thread</span>.<span class="ruby-identifier">alive?</span>
|
|
874
|
+
<span class="ruby-ivar">@read_thread</span> = <span class="ruby-keyword">nil</span>
|
|
875
|
+
|
|
876
|
+
<span class="ruby-comment"># Close the socket if it is open</span>
|
|
877
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">connected?</span>
|
|
878
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">send_msg</span>
|
|
879
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Packet</span><span class="ruby-operator">::</span><span class="ruby-constant">Disconnect</span>.<span class="ruby-identifier">new</span>
|
|
880
|
+
<span class="ruby-identifier">send_packet</span>(<span class="ruby-identifier">packet</span>)
|
|
881
|
+
<span class="ruby-keyword">end</span>
|
|
882
|
+
<span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">nil?</span>
|
|
883
|
+
<span class="ruby-ivar">@socket</span> = <span class="ruby-keyword">nil</span>
|
|
884
|
+
<span class="ruby-keyword">end</span>
|
|
885
|
+
<span class="ruby-keyword">end</span></pre>
|
|
886
|
+
</div>
|
|
887
|
+
|
|
888
|
+
</div>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
</div>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<div id="method-i-get" class="method-detail ">
|
|
897
|
+
|
|
898
|
+
<div class="method-heading">
|
|
899
|
+
<span class="method-name">get</span><span
|
|
900
|
+
class="method-args">(topic=nil) { |topic, payload| ... }</span>
|
|
901
|
+
|
|
902
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
903
|
+
|
|
904
|
+
</div>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
<div class="method-description">
|
|
908
|
+
|
|
909
|
+
<p>Return the next message received from the <a href="../MQTT.html">MQTT</a>
|
|
910
|
+
server. An optional topic can be given to subscribe to.</p>
|
|
911
|
+
|
|
912
|
+
<p>The method either returns the topic and message as an array:</p>
|
|
913
|
+
|
|
914
|
+
<pre class="ruby"><span class="ruby-identifier">topic</span>,<span class="ruby-identifier">message</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">get</span>
|
|
915
|
+
</pre>
|
|
916
|
+
|
|
917
|
+
<p>Or can be used with a block to keep processing messages:</p>
|
|
918
|
+
|
|
919
|
+
<pre class="ruby"><span class="ruby-identifier">client</span>.<span class="ruby-identifier">get</span>(<span class="ruby-string">'test'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">topic</span>,<span class="ruby-identifier">payload</span><span class="ruby-operator">|</span>
|
|
920
|
+
<span class="ruby-comment"># Do stuff here</span>
|
|
921
|
+
<span class="ruby-keyword">end</span>
|
|
922
|
+
</pre>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
<div class="method-source-code" id="get-source">
|
|
928
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 396</span>
|
|
929
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">topic</span>=<span class="ruby-keyword">nil</span>)
|
|
930
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
931
|
+
<span class="ruby-identifier">get_packet</span>(<span class="ruby-identifier">topic</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">packet</span><span class="ruby-operator">|</span>
|
|
932
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">packet</span>.<span class="ruby-identifier">topic</span>, <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">payload</span>)
|
|
933
|
+
<span class="ruby-keyword">end</span>
|
|
934
|
+
<span class="ruby-keyword">else</span>
|
|
935
|
+
<span class="ruby-comment"># Wait for one packet to be available</span>
|
|
936
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-identifier">get_packet</span>(<span class="ruby-identifier">topic</span>)
|
|
937
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">topic</span>, <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">payload</span>
|
|
938
|
+
<span class="ruby-keyword">end</span>
|
|
939
|
+
<span class="ruby-keyword">end</span></pre>
|
|
940
|
+
</div>
|
|
941
|
+
|
|
942
|
+
</div>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
</div>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
<div id="method-i-get_packet" class="method-detail ">
|
|
951
|
+
|
|
952
|
+
<div class="method-heading">
|
|
953
|
+
<span class="method-name">get_packet</span><span
|
|
954
|
+
class="method-args">(topic=nil) { |packet| ... }</span>
|
|
955
|
+
|
|
956
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
957
|
+
|
|
958
|
+
</div>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
<div class="method-description">
|
|
962
|
+
|
|
963
|
+
<p>Return the next packet object received from the <a
|
|
964
|
+
href="../MQTT.html">MQTT</a> server. An optional topic can be given to
|
|
965
|
+
subscribe to.</p>
|
|
966
|
+
|
|
967
|
+
<p>The method either returns a single packet:</p>
|
|
968
|
+
|
|
969
|
+
<pre class="ruby"><span class="ruby-identifier">packet</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">get_packet</span>
|
|
970
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">topic</span>
|
|
971
|
+
</pre>
|
|
972
|
+
|
|
973
|
+
<p>Or can be used with a block to keep processing messages:</p>
|
|
974
|
+
|
|
975
|
+
<pre class="ruby"><span class="ruby-identifier">client</span>.<span class="ruby-identifier">get_packet</span>(<span class="ruby-string">'test'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">packet</span><span class="ruby-operator">|</span>
|
|
976
|
+
<span class="ruby-comment"># Do stuff here</span>
|
|
977
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">topic</span>
|
|
978
|
+
<span class="ruby-keyword">end</span>
|
|
979
|
+
</pre>
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
<div class="method-source-code" id="get_packet-source">
|
|
985
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 421</span>
|
|
986
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_packet</span>(<span class="ruby-identifier">topic</span>=<span class="ruby-keyword">nil</span>)
|
|
987
|
+
<span class="ruby-comment"># Subscribe to a topic, if an argument is given</span>
|
|
988
|
+
<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">topic</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">topic</span>.<span class="ruby-identifier">nil?</span>
|
|
989
|
+
|
|
990
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
991
|
+
<span class="ruby-comment"># Loop forever!</span>
|
|
992
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
993
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-ivar">@read_queue</span>.<span class="ruby-identifier">pop</span>
|
|
994
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">packet</span>)
|
|
995
|
+
<span class="ruby-identifier">puback_packet</span>(<span class="ruby-identifier">packet</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">qos</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
996
|
+
<span class="ruby-keyword">end</span>
|
|
997
|
+
<span class="ruby-keyword">else</span>
|
|
998
|
+
<span class="ruby-comment"># Wait for one packet to be available</span>
|
|
999
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-ivar">@read_queue</span>.<span class="ruby-identifier">pop</span>
|
|
1000
|
+
<span class="ruby-identifier">puback_packet</span>(<span class="ruby-identifier">packet</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">qos</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
1001
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">packet</span>
|
|
1002
|
+
<span class="ruby-keyword">end</span>
|
|
1003
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1004
|
+
</div>
|
|
1005
|
+
|
|
1006
|
+
</div>
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
</div>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
<div id="method-i-key-3D" class="method-detail ">
|
|
1015
|
+
|
|
1016
|
+
<div class="method-heading">
|
|
1017
|
+
<span class="method-name">key=</span><span
|
|
1018
|
+
class="method-args">(*args)</span>
|
|
1019
|
+
|
|
1020
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1021
|
+
|
|
1022
|
+
</div>
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
<div class="method-description">
|
|
1026
|
+
|
|
1027
|
+
<p>Set to a PEM-format client private key</p>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
<div class="method-source-code" id="key-3D-source">
|
|
1033
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 210</span>
|
|
1034
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">key=</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
1035
|
+
<span class="ruby-identifier">cert</span>, <span class="ruby-identifier">passphrase</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">flatten</span>
|
|
1036
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cert</span>, <span class="ruby-identifier">passphrase</span>)
|
|
1037
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1038
|
+
</div>
|
|
1039
|
+
|
|
1040
|
+
</div>
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
</div>
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
<div id="method-i-key_file-3D" class="method-detail ">
|
|
1049
|
+
|
|
1050
|
+
<div class="method-heading">
|
|
1051
|
+
<span class="method-name">key_file=</span><span
|
|
1052
|
+
class="method-args">(*args)</span>
|
|
1053
|
+
|
|
1054
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1055
|
+
|
|
1056
|
+
</div>
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
<div class="method-description">
|
|
1060
|
+
|
|
1061
|
+
<p>Set a path to a file containing a PEM-format client private key</p>
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
<div class="method-source-code" id="key_file-3D-source">
|
|
1067
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 204</span>
|
|
1068
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">key_file=</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
1069
|
+
<span class="ruby-identifier">path</span>, <span class="ruby-identifier">passphrase</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">flatten</span>
|
|
1070
|
+
<span class="ruby-identifier">ssl_context</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">passphrase</span>)
|
|
1071
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1072
|
+
</div>
|
|
1073
|
+
|
|
1074
|
+
</div>
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
</div>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<div id="method-i-publish" class="method-detail ">
|
|
1083
|
+
|
|
1084
|
+
<div class="method-heading">
|
|
1085
|
+
<span class="method-name">publish</span><span
|
|
1086
|
+
class="method-args">(topic, payload='', retain=false, qos=0)</span>
|
|
1087
|
+
|
|
1088
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1089
|
+
|
|
1090
|
+
</div>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<div class="method-description">
|
|
1094
|
+
|
|
1095
|
+
<p>Publish a message on a particular topic to the <a
|
|
1096
|
+
href="../MQTT.html">MQTT</a> server.</p>
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
<div class="method-source-code" id="publish-source">
|
|
1102
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 336</span>
|
|
1103
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">topic</span>, <span class="ruby-identifier">payload</span>=<span class="ruby-string">''</span>, <span class="ruby-identifier">retain</span>=<span class="ruby-keyword">false</span>, <span class="ruby-identifier">qos</span>=<span class="ruby-value">0</span>)
|
|
1104
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Topic name cannot be nil"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">topic</span>.<span class="ruby-identifier">nil?</span>
|
|
1105
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Topic name cannot be empty"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">topic</span>.<span class="ruby-identifier">empty?</span>
|
|
1106
|
+
|
|
1107
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Packet</span><span class="ruby-operator">::</span><span class="ruby-constant">Publish</span>.<span class="ruby-identifier">new</span>(
|
|
1108
|
+
<span class="ruby-value">:id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">next_packet_id</span>,
|
|
1109
|
+
<span class="ruby-value">:qos</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">qos</span>,
|
|
1110
|
+
<span class="ruby-value">:retain</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">retain</span>,
|
|
1111
|
+
<span class="ruby-value">:topic</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">topic</span>,
|
|
1112
|
+
<span class="ruby-value">:payload</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">payload</span>
|
|
1113
|
+
)
|
|
1114
|
+
|
|
1115
|
+
<span class="ruby-comment"># Send the packet</span>
|
|
1116
|
+
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">send_packet</span>(<span class="ruby-identifier">packet</span>)
|
|
1117
|
+
|
|
1118
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">packet</span>.<span class="ruby-identifier">qos</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
1119
|
+
<span class="ruby-constant">Timeout</span>.<span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@ack_timeout</span>) <span class="ruby-keyword">do</span>
|
|
1120
|
+
<span class="ruby-keyword">while</span> <span class="ruby-identifier">connected?</span> <span class="ruby-keyword">do</span>
|
|
1121
|
+
<span class="ruby-ivar">@pubacks_semaphore</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
|
|
1122
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">res</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@pubacks</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">packet</span>.<span class="ruby-identifier">id</span>)
|
|
1123
|
+
<span class="ruby-keyword">end</span>
|
|
1124
|
+
<span class="ruby-comment"># FIXME: make threads communicate with each other, instead of polling</span>
|
|
1125
|
+
<span class="ruby-comment"># (using a pipe and select ?)</span>
|
|
1126
|
+
<span class="ruby-identifier">sleep</span> <span class="ruby-value">0.01</span>
|
|
1127
|
+
<span class="ruby-keyword">end</span>
|
|
1128
|
+
<span class="ruby-keyword">end</span>
|
|
1129
|
+
<span class="ruby-keyword">return</span> <span class="ruby-value">-1</span>
|
|
1130
|
+
<span class="ruby-keyword">end</span>
|
|
1131
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1132
|
+
</div>
|
|
1133
|
+
|
|
1134
|
+
</div>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
</div>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
<div id="method-i-queue_empty-3F" class="method-detail ">
|
|
1143
|
+
|
|
1144
|
+
<div class="method-heading">
|
|
1145
|
+
<span class="method-name">queue_empty?</span><span
|
|
1146
|
+
class="method-args">()</span>
|
|
1147
|
+
|
|
1148
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1149
|
+
|
|
1150
|
+
</div>
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<div class="method-description">
|
|
1154
|
+
|
|
1155
|
+
<p>Returns true if the incoming message queue is empty.</p>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
<div class="method-source-code" id="queue_empty-3F-source">
|
|
1161
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 441</span>
|
|
1162
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">queue_empty?</span>
|
|
1163
|
+
<span class="ruby-ivar">@read_queue</span>.<span class="ruby-identifier">empty?</span>
|
|
1164
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1165
|
+
</div>
|
|
1166
|
+
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
</div>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
<div id="method-i-queue_length" class="method-detail ">
|
|
1176
|
+
|
|
1177
|
+
<div class="method-heading">
|
|
1178
|
+
<span class="method-name">queue_length</span><span
|
|
1179
|
+
class="method-args">()</span>
|
|
1180
|
+
|
|
1181
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1182
|
+
|
|
1183
|
+
</div>
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
<div class="method-description">
|
|
1187
|
+
|
|
1188
|
+
<p>Returns the length of the incoming message queue.</p>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
<div class="method-source-code" id="queue_length-source">
|
|
1194
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 446</span>
|
|
1195
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">queue_length</span>
|
|
1196
|
+
<span class="ruby-ivar">@read_queue</span>.<span class="ruby-identifier">length</span>
|
|
1197
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
</div>
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
</div>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<div id="method-i-remote_host" class="method-detail ">
|
|
1209
|
+
|
|
1210
|
+
<div class="method-heading">
|
|
1211
|
+
<span class="method-name">remote_host</span><span
|
|
1212
|
+
class="method-args">()</span>
|
|
1213
|
+
|
|
1214
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1215
|
+
|
|
1216
|
+
</div>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
<div class="method-description">
|
|
1220
|
+
|
|
1221
|
+
<p>@deprecated Please use {#host} instead</p>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
<div class="method-source-code" id="remote_host-source">
|
|
1227
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 582</span>
|
|
1228
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_host</span>
|
|
1229
|
+
<span class="ruby-identifier">host</span>
|
|
1230
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1231
|
+
</div>
|
|
1232
|
+
|
|
1233
|
+
</div>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</div>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
<div id="method-i-remote_host-3D" class="method-detail ">
|
|
1242
|
+
|
|
1243
|
+
<div class="method-heading">
|
|
1244
|
+
<span class="method-name">remote_host=</span><span
|
|
1245
|
+
class="method-args">(args)</span>
|
|
1246
|
+
|
|
1247
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1248
|
+
|
|
1249
|
+
</div>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
<div class="method-description">
|
|
1253
|
+
|
|
1254
|
+
<p>@deprecated Please use {#host=} instead</p>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
<div class="method-source-code" id="remote_host-3D-source">
|
|
1260
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 587</span>
|
|
1261
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_host=</span>(<span class="ruby-identifier">args</span>)
|
|
1262
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span> = <span class="ruby-identifier">args</span>
|
|
1263
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1264
|
+
</div>
|
|
1265
|
+
|
|
1266
|
+
</div>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
</div>
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
<div id="method-i-remote_port" class="method-detail ">
|
|
1275
|
+
|
|
1276
|
+
<div class="method-heading">
|
|
1277
|
+
<span class="method-name">remote_port</span><span
|
|
1278
|
+
class="method-args">()</span>
|
|
1279
|
+
|
|
1280
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1281
|
+
|
|
1282
|
+
</div>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
<div class="method-description">
|
|
1286
|
+
|
|
1287
|
+
<p>@deprecated Please use {#port} instead</p>
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
<div class="method-source-code" id="remote_port-source">
|
|
1293
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 592</span>
|
|
1294
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_port</span>
|
|
1295
|
+
<span class="ruby-identifier">port</span>
|
|
1296
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1297
|
+
</div>
|
|
1298
|
+
|
|
1299
|
+
</div>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
</div>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
<div id="method-i-remote_port-3D" class="method-detail ">
|
|
1308
|
+
|
|
1309
|
+
<div class="method-heading">
|
|
1310
|
+
<span class="method-name">remote_port=</span><span
|
|
1311
|
+
class="method-args">(args)</span>
|
|
1312
|
+
|
|
1313
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1314
|
+
|
|
1315
|
+
</div>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<div class="method-description">
|
|
1319
|
+
|
|
1320
|
+
<p>@deprecated Please use {#port=} instead</p>
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
<div class="method-source-code" id="remote_port-3D-source">
|
|
1326
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 597</span>
|
|
1327
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_port=</span>(<span class="ruby-identifier">args</span>)
|
|
1328
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">port</span> = <span class="ruby-identifier">args</span>
|
|
1329
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1330
|
+
</div>
|
|
1331
|
+
|
|
1332
|
+
</div>
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
</div>
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
<div id="method-i-set_will" class="method-detail ">
|
|
1341
|
+
|
|
1342
|
+
<div class="method-heading">
|
|
1343
|
+
<span class="method-name">set_will</span><span
|
|
1344
|
+
class="method-args">(topic, payload, retain=false, qos=0)</span>
|
|
1345
|
+
|
|
1346
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1347
|
+
|
|
1348
|
+
</div>
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
<div class="method-description">
|
|
1352
|
+
|
|
1353
|
+
<p>Set the Will for the client</p>
|
|
1354
|
+
|
|
1355
|
+
<p>The will is a message that will be delivered by the server when the client
|
|
1356
|
+
dies. The Will must be set before establishing a connection to the server</p>
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
<div class="method-source-code" id="set_will-source">
|
|
1362
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 227</span>
|
|
1363
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_will</span>(<span class="ruby-identifier">topic</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">retain</span>=<span class="ruby-keyword">false</span>, <span class="ruby-identifier">qos</span>=<span class="ruby-value">0</span>)
|
|
1364
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">will_topic</span> = <span class="ruby-identifier">topic</span>
|
|
1365
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">will_payload</span> = <span class="ruby-identifier">payload</span>
|
|
1366
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">will_retain</span> = <span class="ruby-identifier">retain</span>
|
|
1367
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">will_qos</span> = <span class="ruby-identifier">qos</span>
|
|
1368
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1369
|
+
</div>
|
|
1370
|
+
|
|
1371
|
+
</div>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
</div>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
<div id="method-i-ssl_context" class="method-detail ">
|
|
1380
|
+
|
|
1381
|
+
<div class="method-heading">
|
|
1382
|
+
<span class="method-name">ssl_context</span><span
|
|
1383
|
+
class="method-args">()</span>
|
|
1384
|
+
|
|
1385
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1386
|
+
|
|
1387
|
+
</div>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
<div class="method-description">
|
|
1391
|
+
|
|
1392
|
+
<p>Get the OpenSSL context, that is used if SSL/TLS is enabled</p>
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
<div class="method-source-code" id="ssl_context-source">
|
|
1398
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 189</span>
|
|
1399
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">ssl_context</span>
|
|
1400
|
+
<span class="ruby-ivar">@ssl_context</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span>.<span class="ruby-identifier">new</span>
|
|
1401
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1402
|
+
</div>
|
|
1403
|
+
|
|
1404
|
+
</div>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
</div>
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
<div id="method-i-subscribe" class="method-detail ">
|
|
1413
|
+
|
|
1414
|
+
<div class="method-heading">
|
|
1415
|
+
<span class="method-name">subscribe</span><span
|
|
1416
|
+
class="method-args">(*topics)</span>
|
|
1417
|
+
|
|
1418
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1419
|
+
|
|
1420
|
+
</div>
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<div class="method-description">
|
|
1424
|
+
|
|
1425
|
+
<p>Send a subscribe message for one or more topics on the <a
|
|
1426
|
+
href="../MQTT.html">MQTT</a> server. The topics parameter should be one of
|
|
1427
|
+
the following:</p>
|
|
1428
|
+
<ul><li>
|
|
1429
|
+
<p>String: subscribe to one topic with QoS 0</p>
|
|
1430
|
+
</li><li>
|
|
1431
|
+
<p>Array: subscribe to multiple topics with QoS 0</p>
|
|
1432
|
+
</li><li>
|
|
1433
|
+
<p>Hash: subscribe to multiple topics where the key is the topic and the value
|
|
1434
|
+
is the QoS level</p>
|
|
1435
|
+
</li></ul>
|
|
1436
|
+
|
|
1437
|
+
<p>For example:</p>
|
|
1438
|
+
|
|
1439
|
+
<pre class="ruby"><span class="ruby-identifier">client</span>.<span class="ruby-identifier">subscribe</span>( <span class="ruby-string">'a/b'</span> )
|
|
1440
|
+
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">subscribe</span>( <span class="ruby-string">'a/b'</span>, <span class="ruby-string">'c/d'</span> )
|
|
1441
|
+
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">subscribe</span>( [<span class="ruby-string">'a/b'</span>,<span class="ruby-value">0</span>], [<span class="ruby-string">'c/d'</span>,<span class="ruby-value">1</span>] )
|
|
1442
|
+
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">subscribe</span>( <span class="ruby-string">'a/b'</span> =<span class="ruby-operator">></span> <span class="ruby-value">0</span>, <span class="ruby-string">'c/d'</span> =<span class="ruby-operator">></span> <span class="ruby-value">1</span> )
|
|
1443
|
+
</pre>
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
<div class="method-source-code" id="subscribe-source">
|
|
1449
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 377</span>
|
|
1450
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">subscribe</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">topics</span>)
|
|
1451
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Packet</span><span class="ruby-operator">::</span><span class="ruby-constant">Subscribe</span>.<span class="ruby-identifier">new</span>(
|
|
1452
|
+
<span class="ruby-value">:id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">next_packet_id</span>,
|
|
1453
|
+
<span class="ruby-value">:topics</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">topics</span>
|
|
1454
|
+
)
|
|
1455
|
+
<span class="ruby-identifier">send_packet</span>(<span class="ruby-identifier">packet</span>)
|
|
1456
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1457
|
+
</div>
|
|
1458
|
+
|
|
1459
|
+
</div>
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
<div id="method-i-unsubscribe" class="method-detail ">
|
|
1468
|
+
|
|
1469
|
+
<div class="method-heading">
|
|
1470
|
+
<span class="method-name">unsubscribe</span><span
|
|
1471
|
+
class="method-args">(*topics)</span>
|
|
1472
|
+
|
|
1473
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
1474
|
+
|
|
1475
|
+
</div>
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
<div class="method-description">
|
|
1479
|
+
|
|
1480
|
+
<p>Send a unsubscribe message for one or more topics on the <a
|
|
1481
|
+
href="../MQTT.html">MQTT</a> server</p>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
<div class="method-source-code" id="unsubscribe-source">
|
|
1487
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/client.rb, line 451</span>
|
|
1488
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">unsubscribe</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">topics</span>)
|
|
1489
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">topics</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Enumerable</span>) <span class="ruby-keyword">and</span> <span class="ruby-identifier">topics</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
|
1490
|
+
<span class="ruby-identifier">topics</span> = <span class="ruby-identifier">topics</span>.<span class="ruby-identifier">first</span>
|
|
1491
|
+
<span class="ruby-keyword">end</span>
|
|
1492
|
+
|
|
1493
|
+
<span class="ruby-identifier">packet</span> = <span class="ruby-constant">MQTT</span><span class="ruby-operator">::</span><span class="ruby-constant">Packet</span><span class="ruby-operator">::</span><span class="ruby-constant">Unsubscribe</span>.<span class="ruby-identifier">new</span>(
|
|
1494
|
+
<span class="ruby-value">:topics</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">topics</span>,
|
|
1495
|
+
<span class="ruby-value">:id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">next_packet_id</span>
|
|
1496
|
+
)
|
|
1497
|
+
<span class="ruby-identifier">send_packet</span>(<span class="ruby-identifier">packet</span>)
|
|
1498
|
+
<span class="ruby-keyword">end</span></pre>
|
|
1499
|
+
</div>
|
|
1500
|
+
|
|
1501
|
+
</div>
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
</div>
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
</section>
|
|
1510
|
+
|
|
1511
|
+
</section>
|
|
1512
|
+
</main>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
<footer id="validator-badges" role="contentinfo">
|
|
1516
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
1517
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
1518
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
1519
|
+
</footer>
|
|
1520
|
+
|