diff options
Diffstat (limited to 'documentation/4.1/api/akka/serial/stream/index.html')
| -rw-r--r-- | documentation/4.1/api/akka/serial/stream/index.html | 318 |
1 files changed, 3 insertions, 315 deletions
diff --git a/documentation/4.1/api/akka/serial/stream/index.html b/documentation/4.1/api/akka/serial/stream/index.html index cfd1473..9ac6921 100644 --- a/documentation/4.1/api/akka/serial/stream/index.html +++ b/documentation/4.1/api/akka/serial/stream/index.html @@ -1,316 +1,4 @@ -<!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 current" 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"> - <span class="name">stream</span> - </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="Serial.html" title="Entry point to streaming over serial ports."></a> - <a href="Serial.html" 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><li name="akka.serial.sync" visbl="pub" class="indented3 " data-isabs="false" fullComment="yes" 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> - - <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> - </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>.<a href="../index.html" class="extype" name="akka.serial">serial</a></p> - <h1>stream<span class="permalink"> - <a href="../../../akka/serial/stream/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">stream</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.stream.Serial" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped"> - <a id="SerialextendsExtension"></a><a id="Serial:Serial"></a> - <span class="permalink"> - <a href="../../../akka/serial/stream/index.html#SerialextendsExtension" 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="Entry point to streaming over serial ports." href="Serial.html"><span class="name">Serial</span></a><span class="result"> extends <span class="extype" name="akka.actor.Extension">Extension</span></span> - </span> - - <p class="shortcomment cmt">Entry point to streaming over serial ports.</p><div class="fullcomment"><div class="comment cmt"><p>Entry point to streaming over serial ports. +<!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 " 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"><a href="../index.html" title=""><span class="name">serial</span></a></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 current" name="akka.serial.stream" group="Ungrouped" fullComment="yes" 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"><span class="name">stream</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="akka.serial" id="akka.serial" class="extype">serial</a></dd></dl></div></li><li class="current-entities indented3"><a href="Serial$.html" title="" class="object"></a> <a href="Serial.html" title="Entry point to streaming over serial ports." class="class"></a><a href="Serial.html" title="Entry point to streaming over serial ports.">Serial</a></li><li class="current-entities indented3"><span class="separator"></span> <a href="StreamSerialException.html" title="Represents a generic exception occured during streaming of serial data." class="class"></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 href="StreamWatcherException.html" title="" class="class"></a><a href="StreamWatcherException.html" title="">StreamWatcherException</a></li><li class="indented3 " name="akka.serial.sync" group="Ungrouped" fullComment="yes" 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><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="akka.serial" id="akka.serial" class="extype">serial</a></dd></dl></div></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>.<a href="../index.html" name="akka.serial" id="akka.serial" class="extype">serial</a></p><h1>stream<span class="permalink"><a href="../../../akka/serial/stream/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">stream</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="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="akka.serial.stream.Serial" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SerialextendsExtension"></a><a id="Serial:Serial"></a> <span class="permalink"><a href="../../../akka/serial/stream/index.html#SerialextendsExtension" 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="Serial.html" title="Entry point to streaming over serial ports."><span class="name">Serial</span></a><span class="result"> extends <span name="akka.actor.Extension" class="extype">Extension</span></span></span><p class="shortcomment cmt">Entry point to streaming over serial ports.</p><div class="fullcomment"><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> - </li><li name="akka.serial.stream.StreamSerialException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="StreamSerialExceptionextendsRuntimeException"></a><a id="StreamSerialException:StreamSerialException"></a> - <span class="permalink"> - <a href="../../../akka/serial/stream/index.html#StreamSerialExceptionextendsRuntimeException" 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="Represents a generic exception occured during streaming of serial data." href="StreamSerialException.html"><span class="name">StreamSerialException</span></a><span class="result"> extends <span class="extype" name="scala.RuntimeException">RuntimeException</span></span> - </span> - - <p class="shortcomment cmt">Represents a generic exception occured during streaming of serial data.</p> - </li><li name="akka.serial.stream.StreamWatcherException" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped"> - <a id="StreamWatcherExceptionextendsRuntimeException"></a><a id="StreamWatcherException:StreamWatcherException"></a> - <span class="permalink"> - <a href="../../../akka/serial/stream/index.html#StreamWatcherExceptionextendsRuntimeException" 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="" href="StreamWatcherException.html"><span class="name">StreamWatcherException</span></a><span class="result"> extends <span class="extype" name="scala.RuntimeException">RuntimeException</span></span> - </span> - - - </li></ol> - </div> - - - - <div class="values members"> - <h3>Value Members</h3> - <ol> - <li name="akka.serial.stream.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/stream/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="" href="Serial$.html"><span class="name">Serial</span></a><span class="result"> extends <span class="extype" name="akka.actor.ExtensionId">ExtensionId</span>[<a href="Serial.html" class="extype" name="akka.serial.stream.Serial">Serial</a>] with <span class="extype" name="akka.actor.ExtensionIdProvider">ExtensionIdProvider</span></span> - </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> - </div> - </div> - </div> - </body> - </html> +</p></div></div></li><li class="indented0 " name="akka.serial.stream.StreamSerialException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="StreamSerialExceptionextendsRuntimeException"></a><a id="StreamSerialException:StreamSerialException"></a> <span class="permalink"><a href="../../../akka/serial/stream/index.html#StreamSerialExceptionextendsRuntimeException" 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="StreamSerialException.html" title="Represents a generic exception occured during streaming of serial data."><span class="name">StreamSerialException</span></a><span class="result"> extends <span name="scala.RuntimeException" class="extype">RuntimeException</span></span></span><p class="shortcomment cmt">Represents a generic exception occured during streaming of serial data.</p></li><li class="indented0 " name="akka.serial.stream.StreamWatcherException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="StreamWatcherExceptionextendsRuntimeException"></a><a id="StreamWatcherException:StreamWatcherException"></a> <span class="permalink"><a href="../../../akka/serial/stream/index.html#StreamWatcherExceptionextendsRuntimeException" 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="StreamWatcherException.html" title=""><span class="name">StreamWatcherException</span></a><span class="result"> extends <span name="scala.RuntimeException" class="extype">RuntimeException</span></span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="akka.serial.stream.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/stream/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=""><span class="name">Serial</span></a><span class="result"> extends <span name="akka.actor.ExtensionId" class="extype">ExtensionId</span>[<a href="Serial.html" name="akka.serial.stream.Serial" id="akka.serial.stream.Serial" class="extype">Serial</a>] with <span name="akka.actor.ExtensionIdProvider" class="extype">ExtensionIdProvider</span></span></span></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> |