blob: c700b6fb162644ad34843a2f93d269a189819c2a (
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
|
<!DOCTYPE html >
<html>
<head>
<title>flow - ch.jodersky.flow</title>
<meta name="description" content="flow - ch.jodersky.flow" />
<meta name="keywords" content="flow ch.jodersky.flow" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<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" id="jquery-js"></script>
<script type="text/javascript" src="../../../lib/jquery-ui.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">
if(top === self) {
var url = '../../../index.html';
var hash = 'ch.jodersky.flow.package';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="value">
<div id="definition">
<img alt="Package" src="../../../lib/package_big.png" />
<p id="owner"><a href="../../package.html" class="extype" name="ch">ch</a>.<a href="../package.html" class="extype" name="ch.jodersky">jodersky</a></p>
<h1>flow</h1><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</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">flow</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></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 id="template">
<div id="allMembers">
<div id="types" class="types members">
<h3>Type Members</h3>
<ol><li name="ch.jodersky.flow.AccessDeniedException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="AccessDeniedExceptionextendsException"></a>
<a id="AccessDeniedException:AccessDeniedException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="AccessDeniedException.html"><span class="name">AccessDeniedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@AccessDeniedExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Permissions are not sufficient to open a serial port.</p>
</li><li name="ch.jodersky.flow.InvalidSettingsException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="InvalidSettingsExceptionextendsException"></a>
<a id="InvalidSettingsException:InvalidSettingsException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="InvalidSettingsException.html"><span class="name">InvalidSettingsException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@InvalidSettingsExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">The settings specified are invalid.</p>
</li><li name="ch.jodersky.flow.NoSuchPortException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="NoSuchPortExceptionextendsException"></a>
<a id="NoSuchPortException:NoSuchPortException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="NoSuchPortException.html"><span class="name">NoSuchPortException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@NoSuchPortExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">The requested port could not be found.</p>
</li><li name="ch.jodersky.flow.PortClosedException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortClosedExceptionextendsException"></a>
<a id="PortClosedException:PortClosedException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PortClosedException.html"><span class="name">PortClosedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@PortClosedExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">The specified port has been closed.</p>
</li><li name="ch.jodersky.flow.PortInUseException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortInUseExceptionextendsException"></a>
<a id="PortInUseException:PortInUseException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PortInUseException.html"><span class="name">PortInUseException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@PortInUseExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">The requested port is in use by someone else.</p>
</li><li name="ch.jodersky.flow.PortInterruptedException" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="PortInterruptedExceptionextendsException"></a>
<a id="PortInterruptedException:PortInterruptedException"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="PortInterruptedException.html"><span class="name">PortInterruptedException</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@PortInterruptedExceptionextendsException" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</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="ch.jodersky.flow.SerialExt" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="SerialExtextendsIO.Extension"></a>
<a id="SerialExt:SerialExt"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a 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>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@SerialExtextendsIO.Extension" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Provides the serial IO manager.</p>
</li><li name="ch.jodersky.flow.SerialSettings" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="SerialSettingsextendsProductwithSerializable"></a>
<a id="SerialSettings:SerialSettings"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">case class</span>
</span>
<span class="symbol">
<a 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=ch.jodersky.flow.Parity.Value" class="extmbr" name="ch.jodersky.flow.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>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@SerialSettingsextendsProductwithSerializable" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</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 id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="ch.jodersky.flow.Parity" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Parity"></a>
<a id="Parity:Parity"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Parity$.html"><span class="name">Parity</span></a><span class="result"> extends <span class="extype" name="scala.Enumeration">Enumeration</span></span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@Parity" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Specifies available parities used in serial communication.</p>
</li><li name="ch.jodersky.flow.Serial" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="Serial"></a>
<a id="Serial:Serial"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="Serial$.html"><span class="name">Serial</span></a><span class="result"> extends <span class="extype" name="akka.actor.ExtensionKey">ExtensionKey</span>[<a href="SerialExt.html" class="extype" name="ch.jodersky.flow.SerialExt">SerialExt</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@Serial" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Defines messages used by flow's serial IO layer.</p>
</li><li name="ch.jodersky.flow.samples" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="samples"></a>
<a id="samples:samples"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a href="samples/package.html"><span class="name">samples</span></a>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@samples" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</li><li name="ch.jodersky.flow.stream" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="stream"></a>
<a id="stream:stream"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<a href="stream/package.html"><span class="name">stream</span></a>
</span>
</h4><span class="permalink">
<a href="../../../index.html#ch.jodersky.flow.package@stream" title="Permalink" target="_top">
<img src="../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</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>
</html>
|
