diff options
Diffstat (limited to 'documentation/4.1/api/akka/serial/stream/Serial.html')
| -rw-r--r-- | documentation/4.1/api/akka/serial/stream/Serial.html | 660 |
1 files changed, 660 insertions, 0 deletions
diff --git a/documentation/4.1/api/akka/serial/stream/Serial.html b/documentation/4.1/api/akka/serial/stream/Serial.html new file mode 100644 index 0000000..329c698 --- /dev/null +++ b/documentation/4.1/api/akka/serial/stream/Serial.html @@ -0,0 +1,660 @@ +<!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 " 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"> + <a title="" href="../index.html"> + <span class="name">serial</span> + </a> + </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="yes" 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="index.html"> + <span class="name">stream</span> + </a> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../index.html" class="extype" name="akka.serial">serial</a></dd></dl></div> + </li><li class="current-entities indented3"> + <a class="object" href="Serial$.html" title=""></a> + <a class="class" href="" title="Entry point to streaming over serial ports."></a> + <a href="" title="Entry point to streaming over serial ports."> + Serial + </a> + </li><li class="current-entities indented3"> + <span class="separator"></span> + <a class="class" href="StreamSerialException.html" title="Represents a generic exception occured during streaming of serial data."></a> + <a href="StreamSerialException.html" title="Represents a generic exception occured during streaming of serial data."> + StreamSerialException + </a> + </li><li class="current-entities indented3"> + <span class="separator"></span> + <a class="class" href="StreamWatcherException.html" title=""></a> + <a href="StreamWatcherException.html" title=""> + StreamWatcherException + </a> + </li> + </ul> + </div> + </div> + <div id="content"> + <body class="class type"> + <div id="definition"> + <a href="Serial$.html" title="See companion object"><div class="big-circle class-companion-object">c</div></a> + <p id="owner"><a href="../../index.html" class="extype" name="akka">akka</a>.<a href="../index.html" class="extype" name="akka.serial">serial</a>.<a href="index.html" class="extype" name="akka.serial.stream">stream</a></p> + <h1><a href="Serial$.html" title="See companion object">Serial</a><span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html" title="Permalink"> + <i class="material-icons"></i> + </a> + </span></h1> + <h3><span class="morelinks"><div> + Companion <a href="Serial$.html" title="See companion object">object Serial</a> + </div></span></h3> + </div> + + <h4 id="signature" class="signature"> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">class</span> + </span> + <span class="symbol"> + <span class="name">Serial</span><span class="result"> extends <span class="extype" name="akka.actor.Extension">Extension</span></span> + </span> + </h4> + + + <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Entry point to streaming over serial ports. +The design of this API is inspired by Akka's Tcp streams. +</p></div><div class="toggleContainer block"> + <span class="toggle"> + Linear Supertypes + </span> + <div class="superTypes hiddenContent"><span class="extype" name="akka.actor.Extension">Extension</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> + </div></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> + <li class="inherit out"><span>By Inheritance</span></li> + </ol> + </div> + <div class="ancestors"> + <span class="filtertype">Inherited<br /> + </span> + <ol id="linearization"> + <li class="in" name="akka.serial.stream.Serial"><span>Serial</span></li><li class="in" name="akka.actor.Extension"><span>Extension</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> + </ol> + </div><div class="ancestors"> + <span class="filtertype"></span> + <ol> + <li class="hideall out"><span>Hide All</span></li> + <li class="showall in"><span>Show All</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="constructors" class="members"> + <h3>Instance Constructors</h3> + <ol><li name="akka.serial.stream.Serial#<init>" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="<init>(system:akka.actor.ExtendedActorSystem):akka.serial.stream.Serial"></a><a id="<init>:Serial"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#<init>(system:akka.actor.ExtendedActorSystem):akka.serial.stream.Serial" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">new</span> + </span> + <span class="symbol"> + <span class="name">Serial</span><span class="params">(<span name="system">system: <span class="extype" name="akka.actor.ExtendedActorSystem">ExtendedActorSystem</span></span>)</span> + </span> + + + </li></ol> + </div> + + + + + + <div class="values members"> + <h3>Value Members</h3> + <ol> + <li name="scala.AnyRef#!=" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#!=(x$1:Any):Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.AnyRef###" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="##():Int"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html###():Int" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.AnyRef#==" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#==(x$1:Any):Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.Any#asInstanceOf" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="asInstanceOf[T0]:T0"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#asInstanceOf[T0]:T0" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> + </li><li name="scala.AnyRef#clone" visbl="prt" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="clone():Object"></a><a id="clone():AnyRef"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#clone():Object" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> + <span class="name">@throws</span><span class="args">(<span> + + <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span> + </span>)</span> + + </dd></dl></div> + </li><li name="scala.AnyRef#eq" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#eq(x$1:AnyRef):Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="scala.AnyRef#equals" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="equals(x$1:Any):Boolean"></a><a id="equals(Any):Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#equals(x$1:Any):Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.AnyRef#finalize" visbl="prt" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="finalize():Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#finalize():Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> + <span class="name">@throws</span><span class="args">(<span> + + <span class="symbol">classOf[java.lang.Throwable]</span> + </span>)</span> + + </dd></dl></div> + </li><li name="scala.AnyRef#getClass" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="getClass():Class[_]"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#getClass():Class[_]" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.AnyRef#hashCode" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="hashCode():Int"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#hashCode():Int" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.Any#isInstanceOf" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="isInstanceOf[T0]:Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#isInstanceOf[T0]:Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> + </li><li name="scala.AnyRef#ne" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#ne(x$1:AnyRef):Boolean" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="scala.AnyRef#notify" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="notify():Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#notify():Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="scala.AnyRef#notifyAll" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="notifyAll():Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#notifyAll():Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="akka.serial.stream.Serial#open" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="open(port:String,settings:akka.serial.SerialSettings,failOnOverflow:Boolean,bufferSize:Int):akka.stream.scaladsl.Flow[akka.util.ByteString,akka.util.ByteString,scala.concurrent.Future[akka.serial.stream.Serial.Connection]]"></a><a id="open(String,SerialSettings,Boolean,Int):Flow[ByteString,ByteString,Future[Connection]]"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#open(port:String,settings:akka.serial.SerialSettings,failOnOverflow:Boolean,bufferSize:Int):akka.stream.scaladsl.Flow[akka.util.ByteString,akka.util.ByteString,scala.concurrent.Future[akka.serial.stream.Serial.Connection]]" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">open</span><span class="params">(<span name="port">port: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="settings">settings: <a href="../SerialSettings.html" class="extype" name="akka.serial.SerialSettings">SerialSettings</a></span>, <span name="failOnOverflow">failOnOverflow: <span class="extype" name="scala.Boolean">Boolean</span> = <span class="symbol">false</span></span>, <span name="bufferSize">bufferSize: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">1024</span></span>)</span><span class="result">: <span class="extype" name="akka.stream.scaladsl.Flow">Flow</span>[<span class="extype" name="akka.util.ByteString">ByteString</span>, <span class="extype" name="akka.util.ByteString">ByteString</span>, <span class="extype" name="scala.concurrent.Future">Future</span>[<a href="Serial$$Connection.html" class="extype" name="akka.serial.stream.Serial.Connection">Connection</a>]]</span> + </span> + + <p class="shortcomment cmt">Creates a Flow that will open a serial port when materialized.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a Flow that will open a serial port when materialized. +This Flow then represents an open serial connection: data pushed to its +inlet will be written to the underlying serial port, and data received +on the port will be emitted by its outlet.</p></div><dl class="paramcmts block"><dt class="param">port</dt><dd class="cmt"><p>name of serial port to open</p></dd><dt class="param">settings</dt><dd class="cmt"><p>settings to use with serial port</p></dd><dt class="param">failOnOverflow</dt><dd class="cmt"><p>when set, the returned Flow will fail when incoming data is dropped</p></dd><dt class="param">bufferSize</dt><dd class="cmt"><p>maximum read and write buffer sizes</p></dd><dt>returns</dt><dd class="cmt"><p>a Flow associated to the given serial port</p></dd></dl></div> + </li><li name="scala.AnyRef#synchronized" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](⇒T0):T0"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#synchronized[T0](x$1:=>T0):T0" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> + </li><li name="scala.AnyRef#toString" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="toString():String"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#toString():String" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> + </li><li name="scala.AnyRef#wait" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="wait():Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#wait():Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> + <span class="name">@throws</span><span class="args">(<span> + + <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> + </span>)</span> + + </dd></dl></div> + </li><li name="scala.AnyRef#wait" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> + <span class="name">@throws</span><span class="args">(<span> + + <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> + </span>)</span> + + </dd></dl></div> + </li><li name="scala.AnyRef#wait" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> + <a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#wait(x$1:Long):Unit" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier">final </span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> + </span> + + <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> + <span class="name">@throws</span><span class="args">(<span> + + <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> + </span>)</span> + + </dd></dl></div> + </li><li name="akka.serial.stream.Serial#watch" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped"> + <a id="watch(ports:Set[String]):akka.stream.scaladsl.Source[String,scala.concurrent.Future[akka.serial.stream.Serial.Watch]]"></a><a id="watch(Set[String]):Source[String,Future[Watch]]"></a> + <span class="permalink"> + <a href="../../../akka/serial/stream/Serial.html#watch(ports:Set[String]):akka.stream.scaladsl.Source[String,scala.concurrent.Future[akka.serial.stream.Serial.Watch]]" title="Permalink"> + <i class="material-icons"></i> + </a> + </span> + <span class="modifier_kind"> + <span class="modifier"></span> + <span class="kind">def</span> + </span> + <span class="symbol"> + <span class="name">watch</span><span class="params">(<span name="ports">ports: <span class="extype" name="scala.Predef.Set">Set</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>)</span><span class="result">: <span class="extype" name="akka.stream.scaladsl.Source">Source</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.concurrent.Future">Future</span>[<a href="Serial$$Watch.html" class="extype" name="akka.serial.stream.Serial.Watch">Watch</a>]]</span> + </span> + + + </li> + </ol> + </div> + + + + + </div> + + <div id="inheritedMembers"> + <div class="parent" name="akka.actor.Extension"> + <h3>Inherited from <span class="extype" name="akka.actor.Extension">Extension</span></h3> + </div><div class="parent" name="scala.AnyRef"> + <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3> + </div><div class="parent" name="scala.Any"> + <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3> + </div> + + </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> |