diff options
Diffstat (limited to 'documentation/4.1/api/akka/serial/index.html')
| -rw-r--r-- | documentation/4.1/api/akka/serial/index.html | 486 |
1 files changed, 486 insertions, 0 deletions
diff --git a/documentation/4.1/api/akka/serial/index.html b/documentation/4.1/api/akka/serial/index.html new file mode 100644 index 0000000..d4128f7 --- /dev/null +++ b/documentation/4.1/api/akka/serial/index.html @@ -0,0 +1,486 @@ +<!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> |