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/Serializer.html DELETED
@@ -1,484 +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
- Class: MaxCube::Messages::UDP::Serializer
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::Serializer";
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 (S)</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">Serializer</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::UDP::Serializer
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::UDP::Serializer</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="../Serializer.html" title="MaxCube::Messages::Serializer (module)">Serializer</a></span>, <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::UDP::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/udp/serializer.rb</dd>
103
- </dl>
104
-
105
- </div>
106
-
107
- <h2>Overview</h2><div class="docstring">
108
- <div class="discussion">
109
-
110
- <p>Extends <span class='object_link'><a href="../Serializer.html" title="MaxCube::Messages::Serializer (module)">Serializer</a></span> and <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::UDP::Handler (module)">Handler</a></span> of routines connected to
111
- UDP Cube messages serializing.</p>
112
-
113
-
114
- </div>
115
- </div>
116
- <div class="tags">
117
-
118
-
119
- </div>
120
- <h2>Constant Summary</h2>
121
- <dl class="constants">
122
-
123
- <dt id="MSG_TYPES-constant" class="">MSG_TYPES =
124
- <div class="docstring">
125
- <div class="discussion">
126
-
127
- <p>Known message types in the direction client -&gt; Cube.</p>
128
-
129
-
130
- </div>
131
- </div>
132
- <div class="tags">
133
-
134
-
135
- </div>
136
- </dt>
137
- <dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>I</span><span class='words_sep'> </span><span class='tstring_content'>N</span><span class='words_sep'> </span><span class='tstring_content'>h</span><span class='words_sep'> </span><span class='tstring_content'>c</span><span class='words_sep'> </span><span class='tstring_content'>R</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
138
-
139
- <dt id="MSG_PREFIX-constant" class="">MSG_PREFIX =
140
- <div class="docstring">
141
- <div class="discussion">
142
-
143
- <p><span class='object_link'><a href="../UDP.html#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::MSG_PREFIX (constant)">MSG_PREFIX</a></span> with a suffix.</p>
144
-
145
-
146
- </div>
147
- </div>
148
- <div class="tags">
149
-
150
-
151
- </div>
152
- </dt>
153
- <dd><pre class="code"><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../UDP.html" title="MaxCube::Messages::UDP (module)">UDP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../UDP.html#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::MSG_PREFIX (constant)">MSG_PREFIX</a></span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*\x00</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
154
-
155
- </dl>
156
-
157
-
158
-
159
-
160
-
161
- <h3 class="inherited">Constants included
162
- from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
163
- <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>
164
-
165
-
166
-
167
- <h3 class="inherited">Constants included
168
- from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
169
- <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>
170
-
171
-
172
-
173
-
174
-
175
-
176
- <h2>
177
- Instance Method Summary
178
- <small><a href="#" class="summary_toggle">collapse</a></small>
179
- </h2>
180
-
181
- <ul class="summary">
182
-
183
- <li class="private ">
184
- <span class="summary_signature">
185
-
186
- <a href="#msg_msg_type-instance_method" title="#msg_msg_type (instance method)">#<strong>msg_msg_type</strong>(msg) &#x21d2; String </a>
187
-
188
-
189
-
190
- </span>
191
-
192
-
193
-
194
- <span class="note title private">private</span>
195
-
196
-
197
-
198
-
199
-
200
- <span class="summary_desc"><div class='inline'>
201
- <p>Tells how to get message type from a message.</p>
202
- </div></span>
203
-
204
- </li>
205
-
206
-
207
- <li class="public ">
208
- <span class="summary_signature">
209
-
210
- <a href="#serialize_udp_hash-instance_method" title="#serialize_udp_hash (instance method)">#<strong>serialize_udp_hash</strong>(hash) &#x21d2; String </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>Serializes data from a single hash into UDP Cube message.</p>
226
- </div></span>
227
-
228
- </li>
229
-
230
-
231
- </ul>
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../Serializer.html" title="MaxCube::Messages::Serializer (module)">Serializer</a></span></h3>
244
- <p class="inherited"><span class='object_link'><a href="../Serializer.html#serialize-instance_method" title="MaxCube::Messages::Serializer#serialize (method)">#serialize</a></span>, <span class='object_link'><a href="../Serializer.html#serialize_bounds-instance_method" title="MaxCube::Messages::Serializer#serialize_bounds (method)">#serialize_bounds</a></span>, <span class='object_link'><a href="../Serializer.html#serialize_hash_body-instance_method" title="MaxCube::Messages::Serializer#serialize_hash_body (method)">#serialize_hash_body</a></span>, <span class='object_link'><a href="../Serializer.html#write-instance_method" title="MaxCube::Messages::Serializer#write (method)">#write</a></span></p>
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
255
- <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>
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
266
- <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>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::UDP::Handler (module)">Handler</a></span></h3>
277
- <p class="inherited"><span class='object_link'><a href="Handler.html#check_udp_hash-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_hash (method)">#check_udp_hash</a></span>, <span class='object_link'><a href="Handler.html#check_udp_msg-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_msg (method)">#check_udp_msg</a></span>, <span class='object_link'><a href="Handler.html#check_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_msg_prefix (method)">#check_udp_msg_prefix</a></span>, <span class='object_link'><a href="Handler.html#valid_udp_hash-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_hash (method)">#valid_udp_hash</a></span>, <span class='object_link'><a href="Handler.html#valid_udp_msg-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg (method)">#valid_udp_msg</a></span>, <span class='object_link'><a href="Handler.html#valid_udp_msg_prefix-instance_method" title="MaxCube::Messages::UDP::Handler#valid_udp_msg_prefix (method)">#valid_udp_msg_prefix</a></span></p>
278
-
279
-
280
- <div id="instance_method_details" class="method_details_list">
281
- <h2>Instance Method Details</h2>
282
-
283
-
284
- <div class="method_details first">
285
- <h3 class="signature first" id="msg_msg_type-instance_method">
286
-
287
- #<strong>msg_msg_type</strong>(msg) &#x21d2; <tt>String</tt> <span class="extras">(private)</span>
288
-
289
-
290
-
291
-
292
-
293
- </h3><div class="docstring">
294
- <div class="discussion">
295
-
296
- <p>Tells how to get message type from a message.</p>
297
-
298
-
299
- </div>
300
- </div>
301
- <div class="tags">
302
- <p class="tag_title">Parameters:</p>
303
- <ul class="param">
304
-
305
- <li>
306
-
307
- <span class='name'>msg</span>
308
-
309
-
310
- <span class='type'>(<tt>String</tt>)</span>
311
-
312
-
313
-
314
- &mdash;
315
- <div class='inline'>
316
- <p>input message.</p>
317
- </div>
318
-
319
- </li>
320
-
321
- </ul>
322
-
323
- <p class="tag_title">Returns:</p>
324
- <ul class="return">
325
-
326
- <li>
327
-
328
-
329
- <span class='type'>(<tt>String</tt>)</span>
330
-
331
-
332
-
333
- &mdash;
334
- <div class='inline'>
335
- <p>message type.</p>
336
- </div>
337
-
338
- </li>
339
-
340
- </ul>
341
-
342
- </div><table class="source_code">
343
- <tr>
344
- <td>
345
- <pre class="lines">
346
-
347
-
348
- 40
349
- 41
350
- 42</pre>
351
- </td>
352
- <td>
353
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/serializer.rb', line 40</span>
354
-
355
- <span class='kw'>def</span> <span class='id identifier rubyid_msg_msg_type'>msg_msg_type</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
356
- <span class='id identifier rubyid_msg'>msg</span><span class='lbracket'>[</span><span class='int'>18</span><span class='rbracket'>]</span>
357
- <span class='kw'>end</span></pre>
358
- </td>
359
- </tr>
360
- </table>
361
- </div>
362
-
363
- <div class="method_details ">
364
- <h3 class="signature " id="serialize_udp_hash-instance_method">
365
-
366
- #<strong>serialize_udp_hash</strong>(hash) &#x21d2; <tt>String</tt>
367
-
368
-
369
-
370
-
371
-
372
- </h3><div class="docstring">
373
- <div class="discussion">
374
-
375
- <p>Serializes data from a single hash into UDP Cube message. Calls
376
- <span class='object_link'><a href="Handler.html#check_udp_hash-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_hash (method)">Handler#check_udp_hash</a></span> at the begin and <span class='object_link'><a href="Handler.html#check_udp_msg-instance_method" title="MaxCube::Messages::UDP::Handler#check_udp_msg (method)">Handler#check_udp_msg</a></span> at the end.</p>
377
-
378
-
379
- </div>
380
- </div>
381
- <div class="tags">
382
- <p class="tag_title">Parameters:</p>
383
- <ul class="param">
384
-
385
- <li>
386
-
387
- <span class='name'>hash</span>
388
-
389
-
390
- <span class='type'>(<tt>Hash</tt>)</span>
391
-
392
-
393
-
394
- &mdash;
395
- <div class='inline'>
396
- <p>particular message contents separated into hash.</p>
397
- </div>
398
-
399
- </li>
400
-
401
- </ul>
402
-
403
-
404
-
405
-
406
- <p class="tag_title">Options Hash (<tt>hash</tt>):</p>
407
- <ul class="option">
408
-
409
- <li>
410
- <span class="name">:serial_number</span>
411
- <span class="type">(<tt>String</tt>)</span>
412
- <span class="default">
413
-
414
- </span>
415
-
416
- &mdash; <div class='inline'>
417
- <p>if not specified, it is set to universal value. It is used for broadcast
418
- messages.</p>
419
- </div>
420
-
421
- </li>
422
-
423
- </ul>
424
-
425
-
426
- <p class="tag_title">Returns:</p>
427
- <ul class="return">
428
-
429
- <li>
430
-
431
-
432
- <span class='type'>(<tt>String</tt>)</span>
433
-
434
-
435
-
436
- &mdash;
437
- <div class='inline'>
438
- <p>output message.</p>
439
- </div>
440
-
441
- </li>
442
-
443
- </ul>
444
-
445
- </div><table class="source_code">
446
- <tr>
447
- <td>
448
- <pre class="lines">
449
-
450
-
451
- 28
452
- 29
453
- 30
454
- 31
455
- 32
456
- 33</pre>
457
- </td>
458
- <td>
459
- <pre class="code"><span class="info file"># File 'lib/maxcube/messages/udp/serializer.rb', line 28</span>
460
-
461
- <span class='kw'>def</span> <span class='id identifier rubyid_serialize_udp_hash'>serialize_udp_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
462
- <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>
463
- <span class='id identifier rubyid_serial_number'>serial_number</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:serial_number</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>*</span><span class='tstring_end'>&#39;</span></span> <span class='op'>*</span> <span class='int'>10</span>
464
- <span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#MSG_PREFIX-constant" title="MaxCube::Messages::UDP::Serializer::MSG_PREFIX (constant)">MSG_PREFIX</a></span></span> <span class='op'>+</span> <span class='id identifier rubyid_serial_number'>serial_number</span> <span class='op'>&lt;&lt;</span> <span class='ivar'>@msg_type</span>
465
- <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>
466
- <span class='kw'>end</span></pre>
467
- </td>
468
- </tr>
469
- </table>
470
- </div>
471
-
472
- </div>
473
-
474
- </div>
475
-
476
- <div id="footer">
477
- Generated on Fri Feb 16 13:44:02 2018 by
478
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
479
- 0.9.12 (ruby-2.5.0).
480
- </div>
481
-
482
- </div>
483
- </body>
484
- </html>