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,460 @@
|
|
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::Serializer
|
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::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> »
|
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">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::TCP::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::TCP::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::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/serializer.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/l.rb,<br /> lib/maxcube/messages/tcp/type/m.rb,<br /> lib/maxcube/messages/tcp/type/n.rb,<br /> lib/maxcube/messages/tcp/type/q.rb,<br /> lib/maxcube/messages/tcp/type/s.rb,<br /> lib/maxcube/messages/tcp/type/t.rb,<br /> lib/maxcube/messages/tcp/type/u.rb,<br /> lib/maxcube/messages/tcp/type/z.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="../Serializer.html" title="MaxCube::Messages::Serializer (module)">Serializer</a></span> and <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::TCP::Handler (module)">Handler</a></span> of routines connected to
|
113
|
+
TCP Cube messages serializing.</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="Serializer/MessageA.html" title="MaxCube::Messages::TCP::Serializer::MessageA (module)">MessageA</a></span>, <span class='object_link'><a href="Serializer/MessageC.html" title="MaxCube::Messages::TCP::Serializer::MessageC (module)">MessageC</a></span>, <span class='object_link'><a href="Serializer/MessageF.html" title="MaxCube::Messages::TCP::Serializer::MessageF (module)">MessageF</a></span>, <span class='object_link'><a href="Serializer/MessageL.html" title="MaxCube::Messages::TCP::Serializer::MessageL (module)">MessageL</a></span>, <span class='object_link'><a href="Serializer/MessageM.html" title="MaxCube::Messages::TCP::Serializer::MessageM (module)">MessageM</a></span>, <span class='object_link'><a href="Serializer/MessageN.html" title="MaxCube::Messages::TCP::Serializer::MessageN (module)">MessageN</a></span>, <span class='object_link'><a href="Serializer/MessageQ.html" title="MaxCube::Messages::TCP::Serializer::MessageQ (module)">MessageQ</a></span>, <span class='object_link'><a href="Serializer/MessageS.html" title="MaxCube::Messages::TCP::Serializer::MessageS (module)">MessageS</a></span>, <span class='object_link'><a href="Serializer/MessageT.html" title="MaxCube::Messages::TCP::Serializer::MessageT (module)">MessageT</a></span>, <span class='object_link'><a href="Serializer/MessageU.html" title="MaxCube::Messages::TCP::Serializer::MessageU (module)">MessageU</a></span>, <span class='object_link'><a href="Serializer/MessageZ.html" title="MaxCube::Messages::TCP::Serializer::MessageZ (module)">MessageZ</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 client -> Cube.</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'>u</span><span class='words_sep'> </span><span class='tstring_content'>i</span><span class='words_sep'> </span><span class='tstring_content'>s</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'>x</span><span class='words_sep'> </span><span class='tstring_content'>g</span><span class='words_sep'> </span><span class='tstring_content'>q</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'>a</span><span class='words_sep'> </span><span class='tstring_content'>r</span><span class='words_sep'> </span><span class='tstring_content'>t</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'>v</span><span class='words_sep'> </span><span class='tstring_content'>f</span><span class='words_sep'> </span><span class='tstring_content'>z</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="#serialize_tcp_hash-instance_method" title="#serialize_tcp_hash (instance method)">#<strong>serialize_tcp_hash</strong>(hash) ⇒ String </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>Serializes data from a single hash into TCP Cube message with <tt>\r\n</tt> at the
|
198
|
+
end.</p>
|
199
|
+
</div></span>
|
200
|
+
|
201
|
+
</li>
|
202
|
+
|
203
|
+
|
204
|
+
<li class="public ">
|
205
|
+
<span class="summary_signature">
|
206
|
+
|
207
|
+
<a href="#serialize_tcp_hashes-instance_method" title="#serialize_tcp_hashes (instance method)">#<strong>serialize_tcp_hashes</strong>(hashes) ⇒ String </a>
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
</span>
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<span class="summary_desc"><div class='inline'>
|
222
|
+
<p>Generates set of messages separated by <tt>\r\n</tt>.</p>
|
223
|
+
</div></span>
|
224
|
+
|
225
|
+
</li>
|
226
|
+
|
227
|
+
|
228
|
+
</ul>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Serializer.html" title="MaxCube::Messages::Serializer (module)">Serializer</a></span></h3>
|
241
|
+
<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>
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Handler.html" title="MaxCube::Messages::Handler (module)">Handler</a></span></h3>
|
252
|
+
<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>
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../Messages.html" title="MaxCube::Messages (module)">MaxCube::Messages</a></span></h3>
|
263
|
+
<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>
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Handler.html" title="MaxCube::Messages::TCP::Handler (module)">Handler</a></span></h3>
|
274
|
+
<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>
|
275
|
+
|
276
|
+
|
277
|
+
<div id="instance_method_details" class="method_details_list">
|
278
|
+
<h2>Instance Method Details</h2>
|
279
|
+
|
280
|
+
|
281
|
+
<div class="method_details first">
|
282
|
+
<h3 class="signature first" id="serialize_tcp_hash-instance_method">
|
283
|
+
|
284
|
+
#<strong>serialize_tcp_hash</strong>(hash) ⇒ <tt>String</tt>
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
</h3><div class="docstring">
|
291
|
+
<div class="discussion">
|
292
|
+
|
293
|
+
<p>Serializes data from a single hash into TCP Cube message with <tt>\r\n</tt> at the
|
294
|
+
end. Subsequently calls <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>, <span class='object_link'><a href="../Serializer.html#serialize_hash_body-instance_method" title="MaxCube::Messages::Serializer#serialize_hash_body (method)">Serializer#serialize_hash_body</a></span> and
|
295
|
+
<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>.</p>
|
296
|
+
|
297
|
+
|
298
|
+
</div>
|
299
|
+
</div>
|
300
|
+
<div class="tags">
|
301
|
+
<p class="tag_title">Parameters:</p>
|
302
|
+
<ul class="param">
|
303
|
+
|
304
|
+
<li>
|
305
|
+
|
306
|
+
<span class='name'>hash</span>
|
307
|
+
|
308
|
+
|
309
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
—
|
314
|
+
<div class='inline'>
|
315
|
+
<p>particular message contents separated into hash.</p>
|
316
|
+
</div>
|
317
|
+
|
318
|
+
</li>
|
319
|
+
|
320
|
+
</ul>
|
321
|
+
|
322
|
+
<p class="tag_title">Returns:</p>
|
323
|
+
<ul class="return">
|
324
|
+
|
325
|
+
<li>
|
326
|
+
|
327
|
+
|
328
|
+
<span class='type'>(<tt>String</tt>)</span>
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
—
|
333
|
+
<div class='inline'>
|
334
|
+
<p>output message (with <tt>\r\n</tt>).</p>
|
335
|
+
</div>
|
336
|
+
|
337
|
+
</li>
|
338
|
+
|
339
|
+
</ul>
|
340
|
+
|
341
|
+
</div><table class="source_code">
|
342
|
+
<tr>
|
343
|
+
<td>
|
344
|
+
<pre class="lines">
|
345
|
+
|
346
|
+
|
347
|
+
38
|
348
|
+
39
|
349
|
+
40
|
350
|
+
41
|
351
|
+
42</pre>
|
352
|
+
</td>
|
353
|
+
<td>
|
354
|
+
<pre class="code"><span class="info file"># File 'lib/maxcube/messages/tcp/serializer.rb', line 38</span>
|
355
|
+
|
356
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_serialize_tcp_hash'>serialize_tcp_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
|
357
|
+
<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>
|
358
|
+
<span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@msg_type</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='tstring_end'>"</span></span> <span class='op'><<</span> <span class='id identifier rubyid_serialize_hash_body'>serialize_hash_body</span><span class='lparen'>(</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>
|
359
|
+
<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> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>"</span></span>
|
360
|
+
<span class='kw'>end</span></pre>
|
361
|
+
</td>
|
362
|
+
</tr>
|
363
|
+
</table>
|
364
|
+
</div>
|
365
|
+
|
366
|
+
<div class="method_details ">
|
367
|
+
<h3 class="signature " id="serialize_tcp_hashes-instance_method">
|
368
|
+
|
369
|
+
#<strong>serialize_tcp_hashes</strong>(hashes) ⇒ <tt>String</tt>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
</h3><div class="docstring">
|
376
|
+
<div class="discussion">
|
377
|
+
|
378
|
+
<p>Generates set of messages separated by <tt>\r\n</tt>. Calls <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
|
379
|
+
maps <span class='object_link'><a href="#serialize_tcp_hash-instance_method" title="MaxCube::Messages::TCP::Serializer#serialize_tcp_hash (method)">#serialize_tcp_hash</a></span> on each hash.</p>
|
380
|
+
|
381
|
+
|
382
|
+
</div>
|
383
|
+
</div>
|
384
|
+
<div class="tags">
|
385
|
+
<p class="tag_title">Parameters:</p>
|
386
|
+
<ul class="param">
|
387
|
+
|
388
|
+
<li>
|
389
|
+
|
390
|
+
<span class='name'>hashes</span>
|
391
|
+
|
392
|
+
|
393
|
+
<span class='type'>(<tt>Array<Hash></tt>)</span>
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
—
|
398
|
+
<div class='inline'>
|
399
|
+
<p>particular message contents.</p>
|
400
|
+
</div>
|
401
|
+
|
402
|
+
</li>
|
403
|
+
|
404
|
+
</ul>
|
405
|
+
|
406
|
+
<p class="tag_title">Returns:</p>
|
407
|
+
<ul class="return">
|
408
|
+
|
409
|
+
<li>
|
410
|
+
|
411
|
+
|
412
|
+
<span class='type'>(<tt>String</tt>)</span>
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
—
|
417
|
+
<div class='inline'>
|
418
|
+
<p>raw data for a Cube.</p>
|
419
|
+
</div>
|
420
|
+
|
421
|
+
</li>
|
422
|
+
|
423
|
+
</ul>
|
424
|
+
|
425
|
+
</div><table class="source_code">
|
426
|
+
<tr>
|
427
|
+
<td>
|
428
|
+
<pre class="lines">
|
429
|
+
|
430
|
+
|
431
|
+
26
|
432
|
+
27
|
433
|
+
28
|
434
|
+
29</pre>
|
435
|
+
</td>
|
436
|
+
<td>
|
437
|
+
<pre class="code"><span class="info file"># File 'lib/maxcube/messages/tcp/serializer.rb', line 26</span>
|
438
|
+
|
439
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_serialize_tcp_hashes'>serialize_tcp_hashes</span><span class='lparen'>(</span><span class='id identifier rubyid_hashes'>hashes</span><span class='rparen'>)</span>
|
440
|
+
<span class='id identifier rubyid_raw_data'>raw_data</span> <span class='op'>=</span> <span class='id identifier rubyid_hashes'>hashes</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'>:serialize_tcp_hash</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
|
441
|
+
<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>
|
442
|
+
<span class='kw'>end</span></pre>
|
443
|
+
</td>
|
444
|
+
</tr>
|
445
|
+
</table>
|
446
|
+
</div>
|
447
|
+
|
448
|
+
</div>
|
449
|
+
|
450
|
+
</div>
|
451
|
+
|
452
|
+
<div id="footer">
|
453
|
+
Generated on Fri Feb 16 13:44:02 2018 by
|
454
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
455
|
+
0.9.12 (ruby-2.5.0).
|
456
|
+
</div>
|
457
|
+
|
458
|
+
</div>
|
459
|
+
</body>
|
460
|
+
</html>
|