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
|
@@ -0,0 +1,433 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class MQTT::MQTT::MQTT::Packet::Connack - 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">MQTT::MQTT::Packet
|
|
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 class="calls-super" ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-i-encode_body">#encode_body</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-i-inspect">#inspect</a>
|
|
78
|
+
|
|
79
|
+
<li class="calls-super" ><a href="#method-i-parse_body">#parse_body</a>
|
|
80
|
+
|
|
81
|
+
<li ><a href="#method-i-return_msg">#return_msg</a>
|
|
82
|
+
|
|
83
|
+
<li ><a href="#method-i-session_present-3D">#session_present=</a>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
</nav>
|
|
90
|
+
|
|
91
|
+
<main role="main" aria-labelledby="class-MQTT::MQTT::MQTT::Packet::Connack">
|
|
92
|
+
<h1 id="class-MQTT::MQTT::MQTT::Packet::Connack" class="class">
|
|
93
|
+
class MQTT::MQTT::MQTT::Packet::Connack
|
|
94
|
+
</h1>
|
|
95
|
+
|
|
96
|
+
<section class="description">
|
|
97
|
+
|
|
98
|
+
<p>Class representing an <a href="../../../MQTT.html">MQTT</a> <a
|
|
99
|
+
href="Connect.html">Connect</a> Acknowledgment <a
|
|
100
|
+
href="../Packet.html">Packet</a></p>
|
|
101
|
+
|
|
102
|
+
</section>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<section class="constants-list">
|
|
114
|
+
<header>
|
|
115
|
+
<h3>Constants</h3>
|
|
116
|
+
</header>
|
|
117
|
+
<dl>
|
|
118
|
+
|
|
119
|
+
<dt id="ATTR_DEFAULTS">ATTR_DEFAULTS
|
|
120
|
+
|
|
121
|
+
<dd><p>Default attribute values</p>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</dl>
|
|
125
|
+
</section>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<section class="attribute-method-details" class="method-section">
|
|
130
|
+
<header>
|
|
131
|
+
<h3>Attributes</h3>
|
|
132
|
+
</header>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<div id="attribute-i-return_code" class="method-detail">
|
|
136
|
+
<div class="method-heading attribute-method-heading">
|
|
137
|
+
<span class="method-name">return_code</span><span
|
|
138
|
+
class="attribute-access-type">[RW]</span>
|
|
139
|
+
</div>
|
|
140
|
+
|
|
141
|
+
<div class="method-description">
|
|
142
|
+
|
|
143
|
+
<p>The return code (defaults to 0 for connection accepted)</p>
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
<div id="attribute-i-session_present" class="method-detail">
|
|
149
|
+
<div class="method-heading attribute-method-heading">
|
|
150
|
+
<span class="method-name">session_present</span><span
|
|
151
|
+
class="attribute-access-type">[RW]</span>
|
|
152
|
+
</div>
|
|
153
|
+
|
|
154
|
+
<div class="method-description">
|
|
155
|
+
|
|
156
|
+
<p>Session Present flag</p>
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
</div>
|
|
160
|
+
|
|
161
|
+
</section>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
166
|
+
<header>
|
|
167
|
+
<h3>Public Class Methods</h3>
|
|
168
|
+
</header>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div id="method-c-new" class="method-detail ">
|
|
172
|
+
|
|
173
|
+
<div class="method-heading">
|
|
174
|
+
<span class="method-name">new</span><span
|
|
175
|
+
class="method-args">(args={})</span>
|
|
176
|
+
|
|
177
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<div class="method-description">
|
|
183
|
+
|
|
184
|
+
<p>Create a new <a href="../../../Client.html">Client</a> <a
|
|
185
|
+
href="Connect.html">Connect</a> packet</p>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<div class="method-calls-super">
|
|
189
|
+
Calls superclass method
|
|
190
|
+
|
|
191
|
+
</div>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<div class="method-source-code" id="new-source">
|
|
196
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 594</span>
|
|
197
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>={})
|
|
198
|
+
<span class="ruby-comment"># We must set flags before other attributes</span>
|
|
199
|
+
<span class="ruby-ivar">@connack_flags</span> = [<span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>]
|
|
200
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-constant">ATTR_DEFAULTS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
|
|
201
|
+
<span class="ruby-keyword">end</span></pre>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</section>
|
|
213
|
+
|
|
214
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
215
|
+
<header>
|
|
216
|
+
<h3>Public Instance Methods</h3>
|
|
217
|
+
</header>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<div id="method-i-encode_body" class="method-detail ">
|
|
221
|
+
|
|
222
|
+
<div class="method-heading">
|
|
223
|
+
<span class="method-name">encode_body</span><span
|
|
224
|
+
class="method-args">()</span>
|
|
225
|
+
|
|
226
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<div class="method-description">
|
|
232
|
+
|
|
233
|
+
<p>Get serialisation of packet's body</p>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<div class="method-source-code" id="encode_body-source">
|
|
239
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 635</span>
|
|
240
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">encode_body</span>
|
|
241
|
+
<span class="ruby-identifier">body</span> = <span class="ruby-string">''</span>
|
|
242
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_bits</span>(<span class="ruby-ivar">@connack_flags</span>)
|
|
243
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_bytes</span>(<span class="ruby-ivar">@return_code</span>.<span class="ruby-identifier">to_i</span>)
|
|
244
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">body</span>
|
|
245
|
+
<span class="ruby-keyword">end</span></pre>
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<div id="method-i-inspect" class="method-detail ">
|
|
257
|
+
|
|
258
|
+
<div class="method-heading">
|
|
259
|
+
<span class="method-name">inspect</span><span
|
|
260
|
+
class="method-args">()</span>
|
|
261
|
+
|
|
262
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
263
|
+
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<div class="method-description">
|
|
268
|
+
|
|
269
|
+
<p>Returns a human readable string, summarising the properties of the packet</p>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<div class="method-source-code" id="inspect-source">
|
|
275
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 657</span>
|
|
276
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
|
|
277
|
+
<span class="ruby-node">"\#<#{self.class}: 0x%2.2X>"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">return_code</span>
|
|
278
|
+
<span class="ruby-keyword">end</span></pre>
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</div>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<div id="method-i-parse_body" class="method-detail ">
|
|
290
|
+
|
|
291
|
+
<div class="method-heading">
|
|
292
|
+
<span class="method-name">parse_body</span><span
|
|
293
|
+
class="method-args">(buffer)</span>
|
|
294
|
+
|
|
295
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
296
|
+
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<div class="method-description">
|
|
301
|
+
|
|
302
|
+
<p>Parse the body (variable header and payload) of a <a
|
|
303
|
+
href="Connect.html">Connect</a> Acknowledgment packet</p>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<div class="method-calls-super">
|
|
307
|
+
Calls superclass method
|
|
308
|
+
|
|
309
|
+
</div>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<div class="method-source-code" id="parse_body-source">
|
|
314
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 643</span>
|
|
315
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_body</span>(<span class="ruby-identifier">buffer</span>)
|
|
316
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">buffer</span>)
|
|
317
|
+
<span class="ruby-ivar">@connack_flags</span> = <span class="ruby-identifier">shift_bits</span>(<span class="ruby-identifier">buffer</span>)
|
|
318
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@connack_flags</span>[<span class="ruby-value">1</span>,<span class="ruby-value">7</span>] <span class="ruby-operator">==</span> [<span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">false</span>]
|
|
319
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ProtocolException</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Invalid flags in Connack variable header"</span>)
|
|
320
|
+
<span class="ruby-keyword">end</span>
|
|
321
|
+
<span class="ruby-ivar">@return_code</span> = <span class="ruby-identifier">shift_byte</span>(<span class="ruby-identifier">buffer</span>)
|
|
322
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">empty?</span>
|
|
323
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ProtocolException</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Extra bytes at end of Connect Acknowledgment packet"</span>)
|
|
324
|
+
<span class="ruby-keyword">end</span>
|
|
325
|
+
<span class="ruby-identifier">pubACK</span>(<span class="ruby-ivar">@return_code</span>)
|
|
326
|
+
<span class="ruby-keyword">end</span></pre>
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<div id="method-i-return_msg" class="method-detail ">
|
|
338
|
+
|
|
339
|
+
<div class="method-heading">
|
|
340
|
+
<span class="method-name">return_msg</span><span
|
|
341
|
+
class="method-args">()</span>
|
|
342
|
+
|
|
343
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
344
|
+
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<div class="method-description">
|
|
349
|
+
|
|
350
|
+
<p>Get a string message corresponding to a return code</p>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<div class="method-source-code" id="return_msg-source">
|
|
356
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 615</span>
|
|
357
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">return_msg</span>
|
|
358
|
+
<span class="ruby-keyword">case</span> <span class="ruby-identifier">return_code</span>
|
|
359
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x00</span>
|
|
360
|
+
<span class="ruby-string">"Connection Accepted"</span>
|
|
361
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x01</span>
|
|
362
|
+
<span class="ruby-string">"Connection refused: unacceptable protocol version"</span>
|
|
363
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x02</span>
|
|
364
|
+
<span class="ruby-string">"Connection refused: client identifier rejected"</span>
|
|
365
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x03</span>
|
|
366
|
+
<span class="ruby-string">"Connection refused: server unavailable"</span>
|
|
367
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x04</span>
|
|
368
|
+
<span class="ruby-string">"Connection refused: bad user name or password"</span>
|
|
369
|
+
<span class="ruby-keyword">when</span> <span class="ruby-value">0x05</span>
|
|
370
|
+
<span class="ruby-string">"Connection refused: not authorised"</span>
|
|
371
|
+
<span class="ruby-keyword">else</span>
|
|
372
|
+
<span class="ruby-node">"Connection refused: error code #{return_code}"</span>
|
|
373
|
+
<span class="ruby-keyword">end</span>
|
|
374
|
+
<span class="ruby-keyword">end</span></pre>
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<div id="method-i-session_present-3D" class="method-detail ">
|
|
386
|
+
|
|
387
|
+
<div class="method-heading">
|
|
388
|
+
<span class="method-name">session_present=</span><span
|
|
389
|
+
class="method-args">(arg)</span>
|
|
390
|
+
|
|
391
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
392
|
+
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<div class="method-description">
|
|
397
|
+
|
|
398
|
+
<p>Set the Session Present flag</p>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<div class="method-source-code" id="session_present-3D-source">
|
|
404
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 606</span>
|
|
405
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">session_present=</span>(<span class="ruby-identifier">arg</span>)
|
|
406
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Integer</span>)
|
|
407
|
+
<span class="ruby-ivar">@connack_flags</span>[<span class="ruby-value">0</span>] = (<span class="ruby-identifier">arg</span> <span class="ruby-operator">==</span> <span class="ruby-value">0x1</span>)
|
|
408
|
+
<span class="ruby-keyword">else</span>
|
|
409
|
+
<span class="ruby-ivar">@connack_flags</span>[<span class="ruby-value">0</span>] = <span class="ruby-identifier">arg</span>
|
|
410
|
+
<span class="ruby-keyword">end</span>
|
|
411
|
+
<span class="ruby-keyword">end</span></pre>
|
|
412
|
+
</div>
|
|
413
|
+
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
</section>
|
|
423
|
+
|
|
424
|
+
</section>
|
|
425
|
+
</main>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<footer id="validator-badges" role="contentinfo">
|
|
429
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
430
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
431
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
432
|
+
</footer>
|
|
433
|
+
|
|
@@ -0,0 +1,596 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class MQTT::MQTT::MQTT::Packet::Connect - 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">MQTT::MQTT::Packet
|
|
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 class="calls-super" ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-i-encode_body">#encode_body</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-i-inspect">#inspect</a>
|
|
78
|
+
|
|
79
|
+
<li class="calls-super" ><a href="#method-i-parse_body">#parse_body</a>
|
|
80
|
+
|
|
81
|
+
<li ><a href="#method-i-protocol_version">#protocol_version</a>
|
|
82
|
+
|
|
83
|
+
<li ><a href="#method-i-protocol_version-3D">#protocol_version=</a>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
</nav>
|
|
90
|
+
|
|
91
|
+
<main role="main" aria-labelledby="class-MQTT::MQTT::MQTT::Packet::Connect">
|
|
92
|
+
<h1 id="class-MQTT::MQTT::MQTT::Packet::Connect" class="class">
|
|
93
|
+
class MQTT::MQTT::MQTT::Packet::Connect
|
|
94
|
+
</h1>
|
|
95
|
+
|
|
96
|
+
<section class="description">
|
|
97
|
+
|
|
98
|
+
<p>Class representing an <a href="../../../MQTT.html">MQTT</a> <a
|
|
99
|
+
href="Connect.html">Connect</a> <a href="../Packet.html">Packet</a></p>
|
|
100
|
+
|
|
101
|
+
</section>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<section class="constants-list">
|
|
113
|
+
<header>
|
|
114
|
+
<h3>Constants</h3>
|
|
115
|
+
</header>
|
|
116
|
+
<dl>
|
|
117
|
+
|
|
118
|
+
<dt id="ATTR_DEFAULTS">ATTR_DEFAULTS
|
|
119
|
+
|
|
120
|
+
<dd><p>Default attribute values</p>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</dl>
|
|
124
|
+
</section>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<section class="attribute-method-details" class="method-section">
|
|
129
|
+
<header>
|
|
130
|
+
<h3>Attributes</h3>
|
|
131
|
+
</header>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<div id="attribute-i-clean_session" class="method-detail">
|
|
135
|
+
<div class="method-heading attribute-method-heading">
|
|
136
|
+
<span class="method-name">clean_session</span><span
|
|
137
|
+
class="attribute-access-type">[RW]</span>
|
|
138
|
+
</div>
|
|
139
|
+
|
|
140
|
+
<div class="method-description">
|
|
141
|
+
|
|
142
|
+
<p>Set to false to keep a persistent session with the server</p>
|
|
143
|
+
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
|
|
147
|
+
<div id="attribute-i-client_id" class="method-detail">
|
|
148
|
+
<div class="method-heading attribute-method-heading">
|
|
149
|
+
<span class="method-name">client_id</span><span
|
|
150
|
+
class="attribute-access-type">[RW]</span>
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
<div class="method-description">
|
|
154
|
+
|
|
155
|
+
<p>The client identifier string</p>
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<div id="attribute-i-keep_alive" class="method-detail">
|
|
161
|
+
<div class="method-heading attribute-method-heading">
|
|
162
|
+
<span class="method-name">keep_alive</span><span
|
|
163
|
+
class="attribute-access-type">[RW]</span>
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
<div class="method-description">
|
|
167
|
+
|
|
168
|
+
<p>Period the server should keep connection open for between pings</p>
|
|
169
|
+
|
|
170
|
+
</div>
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
<div id="attribute-i-password" class="method-detail">
|
|
174
|
+
<div class="method-heading attribute-method-heading">
|
|
175
|
+
<span class="method-name">password</span><span
|
|
176
|
+
class="attribute-access-type">[RW]</span>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
<div class="method-description">
|
|
180
|
+
|
|
181
|
+
<p>The password for authenticating with the server</p>
|
|
182
|
+
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
<div id="attribute-i-protocol_level" class="method-detail">
|
|
187
|
+
<div class="method-heading attribute-method-heading">
|
|
188
|
+
<span class="method-name">protocol_level</span><span
|
|
189
|
+
class="attribute-access-type">[RW]</span>
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div class="method-description">
|
|
193
|
+
|
|
194
|
+
<p>The version number of the protocol</p>
|
|
195
|
+
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
|
|
199
|
+
<div id="attribute-i-protocol_name" class="method-detail">
|
|
200
|
+
<div class="method-heading attribute-method-heading">
|
|
201
|
+
<span class="method-name">protocol_name</span><span
|
|
202
|
+
class="attribute-access-type">[RW]</span>
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
<div class="method-description">
|
|
206
|
+
|
|
207
|
+
<p>The name of the protocol</p>
|
|
208
|
+
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div id="attribute-i-username" class="method-detail">
|
|
213
|
+
<div class="method-heading attribute-method-heading">
|
|
214
|
+
<span class="method-name">username</span><span
|
|
215
|
+
class="attribute-access-type">[RW]</span>
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
<div class="method-description">
|
|
219
|
+
|
|
220
|
+
<p>The username for authenticating with the server</p>
|
|
221
|
+
|
|
222
|
+
</div>
|
|
223
|
+
</div>
|
|
224
|
+
|
|
225
|
+
<div id="attribute-i-will_payload" class="method-detail">
|
|
226
|
+
<div class="method-heading attribute-method-heading">
|
|
227
|
+
<span class="method-name">will_payload</span><span
|
|
228
|
+
class="attribute-access-type">[RW]</span>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
<div class="method-description">
|
|
232
|
+
|
|
233
|
+
<p>The payload of the Will message</p>
|
|
234
|
+
|
|
235
|
+
</div>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
<div id="attribute-i-will_qos" class="method-detail">
|
|
239
|
+
<div class="method-heading attribute-method-heading">
|
|
240
|
+
<span class="method-name">will_qos</span><span
|
|
241
|
+
class="attribute-access-type">[RW]</span>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
<div class="method-description">
|
|
245
|
+
|
|
246
|
+
<p>The QoS level to send the Will message as</p>
|
|
247
|
+
|
|
248
|
+
</div>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div id="attribute-i-will_retain" class="method-detail">
|
|
252
|
+
<div class="method-heading attribute-method-heading">
|
|
253
|
+
<span class="method-name">will_retain</span><span
|
|
254
|
+
class="attribute-access-type">[RW]</span>
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
<div class="method-description">
|
|
258
|
+
|
|
259
|
+
<p>Set to true to make the Will message retained</p>
|
|
260
|
+
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
<div id="attribute-i-will_topic" class="method-detail">
|
|
265
|
+
<div class="method-heading attribute-method-heading">
|
|
266
|
+
<span class="method-name">will_topic</span><span
|
|
267
|
+
class="attribute-access-type">[RW]</span>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
<div class="method-description">
|
|
271
|
+
|
|
272
|
+
<p>The topic name to send the Will message to</p>
|
|
273
|
+
|
|
274
|
+
</div>
|
|
275
|
+
</div>
|
|
276
|
+
|
|
277
|
+
</section>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
282
|
+
<header>
|
|
283
|
+
<h3>Public Class Methods</h3>
|
|
284
|
+
</header>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<div id="method-c-new" class="method-detail ">
|
|
288
|
+
|
|
289
|
+
<div class="method-heading">
|
|
290
|
+
<span class="method-name">new</span><span
|
|
291
|
+
class="method-args">(args={})</span>
|
|
292
|
+
|
|
293
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div class="method-description">
|
|
299
|
+
|
|
300
|
+
<p>Create a new <a href="../../../Client.html">Client</a> <a
|
|
301
|
+
href="Connect.html">Connect</a> packet</p>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<div class="method-calls-super">
|
|
305
|
+
Calls superclass method
|
|
306
|
+
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<div class="method-source-code" id="new-source">
|
|
312
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 469</span>
|
|
313
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>={})
|
|
314
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-constant">ATTR_DEFAULTS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
|
|
315
|
+
|
|
316
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-string">'3.1.0'</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-string">'3.1'</span>
|
|
317
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol_name</span> <span class="ruby-operator">||=</span> <span class="ruby-string">'MQIsdp'</span>
|
|
318
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol_level</span> <span class="ruby-operator">||=</span> <span class="ruby-value">0x03</span>
|
|
319
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-string">'3.1.1'</span>
|
|
320
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol_name</span> <span class="ruby-operator">||=</span> <span class="ruby-string">'MQTT'</span>
|
|
321
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol_level</span> <span class="ruby-operator">||=</span> <span class="ruby-value">0x04</span>
|
|
322
|
+
<span class="ruby-keyword">else</span>
|
|
323
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Unsupported protocol version: #{version}"</span>)
|
|
324
|
+
<span class="ruby-keyword">end</span>
|
|
325
|
+
<span class="ruby-keyword">end</span></pre>
|
|
326
|
+
</div>
|
|
327
|
+
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</div>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</section>
|
|
337
|
+
|
|
338
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
339
|
+
<header>
|
|
340
|
+
<h3>Public Instance Methods</h3>
|
|
341
|
+
</header>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<div id="method-i-encode_body" class="method-detail ">
|
|
345
|
+
|
|
346
|
+
<div class="method-heading">
|
|
347
|
+
<span class="method-name">encode_body</span><span
|
|
348
|
+
class="method-args">()</span>
|
|
349
|
+
|
|
350
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
351
|
+
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<div class="method-description">
|
|
356
|
+
|
|
357
|
+
<p>Get serialisation of packet's body</p>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<div class="method-source-code" id="encode_body-source">
|
|
363
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 484</span>
|
|
364
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">encode_body</span>
|
|
365
|
+
<span class="ruby-identifier">body</span> = <span class="ruby-string">''</span>
|
|
366
|
+
<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>
|
|
367
|
+
<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">bytesize</span> <span class="ruby-operator"><</span> <span class="ruby-value">1</span>
|
|
368
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Client identifier too short while serialising packet"</span>
|
|
369
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@client_id</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">></span> <span class="ruby-value">51</span>
|
|
370
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Client identifier too long when serialising packet"</span>
|
|
371
|
+
<span class="ruby-keyword">end</span>
|
|
372
|
+
<span class="ruby-keyword">end</span>
|
|
373
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@protocol_name</span>)
|
|
374
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_bytes</span>(<span class="ruby-ivar">@protocol_level</span>.<span class="ruby-identifier">to_i</span>)
|
|
375
|
+
|
|
376
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@keep_alive</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>
|
|
377
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Invalid keep-alive value: cannot be less than 0"</span>
|
|
378
|
+
<span class="ruby-keyword">end</span>
|
|
379
|
+
|
|
380
|
+
<span class="ruby-comment"># Set the Connect flags</span>
|
|
381
|
+
<span class="ruby-ivar">@connect_flags</span> = <span class="ruby-value">0</span>
|
|
382
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> <span class="ruby-value">0x02</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@clean_session</span>
|
|
383
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> <span class="ruby-value">0x04</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@will_topic</span>.<span class="ruby-identifier">nil?</span>
|
|
384
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> ((<span class="ruby-ivar">@will_qos</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x03</span>) <span class="ruby-operator"><<</span> <span class="ruby-value">3</span>)
|
|
385
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> <span class="ruby-value">0x20</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@will_retain</span>
|
|
386
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> <span class="ruby-value">0x40</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@password</span>.<span class="ruby-identifier">nil?</span>
|
|
387
|
+
<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">|=</span> <span class="ruby-value">0x80</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@username</span>.<span class="ruby-identifier">nil?</span>
|
|
388
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_bytes</span>(<span class="ruby-ivar">@connect_flags</span>)
|
|
389
|
+
|
|
390
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_short</span>(<span class="ruby-ivar">@keep_alive</span>)
|
|
391
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@client_id</span>)
|
|
392
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">will_topic</span>.<span class="ruby-identifier">nil?</span>
|
|
393
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@will_topic</span>)
|
|
394
|
+
<span class="ruby-comment"># The MQTT v3.1 specification says that the payload is a UTF-8 string</span>
|
|
395
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@will_payload</span>)
|
|
396
|
+
<span class="ruby-keyword">end</span>
|
|
397
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@username</span>) <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@username</span>.<span class="ruby-identifier">nil?</span>
|
|
398
|
+
<span class="ruby-identifier">body</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">encode_string</span>(<span class="ruby-ivar">@password</span>) <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@password</span>.<span class="ruby-identifier">nil?</span>
|
|
399
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">body</span>
|
|
400
|
+
<span class="ruby-keyword">end</span></pre>
|
|
401
|
+
</div>
|
|
402
|
+
|
|
403
|
+
</div>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
<div id="method-i-inspect" class="method-detail ">
|
|
412
|
+
|
|
413
|
+
<div class="method-heading">
|
|
414
|
+
<span class="method-name">inspect</span><span
|
|
415
|
+
class="method-args">()</span>
|
|
416
|
+
|
|
417
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
418
|
+
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<div class="method-description">
|
|
423
|
+
|
|
424
|
+
<p>Returns a human readable string, summarising the properties of the packet</p>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<div class="method-source-code" id="inspect-source">
|
|
430
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 558</span>
|
|
431
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
|
|
432
|
+
<span class="ruby-identifier">str</span> = <span class="ruby-node">"\#<#{self.class}: "</span>
|
|
433
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"keep_alive=#{keep_alive}"</span>
|
|
434
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-string">", clean"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">clean_session</span>
|
|
435
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">", client_id='#{client_id}'"</span>
|
|
436
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-node">", username='#{username}'"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">username</span>.<span class="ruby-identifier">nil?</span>
|
|
437
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-string">", password=..."</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">password</span>.<span class="ruby-identifier">nil?</span>
|
|
438
|
+
<span class="ruby-identifier">str</span> <span class="ruby-operator">+=</span> <span class="ruby-string">">"</span>
|
|
439
|
+
<span class="ruby-keyword">end</span></pre>
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</div>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="method-i-parse_body" class="method-detail ">
|
|
451
|
+
|
|
452
|
+
<div class="method-heading">
|
|
453
|
+
<span class="method-name">parse_body</span><span
|
|
454
|
+
class="method-args">(buffer)</span>
|
|
455
|
+
|
|
456
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
<div class="method-description">
|
|
462
|
+
|
|
463
|
+
<p>Parse the body (variable header and payload) of a <a
|
|
464
|
+
href="Connect.html">Connect</a> packet</p>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<div class="method-calls-super">
|
|
468
|
+
Calls superclass method
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<div class="method-source-code" id="parse_body-source">
|
|
475
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 523</span>
|
|
476
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_body</span>(<span class="ruby-identifier">buffer</span>)
|
|
477
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">buffer</span>)
|
|
478
|
+
<span class="ruby-ivar">@protocol_name</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
479
|
+
<span class="ruby-ivar">@protocol_level</span> = <span class="ruby-identifier">shift_byte</span>(<span class="ruby-identifier">buffer</span>).<span class="ruby-identifier">to_i</span>
|
|
480
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@protocol_name</span> <span class="ruby-operator">==</span> <span class="ruby-string">'MQIsdp'</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@protocol_level</span> <span class="ruby-operator">==</span> <span class="ruby-value">3</span>
|
|
481
|
+
<span class="ruby-ivar">@version</span> = <span class="ruby-string">'3.1.0'</span>
|
|
482
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@protocol_name</span> <span class="ruby-operator">==</span> <span class="ruby-string">'MQTT'</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@protocol_level</span> <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
|
483
|
+
<span class="ruby-ivar">@version</span> = <span class="ruby-string">'3.1.1'</span>
|
|
484
|
+
<span class="ruby-keyword">else</span>
|
|
485
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ProtocolException</span>.<span class="ruby-identifier">new</span>(
|
|
486
|
+
<span class="ruby-node">"Unsupported protocol: #{@protocol_name}/#{@protocol_level}"</span>
|
|
487
|
+
)
|
|
488
|
+
<span class="ruby-keyword">end</span>
|
|
489
|
+
|
|
490
|
+
<span class="ruby-ivar">@connect_flags</span> = <span class="ruby-identifier">shift_byte</span>(<span class="ruby-identifier">buffer</span>)
|
|
491
|
+
<span class="ruby-ivar">@clean_session</span> = ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x02</span>) <span class="ruby-operator">>></span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0x01</span>
|
|
492
|
+
<span class="ruby-ivar">@keep_alive</span> = <span class="ruby-identifier">shift_short</span>(<span class="ruby-identifier">buffer</span>)
|
|
493
|
+
<span class="ruby-ivar">@client_id</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
494
|
+
<span class="ruby-keyword">if</span> ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x04</span>) <span class="ruby-operator">>></span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0x01</span>
|
|
495
|
+
<span class="ruby-comment"># Last Will and Testament</span>
|
|
496
|
+
<span class="ruby-ivar">@will_qos</span> = ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x18</span>) <span class="ruby-operator">>></span> <span class="ruby-value">3</span>)
|
|
497
|
+
<span class="ruby-ivar">@will_retain</span> = ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x20</span>) <span class="ruby-operator">>></span> <span class="ruby-value">5</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0x01</span>
|
|
498
|
+
<span class="ruby-ivar">@will_topic</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
499
|
+
<span class="ruby-comment"># The MQTT v3.1 specification says that the payload is a UTF-8 string</span>
|
|
500
|
+
<span class="ruby-ivar">@will_payload</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
501
|
+
<span class="ruby-keyword">end</span>
|
|
502
|
+
<span class="ruby-keyword">if</span> ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x80</span>) <span class="ruby-operator">>></span> <span class="ruby-value">7</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0x01</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
503
|
+
<span class="ruby-ivar">@username</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
504
|
+
<span class="ruby-keyword">end</span>
|
|
505
|
+
<span class="ruby-keyword">if</span> ((<span class="ruby-ivar">@connect_flags</span> <span class="ruby-operator">&</span> <span class="ruby-value">0x40</span>) <span class="ruby-operator">>></span> <span class="ruby-value">6</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0x01</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
506
|
+
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">shift_string</span>(<span class="ruby-identifier">buffer</span>)
|
|
507
|
+
<span class="ruby-keyword">end</span>
|
|
508
|
+
<span class="ruby-keyword">end</span></pre>
|
|
509
|
+
</div>
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<div id="method-i-protocol_version" class="method-detail ">
|
|
520
|
+
|
|
521
|
+
<div class="method-heading">
|
|
522
|
+
<span class="method-name">protocol_version</span><span
|
|
523
|
+
class="method-args">()</span>
|
|
524
|
+
|
|
525
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
526
|
+
|
|
527
|
+
</div>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
<div class="method-description">
|
|
531
|
+
|
|
532
|
+
<p>@deprecated Please use {#protocol_level} instead</p>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<div class="method-source-code" id="protocol_version-source">
|
|
538
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 572</span>
|
|
539
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol_version</span>
|
|
540
|
+
<span class="ruby-identifier">protocol_level</span>
|
|
541
|
+
<span class="ruby-keyword">end</span></pre>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
<div id="method-i-protocol_version-3D" class="method-detail ">
|
|
553
|
+
|
|
554
|
+
<div class="method-heading">
|
|
555
|
+
<span class="method-name">protocol_version=</span><span
|
|
556
|
+
class="method-args">(args)</span>
|
|
557
|
+
|
|
558
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
559
|
+
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<div class="method-description">
|
|
564
|
+
|
|
565
|
+
<p>@deprecated Please use {#protocol_level=} instead</p>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<div class="method-source-code" id="protocol_version-3D-source">
|
|
571
|
+
<pre><span class="ruby-comment"># File lib/mqttbridge/packet.rb, line 577</span>
|
|
572
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol_version=</span>(<span class="ruby-identifier">args</span>)
|
|
573
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol_level</span> = <span class="ruby-identifier">args</span>
|
|
574
|
+
<span class="ruby-keyword">end</span></pre>
|
|
575
|
+
</div>
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
</section>
|
|
586
|
+
|
|
587
|
+
</section>
|
|
588
|
+
</main>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
<footer id="validator-badges" role="contentinfo">
|
|
592
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
593
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
594
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
595
|
+
</footer>
|
|
596
|
+
|