blob: 17dd1a803b13520799ddf7e38227ea7c2b510510 (
plain) (
blame)
1
2
|
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><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/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 class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><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 href="../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.akka" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><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 href="../index.html" title=""><span class="name">akka</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 current" name="akka.serial" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><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" name="akka" id="akka" class="extype">akka</a></dd></dl></div></li><li class="indented3 " name="akka.serial.stream" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="stream/index.html" title=""><span class="name">stream</span></a></span></li><li class="indented3 " name="akka.serial.sync" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="sync/index.html" title=""><span class="name">sync</span></a></span></li><li class="current-entities indented2"><span class="separator"></span> <a href="AccessDeniedException.html" title="Permissions are not sufficient to open a serial port." class="class"></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 href="InvalidSettingsException.html" title="The settings specified are invalid." class="class"></a><a href="InvalidSettingsException.html" title="The settings specified are invalid.">InvalidSettingsException</a></li><li class="current-entities indented2"><span class="separator"></span> <a href="NoSuchPortException.html" title="The requested port could not be found." class="class"></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 href="Parity$.html" title="Specifies available parities used in serial communication." class="object"></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 href="PortClosedException.html" title="The specified port has been closed." class="class"></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 href="PortInUseException.html" title="The requested port is in use by someone else." class="class"></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 href="PortInterruptedException.html" title="A blocking operation on a port was interrupted, most likely indicating that the port is closing." class="class"></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 href="Serial$.html" title="Defines messages used by akka-serial's serial IO layer." class="object"></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 href="SerialExt.html" title="Provides the serial IO manager." class="class"></a><a href="SerialExt.html" title="Provides the serial IO manager.">SerialExt</a></li><li class="current-entities indented2"><span class="separator"></span> <a href="SerialSettings.html" title="Groups settings used in communication over a serial port." class="class"></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" name="akka" id="akka" class="extype">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 placeholder="Filter all members" id="mbrsel-input" 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="packages" class="package members"><h3>Package Members</h3><ol><li class="indented0 " name="akka.serial.stream" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="stream/index.html" title=""><span class="name">stream</span></a></span></li><li class="indented0 " name="akka.serial.sync" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="sync/index.html" title=""><span class="name">sync</span></a></span></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="akka.serial.AccessDeniedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="AccessDeniedException.html" title="Permissions are not sufficient to open a serial port."><span class="name">AccessDeniedException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span><p class="shortcomment cmt">Permissions are not sufficient to open a serial port.</p></li><li class="indented0 " name="akka.serial.InvalidSettingsException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="InvalidSettingsException.html" title="The settings specified are invalid."><span class="name">InvalidSettingsException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span><p class="shortcomment cmt">The settings specified are invalid.</p></li><li class="indented0 " name="akka.serial.NoSuchPortException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="NoSuchPortException.html" title="The requested port could not be found."><span class="name">NoSuchPortException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span><p class="shortcomment cmt">The requested port could not be found.</p></li><li class="indented0 " name="akka.serial.PortClosedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="PortClosedException.html" title="The specified port has been closed."><span class="name">PortClosedException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span><p class="shortcomment cmt">The specified port has been closed.</p></li><li class="indented0 " name="akka.serial.PortInUseException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="PortInUseException.html" title="The requested port is in use by someone else."><span class="name">PortInUseException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">Exception</span></span></span><p class="shortcomment cmt">The requested port is in use by someone else.</p></li><li class="indented0 " name="akka.serial.PortInterruptedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="PortInterruptedException.html" title="A blocking operation on a port was interrupted, most likely indicating that the port is closing."><span class="name">PortInterruptedException</span></a><span class="result"> extends <span name="scala.Exception" class="extype">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 class="indented0 " name="akka.serial.SerialExt" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="SerialExt.html" title="Provides the serial IO manager."><span class="name">SerialExt</span></a><span class="result"> extends <span name="akka.io.IO.Extension" class="extype">Extension</span></span></span><p class="shortcomment cmt">Provides the serial IO manager.</p></li><li class="indented0 " name="akka.serial.SerialSettings" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><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 href="SerialSettings.html" title="Groups settings used in communication over a serial port."><span class="name">SerialSettings</span></a><span class="params">(<span name="baud">baud: <span name="scala.Int" class="extype">Int</span></span>, <span name="characterSize">characterSize: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">8</span></span>, <span name="twoStopBits">twoStopBits: <span name="scala.Boolean" class="extype">Boolean</span> = <span class="symbol">false</span></span>, <span name="parity">parity: <a href="Parity$.html#Parity=akka.serial.Parity.Value" name="akka.serial.Parity.Parity" id="akka.serial.Parity.Parity" class="extmbr">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 name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">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 class="indented0 " name="akka.serial.Parity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="Parity$.html" title="Specifies available parities used in serial communication."><span class="name">Parity</span></a><span class="result"> extends <span name="scala.Enumeration" class="extype">Enumeration</span></span></span><p class="shortcomment cmt">Specifies available parities used in serial communication.</p></li><li class="indented0 " name="akka.serial.Serial" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><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 href="Serial$.html" title="Defines messages used by akka-serial's serial IO layer."><span class="name">Serial</span></a><span class="result"> extends <span name="akka.actor.ExtensionId" class="extype">ExtensionId</span>[<a href="SerialExt.html" name="akka.serial.SerialExt" id="akka.serial.SerialExt" class="extype">SerialExt</a>] with <span name="akka.actor.ExtensionIdProvider" class="extype">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 name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|
