maxcube-client 0.5.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -0
  3. data/data/save/20180214-2023/recv.data +12 -0
  4. data/data/save/20180214-2023/recv.yaml +152 -0
  5. data/data/save/20180214-2023/sent.data +10 -0
  6. data/data/save/20180214-2023/sent.yaml +26 -0
  7. data/data/save/20180214-2230/recv.data +2 -0
  8. data/data/save/20180214-2230/recv.yaml +68 -0
  9. data/data/save/20180214-2230/sent.data +1 -0
  10. data/data/save/20180214-2230/sent.yaml +19 -0
  11. data/data/save/20180215-0057/recv.data +3 -0
  12. data/data/save/20180215-0057/recv.yaml +69 -0
  13. data/data/save/20180215-0057/sent.data +2 -0
  14. data/data/save/20180215-0057/sent.yaml +22 -0
  15. data/data/save/20180216-1641/recv.data +4 -0
  16. data/data/save/20180216-1641/recv.yaml +133 -0
  17. data/data/save/20180216-1641/sent.data +2 -0
  18. data/data/save/20180216-1641/sent.yaml +3 -0
  19. data/lib/maxcube/version.rb +1 -1
  20. data/maxcube-client.gemspec +5 -6
  21. data/spec/msg_spec.rb +2117 -0
  22. data/spec/spec_helper.rb +7 -0
  23. metadata +21 -75
  24. data/.gitignore +0 -6
  25. data/.rubocop.yml +0 -29
  26. data/.yardopts +0 -1
  27. data/Gemfile +0 -5
  28. data/bin/console +0 -8
  29. data/bin/maxcube-client +0 -6
  30. data/bin/sample_server +0 -13
  31. data/bin/sample_socket +0 -13
  32. data/bin/setup +0 -6
  33. data/doc/MaxCube.html +0 -502
  34. data/doc/MaxCube/Messages.html +0 -1927
  35. data/doc/MaxCube/Messages/Handler.html +0 -2912
  36. data/doc/MaxCube/Messages/InvalidMessage.html +0 -140
  37. data/doc/MaxCube/Messages/InvalidMessageBody.html +0 -264
  38. data/doc/MaxCube/Messages/InvalidMessageFormat.html +0 -247
  39. data/doc/MaxCube/Messages/InvalidMessageLength.html +0 -247
  40. data/doc/MaxCube/Messages/InvalidMessageType.html +0 -263
  41. data/doc/MaxCube/Messages/Parser.html +0 -520
  42. data/doc/MaxCube/Messages/Serializer.html +0 -701
  43. data/doc/MaxCube/Messages/TCP.html +0 -172
  44. data/doc/MaxCube/Messages/TCP/Handler.html +0 -1396
  45. data/doc/MaxCube/Messages/TCP/Parser.html +0 -462
  46. data/doc/MaxCube/Messages/TCP/Parser/MessageA.html +0 -186
  47. data/doc/MaxCube/Messages/TCP/Parser/MessageC.html +0 -1077
  48. data/doc/MaxCube/Messages/TCP/Parser/MessageF.html +0 -206
  49. data/doc/MaxCube/Messages/TCP/Parser/MessageH.html +0 -338
  50. data/doc/MaxCube/Messages/TCP/Parser/MessageL.html +0 -535
  51. data/doc/MaxCube/Messages/TCP/Parser/MessageM.html +0 -510
  52. data/doc/MaxCube/Messages/TCP/Parser/MessageN.html +0 -226
  53. data/doc/MaxCube/Messages/TCP/Parser/MessageS.html +0 -225
  54. data/doc/MaxCube/Messages/TCP/Serializer.html +0 -460
  55. data/doc/MaxCube/Messages/TCP/Serializer/MessageA.html +0 -186
  56. data/doc/MaxCube/Messages/TCP/Serializer/MessageC.html +0 -185
  57. data/doc/MaxCube/Messages/TCP/Serializer/MessageF.html +0 -206
  58. data/doc/MaxCube/Messages/TCP/Serializer/MessageL.html +0 -185
  59. data/doc/MaxCube/Messages/TCP/Serializer/MessageM.html +0 -428
  60. data/doc/MaxCube/Messages/TCP/Serializer/MessageN.html +0 -209
  61. data/doc/MaxCube/Messages/TCP/Serializer/MessageQ.html +0 -185
  62. data/doc/MaxCube/Messages/TCP/Serializer/MessageS.html +0 -1168
  63. data/doc/MaxCube/Messages/TCP/Serializer/MessageT.html +0 -240
  64. data/doc/MaxCube/Messages/TCP/Serializer/MessageU.html +0 -206
  65. data/doc/MaxCube/Messages/TCP/Serializer/MessageZ.html +0 -252
  66. data/doc/MaxCube/Messages/UDP.html +0 -164
  67. data/doc/MaxCube/Messages/UDP/Handler.html +0 -832
  68. data/doc/MaxCube/Messages/UDP/Parser.html +0 -609
  69. data/doc/MaxCube/Messages/UDP/Parser/MessageH.html +0 -218
  70. data/doc/MaxCube/Messages/UDP/Parser/MessageI.html +0 -215
  71. data/doc/MaxCube/Messages/UDP/Parser/MessageN.html +0 -226
  72. data/doc/MaxCube/Messages/UDP/Serializer.html +0 -484
  73. data/doc/MaxCube/Network.html +0 -167
  74. data/doc/MaxCube/Network/TCP.html +0 -150
  75. data/doc/MaxCube/Network/TCP/Client.html +0 -1930
  76. data/doc/MaxCube/Network/TCP/Client/Commands.html +0 -2457
  77. data/doc/MaxCube/Network/TCP/SampleServer.html +0 -910
  78. data/doc/MaxCube/Network/UDP.html +0 -150
  79. data/doc/MaxCube/Network/UDP/Client.html +0 -518
  80. data/doc/MaxCube/Network/UDP/SampleSocket.html +0 -628
  81. data/doc/MaxCube/Runner.html +0 -355
  82. data/doc/_index.html +0 -518
  83. data/doc/class_list.html +0 -51
  84. data/doc/css/common.css +0 -1
  85. data/doc/css/full_list.css +0 -58
  86. data/doc/css/style.css +0 -499
  87. data/doc/file.README.html +0 -140
  88. data/doc/file_list.html +0 -56
  89. data/doc/frames.html +0 -17
  90. data/doc/index.html +0 -140
  91. data/doc/js/app.js +0 -248
  92. data/doc/js/full_list.js +0 -216
  93. data/doc/js/jquery.js +0 -4
  94. data/doc/method_list.html +0 -1699
  95. data/doc/top-level-namespace.html +0 -110
data/doc/MaxCube/Messages/UDP.html DELETED
@@ -1,164 +0,0 @@
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
- Module: MaxCube::Messages::UDP
8
-
9
- &mdash; 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::UDP";
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 (U)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../MaxCube.html" title="MaxCube (module)">MaxCube</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Messages.html" title="MaxCube::Messages (module)">Messages</a></span></span>
41
- &raquo;
42
- <span class="title">UDP</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>Module: MaxCube::Messages::UDP
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Defined in:</dt>
81
- <dd>lib/maxcube/messages/udp.rb<span class="defines">,<br />
82
- lib/maxcube/messages/udp/parser.rb,<br /> lib/maxcube/messages/udp/type/h.rb,<br /> lib/maxcube/messages/udp/type/i.rb,<br /> lib/maxcube/messages/udp/type/n.rb,<br /> lib/maxcube/messages/udp/handler.rb,<br /> lib/maxcube/messages/udp/serializer.rb</span>
83
- </dd>
84
- </dl>
85
-
86
- </div>
87
-
88
- <h2>Overview</h2><div class="docstring">
89
- <div class="discussion">
90
-
91
- <p>This module contains classes aimed onto UDP messages of Cube protocol.</p>
92
-
93
- <p>Structure of every UDP Cube message:</p>
94
- <ul><li>
95
- <p>Starts with <span class='object_link'><a href="#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::MSG_PREFIX (constant)">MSG_PREFIX</a></span></p>
96
- </li></ul>
97
-
98
-
99
- </div>
100
- </div>
101
- <div class="tags">
102
-
103
- <div class="examples">
104
- <p class="tag_title">Examples:</p>
105
-
106
-
107
- <pre class="example code"><code><span class='id identifier rubyid_eQ3MaxApKEQ0523864'>eQ3MaxApKEQ0523864</span><span class='op'>&gt;</span><span class='const'>I</span></code></pre>
108
-
109
- </div>
110
-
111
-
112
- </div><h2>Defined Under Namespace</h2>
113
- <p class="children">
114
-
115
-
116
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="UDP/Handler.html" title="MaxCube::Messages::UDP::Handler (module)">Handler</a></span>
117
-
118
-
119
-
120
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="UDP/Parser.html" title="MaxCube::Messages::UDP::Parser (class)">Parser</a></span>, <span class='object_link'><a href="UDP/Serializer.html" title="MaxCube::Messages::UDP::Serializer (class)">Serializer</a></span>
121
-
122
-
123
- </p>
124
-
125
- <h2>Constant Summary</h2>
126
- <dl class="constants">
127
-
128
- <dt id="MSG_PREFIX-constant" class="">MSG_PREFIX =
129
- <div class="docstring">
130
- <div class="discussion">
131
-
132
- <p>Prefix of any UDP Cube message</p>
133
-
134
-
135
- </div>
136
- </div>
137
- <div class="tags">
138
-
139
-
140
- </div>
141
- </dt>
142
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>eQ3Max</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
143
-
144
- </dl>
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
- </div>
155
-
156
- <div id="footer">
157
- Generated on Fri Feb 16 13:44:01 2018 by
158
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
159
- 0.9.12 (ruby-2.5.0).
160
- </div>
161
-
162
- </div>
163
- </body>
164
- </html>
data/doc/MaxCube/Messages/UDP/Handler.html DELETED
@@ -1,832 +0,0 @@
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
- Module: MaxCube::Messages::UDP::Handler
8
-
9
- &mdash; 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::UDP::Handler";
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 (H)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../../MaxCube.html" title="MaxCube (module)">MaxCube</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">Messages</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../UDP.html" title="MaxCube::Messages::UDP (module)">UDP</a></span></span>
41
- &raquo;
42
- <span class="title">Handler</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>Module: MaxCube::Messages::UDP::Handler
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
- <dl>
75
- <dt>Includes:</dt>
76
- <dd><span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></dd>
77
- </dl>
78
-
79
-
80
-
81
-
82
- <dl>
83
- <dt>Included in:</dt>
84
- <dd><span class='object_link'><a href="Parser.html" title="MaxCube::Messages::UDP::Parser (class)">Parser</a></span>, <span class='object_link'><a href="Serializer.html" title="MaxCube::Messages::UDP::Serializer (class)">Serializer</a></span></dd>
85
- </dl>
86
-
87
-
88
-
89
- <dl>
90
- <dt>Defined in:</dt>
91
- <dd>lib/maxcube/messages/udp/handler.rb</dd>
92
- </dl>
93
-
94
- </div>
95
-
96
- <h2>Overview</h2><div class="docstring">
97
- <div class="discussion">
98
-
99
- <p>Extends <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span> of routines connected to UDP Cube messages.</p>
100
-
101
-
102
- </div>
103
- </div>
104
- <div class="tags">
105
-
106
-
107
- </div>
108
-
109
-
110
- <h2>Constant Summary</h2>
111
-
112
- <h3 class="inherited">Constants included
113
- from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
114
- <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>
115
-
116
-
117
-
118
- <h3 class="inherited">Constants included
119
- from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
120
- <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>
121
-
122
-
123
-
124
-
125
-
126
-
127
- <h2>
128
- Instance Method Summary
129
- <small><a href="#" class="summary_toggle">collapse</a></small>
130
- </h2>
131
-
132
- <ul class="summary">
133
-
134
- <li class="public ">
135
- <span class="summary_signature">
136
-
137
- <a href="#check_udp_hash-instance_method" title="#check_udp_hash (instance method)">#<strong>check_udp_hash</strong>(hash) &#x21d2; Hash </a>
138
-
139
-
140
-
141
- </span>
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <span class="summary_desc"><div class='inline'>
152
- <p>As <span class='object_link'><a href="#valid_udp_hash-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_hash (method)">#valid_udp_hash</a></span>, but raises exception if hash is not valid.</p>
153
- </div></span>
154
-
155
- </li>
156
-
157
-
158
- <li class="public ">
159
- <span class="summary_signature">
160
-
161
- <a href="#check_udp_msg-instance_method" title="#check_udp_msg (instance method)">#<strong>check_udp_msg</strong>(msg) &#x21d2; String </a>
162
-
163
-
164
-
165
- </span>
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
- <span class="summary_desc"><div class='inline'>
176
- <p>As <span class='object_link'><a href="#valid_udp_msg-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg (method)">#valid_udp_msg</a></span>, but raises exception if message is not valid.</p>
177
- </div></span>
178
-
179
- </li>
180
-
181
-
182
- <li class="public ">
183
- <span class="summary_signature">
184
-
185
- <a href="#check_udp_msg_prefix-instance_method" title="#check_udp_msg_prefix (instance method)">#<strong>check_udp_msg_prefix</strong>(msg) &#x21d2; String </a>
186
-
187
-
188
-
189
- </span>
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
- <span class="summary_desc"><div class='inline'>
200
- <p>As <span class='object_link'><a href="#valid_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg_prefix (method)">#valid_udp_msg_prefix</a></span>, but it raises exception if the prefix is not
201
- valid.</p>
202
- </div></span>
203
-
204
- </li>
205
-
206
-
207
- <li class="public ">
208
- <span class="summary_signature">
209
-
210
- <a href="#valid_udp_hash-instance_method" title="#valid_udp_hash (instance method)">#<strong>valid_udp_hash</strong>(hash) &#x21d2; Boolean </a>
211
-
212
-
213
-
214
- </span>
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
- <span class="summary_desc"><div class='inline'>
225
- <p>Validates whether given hash with message contents is valid for UDP Cube
226
- messaging purposes.</p>
227
- </div></span>
228
-
229
- </li>
230
-
231
-
232
- <li class="public ">
233
- <span class="summary_signature">
234
-
235
- <a href="#valid_udp_msg-instance_method" title="#valid_udp_msg (instance method)">#<strong>valid_udp_msg</strong>(msg) &#x21d2; Boolean </a>
236
-
237
-
238
-
239
- </span>
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
- <span class="summary_desc"><div class='inline'>
250
- <p>Validates whether given message is a valid UDP Cube message.</p>
251
- </div></span>
252
-
253
- </li>
254
-
255
-
256
- <li class="public ">
257
- <span class="summary_signature">
258
-
259
- <a href="#valid_udp_msg_prefix-instance_method" title="#valid_udp_msg_prefix (instance method)">#<strong>valid_udp_msg_prefix</strong>(msg) &#x21d2; Boolean </a>
260
-
261
-
262
-
263
- </span>
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
- <span class="summary_desc"><div class='inline'>
274
- <p>Validates whether message contains correct <span class='object_link'><a href="../UDP.html#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::MSG_PREFIX (constant)">MSG_PREFIX</a></span> (suffix of the
275
- prefix differs for parser and serializer).</p>
276
- </div></span>
277
-
278
- </li>
279
-
280
-
281
- </ul>
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
294
- <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>
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
305
- <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>
306
-
307
-
308
- <div id="instance_method_details" class="method_details_list">
309
- <h2>Instance Method Details</h2>
310
-
311
-
312
- <div class="method_details first">
313
- <h3 class="signature first" id="check_udp_hash-instance_method">
314
-
315
- #<strong>check_udp_hash</strong>(hash) &#x21d2; <tt>Hash</tt>
316
-
317
-
318
-
319
-
320
-
321
- </h3><div class="docstring">
322
- <div class="discussion">
323
-
324
- <p>As <span class='object_link'><a href="#valid_udp_hash-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_hash (method)">#valid_udp_hash</a></span>, but raises exception if hash is not valid. It only
325
- calls <span class='object_link'><a href="../Handler.html#check_hash-instance_method" title="MaxCube::Messages::Handler#check_hash (method)">Handler#check_hash</a></span>.</p>
326
-
327
-
328
- </div>
329
- </div>
330
- <div class="tags">
331
- <p class="tag_title">Parameters:</p>
332
- <ul class="param">
333
-
334
- <li>
335
-
336
- <span class='name'>hash</span>
337
-
338
-
339
- <span class='type'>(<tt>Hash</tt>)</span>
340
-
341
-
342
-
343
- &mdash;
344
- <div class='inline'>
345
- <p>input hash.</p>
346
- </div>
347
-
348
- </li>
349
-
350
- </ul>
351
-
352
- <p class="tag_title">Returns:</p>
353
- <ul class="return">
354
-
355
- <li>
356
-
357
-
358
- <span class='type'>(<tt>Hash</tt>)</span>
359
-
360
-
361
-
362
- &mdash;
363
- <div class='inline'>
364
- <p>input hash.</p>
365
- </div>
366
-
367
- </li>
368
-
369
- </ul>
370
-
371
- </div><table class="source_code">
372
- <tr>
373
- <td>
374
- <pre class="lines">
375
-
376
-
377
- 61
378
- 62
379
- 63
380
- 64</pre>
381
- </td>
382
- <td>
383
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 61</span>
384
-
385
- <span class='kw'>def</span> <span class='id identifier rubyid_check_udp_hash'>check_udp_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
386
- <span class='id identifier rubyid_check_hash'>check_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
387
- <span class='id identifier rubyid_hash'>hash</span>
388
- <span class='kw'>end</span></pre>
389
- </td>
390
- </tr>
391
- </table>
392
- </div>
393
-
394
- <div class="method_details ">
395
- <h3 class="signature " id="check_udp_msg-instance_method">
396
-
397
- #<strong>check_udp_msg</strong>(msg) &#x21d2; <tt>String</tt>
398
-
399
-
400
-
401
-
402
-
403
- </h3><div class="docstring">
404
- <div class="discussion">
405
-
406
- <p>As <span class='object_link'><a href="#valid_udp_msg-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg (method)">#valid_udp_msg</a></span>, but raises exception if message is not valid. It calls
407
- <span class='object_link'><a href="#check_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_msg_prefix (method)">#check_udp_msg_prefix</a></span> and <span class='object_link'><a href="../Handler.html#check_msg-instance_method" title="MaxCube::Messages::Handler#check_msg (method)">Handler#check_msg</a></span>.</p>
408
-
409
-
410
- </div>
411
- </div>
412
- <div class="tags">
413
- <p class="tag_title">Parameters:</p>
414
- <ul class="param">
415
-
416
- <li>
417
-
418
- <span class='name'>msg</span>
419
-
420
-
421
- <span class='type'>(<tt>String</tt>)</span>
422
-
423
-
424
-
425
- &mdash;
426
- <div class='inline'>
427
- <p>input message.</p>
428
- </div>
429
-
430
- </li>
431
-
432
- </ul>
433
-
434
- <p class="tag_title">Returns:</p>
435
- <ul class="return">
436
-
437
- <li>
438
-
439
-
440
- <span class='type'>(<tt>String</tt>)</span>
441
-
442
-
443
-
444
- &mdash;
445
- <div class='inline'>
446
- <p>input message.</p>
447
- </div>
448
-
449
- </li>
450
-
451
- </ul>
452
-
453
- </div><table class="source_code">
454
- <tr>
455
- <td>
456
- <pre class="lines">
457
-
458
-
459
- 42
460
- 43
461
- 44
462
- 45
463
- 46</pre>
464
- </td>
465
- <td>
466
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 42</span>
467
-
468
- <span class='kw'>def</span> <span class='id identifier rubyid_check_udp_msg'>check_udp_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
469
- <span class='id identifier rubyid_check_udp_msg_prefix'>check_udp_msg_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
470
- <span class='id identifier rubyid_check_msg'>check_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
471
- <span class='id identifier rubyid_msg'>msg</span>
472
- <span class='kw'>end</span></pre>
473
- </td>
474
- </tr>
475
- </table>
476
- </div>
477
-
478
- <div class="method_details ">
479
- <h3 class="signature " id="check_udp_msg_prefix-instance_method">
480
-
481
- #<strong>check_udp_msg_prefix</strong>(msg) &#x21d2; <tt>String</tt>
482
-
483
-
484
-
485
-
486
-
487
- </h3><div class="docstring">
488
- <div class="discussion">
489
-
490
- <p>As <span class='object_link'><a href="#valid_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg_prefix (method)">#valid_udp_msg_prefix</a></span>, but it raises exception if the prefix is not
491
- valid.</p>
492
-
493
-
494
- </div>
495
- </div>
496
- <div class="tags">
497
- <p class="tag_title">Parameters:</p>
498
- <ul class="param">
499
-
500
- <li>
501
-
502
- <span class='name'>msg</span>
503
-
504
-
505
- <span class='type'>(<tt>String</tt>)</span>
506
-
507
-
508
-
509
- &mdash;
510
- <div class='inline'>
511
- <p>input message.</p>
512
- </div>
513
-
514
- </li>
515
-
516
- </ul>
517
-
518
- <p class="tag_title">Returns:</p>
519
- <ul class="return">
520
-
521
- <li>
522
-
523
-
524
- <span class='type'>(<tt>String</tt>)</span>
525
-
526
-
527
-
528
- &mdash;
529
- <div class='inline'>
530
- <p>input message.</p>
531
- </div>
532
-
533
- </li>
534
-
535
- </ul>
536
- <p class="tag_title">Raises:</p>
537
- <ul class="raise">
538
-
539
- <li>
540
-
541
-
542
- <span class='type'>(<tt><span class='object_link'><a href="../InvalidMessageFormat.html" title="MaxCube::Messages::InvalidMessageFormat (class)">InvalidMessageFormat</a></span></tt>)</span>
543
-
544
-
545
-
546
- &mdash;
547
- <div class='inline'>
548
- <p>if the prefix is not valid.</p>
549
- </div>
550
-
551
- </li>
552
-
553
- </ul>
554
-
555
- </div><table class="source_code">
556
- <tr>
557
- <td>
558
- <pre class="lines">
559
-
560
-
561
- 24
562
- 25
563
- 26
564
- 27</pre>
565
- </td>
566
- <td>
567
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 24</span>
568
-
569
- <span class='kw'>def</span> <span class='id identifier rubyid_check_udp_msg_prefix'>check_udp_msg_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
570
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../InvalidMessageFormat.html" title="MaxCube::Messages::InvalidMessageFormat (class)">InvalidMessageFormat</a></span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_valid_udp_msg_prefix'>valid_udp_msg_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
571
- <span class='id identifier rubyid_msg'>msg</span>
572
- <span class='kw'>end</span></pre>
573
- </td>
574
- </tr>
575
- </table>
576
- </div>
577
-
578
- <div class="method_details ">
579
- <h3 class="signature " id="valid_udp_hash-instance_method">
580
-
581
- #<strong>valid_udp_hash</strong>(hash) &#x21d2; <tt>Boolean</tt>
582
-
583
-
584
-
585
-
586
-
587
- </h3><div class="docstring">
588
- <div class="discussion">
589
-
590
- <p>Validates whether given hash with message contents is valid for UDP Cube
591
- messaging purposes. It only calls <span class='object_link'><a href="../Handler.html#valid_hash-instance_method" title="MaxCube::Messages::Handler#valid_hash (method)">Handler#valid_hash</a></span>.</p>
592
-
593
-
594
- </div>
595
- </div>
596
- <div class="tags">
597
- <p class="tag_title">Parameters:</p>
598
- <ul class="param">
599
-
600
- <li>
601
-
602
- <span class='name'>hash</span>
603
-
604
-
605
- <span class='type'>(<tt>Hash</tt>)</span>
606
-
607
-
608
-
609
- &mdash;
610
- <div class='inline'>
611
- <p>input hash.</p>
612
- </div>
613
-
614
- </li>
615
-
616
- </ul>
617
-
618
- <p class="tag_title">Returns:</p>
619
- <ul class="return">
620
-
621
- <li>
622
-
623
-
624
- <span class='type'>(<tt>Boolean</tt>)</span>
625
-
626
-
627
-
628
- &mdash;
629
- <div class='inline'>
630
- <p>whether hash is valid.</p>
631
- </div>
632
-
633
- </li>
634
-
635
- </ul>
636
-
637
- </div><table class="source_code">
638
- <tr>
639
- <td>
640
- <pre class="lines">
641
-
642
-
643
- 53
644
- 54
645
- 55</pre>
646
- </td>
647
- <td>
648
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 53</span>
649
-
650
- <span class='kw'>def</span> <span class='id identifier rubyid_valid_udp_hash'>valid_udp_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
651
- <span class='id identifier rubyid_valid_hash'>valid_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
652
- <span class='kw'>end</span></pre>
653
- </td>
654
- </tr>
655
- </table>
656
- </div>
657
-
658
- <div class="method_details ">
659
- <h3 class="signature " id="valid_udp_msg-instance_method">
660
-
661
- #<strong>valid_udp_msg</strong>(msg) &#x21d2; <tt>Boolean</tt>
662
-
663
-
664
-
665
-
666
-
667
- </h3><div class="docstring">
668
- <div class="discussion">
669
-
670
- <p>Validates whether given message is a valid UDP Cube message. It calls
671
- <span class='object_link'><a href="#valid_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg_prefix (method)">#valid_udp_msg_prefix</a></span> and <span class='object_link'><a href="../Handler.html#valid_msg-instance_method" title="MaxCube::Messages::Handler#valid_msg (method)">Handler#valid_msg</a></span>.</p>
672
-
673
-
674
- </div>
675
- </div>
676
- <div class="tags">
677
- <p class="tag_title">Parameters:</p>
678
- <ul class="param">
679
-
680
- <li>
681
-
682
- <span class='name'>msg</span>
683
-
684
-
685
- <span class='type'>(<tt>String</tt>)</span>
686
-
687
-
688
-
689
- &mdash;
690
- <div class='inline'>
691
- <p>input message.</p>
692
- </div>
693
-
694
- </li>
695
-
696
- </ul>
697
-
698
- <p class="tag_title">Returns:</p>
699
- <ul class="return">
700
-
701
- <li>
702
-
703
-
704
- <span class='type'>(<tt>Boolean</tt>)</span>
705
-
706
-
707
-
708
- &mdash;
709
- <div class='inline'>
710
- <p>whether message is valid.</p>
711
- </div>
712
-
713
- </li>
714
-
715
- </ul>
716
-
717
- </div><table class="source_code">
718
- <tr>
719
- <td>
720
- <pre class="lines">
721
-
722
-
723
- 33
724
- 34
725
- 35
726
- 36</pre>
727
- </td>
728
- <td>
729
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 33</span>
730
-
731
- <span class='kw'>def</span> <span class='id identifier rubyid_valid_udp_msg'>valid_udp_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
732
- <span class='id identifier rubyid_valid_udp_msg_prefix'>valid_udp_msg_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
733
- <span class='id identifier rubyid_valid_msg'>valid_msg</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
734
- <span class='kw'>end</span></pre>
735
- </td>
736
- </tr>
737
- </table>
738
- </div>
739
-
740
- <div class="method_details ">
741
- <h3 class="signature " id="valid_udp_msg_prefix-instance_method">
742
-
743
- #<strong>valid_udp_msg_prefix</strong>(msg) &#x21d2; <tt>Boolean</tt>
744
-
745
-
746
-
747
-
748
-
749
- </h3><div class="docstring">
750
- <div class="discussion">
751
-
752
- <p>Validates whether message contains correct <span class='object_link'><a href="../UDP.html#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::MSG_PREFIX (constant)">MSG_PREFIX</a></span> (suffix of the
753
- prefix differs for parser and serializer).</p>
754
-
755
-
756
- </div>
757
- </div>
758
- <div class="tags">
759
- <p class="tag_title">Parameters:</p>
760
- <ul class="param">
761
-
762
- <li>
763
-
764
- <span class='name'>msg</span>
765
-
766
-
767
- <span class='type'>(<tt>String</tt>)</span>
768
-
769
-
770
-
771
- &mdash;
772
- <div class='inline'>
773
- <p>input message.</p>
774
- </div>
775
-
776
- </li>
777
-
778
- </ul>
779
-
780
- <p class="tag_title">Returns:</p>
781
- <ul class="return">
782
-
783
- <li>
784
-
785
-
786
- <span class='type'>(<tt>Boolean</tt>)</span>
787
-
788
-
789
-
790
- &mdash;
791
- <div class='inline'>
792
- <p>whether message prefix is valid.</p>
793
- </div>
794
-
795
- </li>
796
-
797
- </ul>
798
-
799
- </div><table class="source_code">
800
- <tr>
801
- <td>
802
- <pre class="lines">
803
-
804
-
805
- 15
806
- 16
807
- 17</pre>
808
- </td>
809
- <td>
810
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/handler.rb', line 15</span>
811
-
812
- <span class='kw'>def</span> <span class='id identifier rubyid_valid_udp_msg_prefix'>valid_udp_msg_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
813
- <span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MSG_PREFIX</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
814
- <span class='kw'>end</span></pre>
815
- </td>
816
- </tr>
817
- </table>
818
- </div>
819
-
820
- </div>
821
-
822
- </div>
823
-
824
- <div id="footer">
825
- Generated on Fri Feb 16 13:44:02 2018 by
826
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
827
- 0.9.12 (ruby-2.5.0).
828
- </div>
829
-
830
- </div>
831
- </body>
832
- </html>