| <!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_191) on Sat Mar 16 19:15:33 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SerialAddress (Apache MINA 2.0.0-M2 API Documentation)</title> |
| <meta name="date" content="2019-03-16"> |
| <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="SerialAddress (Apache MINA 2.0.0-M2 API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/SerialAddress.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><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/transport/serial/SerialAddress.html" target="_top">Frames</a></li> |
| <li><a href="SerialAddress.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.mina.transport.serial</div> |
| <h2 title="Class SerialAddress" class="title">Class SerialAddress</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.net.SocketAddress</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.transport.serial.SerialAddress</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SerialAddress</span> |
| extends java.net.SocketAddress</pre> |
| <div class="block">An address for a serial port communication.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 529576 $, $Date: 2007-04-17 14:25:07 +0200 (mar., 17 avr. 2007) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache MINA Project (dev@mina.apache.org)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.mina.transport.serial.SerialAddress">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.DataBits</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.FlowControl.html" title="enum in org.apache.mina.transport.serial">SerialAddress.FlowControl</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.Parity.html" title="enum in org.apache.mina.transport.serial">SerialAddress.Parity</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.StopBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.StopBits</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#SerialAddress-java.lang.String-int-org.apache.mina.transport.serial.SerialAddress.DataBits-org.apache.mina.transport.serial.SerialAddress.StopBits-org.apache.mina.transport.serial.SerialAddress.Parity-org.apache.mina.transport.serial.SerialAddress.FlowControl-">SerialAddress</a></span>(java.lang.String name, |
| int bauds, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.DataBits</a> dataBits, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.StopBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.StopBits</a> stopBits, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.Parity.html" title="enum in org.apache.mina.transport.serial">SerialAddress.Parity</a> parity, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.FlowControl.html" title="enum in org.apache.mina.transport.serial">SerialAddress.FlowControl</a> flowControl)</code> |
| <div class="block">Create an address for a serial communication, associating a serial interface and |
| various serial signal carcteristics.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getBauds--">getBauds</a></span>()</code> |
| <div class="block">Bauds rate for the communication.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.DataBits</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getDataBits--">getDataBits</a></span>()</code> |
| <div class="block">Number of data bits for each communicated bytes.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.FlowControl.html" title="enum in org.apache.mina.transport.serial">SerialAddress.FlowControl</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getFlowControl--">getFlowControl</a></span>()</code> |
| <div class="block">The flow control policie used for this communication.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getName--">getName</a></span>()</code> |
| <div class="block">The name of the device.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.Parity.html" title="enum in org.apache.mina.transport.serial">SerialAddress.Parity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getParity--">getParity</a></span>()</code> |
| <div class="block">The parity check for this communication.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.StopBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.StopBits</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#getStopBits--">getStopBits</a></span>()</code> |
| <div class="block">Number of stop bits used.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html#toString--">toString</a></span>()</code> |
| <div class="block">Convert this serial address to a human readable string.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SerialAddress-java.lang.String-int-org.apache.mina.transport.serial.SerialAddress.DataBits-org.apache.mina.transport.serial.SerialAddress.StopBits-org.apache.mina.transport.serial.SerialAddress.Parity-org.apache.mina.transport.serial.SerialAddress.FlowControl-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SerialAddress</h4> |
| <pre>public SerialAddress(java.lang.String name, |
| int bauds, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.DataBits</a> dataBits, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.StopBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.StopBits</a> stopBits, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.Parity.html" title="enum in org.apache.mina.transport.serial">SerialAddress.Parity</a> parity, |
| <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.FlowControl.html" title="enum in org.apache.mina.transport.serial">SerialAddress.FlowControl</a> flowControl)</pre> |
| <div class="block">Create an address for a serial communication, associating a serial interface and |
| various serial signal carcteristics.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the device, COM1 COM2 for Windows, /dev/ttyS0 for Unix</dd> |
| <dd><code>bauds</code> - baud rate for the communication</dd> |
| <dd><code>dataBits</code> - number of data bits per bytes</dd> |
| <dd><code>stopBits</code> - number of stop bits</dd> |
| <dd><code>parity</code> - parity used</dd> |
| <dd><code>flowControl</code> - flow control used</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBauds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBauds</h4> |
| <pre>public int getBauds()</pre> |
| <div class="block">Bauds rate for the communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the bauds (bits per seconds) for this serial link</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataBits--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataBits</h4> |
| <pre>public <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.DataBits</a> getDataBits()</pre> |
| <div class="block">Number of data bits for each communicated bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the data bits</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlowControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlowControl</h4> |
| <pre>public <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.FlowControl.html" title="enum in org.apache.mina.transport.serial">SerialAddress.FlowControl</a> getFlowControl()</pre> |
| <div class="block">The flow control policie used for this communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the flow control</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public java.lang.String getName()</pre> |
| <div class="block">The name of the device. Can be COM1, COM2, /dev/ttyS0, /dev/ttyUSB1, etc..</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParity</h4> |
| <pre>public <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.Parity.html" title="enum in org.apache.mina.transport.serial">SerialAddress.Parity</a> getParity()</pre> |
| <div class="block">The parity check for this communication.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parity type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStopBits--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStopBits</h4> |
| <pre>public <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.StopBits.html" title="enum in org.apache.mina.transport.serial">SerialAddress.StopBits</a> getStopBits()</pre> |
| <div class="block">Number of stop bits used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>stop bits number</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <div class="block">Convert this serial address to a human readable string.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></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/SerialAddress.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><a href="../../../../../org/apache/mina/transport/serial/SerialAddress.DataBits.html" title="enum in org.apache.mina.transport.serial"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/transport/serial/SerialAddress.html" target="_top">Frames</a></li> |
| <li><a href="SerialAddress.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
