maxcube-client 0.4.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +6 -0
- data/.rubocop.yml +0 -3
- data/.yardopts +1 -0
- data/README.md +17 -2
- data/bin/maxcube-client +2 -27
- data/doc/MaxCube.html +502 -0
- data/doc/MaxCube/Messages.html +1927 -0
- data/doc/MaxCube/Messages/Handler.html +2912 -0
- data/doc/MaxCube/Messages/InvalidMessage.html +140 -0
- data/doc/MaxCube/Messages/InvalidMessageBody.html +264 -0
- data/doc/MaxCube/Messages/InvalidMessageFormat.html +247 -0
- data/doc/MaxCube/Messages/InvalidMessageLength.html +247 -0
- data/doc/MaxCube/Messages/InvalidMessageType.html +263 -0
- data/doc/MaxCube/Messages/Parser.html +520 -0
- data/doc/MaxCube/Messages/Serializer.html +701 -0
- data/doc/MaxCube/Messages/TCP.html +172 -0
- data/doc/MaxCube/Messages/TCP/Handler.html +1396 -0
- data/doc/MaxCube/Messages/TCP/Parser.html +462 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageA.html +186 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageC.html +1077 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageF.html +206 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageH.html +338 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageL.html +535 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageM.html +510 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageN.html +226 -0
- data/doc/MaxCube/Messages/TCP/Parser/MessageS.html +225 -0
- data/doc/MaxCube/Messages/TCP/Serializer.html +460 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageA.html +186 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageC.html +185 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageF.html +206 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageL.html +185 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageM.html +428 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageN.html +209 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageQ.html +185 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageS.html +1168 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageT.html +240 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageU.html +206 -0
- data/doc/MaxCube/Messages/TCP/Serializer/MessageZ.html +252 -0
- data/doc/MaxCube/Messages/UDP.html +164 -0
- data/doc/MaxCube/Messages/UDP/Handler.html +832 -0
- data/doc/MaxCube/Messages/UDP/Parser.html +609 -0
- data/doc/MaxCube/Messages/UDP/Parser/MessageH.html +218 -0
- data/doc/MaxCube/Messages/UDP/Parser/MessageI.html +215 -0
- data/doc/MaxCube/Messages/UDP/Parser/MessageN.html +226 -0
- data/doc/MaxCube/Messages/UDP/Serializer.html +484 -0
- data/doc/MaxCube/Network.html +167 -0
- data/doc/MaxCube/Network/TCP.html +150 -0
- data/doc/MaxCube/Network/TCP/Client.html +1930 -0
- data/doc/MaxCube/Network/TCP/Client/Commands.html +2457 -0
- data/doc/MaxCube/Network/TCP/SampleServer.html +910 -0
- data/doc/MaxCube/Network/UDP.html +150 -0
- data/doc/MaxCube/Network/UDP/Client.html +518 -0
- data/doc/MaxCube/Network/UDP/SampleSocket.html +628 -0
- data/doc/MaxCube/Runner.html +355 -0
- data/doc/_index.html +518 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +499 -0
- data/doc/file.README.html +140 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +140 -0
- data/doc/js/app.js +248 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1699 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/maxcube.rb +11 -0
- data/lib/maxcube/messages.rb +85 -8
- data/lib/maxcube/messages/handler.rb +138 -4
- data/lib/maxcube/messages/parser.rb +33 -2
- data/lib/maxcube/messages/serializer.rb +64 -16
- data/lib/maxcube/messages/tcp.rb +11 -7
- data/lib/maxcube/messages/tcp/handler.rb +50 -2
- data/lib/maxcube/messages/tcp/parser.rb +18 -17
- data/lib/maxcube/messages/tcp/serializer.rb +20 -21
- data/lib/maxcube/messages/tcp/type/a.rb +6 -6
- data/lib/maxcube/messages/tcp/type/c.rb +5 -3
- data/lib/maxcube/messages/tcp/type/f.rb +5 -3
- data/lib/maxcube/messages/tcp/type/h.rb +3 -2
- data/lib/maxcube/messages/tcp/type/l.rb +8 -7
- data/lib/maxcube/messages/tcp/type/m.rb +11 -7
- data/lib/maxcube/messages/tcp/type/n.rb +5 -3
- data/lib/maxcube/messages/tcp/type/q.rb +2 -2
- data/lib/maxcube/messages/tcp/type/s.rb +5 -2
- data/lib/maxcube/messages/tcp/type/t.rb +5 -4
- data/lib/maxcube/messages/tcp/type/u.rb +2 -1
- data/lib/maxcube/messages/tcp/type/z.rb +4 -2
- data/lib/maxcube/messages/udp.rb +7 -0
- data/lib/maxcube/messages/udp/handler.rb +28 -0
- data/lib/maxcube/messages/udp/parser.rb +23 -6
- data/lib/maxcube/messages/udp/serializer.rb +17 -1
- data/lib/maxcube/messages/udp/type/h.rb +2 -0
- data/lib/maxcube/messages/udp/type/i.rb +3 -0
- data/lib/maxcube/messages/udp/type/n.rb +3 -0
- data/lib/maxcube/network.rb +5 -1
- data/lib/maxcube/network/tcp.rb +3 -0
- data/lib/maxcube/network/tcp/client.rb +117 -3
- data/lib/maxcube/network/tcp/client/commands.rb +306 -239
- data/lib/maxcube/network/tcp/sample_server.rb +1 -0
- data/lib/maxcube/network/udp.rb +3 -0
- data/lib/maxcube/network/udp/client.rb +2 -0
- data/lib/maxcube/network/udp/sample_socket.rb +1 -0
- data/lib/maxcube/runner.rb +45 -0
- data/lib/maxcube/version.rb +2 -1
- data/maxcube-client.gemspec +2 -0
- metadata +84 -3
@@ -0,0 +1,462 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Class: MaxCube::Messages::TCP::Parser
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.12
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "MaxCube::Messages::TCP::Parser";
|
19
|
+
relpath = '../../../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../../../_index.html">Index (P)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../../MaxCube.html" title="MaxCube (module)">MaxCube</a></span></span> » <span class='title'><span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">Messages</a></span></span> » <span class='title'><span class='object_link'><a href="../TCP.html" title="MaxCube::Messages::TCP (module)">TCP</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Parser</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../../../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Class: MaxCube::Messages::TCP::Parser
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">MaxCube::Messages::TCP::Parser</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
<dl>
|
91
|
+
<dt>Includes:</dt>
|
92
|
+
<dd><span class='object_link'><a href="../Parser.html" title="MaxCube::Messages::Parser (module)">Parser</a></span>, <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::TCP::Handler (module)">Handler</a></span></dd>
|
93
|
+
</dl>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
<dl>
|
101
|
+
<dt>Defined in:</dt>
|
102
|
+
<dd>lib/maxcube/messages/tcp/parser.rb<span class="defines">,<br />
|
103
|
+
lib/maxcube/messages/tcp/type/a.rb,<br /> lib/maxcube/messages/tcp/type/c.rb,<br /> lib/maxcube/messages/tcp/type/f.rb,<br /> lib/maxcube/messages/tcp/type/h.rb,<br /> lib/maxcube/messages/tcp/type/l.rb,<br /> lib/maxcube/messages/tcp/type/m.rb,<br /> lib/maxcube/messages/tcp/type/n.rb,<br /> lib/maxcube/messages/tcp/type/s.rb</span>
|
104
|
+
</dd>
|
105
|
+
</dl>
|
106
|
+
|
107
|
+
</div>
|
108
|
+
|
109
|
+
<h2>Overview</h2><div class="docstring">
|
110
|
+
<div class="discussion">
|
111
|
+
|
112
|
+
<p>Extends <span class='object_link'><a href="../Parser.html" title="MaxCube::Messages::Parser (module)">Parser</a></span> and <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::TCP::Handler (module)">Handler</a></span> of routines connected to TCP
|
113
|
+
Cube messages parsing.</p>
|
114
|
+
|
115
|
+
|
116
|
+
</div>
|
117
|
+
</div>
|
118
|
+
<div class="tags">
|
119
|
+
|
120
|
+
|
121
|
+
</div><h2>Defined Under Namespace</h2>
|
122
|
+
<p class="children">
|
123
|
+
|
124
|
+
|
125
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Parser/MessageA.html" title="MaxCube::Messages::TCP::Parser::MessageA (module)">MessageA</a></span>, <span class='object_link'><a href="Parser/MessageC.html" title="MaxCube::Messages::TCP::Parser::MessageC (module)">MessageC</a></span>, <span class='object_link'><a href="Parser/MessageF.html" title="MaxCube::Messages::TCP::Parser::MessageF (module)">MessageF</a></span>, <span class='object_link'><a href="Parser/MessageH.html" title="MaxCube::Messages::TCP::Parser::MessageH (module)">MessageH</a></span>, <span class='object_link'><a href="Parser/MessageL.html" title="MaxCube::Messages::TCP::Parser::MessageL (module)">MessageL</a></span>, <span class='object_link'><a href="Parser/MessageM.html" title="MaxCube::Messages::TCP::Parser::MessageM (module)">MessageM</a></span>, <span class='object_link'><a href="Parser/MessageN.html" title="MaxCube::Messages::TCP::Parser::MessageN (module)">MessageN</a></span>, <span class='object_link'><a href="Parser/MessageS.html" title="MaxCube::Messages::TCP::Parser::MessageS (module)">MessageS</a></span>
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
</p>
|
131
|
+
|
132
|
+
<h2>Constant Summary</h2>
|
133
|
+
<dl class="constants">
|
134
|
+
|
135
|
+
<dt id="MSG_TYPES-constant" class="">MSG_TYPES =
|
136
|
+
<div class="docstring">
|
137
|
+
<div class="discussion">
|
138
|
+
|
139
|
+
<p>Known message types in the direction Cube -> client.</p>
|
140
|
+
|
141
|
+
|
142
|
+
</div>
|
143
|
+
</div>
|
144
|
+
<div class="tags">
|
145
|
+
|
146
|
+
|
147
|
+
</div>
|
148
|
+
</dt>
|
149
|
+
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>H</span><span class='words_sep'> </span><span class='tstring_content'>F</span><span class='words_sep'> </span><span class='tstring_content'>L</span><span class='words_sep'> </span><span class='tstring_content'>C</span><span class='words_sep'> </span><span class='tstring_content'>M</span><span class='words_sep'> </span><span class='tstring_content'>N</span><span class='words_sep'> </span><span class='tstring_content'>A</span><span class='words_sep'> </span><span class='tstring_content'>E</span><span class='words_sep'> </span><span class='tstring_content'>D</span><span class='words_sep'> </span><span class='tstring_content'>b</span><span class='words_sep'> </span><span class='tstring_content'>g</span><span class='words_sep'> </span><span class='tstring_content'>j</span><span class='words_sep'> </span><span class='tstring_content'>p</span><span class='words_sep'> </span><span class='tstring_content'>o</span><span class='words_sep'> </span><span class='tstring_content'>v</span><span class='words_sep'> </span><span class='tstring_content'>w</span><span class='words_sep'> </span><span class='tstring_content'>S</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
150
|
+
|
151
|
+
</dl>
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
<h3 class="inherited">Constants included
|
158
|
+
from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
|
159
|
+
<p class="inherited"><span class='object_link'><a href="../Handler.html#PACK_FORMAT-constant" title="MaxCube::Messages::Handler::PACK_FORMAT (constant)">Handler::PACK_FORMAT</a></span></p>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
<h3 class="inherited">Constants included
|
164
|
+
from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
|
165
|
+
<p class="inherited"><span class='object_link'><a href="../../Messages.html#DAYS_OF_WEEK-constant" title="MaxCube::Messages::DAYS_OF_WEEK (constant)">DAYS_OF_WEEK</a></span>, <span class='object_link'><a href="../../Messages.html#DEVICE_MODE-constant" title="MaxCube::Messages::DEVICE_MODE (constant)">DEVICE_MODE</a></span>, <span class='object_link'><a href="../../Messages.html#DEVICE_TYPE-constant" title="MaxCube::Messages::DEVICE_TYPE (constant)">DEVICE_TYPE</a></span></p>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<h2>
|
173
|
+
Instance Method Summary
|
174
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
175
|
+
</h2>
|
176
|
+
|
177
|
+
<ul class="summary">
|
178
|
+
|
179
|
+
<li class="public ">
|
180
|
+
<span class="summary_signature">
|
181
|
+
|
182
|
+
<a href="#parse_tcp_data-instance_method" title="#parse_tcp_data (instance method)">#<strong>parse_tcp_data</strong>(raw_data) ⇒ Array<Hash> </a>
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
</span>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
197
|
+
<p>Processes set of messages - raw data separated by <tt>\r\n</tt>.</p>
|
198
|
+
</div></span>
|
199
|
+
|
200
|
+
</li>
|
201
|
+
|
202
|
+
|
203
|
+
<li class="public ">
|
204
|
+
<span class="summary_signature">
|
205
|
+
|
206
|
+
<a href="#parse_tcp_msg-instance_method" title="#parse_tcp_msg (instance method)">#<strong>parse_tcp_msg</strong>(msg) ⇒ Hash </a>
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
</span>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
<span class="summary_desc"><div class='inline'>
|
221
|
+
<p>Parses single message already without <tt>\r\n</tt>.</p>
|
222
|
+
</div></span>
|
223
|
+
|
224
|
+
</li>
|
225
|
+
|
226
|
+
|
227
|
+
</ul>
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Parser.html" title="MaxCube::Messages::Parser (module)">Parser</a></span></h3>
|
240
|
+
<p class="inherited"><span class='object_link'><a href="../Parser.html#parse_msg_body-instance_method" title="MaxCube::Messages::Parser#parse_msg_body (method)">#parse_msg_body</a></span>, <span class='object_link'><a href="../Parser.html#read-instance_method" title="MaxCube::Messages::Parser#read (method)">#read</a></span></p>
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
|
251
|
+
<p class="inherited"><span class='object_link'><a href="../Handler.html#check_data_type-instance_method" title="MaxCube::Messages::Handler#check_data_type (method)">#check_data_type</a></span>, <span class='object_link'><a href="../Handler.html#check_hash-instance_method" title="MaxCube::Messages::Handler#check_hash (method)">#check_hash</a></span>, <span class='object_link'><a href="../Handler.html#check_hash_keys-instance_method" title="MaxCube::Messages::Handler#check_hash_keys (method)">#check_hash_keys</a></span>, <span class='object_link'><a href="../Handler.html#check_hash_msg_type-instance_method" title="MaxCube::Messages::Handler#check_hash_msg_type (method)">#check_hash_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#check_hash_values-instance_method" title="MaxCube::Messages::Handler#check_hash_values (method)">#check_hash_values</a></span>, <span class='object_link'><a href="../Handler.html#check_msg-instance_method" title="MaxCube::Messages::Handler#check_msg (method)">#check_msg</a></span>, <span class='object_link'><a href="../Handler.html#check_msg_msg_type-instance_method" title="MaxCube::Messages::Handler#check_msg_msg_type (method)">#check_msg_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#check_msg_part_lengths-instance_method" title="MaxCube::Messages::Handler#check_msg_part_lengths (method)">#check_msg_part_lengths</a></span>, <span class='object_link'><a href="../Handler.html#check_msg_type-instance_method" title="MaxCube::Messages::Handler#check_msg_type (method)">#check_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#decode-instance_method" title="MaxCube::Messages::Handler#decode (method)">#decode</a></span>, <span class='object_link'><a href="../Handler.html#encode-instance_method" title="MaxCube::Messages::Handler#encode (method)">#encode</a></span>, <span class='object_link'><a href="../Handler.html#maybe_check_valid_hash_keys-instance_method" title="MaxCube::Messages::Handler#maybe_check_valid_hash_keys (method)">#maybe_check_valid_hash_keys</a></span>, <span class='object_link'><a href="../Handler.html#maybe_check_valid_msg_type-instance_method" title="MaxCube::Messages::Handler#maybe_check_valid_msg_type (method)">#maybe_check_valid_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#msg_type_hash_keys-instance_method" title="MaxCube::Messages::Handler#msg_type_hash_keys (method)">#msg_type_hash_keys</a></span>, <span class='object_link'><a href="../Handler.html#msg_type_hash_opt_keys-instance_method" title="MaxCube::Messages::Handler#msg_type_hash_opt_keys (method)">#msg_type_hash_opt_keys</a></span>, <span class='object_link'><a href="../Handler.html#msg_type_which_hash_keys-instance_method" title="MaxCube::Messages::Handler#msg_type_which_hash_keys (method)">#msg_type_which_hash_keys</a></span>, <span class='object_link'><a href="../Handler.html#msg_types-instance_method" title="MaxCube::Messages::Handler#msg_types (method)">#msg_types</a></span>, <span class='object_link'><a href="../Handler.html#valid_data_type-instance_method" title="MaxCube::Messages::Handler#valid_data_type (method)">#valid_data_type</a></span>, <span class='object_link'><a href="../Handler.html#valid_hash-instance_method" title="MaxCube::Messages::Handler#valid_hash (method)">#valid_hash</a></span>, <span class='object_link'><a href="../Handler.html#valid_hash_keys-instance_method" title="MaxCube::Messages::Handler#valid_hash_keys (method)">#valid_hash_keys</a></span>, <span class='object_link'><a href="../Handler.html#valid_hash_msg_type-instance_method" title="MaxCube::Messages::Handler#valid_hash_msg_type (method)">#valid_hash_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#valid_hash_values-instance_method" title="MaxCube::Messages::Handler#valid_hash_values (method)">#valid_hash_values</a></span>, <span class='object_link'><a href="../Handler.html#valid_msg-instance_method" title="MaxCube::Messages::Handler#valid_msg (method)">#valid_msg</a></span>, <span class='object_link'><a href="../Handler.html#valid_msg_msg_type-instance_method" title="MaxCube::Messages::Handler#valid_msg_msg_type (method)">#valid_msg_msg_type</a></span>, <span class='object_link'><a href="../Handler.html#valid_msg_part_lengths-instance_method" title="MaxCube::Messages::Handler#valid_msg_part_lengths (method)">#valid_msg_part_lengths</a></span>, <span class='object_link'><a href="../Handler.html#valid_msg_type-instance_method" title="MaxCube::Messages::Handler#valid_msg_type (method)">#valid_msg_type</a></span></p>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
|
262
|
+
<p class="inherited"><span class='object_link'><a href="../../Messages.html#ary_elem-instance_method" title="MaxCube::Messages#ary_elem (method)">#ary_elem</a></span>, <span class='object_link'><a href="../../Messages.html#ary_elem_id-instance_method" title="MaxCube::Messages#ary_elem_id (method)">#ary_elem_id</a></span>, <span class='object_link'><a href="../../Messages.html#conv_args-instance_method" title="MaxCube::Messages#conv_args (method)">#conv_args</a></span>, <span class='object_link'><a href="../../Messages.html#day_of_week-instance_method" title="MaxCube::Messages#day_of_week (method)">#day_of_week</a></span>, <span class='object_link'><a href="../../Messages.html#day_of_week_id-instance_method" title="MaxCube::Messages#day_of_week_id (method)">#day_of_week_id</a></span>, <span class='object_link'><a href="../../Messages.html#device_mode-instance_method" title="MaxCube::Messages#device_mode (method)">#device_mode</a></span>, <span class='object_link'><a href="../../Messages.html#device_mode_id-instance_method" title="MaxCube::Messages#device_mode_id (method)">#device_mode_id</a></span>, <span class='object_link'><a href="../../Messages.html#device_type-instance_method" title="MaxCube::Messages#device_type (method)">#device_type</a></span>, <span class='object_link'><a href="../../Messages.html#device_type_id-instance_method" title="MaxCube::Messages#device_type_id (method)">#device_type_id</a></span>, <span class='object_link'><a href="../../Messages.html#to_bool-instance_method" title="MaxCube::Messages#to_bool (method)">#to_bool</a></span>, <span class='object_link'><a href="../../Messages.html#to_bools-instance_method" title="MaxCube::Messages#to_bools (method)">#to_bools</a></span>, <span class='object_link'><a href="../../Messages.html#to_datetime-instance_method" title="MaxCube::Messages#to_datetime (method)">#to_datetime</a></span>, <span class='object_link'><a href="../../Messages.html#to_datetimes-instance_method" title="MaxCube::Messages#to_datetimes (method)">#to_datetimes</a></span>, <span class='object_link'><a href="../../Messages.html#to_float-instance_method" title="MaxCube::Messages#to_float (method)">#to_float</a></span>, <span class='object_link'><a href="../../Messages.html#to_floats-instance_method" title="MaxCube::Messages#to_floats (method)">#to_floats</a></span>, <span class='object_link'><a href="../../Messages.html#to_int-instance_method" title="MaxCube::Messages#to_int (method)">#to_int</a></span>, <span class='object_link'><a href="../../Messages.html#to_ints-instance_method" title="MaxCube::Messages#to_ints (method)">#to_ints</a></span></p>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::TCP::Handler (module)">Handler</a></span></h3>
|
273
|
+
<p class="inherited"><span class='object_link'><a href="Handler.html#check_tcp_data-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_data (method)">#check_tcp_data</a></span>, <span class='object_link'><a href="Handler.html#check_tcp_hash-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_hash (method)">#check_tcp_hash</a></span>, <span class='object_link'><a href="Handler.html#check_tcp_msg-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_msg (method)">#check_tcp_msg</a></span>, <span class='object_link'><a href="Handler.html#check_tcp_msg_format-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_msg_format (method)">#check_tcp_msg_format</a></span>, <span class='object_link'><a href="Handler.html#check_tcp_msg_length-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_msg_length (method)">#check_tcp_msg_length</a></span>, <span class='object_link'><a href="Handler.html#msg_msg_type-instance_method" title="MaxCube::Messages::TCP::Handler#msg_msg_type (method)">#msg_msg_type</a></span>, <span class='object_link'><a href="Handler.html#valid_tcp_data-instance_method" title="MaxCube::Messages::TCP::Handler#valid_tcp_data (method)">#valid_tcp_data</a></span>, <span class='object_link'><a href="Handler.html#valid_tcp_hash-instance_method" title="MaxCube::Messages::TCP::Handler#valid_tcp_hash (method)">#valid_tcp_hash</a></span>, <span class='object_link'><a href="Handler.html#valid_tcp_msg-instance_method" title="MaxCube::Messages::TCP::Handler#valid_tcp_msg (method)">#valid_tcp_msg</a></span>, <span class='object_link'><a href="Handler.html#valid_tcp_msg_format-instance_method" title="MaxCube::Messages::TCP::Handler#valid_tcp_msg_format (method)">#valid_tcp_msg_format</a></span>, <span class='object_link'><a href="Handler.html#valid_tcp_msg_length-instance_method" title="MaxCube::Messages::TCP::Handler#valid_tcp_msg_length (method)">#valid_tcp_msg_length</a></span></p>
|
274
|
+
|
275
|
+
|
276
|
+
<div id="instance_method_details" class="method_details_list">
|
277
|
+
<h2>Instance Method Details</h2>
|
278
|
+
|
279
|
+
|
280
|
+
<div class="method_details first">
|
281
|
+
<h3 class="signature first" id="parse_tcp_data-instance_method">
|
282
|
+
|
283
|
+
#<strong>parse_tcp_data</strong>(raw_data) ⇒ <tt>Array<Hash></tt>
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
</h3><div class="docstring">
|
290
|
+
<div class="discussion">
|
291
|
+
|
292
|
+
<p>Processes set of messages - raw data separated by <tt>\r\n</tt>. Calls
|
293
|
+
<span class='object_link'><a href="Handler.html#check_tcp_data-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_data (method)">Handler#check_tcp_data</a></span> and maps <span class='object_link'><a href="#parse_tcp_msg-instance_method" title="MaxCube::Messages::TCP::Parser#parse_tcp_msg (method)">#parse_tcp_msg</a></span> on each message.</p>
|
294
|
+
|
295
|
+
|
296
|
+
</div>
|
297
|
+
</div>
|
298
|
+
<div class="tags">
|
299
|
+
<p class="tag_title">Parameters:</p>
|
300
|
+
<ul class="param">
|
301
|
+
|
302
|
+
<li>
|
303
|
+
|
304
|
+
<span class='name'>raw_data</span>
|
305
|
+
|
306
|
+
|
307
|
+
<span class='type'>(<tt>String</tt>)</span>
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
—
|
312
|
+
<div class='inline'>
|
313
|
+
<p>raw data from a Cube</p>
|
314
|
+
</div>
|
315
|
+
|
316
|
+
</li>
|
317
|
+
|
318
|
+
</ul>
|
319
|
+
|
320
|
+
<p class="tag_title">Returns:</p>
|
321
|
+
<ul class="return">
|
322
|
+
|
323
|
+
<li>
|
324
|
+
|
325
|
+
|
326
|
+
<span class='type'>(<tt>Array<Hash></tt>)</span>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
—
|
331
|
+
<div class='inline'>
|
332
|
+
<p>particular message contents</p>
|
333
|
+
</div>
|
334
|
+
|
335
|
+
</li>
|
336
|
+
|
337
|
+
</ul>
|
338
|
+
|
339
|
+
</div><table class="source_code">
|
340
|
+
<tr>
|
341
|
+
<td>
|
342
|
+
<pre class="lines">
|
343
|
+
|
344
|
+
|
345
|
+
26
|
346
|
+
27
|
347
|
+
28
|
348
|
+
29</pre>
|
349
|
+
</td>
|
350
|
+
<td>
|
351
|
+
<pre class="code"><span class="info file"># File 'lib/maxcube/messages/tcp/parser.rb', line 26</span>
|
352
|
+
|
353
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_tcp_data'>parse_tcp_data</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_data'>raw_data</span><span class='rparen'>)</span>
|
354
|
+
<span class='id identifier rubyid_check_tcp_data'>check_tcp_data</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_data'>raw_data</span><span class='rparen'>)</span>
|
355
|
+
<span class='id identifier rubyid_raw_data'>raw_data</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:parse_tcp_msg</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
356
|
+
<span class='kw'>end</span></pre>
|
357
|
+
</td>
|
358
|
+
</tr>
|
359
|
+
</table>
|
360
|
+
</div>
|
361
|
+
|
362
|
+
<div class="method_details ">
|
363
|
+
<h3 class="signature " id="parse_tcp_msg-instance_method">
|
364
|
+
|
365
|
+
#<strong>parse_tcp_msg</strong>(msg) ⇒ <tt>Hash</tt>
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
</h3><div class="docstring">
|
372
|
+
<div class="discussion">
|
373
|
+
|
374
|
+
<p>Parses single message already without <tt>\r\n</tt>. Subsequently calls
|
375
|
+
<span class='object_link'><a href="Handler.html#check_tcp_msg-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_msg (method)">Handler#check_tcp_msg</a></span>, <span class='object_link'><a href="../Parser.html#parse_msg_body-instance_method" title="MaxCube::Messages::Parser#parse_msg_body (method)">Parser#parse_msg_body</a></span> and <span class='object_link'><a href="Handler.html#check_tcp_hash-instance_method" title="MaxCube::Messages::TCP::Handler#check_tcp_hash (method)">Handler#check_tcp_hash</a></span>.</p>
|
376
|
+
|
377
|
+
|
378
|
+
</div>
|
379
|
+
</div>
|
380
|
+
<div class="tags">
|
381
|
+
<p class="tag_title">Parameters:</p>
|
382
|
+
<ul class="param">
|
383
|
+
|
384
|
+
<li>
|
385
|
+
|
386
|
+
<span class='name'>msg</span>
|
387
|
+
|
388
|
+
|
389
|
+
<span class='type'>(<tt>String</tt>)</span>
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
—
|
394
|
+
<div class='inline'>
|
395
|
+
<p>input message (without <tt>\r\n</tt>).</p>
|
396
|
+
</div>
|
397
|
+
|
398
|
+
</li>
|
399
|
+
|
400
|
+
</ul>
|
401
|
+
|
402
|
+
<p class="tag_title">Returns:</p>
|
403
|
+
<ul class="return">
|
404
|
+
|
405
|
+
<li>
|
406
|
+
|
407
|
+
|
408
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
—
|
413
|
+
<div class='inline'>
|
414
|
+
<p>particular message contents separated into hash.</p>
|
415
|
+
</div>
|
416
|
+
|
417
|
+
</li>
|
418
|
+
|
419
|
+
</ul>
|
420
|
+
|
421
|
+
</div><table class="source_code">
|
422
|
+
<tr>
|
423
|
+
<td>
|
424
|
+
<pre class="lines">
|
425
|
+
|
426
|
+
|
427
|
+
37
|
428
|
+
38
|
429
|
+
39
|
430
|
+
40
|
431
|
+
41
|
432
|
+
42
|
433
|
+
43</pre>
|
434
|
+
</td>
|
435
|
+
<td>
|
436
|
+
<pre class="code"><span class="info file"># File 'lib/maxcube/messages/tcp/parser.rb', line 37</span>
|
437
|
+
|
438
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parse_tcp_msg'>parse_tcp_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
|
439
|
+
<span class='id identifier rubyid_check_tcp_msg'>check_tcp_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
|
440
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
441
|
+
<span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='ivar'>@msg_type</span> <span class='rbrace'>}</span>
|
442
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_hash'>hash</span> <span class='kw'>unless</span> <span class='id identifier rubyid_parse_msg_body'>parse_msg_body</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tcp</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
443
|
+
<span class='id identifier rubyid_check_tcp_hash'>check_tcp_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
444
|
+
<span class='kw'>end</span></pre>
|
445
|
+
</td>
|
446
|
+
</tr>
|
447
|
+
</table>
|
448
|
+
</div>
|
449
|
+
|
450
|
+
</div>
|
451
|
+
|
452
|
+
</div>
|
453
|
+
|
454
|
+
<div id="footer">
|
455
|
+
Generated on Fri Feb 16 13:44:02 2018 by
|
456
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
457
|
+
0.9.12 (ruby-2.5.0).
|
458
|
+
</div>
|
459
|
+
|
460
|
+
</div>
|
461
|
+
</body>
|
462
|
+
</html>
|