| <!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 (version 1.7.0_55) on Mon Sep 15 17:28:23 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SerialSessionConfig (Apache MINA 2.0.8 API)</title> |
| <meta name="date" content="2014-09-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SerialSessionConfig (Apache MINA 2.0.8 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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 <span class="strong">SerialSessionConfig</span> |
| 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="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getInputBufferSize()">getInputBufferSize</a></strong>()</code> |
| <div class="block">Gets the input buffer size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getOutputBufferSize()">getOutputBufferSize</a></strong>()</code> |
| <div class="block">Gets the output buffer size.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#getReceiveThreshold()">getReceiveThreshold</a></strong>()</code> |
| <div class="block">The current receive threshold (-1 if not enabled).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#isLowLatency()">isLowLatency</a></strong>()</code> |
| <div class="block">Is the low latency mode is enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setInputBufferSize(int)">setInputBufferSize</a></strong>(int bufferSize)</code> |
| <div class="block">Sets the input buffer size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setLowLatency(boolean)">setLowLatency</a></strong>(boolean lowLatency)</code> |
| <div class="block">Set the low latency mode, be carefull it's not supported by all the OS/hardware.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setOutputBufferSize(int)">setOutputBufferSize</a></strong>(int bufferSize)</code> |
| <div class="block">Sets the output buffer size.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html#setReceiveThreshold(int)">setReceiveThreshold</a></strong>(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 getInputBufferSize()</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="strong">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 setInputBufferSize(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="strong">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 getOutputBufferSize()</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="strong">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 setOutputBufferSize(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="strong">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 isLowLatency()</pre> |
| <div class="block">Is the low latency mode is enabled.</div> |
| <dl><dt><span class="strong">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 setLowLatency(boolean lowLatency)</pre> |
| <div class="block">Set the low latency mode, be carefull it's not supported by all the OS/hardware.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lowLatency</code> - </dd></dl> |
| </li> |
| </ul> |
| <a name="getReceiveThreshold()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReceiveThreshold</h4> |
| <pre>int getReceiveThreshold()</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="strong">Returns:</span></dt><dd>the receive thresold 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 setReceiveThreshold(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 carefull some devices doesn't support it.</div> |
| <dl><dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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–2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
