diff options
Diffstat (limited to 'latest/api/com/github/jodersky/flow/package.html')
| -rw-r--r-- | latest/api/com/github/jodersky/flow/package.html | 377 |
1 files changed, 377 insertions, 0 deletions
diff --git a/latest/api/com/github/jodersky/flow/package.html b/latest/api/com/github/jodersky/flow/package.html new file mode 100644 index 0000000..bfaa29e --- /dev/null +++ b/latest/api/com/github/jodersky/flow/package.html @@ -0,0 +1,377 @@ +<!DOCTYPE html > +<html> + <head> + <title>flow - com.github.jodersky.flow</title> + <meta name="description" content="flow - com.github.jodersky.flow" /> + <meta name="keywords" content="flow com.github.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" src="../../../../lib/modernizr.custom.js"></script><script type="text/javascript" src="../../../../lib/diagrams.js" id="diagrams-js"></script> + <script type="text/javascript"> + if(top === self) { + var url = '../../../../index.html'; + var hash = 'com.github.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="com">com</a>.<a href="../../package.html" class="extype" name="com.github">github</a>.<a href="../package.html" class="extype" name="com.github.jodersky">jodersky</a></p> + <h1>flow</h1><span class="permalink"> + <a href="../../../../index.html#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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#com.github.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="com.github.jodersky.flow.SerialManager" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="SerialManagerextendsActorwithActorLogging"></a> + <a id="SerialManager:SerialManager"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <a href="SerialManager.html"><span class="name">SerialManager</span></a><span class="result"> extends <span class="extype" name="akka.actor.Actor">Actor</span> with <span class="extype" name="akka.actor.ActorLogging">ActorLogging</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.jodersky.flow.package@SerialManagerextendsActorwithActorLogging" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">Entry point to the serial API.</p><div class="fullcomment"><div class="comment cmt"><p>Entry point to the serial API. Actor that manages serial port creation. Once opened, a serial port is handed over to +a dedicated operator actor that acts as an intermediate between client code and the native system serial port.</p></div><dl class="attributes block"> <dt>See also</dt><dd><span class="cmt"><p>SerialOperator</p></span></dd></dl></div> + </li><li name="com.github.jodersky.flow.SerialOperator" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="SerialOperatorextendsActorwithActorLogging"></a> + <a id="SerialOperator:SerialOperator"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <a href="SerialOperator.html"><span class="name">SerialOperator</span></a><span class="result"> extends <span class="extype" name="akka.actor.Actor">Actor</span> with <span class="extype" name="akka.actor.ActorLogging">ActorLogging</span></span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.jodersky.flow.package@SerialOperatorextendsActorwithActorLogging" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + <p class="shortcomment cmt">Operator associated to an open serial port.</p><div class="fullcomment"><div class="comment cmt"><p>Operator associated to an open serial port. All communication with a port is done via an operator. Operators are created though the serial manager.</p></div><dl class="attributes block"> <dt>See also</dt><dd><span class="cmt"><p>SerialManager</p></span></dd></dl></div> + </li><li name="com.github.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=com.github.jodersky.flow.Parity.Value" class="extmbr" name="com.github.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#com.github.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="com.github.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#com.github.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="com.github.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="com.github.jodersky.flow.SerialExt">SerialExt</a>]</span> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.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="com.github.jodersky.flow.SerialManager" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="SerialManager"></a> + <a id="SerialManager:SerialManager"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">object</span> + </span> + <span class="symbol"> + <a href="SerialManager$.html"><span class="name">SerialManager</span></a> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.jodersky.flow.package@SerialManager" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + + </li><li name="com.github.jodersky.flow.SerialOperator" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="SerialOperator"></a> + <a id="SerialOperator:SerialOperator"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">object</span> + </span> + <span class="symbol"> + <a href="SerialOperator$.html"><span class="name">SerialOperator</span></a> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.jodersky.flow.package@SerialOperator" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + + </li><li name="com.github.jodersky.flow.internal" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="internal"></a> + <a id="internal:internal"></a> + <h4 class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">package</span> + </span> + <span class="symbol"> + <a href="internal/package.html"><span class="name">internal</span></a> + </span> + </h4><span class="permalink"> + <a href="../../../../index.html#com.github.jodersky.flow.package@internal" title="Permalink" target="_top"> + <img src="../../../../lib/permalink.png" alt="Permalink" /> + </a> + </span> + + </li><li name="com.github.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#com.github.jodersky.flow.package@samples" 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> |