http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/SerialPort.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/SerialPort.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/SerialPort.html new file mode 100644 index 0000000..f6f7a6a --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/SerialPort.html @@ -0,0 +1,254 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:08 EST 2017 --> +<title>SerialPort (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SerialPort (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SerialPort.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/SerialPort.html" target="_top">Frames</a></li> +<li><a href="SerialPort.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.edgent.connectors.serial</div> +<h2 title="Interface SerialPort" class="title">Interface SerialPort</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">SerialPort</span></pre> +<div class="block">Serial port runtime access. + + A serial port has an <a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html#getOutput--"><code>getOutput()</code></a> and + an <a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html#getOutput--"><code>output</code></a> I/O stream.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html#getInput--">getInput</a></span>()</code> +<div class="block">Get the input stream for this serial port.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html#getOutput--">getOutput</a></span>()</code> +<div class="block">Get the output stream for this serial port.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInput--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInput</h4> +<pre>java.io.InputStream getInput()</pre> +<div class="block">Get the input stream for this serial port.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>input stream for this serial port.</dd> +</dl> +</li> +</ul> +<a name="getOutput--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOutput</h4> +<pre>java.io.OutputStream getOutput()</pre> +<div class="block">Get the output stream for this serial port.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>output stream for this serial port.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SerialPort.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/SerialPort.html" target="_top">Frames</a></li> +<li><a href="SerialPort.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialDevice.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialDevice.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialDevice.html new file mode 100644 index 0000000..123cb80 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialDevice.html @@ -0,0 +1,212 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.serial.SerialDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Interface org.apache.edgent.connectors.serial.SerialDevice (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/serial/class-use/SerialDevice.html" target="_top">Frames</a></li> +<li><a href="SerialDevice.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface org.apache.edgent.connectors.serial.SerialDevice" class="title">Uses of Interface<br>org.apache.edgent.connectors.serial.SerialDevice</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.samples.connectors.elm327">org.apache.edgent.samples.connectors.elm327</a></td> +<td class="colLast"> +<div class="block">OBD-II protocol sample using ELM327.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.edgent.samples.connectors.obd2">org.apache.edgent.samples.connectors.obd2</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.edgent.samples.connectors.elm327"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> in <a href="../../../../../../org/apache/edgent/samples/connectors/elm327/package-summary.html">org.apache.edgent.samples.connectors.elm327</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/edgent/samples/connectors/elm327/package-summary.html">org.apache.edgent.samples.connectors.elm327</a> with parameters of type <a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="typeNameLabel">Elm327Cmds.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/connectors/elm327/Elm327Cmds.html#initializeProtocol-org.apache.edgent.connectors.serial.SerialDevice-org.apache.edgent.samples.connectors.elm327.Elm327Cmds-">initializeProtocol</a></span>(<a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> device, + <a href="../../../../../../org/apache/edgent/samples/connectors/elm327/Elm327Cmds.html" title="enum in org.apache.edgent.samples.connectors.elm327">Elm327Cmds</a> protocol)</code> +<div class="block">Initialize the ELM327 to a specific protocol.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonArray></code></td> +<td class="colLast"><span class="typeNameLabel">Elm327Streams.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/connectors/elm327/Elm327Streams.html#poll-org.apache.edgent.connectors.serial.SerialDevice-long-java.util.concurrent.TimeUnit-org.apache.edgent.samples.connectors.elm327.Cmd...-">poll</a></span>(<a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> device, + long period, + java.util.concurrent.TimeUnit unit, + <a href="../../../../../../org/apache/edgent/samples/connectors/elm327/Cmd.html" title="interface in org.apache.edgent.samples.connectors.elm327">Cmd</a>... cmds)</code> +<div class="block">Periodically execute a number of ELM327 commands.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.edgent.samples.connectors.obd2"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> in <a href="../../../../../../org/apache/edgent/samples/connectors/obd2/package-summary.html">org.apache.edgent.samples.connectors.obd2</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/edgent/samples/connectors/obd2/package-summary.html">org.apache.edgent.samples.connectors.obd2</a> with parameters of type <a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><span class="typeNameLabel">Obd2Streams.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/connectors/obd2/Obd2Streams.html#increasingTemps-org.apache.edgent.connectors.serial.SerialDevice-">increasingTemps</a></span>(<a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> device)</code> +<div class="block">Get a stream of temperature readings which + are increasing over the last minute.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><span class="typeNameLabel">Obd2Streams.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/connectors/obd2/Obd2Streams.html#tach-org.apache.edgent.connectors.serial.SerialDevice-">tach</a></span>(<a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a> device)</code> +<div class="block">Get a stream containing vehicle speed (km/h) + and engine revs (rpm).</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/serial/class-use/SerialDevice.html" target="_top">Frames</a></li> +<li><a href="SerialDevice.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialPort.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialPort.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialPort.html new file mode 100644 index 0000000..f80fe5f --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/class-use/SerialPort.html @@ -0,0 +1,177 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.serial.SerialPort (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Interface org.apache.edgent.connectors.serial.SerialPort (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/serial/class-use/SerialPort.html" target="_top">Frames</a></li> +<li><a href="SerialPort.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface org.apache.edgent.connectors.serial.SerialPort" class="title">Uses of Interface<br>org.apache.edgent.connectors.serial.SerialPort</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.connectors.serial">org.apache.edgent.connectors.serial</a></td> +<td class="colLast"> +<div class="block">Serial port connector API.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.edgent.connectors.serial"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a> in <a href="../../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a> with type arguments of type <a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T> <a href="../../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">SerialDevice.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html#getSource-org.apache.edgent.function.Function-">getSource</a></span>(<a href="../../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a>,T> driver)</code> +<div class="block">Create a function that can be used to source a + stream from a serial port device.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">SerialDevice.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/serial/SerialDevice.html#setInitializer-org.apache.edgent.function.Consumer-">setInitializer</a></span>(<a href="../../../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a><<a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a>> initializer)</code> +<div class="block">Set the initialization function for this port.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/serial/class-use/SerialPort.html" target="_top">Frames</a></li> +<li><a href="SerialPort.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-frame.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-frame.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-frame.html new file mode 100644 index 0000000..5d8b8bb --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-frame.html @@ -0,0 +1,21 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.serial (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html" target="classFrame">org.apache.edgent.connectors.serial</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="SerialDevice.html" title="interface in org.apache.edgent.connectors.serial" target="classFrame"><span class="interfaceName">SerialDevice</span></a></li> +<li><a href="SerialPort.html" title="interface in org.apache.edgent.connectors.serial" target="classFrame"><span class="interfaceName">SerialPort</span></a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-summary.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-summary.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-summary.html new file mode 100644 index 0000000..c9fca0c --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-summary.html @@ -0,0 +1,161 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.serial (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.edgent.connectors.serial (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/pubsub/service/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/edgent/connectors/wsclient/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.edgent.connectors.serial</h1> +<div class="docSummary"> +<div class="block">Serial port connector API.</div> +</div> +<p>See: <a href="#package.description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial">SerialDevice</a></td> +<td class="colLast"> +<div class="block">Access to a device (or devices) connected by a serial port.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial">SerialPort</a></td> +<td class="colLast"> +<div class="block">Serial port runtime access.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package.description"> +<!-- --> +</a> +<h2 title="Package org.apache.edgent.connectors.serial Description">Package org.apache.edgent.connectors.serial Description</h2> +<div class="block">Serial port connector API.</div> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/pubsub/service/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/edgent/connectors/wsclient/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-tree.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-tree.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-tree.html new file mode 100644 index 0000000..2ccf4be --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-tree.html @@ -0,0 +1,140 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.serial Class Hierarchy (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.edgent.connectors.serial Class Hierarchy (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/pubsub/service/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/edgent/connectors/wsclient/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.edgent.connectors.serial</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.edgent.connectors.serial.<a href="../../../../../org/apache/edgent/connectors/serial/SerialPort.html" title="interface in org.apache.edgent.connectors.serial"><span class="typeNameLink">SerialPort</span></a></li> +<li type="circle">org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">TopologyElement</span></a> +<ul> +<li type="circle">org.apache.edgent.connectors.serial.<a href="../../../../../org/apache/edgent/connectors/serial/SerialDevice.html" title="interface in org.apache.edgent.connectors.serial"><span class="typeNameLink">SerialDevice</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/pubsub/service/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/edgent/connectors/wsclient/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-use.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-use.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-use.html new file mode 100644 index 0000000..6416c58 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/serial/package-use.html @@ -0,0 +1,207 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> +<title>Uses of Package org.apache.edgent.connectors.serial (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Package org.apache.edgent.connectors.serial (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package org.apache.edgent.connectors.serial" class="title">Uses of Package<br>org.apache.edgent.connectors.serial</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.connectors.serial">org.apache.edgent.connectors.serial</a></td> +<td class="colLast"> +<div class="block">Serial port connector API.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.edgent.samples.connectors.elm327">org.apache.edgent.samples.connectors.elm327</a></td> +<td class="colLast"> +<div class="block">OBD-II protocol sample using ELM327.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.samples.connectors.obd2">org.apache.edgent.samples.connectors.obd2</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.edgent.connectors.serial"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a> used by <a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/edgent/connectors/serial/class-use/SerialPort.html#org.apache.edgent.connectors.serial">SerialPort</a> +<div class="block">Serial port runtime access.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.edgent.samples.connectors.elm327"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a> used by <a href="../../../../../org/apache/edgent/samples/connectors/elm327/package-summary.html">org.apache.edgent.samples.connectors.elm327</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/edgent/connectors/serial/class-use/SerialDevice.html#org.apache.edgent.samples.connectors.elm327">SerialDevice</a> +<div class="block">Access to a device (or devices) connected by a serial port.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.edgent.samples.connectors.obd2"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/edgent/connectors/serial/package-summary.html">org.apache.edgent.connectors.serial</a> used by <a href="../../../../../org/apache/edgent/samples/connectors/obd2/package-summary.html">org.apache.edgent.samples.connectors.obd2</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/edgent/connectors/serial/class-use/SerialDevice.html#org.apache.edgent.samples.connectors.obd2">SerialDevice</a> +<div class="block">Access to a device (or devices) connected by a serial port.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/serial/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/WebSocketClient.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/WebSocketClient.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/WebSocketClient.html new file mode 100644 index 0000000..59687e0 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/WebSocketClient.html @@ -0,0 +1,412 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:08 EST 2017 --> +<title>WebSocketClient (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="WebSocketClient (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/WebSocketClient.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/wsclient/WebSocketClient.html" target="_top">Frames</a></li> +<li><a href="WebSocketClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.edgent.connectors.wsclient</div> +<h2 title="Interface WebSocketClient" class="title">Interface WebSocketClient</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/edgent/connectors/wsclient/javax/websocket/Jsr356WebSocketClient.html" title="class in org.apache.edgent.connectors.wsclient.javax.websocket">Jsr356WebSocketClient</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">WebSocketClient</span> +extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></pre> +<div class="block">A generic connector for sending and receiving messages to a WebSocket Server. + <p> + A connector is bound to its configuration specified + <code>javax.websockets</code> WebSocket URI. + <p> + A single connector instance supports sinking at most one stream + and sourcing at most one stream. + <p> + Sample use: + <pre><code> + // assuming a properties file containing at least: + // ws.uri=ws://myWsServerHost/myService + + String propsPath = <path to properties file>; + Properties properties = new Properties(); + properties.load(Files.newBufferedReader(new File(propsPath).toPath())); + + Topology t = ...; + Jsr356WebSocketClient wsclient = new SomeWebSocketClient(t, properties); + + // send a stream's JsonObject tuples as JSON WebSocket text messages + TStream<JsonObject> s = ...; + wsclient.send(s); + + // create a stream of JsonObject tuples from received JSON WebSocket text messages + TStream<JsonObject> r = wsclient.receive(); + r.print(); + </code></pre> + <p> + Note, the WebSocket protocol differentiates between text/String and + binary/byte messages. + A receiver only receives the messages of the type that it requests. + <p> + Implementations are strongly encouraged to support construction from + Properties with the following configuration parameters: + <ul> + <li>ws.uri - "ws://host[:port][/path]", "wss://host[:port][/path]" + the default port is 80 and 443 for "ws" and "wss" respectively. + The optional path must match the server's configuration.</li> + <li>ws.trustStore - optional. Only used with "wss:". + Path to trust store file in JKS format. + If not set, the standard JRE and javax.net.ssl system properties + control the SSL behavior. + Generally not required if server has a CA-signed certificate.</li> + <li>ws.trustStorePassword - required if ws.trustStore is set</li> + <li>ws.keyStore - optional. Only used with "wss:" when the + server is configured for client auth. + Path to key store file in JKS format. + If not set, the standard JRE and javax.net.ssl system properties + control the SSL behavior.</li> + <li>ws.keyStorePassword - required if ws.keyStore is set.</li> + <li>ws.keyPassword - defaults to ws.keyStorePassword value</li> + <li>ws.keyCertificateAlias - alias for certificate in key store. defaults to "default"</li> + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#receive--">receive</a></span>()</code> +<div class="block">Create a stream of JsonObject tuples from received JSON WebSocket text messages.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><byte[]></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#receiveBytes--">receiveBytes</a></span>()</code> +<div class="block">Create a stream of byte[] tuples from received WebSocket binary messages.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#receiveString--">receiveString</a></span>()</code> +<div class="block">Create a stream of String tuples from received WebSocket text messages.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#send-org.apache.edgent.topology.TStream-">send</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream)</code> +<div class="block">Send a stream's JsonObject tuples as JSON in a WebSocket text message.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><byte[]></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#sendBytes-org.apache.edgent.topology.TStream-">sendBytes</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><byte[]> stream)</code> +<div class="block">Send a stream's byte[] tuples in a WebSocket binary message.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html#sendString-org.apache.edgent.topology.TStream-">sendString</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> stream)</code> +<div class="block">Send a stream's String tuples in a WebSocket text message.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></h3> +<code><a href="../../../../../org/apache/edgent/topology/TopologyElement.html#topology--">topology</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="send-org.apache.edgent.topology.TStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> send(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream)</pre> +<div class="block">Send a stream's JsonObject tuples as JSON in a WebSocket text message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - the stream</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sink</dd> +</dl> +</li> +</ul> +<a name="sendString-org.apache.edgent.topology.TStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendString</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String> sendString(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> stream)</pre> +<div class="block">Send a stream's String tuples in a WebSocket text message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - the stream</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sink</dd> +</dl> +</li> +</ul> +<a name="sendBytes-org.apache.edgent.topology.TStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendBytes</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><byte[]> sendBytes(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><byte[]> stream)</pre> +<div class="block">Send a stream's byte[] tuples in a WebSocket binary message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - the stream</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sink</dd> +</dl> +</li> +</ul> +<a name="receive--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receive</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> receive()</pre> +<div class="block">Create a stream of JsonObject tuples from received JSON WebSocket text messages.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stream</dd> +</dl> +</li> +</ul> +<a name="receiveString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receiveString</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> receiveString()</pre> +<div class="block">Create a stream of String tuples from received WebSocket text messages. + <p> + Note, the WebSocket protocol differentiates between text/String and + binary/byte messages. This method only receives messages sent as text.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stream</dd> +</dl> +</li> +</ul> +<a name="receiveBytes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>receiveBytes</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><byte[]> receiveBytes()</pre> +<div class="block">Create a stream of byte[] tuples from received WebSocket binary messages. + <p> + Note, the WebSocket protocol differentiates between text/String and + binary/byte messages. This method only receives messages sent as bytes.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stream</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/WebSocketClient.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/wsclient/WebSocketClient.html" target="_top">Frames</a></li> +<li><a href="WebSocketClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html b/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html new file mode 100644 index 0000000..a0b8e01 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.wsclient.WebSocketClient (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Interface org.apache.edgent.connectors.wsclient.WebSocketClient (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html" title="interface in org.apache.edgent.connectors.wsclient">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html" target="_top">Frames</a></li> +<li><a href="WebSocketClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface org.apache.edgent.connectors.wsclient.WebSocketClient" class="title">Uses of Interface<br>org.apache.edgent.connectors.wsclient.WebSocketClient</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html" title="interface in org.apache.edgent.connectors.wsclient">WebSocketClient</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.connectors.wsclient.javax.websocket">org.apache.edgent.connectors.wsclient.javax.websocket</a></td> +<td class="colLast"> +<div class="block">WebSocket Client Connector for sending and receiving messages to a WebSocket Server.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.edgent.connectors.wsclient.javax.websocket"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html" title="interface in org.apache.edgent.connectors.wsclient">WebSocketClient</a> in <a href="../../../../../../org/apache/edgent/connectors/wsclient/javax/websocket/package-summary.html">org.apache.edgent.connectors.wsclient.javax.websocket</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../org/apache/edgent/connectors/wsclient/javax/websocket/package-summary.html">org.apache.edgent.connectors.wsclient.javax.websocket</a> that implement <a href="../../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html" title="interface in org.apache.edgent.connectors.wsclient">WebSocketClient</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/wsclient/javax/websocket/Jsr356WebSocketClient.html" title="class in org.apache.edgent.connectors.wsclient.javax.websocket">Jsr356WebSocketClient</a></span></code> +<div class="block">A connector for sending and receiving messages to a WebSocket Server.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/wsclient/WebSocketClient.html" title="interface in org.apache.edgent.connectors.wsclient">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/wsclient/class-use/WebSocketClient.html" target="_top">Frames</a></li> +<li><a href="WebSocketClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
