blob: 45fdf6593bba4121d993a5eddf3b2a195c7ee823 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
<!DOCTYPE html >
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
<title></title>
<meta name="description" content="" />
<meta name="keywords" content="" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../lib/index.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../lib/jquery.js"></script>
<script type="text/javascript" src="../../lib/jquery.panzoom.min.js"></script>
<script type="text/javascript" src="../../lib/jquery.mousewheel.min.js"></script>
<script type="text/javascript" src="../../lib/index.js"></script>
<script type="text/javascript" src="../../index.js"></script>
<script type="text/javascript" src="../../lib/scheduler.js"></script>
<script type="text/javascript" src="../../lib/template.js"></script>
<script type="text/javascript" src="../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../';
</script>
</head>
<body>
<div id="search">
<span id="doc-title"><span id="doc-version"></span></span>
<span class="close-results"><span class="left"><</span> Back</span>
<div id="textfilter">
<span class="input">
<input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/" />
<i class="clear material-icons"></i>
<i id="search-icon" class="material-icons"></i>
</span>
</div>
</div>
<div id="search-results">
<div id="search-progress">
<div id="progress-fill"></div>
</div>
<div id="results-content">
<div id="entity-results"></div>
<div id="member-results"></div>
</div>
</div>
<div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;">
<div id="content-container" style="-webkit-overflow-scrolling: touch;">
<div id="subpackage-spacer">
<div id="packages">
<h1>Packages</h1>
<ul>
<li name="_root_.root" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="_root_"></a><a id="root:_root_"></a>
<span class="permalink">
<a href="index.html#_root_" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a title="" href="../../index.html"><span class="name">root</span></a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../index.html" class="extype" name="_root_">root</a></dd></dl></div>
</li><li name="_root_.akka" visbl="pub" class="indented1 " data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="akka"></a><a id="akka:akka"></a>
<span class="permalink">
<a href="index.html#akka" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a title="" href="../index.html"><span class="name">akka</span></a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../../index.html" class="extype" name="_root_">root</a></dd></dl></div>
</li><li name="akka.serial" visbl="pub" class="indented2 current" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="serial"></a><a id="serial:serial"></a>
<span class="permalink">
<a href="../akka/index.html#serial" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<span class="name">serial</span>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../index.html" class="extype" name="akka">akka</a></dd></dl></div>
</li><li name="akka.serial.stream" visbl="pub" class="indented3 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="stream"></a><a id="stream:stream"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#stream" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a title="" href="stream/index.html"><span class="name">stream</span></a>
</span>
</li><li name="akka.serial.sync" visbl="pub" class="indented3 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="sync"></a><a id="sync:sync"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#sync" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a title="" href="sync/index.html"><span class="name">sync</span></a>
</span>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="AccessDeniedException.html" title="Permissions are not sufficient to open a serial port."></a>
<a href="AccessDeniedException.html" title="Permissions are not sufficient to open a serial port.">AccessDeniedException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="InvalidSettingsException.html" title="The settings specified are invalid."></a>
<a href="InvalidSettingsException.html" title="The settings specified are invalid.">InvalidSettingsException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="NoSuchPortException.html" title="The requested port could not be found."></a>
<a href="NoSuchPortException.html" title="The requested port could not be found.">NoSuchPortException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="object" href="Parity$.html" title="Specifies available parities used in serial communication."></a>
<a href="Parity$.html" title="Specifies available parities used in serial communication.">Parity</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="PortClosedException.html" title="The specified port has been closed."></a>
<a href="PortClosedException.html" title="The specified port has been closed.">PortClosedException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="PortInUseException.html" title="The requested port is in use by someone else."></a>
<a href="PortInUseException.html" title="The requested port is in use by someone else.">PortInUseException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="PortInterruptedException.html" title="A blocking operation on a port was interrupted, most likely indicating that the port is closing."></a>
<a href="PortInterruptedException.html" title="A blocking operation on a port was interrupted, most likely indicating that the port is closing.">PortInterruptedException</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="object" href="Serial$.html" title="Defines messages used by akka-serial's serial IO layer."></a>
<a href="Serial$.html" title="Defines messages used by akka-serial's serial IO layer.">Serial</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="SerialExt.html" title="Provides the serial IO manager."></a>
<a href="SerialExt.html" title="Provides the serial IO manager.">SerialExt</a>
</li><li class="current-entities indented2">
<span class="separator"></span>
<a class="class" href="SerialSettings.html" title="Groups settings used in communication over a serial port."></a>
<a href="SerialSettings.html" title="Groups settings used in communication over a serial port.">SerialSettings</a>
</li>
</ul>
</div>
</div>
<div id="content">
<body class="package value">
<div id="definition">
<div class="big-circle package">p</div>
<p id="owner"><a href="../index.html" class="extype" name="akka">akka</a></p>
<h1>serial<span class="permalink">
<a href="../../akka/serial/index.html" title="Permalink">
<i class="material-icons"></i>
</a>
</span></h1>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<span class="name">serial</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"></div>
<div id="mbrsel">
<div class="toggle"></div>
<div id="memberfilter">
<i class="material-icons arrow"></i>
<span class="input">
<input id="mbrsel-input" placeholder="Filter all members" type="text" accesskey="/" />
</span>
<i class="clear material-icons"></i>
</div>
<div id="filterby">
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
</ol>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="types" class="types members">
<h3>Type Members</h3>
<ol><li name="akka.serial.AccessDeniedException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="AccessDeniedExceptionextendsException"></a><a id="AccessDeniedException:AccessDeniedException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#AccessDeniedExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="Permissions are not sufficient to open a serial port." href="AccessDeniedException.html"><span class="name">AccessDeniedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">Permissions are not sufficient to open a serial port.</p>
</li><li name="akka.serial.InvalidSettingsException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="InvalidSettingsExceptionextendsException"></a><a id="InvalidSettingsException:InvalidSettingsException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#InvalidSettingsExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="The settings specified are invalid." href="InvalidSettingsException.html"><span class="name">InvalidSettingsException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">The settings specified are invalid.</p>
</li><li name="akka.serial.NoSuchPortException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="NoSuchPortExceptionextendsException"></a><a id="NoSuchPortException:NoSuchPortException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#NoSuchPortExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="The requested port could not be found." href="NoSuchPortException.html"><span class="name">NoSuchPortException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">The requested port could not be found.</p>
</li><li name="akka.serial.PortClosedException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortClosedExceptionextendsException"></a><a id="PortClosedException:PortClosedException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#PortClosedExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="The specified port has been closed." href="PortClosedException.html"><span class="name">PortClosedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">The specified port has been closed.</p>
</li><li name="akka.serial.PortInUseException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortInUseExceptionextendsException"></a><a id="PortInUseException:PortInUseException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#PortInUseExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="The requested port is in use by someone else." href="PortInUseException.html"><span class="name">PortInUseException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">The requested port is in use by someone else.</p>
</li><li name="akka.serial.PortInterruptedException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortInterruptedExceptionextendsException"></a><a id="PortInterruptedException:PortInterruptedException"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#PortInterruptedExceptionextendsException" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="A blocking operation on a port was interrupted, most likely indicating that the port is closing." href="PortInterruptedException.html"><span class="name">PortInterruptedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
<p class="shortcomment cmt">A blocking operation on a port was interrupted, most likely indicating that the port is closing.</p>
</li><li name="akka.serial.SerialExt" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="SerialExtextendsIO.Extension"></a><a id="SerialExt:SerialExt"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#SerialExtextendsIO.Extension" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a title="Provides the serial IO manager." href="SerialExt.html"><span class="name">SerialExt</span></a><span class="result"> extends <span class="extype" name="akka.io.IO.Extension">Extension</span></span>
</span>
<p class="shortcomment cmt">Provides the serial IO manager.</p>
</li><li name="akka.serial.SerialSettings" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="SerialSettingsextendsProductwithSerializable"></a><a id="SerialSettings:SerialSettings"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#SerialSettingsextendsProductwithSerializable" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a title="Groups settings used in communication over a serial port." href="SerialSettings.html"><span class="name">SerialSettings</span></a><span class="params">(<span name="baud">baud: <span class="extype" name="scala.Int">Int</span></span>, <span name="characterSize">characterSize: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">8</span></span>, <span name="twoStopBits">twoStopBits: <span class="extype" name="scala.Boolean">Boolean</span> = <span class="symbol">false</span></span>, <span name="parity">parity: <a href="Parity$.html#Parity=akka.serial.Parity.Value" class="extmbr" name="akka.serial.Parity.Parity">Parity.Parity</a> = <span class="symbol"><span class="name"><a href="Parity$.html">Parity.None</a></span></span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
<p class="shortcomment cmt">Groups settings used in communication over a serial port.</p><div class="fullcomment"><div class="comment cmt"><p>Groups settings used in communication over a serial port.</p></div><dl class="paramcmts block"><dt class="param">baud</dt><dd class="cmt"><p>baud rate to use with serial port</p></dd><dt class="param">characterSize</dt><dd class="cmt"><p>size of a character of the data sent through the serial port</p></dd><dt class="param">twoStopBits</dt><dd class="cmt"><p>set to use two stop bits instead of one</p></dd><dt class="param">parity</dt><dd class="cmt"><p>type of parity to use with serial port</p></dd></dl></div>
</li></ol>
</div>
<div class="values members">
<h3>Value Members</h3>
<ol>
<li name="akka.serial.Parity" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Parity"></a><a id="Parity:Parity"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#Parity" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a title="Specifies available parities used in serial communication." href="Parity$.html"><span class="name">Parity</span></a><span class="result"> extends <span class="extype" name="scala.Enumeration">Enumeration</span></span>
</span>
<p class="shortcomment cmt">Specifies available parities used in serial communication.</p>
</li><li name="akka.serial.Serial" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Serial"></a><a id="Serial:Serial"></a>
<span class="permalink">
<a href="../../akka/serial/index.html#Serial" title="Permalink">
<i class="material-icons"></i>
</a>
</span>
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a title="Defines messages used by akka-serial's serial IO layer." href="Serial$.html"><span class="name">Serial</span></a><span class="result"> extends <span class="extype" name="akka.actor.ExtensionId">ExtensionId</span>[<a href="SerialExt.html" class="extype" name="akka.serial.SerialExt">SerialExt</a>] with <span class="extype" name="akka.actor.ExtensionIdProvider">ExtensionIdProvider</span></span>
</span>
<p class="shortcomment cmt">Defines messages used by akka-serial's serial IO layer.</p>
</li>
</ol>
</div>
</div>
<div id="inheritedMembers">
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</div>
</div>
</div>
</body>
</html>
|
