| <!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_60) on Fri Jan 22 17:28:42 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SerialSessionConfig (Apache MINA 2.0.11 API)</title> |
| <meta name="date" content="2016-01-22"> |
| <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="SerialSessionConfig (Apache MINA 2.0.11 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/SerialSessionConfig.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/mina/transport/serial/SerialSession.html" title="interface in org.apache.mina.transport.serial"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/transport/serial/SerialSessionConfig.html" target="_top">Frames</a></li> |
| <li><a href="SerialSessionConfig.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.mina.transport.serial</div> |
| <h2 title="Interface SerialSessionConfig" class="title">Interface SerialSessionConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.30">SerialSessionConfig</a> |
| extends <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></pre> |
| <div class="block">An <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session"><code>IoSessionConfig</code></a> for serial transport type. |
| All those parameters are extracted from rxtx.org API for more details : |
| http://www.rxtx.org</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd> |
| </dl> |
| </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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getInputBufferSize--">getInputBufferSize</a></span>()</code> |
| <div class="block">Gets the input buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getOutputBufferSize--">getOutputBufferSize</a></span>()</code> |
| <div class="block">Gets the output buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getReceiveThreshold--">getReceiveThreshold</a></span>()</code> |
| <div class="block">The current receive threshold (-1 if not enabled).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#isLowLatency--">isLowLatency</a></span>()</code> |
| <div class="block">Is the low latency mode is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setInputBufferSize-int-">setInputBufferSize</a></span>(int bufferSize)</code> |
| <div class="block">Sets the input buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setLowLatency-boolean-">setLowLatency</a></span>(boolean lowLatency)</code> |
| <div class="block">Set the low latency mode, be careful it's not supported by all the OS/hardware.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setOutputBufferSize-int-">setOutputBufferSize</a></span>(int bufferSize)</code> |
| <div class="block">Sets the output buffer size.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setReceiveThreshold-int-">setReceiveThreshold</a></span>(int bytes)</code> |
| <div class="block">Set the receive threshold in byte (set it to -1 for disable).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.core.session.IoSessionConfig"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.core.session.<a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></h3> |
| <code><a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTime--">getBothIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTimeInMillis--">getBothIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTime-org.apache.mina.core.session.IdleStatus-">getIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTimeInMillis-org.apache.mina.core.session.IdleStatus-">getIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMaxReadBufferSize--">getMaxReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMinReadBufferSize--">getMinReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReadBufferSize--">getReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTime--">getReaderIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTimeInMillis--">getReaderIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationInterval--">getThroughputCalculationInterval</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationIntervalInMillis--">getThroughputCalculationIntervalInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTime--">getWriterIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTimeInMillis--">getWriterIdleTimeInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeout--">getWriteTimeout</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeoutInMillis--">getWriteTimeoutInMillis</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#isUseReadOperation--">isUseReadOperation</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setAll-org.apache.mina.core.session.IoSessionConfig-">setAll</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setBothIdleTime-int-">setBothIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setIdleTime-org.apache.mina.core.session.IdleStatus-int-">setIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMaxReadBufferSize-int-">setMaxReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMinReadBufferSize-int-">setMinReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReadBufferSize-int-">setReadBufferSize</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReaderIdleTime-int-">setReaderIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setThroughputCalculationInterval-int-">setThroughputCalculationInterval</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setUseReadOperation-boolean-">setUseReadOperation</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriterIdleTime-int-">setWriterIdleTime</a>, <a href="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriteTimeout-int-">setWriteTimeout</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="getInputBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputBufferSize</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.37">getInputBufferSize</a>()</pre> |
| <div class="block">Gets the input buffer size. Note that this method is advisory and the underlying OS |
| may choose not to report correct values for the buffer size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>input buffer size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInputBufferSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInputBufferSize</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.44">setInputBufferSize</a>(int bufferSize)</pre> |
| <div class="block">Sets the input buffer size. Note that this is advisory and memory availability may |
| determine the ultimate buffer size used by the driver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bufferSize</code> - the buffer size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputBufferSize</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.51">getOutputBufferSize</a>()</pre> |
| <div class="block">Gets the output buffer size. Note that this method is advisory and the underlying OS |
| may choose not to report correct values for the buffer size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>input buffer size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputBufferSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputBufferSize</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.58">setOutputBufferSize</a>(int bufferSize)</pre> |
| <div class="block">Sets the output buffer size. Note that this is advisory and memory availability may |
| determine the ultimate buffer size used by the driver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bufferSize</code> - the buffer size in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLowLatency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLowLatency</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.64">isLowLatency</a>()</pre> |
| <div class="block">Is the low latency mode is enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>low latency on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLowLatency-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLowLatency</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.70">setLowLatency</a>(boolean lowLatency)</pre> |
| <div class="block">Set the low latency mode, be careful it's not supported by all the OS/hardware.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowLatency</code> - The low latency mode</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReceiveThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReceiveThreshold</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.77">getReceiveThreshold</a>()</pre> |
| <div class="block">The current receive threshold (-1 if not enabled). Give the value of the current buffer |
| needed for generate a new frame.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receive threshold in bytes or -1 if disabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReceiveThreshold-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setReceiveThreshold</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/transport/serial/SerialSessionConfig.html#line.84">setReceiveThreshold</a>(int bytes)</pre> |
| <div class="block">Set the receive threshold in byte (set it to -1 for disable). The serial port will try to |
| provide frame of the given minimal byte count. Be careful some devices doesn't support it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - minimal amount of byte before producing a new frame, or -1 if disabled</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/SerialSessionConfig.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/mina/transport/serial/SerialSession.html" title="interface in org.apache.mina.transport.serial"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/transport/serial/SerialSessionConfig.html" target="_top">Frames</a></li> |
| <li><a href="SerialSessionConfig.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 © 2004–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
