blob: 7e58b1e4a8ddc926296786843c153af840ef25a9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_26) on Wed Jun 15 18:09:21 CEST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
IoSessionConfig (Apache MINA 2.0.4 API Documentation)
</TITLE>
<META NAME="date" CONTENT="2011-06-15">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IoSessionConfig (Apache MINA 2.0.4 API Documentation)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IoSessionConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/mina/core/session/IoSessionAttributeMap.html" title="interface in org.apache.mina.core.session"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/mina/core/session/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.core.session"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/mina/core/session/IoSessionConfig.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IoSessionConfig.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mina.core.session</FONT>
<BR>
Interface IoSessionConfig</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/mina/transport/socket/DatagramSessionConfig.html" title="interface in org.apache.mina.transport.socket">DatagramSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/serial/SerialSessionConfig.html" title="interface in org.apache.mina.transport.serial">SerialSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/socket/SocketSessionConfig.html" title="interface in org.apache.mina.transport.socket">SocketSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/vmpipe/VmPipeSessionConfig.html" title="interface in org.apache.mina.transport.vmpipe">VmPipeSessionConfig</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/mina/transport/socket/AbstractDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket">AbstractDatagramSessionConfig</A>, <A HREF="../../../../../org/apache/mina/core/session/AbstractIoSessionConfig.html" title="class in org.apache.mina.core.session">AbstractIoSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/socket/AbstractSocketSessionConfig.html" title="class in org.apache.mina.transport.socket">AbstractSocketSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/socket/DefaultDatagramSessionConfig.html" title="class in org.apache.mina.transport.socket">DefaultDatagramSessionConfig</A>, <A HREF="../../../../../org/apache/mina/transport/socket/DefaultSocketSessionConfig.html" title="class in org.apache.mina.transport.socket">DefaultSocketSessionConfig</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IoSessionConfig</B></DL>
</PRE>
<P>
The configuration of <A HREF="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><CODE>IoSession</CODE></A>.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD><a href="http://mina.apache.org">Apache MINA Project</a></DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTime()">getBothIdleTime</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#BOTH_IDLE"><CODE>IdleStatus.BOTH_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getBothIdleTimeInMillis()">getBothIdleTimeInMillis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#BOTH_IDLE"><CODE>IdleStatus.BOTH_IDLE</CODE></A> in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTime(org.apache.mina.core.session.IdleStatus)">getIdleTime</A></B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for the specified type of idleness in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getIdleTimeInMillis(org.apache.mina.core.session.IdleStatus)">getIdleTimeInMillis</A></B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for the specified type of idleness in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMaxReadBufferSize()">getMaxReadBufferSize</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the maximum size of the read buffer that I/O processor
allocates per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getMinReadBufferSize()">getMinReadBufferSize</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the minimum size of the read buffer that I/O processor
allocates per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReadBufferSize()">getReadBufferSize</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of the read buffer that I/O processor allocates
per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTime()">getReaderIdleTime</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getReaderIdleTimeInMillis()">getReaderIdleTimeInMillis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationInterval()">getThroughputCalculationInterval</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the interval (seconds) between each throughput calculation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getThroughputCalculationIntervalInMillis()">getThroughputCalculationIntervalInMillis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the interval (milliseconds) between each throughput calculation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTime()">getWriterIdleTime</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriterIdleTimeInMillis()">getWriterIdleTimeInMillis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeout()">getWriteTimeout</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns write timeout in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#getWriteTimeoutInMillis()">getWriteTimeoutInMillis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns write timeout in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#isUseReadOperation()">isUseReadOperation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <tt>true</tt> if and only if <A HREF="../../../../../org/apache/mina/core/session/IoSession.html#read()"><CODE>IoSession.read()</CODE></A> operation
is enabled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setAll(org.apache.mina.core.session.IoSessionConfig)">setAll</A></B>(<A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</A>&nbsp;config)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets all configuration properties retrieved from the specified
<tt>config</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setBothIdleTime(int)">setBothIdleTime</A></B>(int&nbsp;idleTime)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setIdleTime(org.apache.mina.core.session.IdleStatus, int)">setIdleTime</A></B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status,
int&nbsp;idleTime)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets idle time for the specified type of idleness in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMaxReadBufferSize(int)">setMaxReadBufferSize</A></B>(int&nbsp;maxReadBufferSize)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum size of the read buffer that I/O processor
allocates per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setMinReadBufferSize(int)">setMinReadBufferSize</A></B>(int&nbsp;minReadBufferSize)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the minimum size of the read buffer that I/O processor
allocates per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReadBufferSize(int)">setReadBufferSize</A></B>(int&nbsp;readBufferSize)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the size of the read buffer that I/O processor allocates
per each read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setReaderIdleTime(int)">setReaderIdleTime</A></B>(int&nbsp;idleTime)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setThroughputCalculationInterval(int)">setThroughputCalculationInterval</A></B>(int&nbsp;throughputCalculationInterval)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the interval (seconds) between each throughput calculation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setUseReadOperation(boolean)">setUseReadOperation</A></B>(boolean&nbsp;useReadOperation)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enables or disabled <A HREF="../../../../../org/apache/mina/core/session/IoSession.html#read()"><CODE>IoSession.read()</CODE></A> operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriterIdleTime(int)">setWriterIdleTime</A></B>(int&nbsp;idleTime)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html#setWriteTimeout(int)">setWriteTimeout</A></B>(int&nbsp;writeTimeout)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets write timeout in seconds.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getReadBufferSize()"><!-- --></A><H3>
getReadBufferSize</H3>
<PRE>
int <B>getReadBufferSize</B>()</PRE>
<DL>
<DD>Returns the size of the read buffer that I/O processor allocates
per each read. It's unusual to adjust this property because
it's often adjusted automatically by the I/O processor.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setReadBufferSize(int)"><!-- --></A><H3>
setReadBufferSize</H3>
<PRE>
void <B>setReadBufferSize</B>(int&nbsp;readBufferSize)</PRE>
<DL>
<DD>Sets the size of the read buffer that I/O processor allocates
per each read. It's unusual to adjust this property because
it's often adjusted automatically by the I/O processor.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMinReadBufferSize()"><!-- --></A><H3>
getMinReadBufferSize</H3>
<PRE>
int <B>getMinReadBufferSize</B>()</PRE>
<DL>
<DD>Returns the minimum size of the read buffer that I/O processor
allocates per each read. I/O processor will not decrease the
read buffer size to the smaller value than this property value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setMinReadBufferSize(int)"><!-- --></A><H3>
setMinReadBufferSize</H3>
<PRE>
void <B>setMinReadBufferSize</B>(int&nbsp;minReadBufferSize)</PRE>
<DL>
<DD>Sets the minimum size of the read buffer that I/O processor
allocates per each read. I/O processor will not decrease the
read buffer size to the smaller value than this property value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxReadBufferSize()"><!-- --></A><H3>
getMaxReadBufferSize</H3>
<PRE>
int <B>getMaxReadBufferSize</B>()</PRE>
<DL>
<DD>Returns the maximum size of the read buffer that I/O processor
allocates per each read. I/O processor will not increase the
read buffer size to the greater value than this property value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setMaxReadBufferSize(int)"><!-- --></A><H3>
setMaxReadBufferSize</H3>
<PRE>
void <B>setMaxReadBufferSize</B>(int&nbsp;maxReadBufferSize)</PRE>
<DL>
<DD>Sets the maximum size of the read buffer that I/O processor
allocates per each read. I/O processor will not increase the
read buffer size to the greater value than this property value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getThroughputCalculationInterval()"><!-- --></A><H3>
getThroughputCalculationInterval</H3>
<PRE>
int <B>getThroughputCalculationInterval</B>()</PRE>
<DL>
<DD>Returns the interval (seconds) between each throughput calculation.
The default value is <tt>3</tt> seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getThroughputCalculationIntervalInMillis()"><!-- --></A><H3>
getThroughputCalculationIntervalInMillis</H3>
<PRE>
long <B>getThroughputCalculationIntervalInMillis</B>()</PRE>
<DL>
<DD>Returns the interval (milliseconds) between each throughput calculation.
The default value is <tt>3</tt> seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setThroughputCalculationInterval(int)"><!-- --></A><H3>
setThroughputCalculationInterval</H3>
<PRE>
void <B>setThroughputCalculationInterval</B>(int&nbsp;throughputCalculationInterval)</PRE>
<DL>
<DD>Sets the interval (seconds) between each throughput calculation. The
default value is <tt>3</tt> seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getIdleTime(org.apache.mina.core.session.IdleStatus)"><!-- --></A><H3>
getIdleTime</H3>
<PRE>
int <B>getIdleTime</B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status)</PRE>
<DL>
<DD>Returns idle time for the specified type of idleness in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getIdleTimeInMillis(org.apache.mina.core.session.IdleStatus)"><!-- --></A><H3>
getIdleTimeInMillis</H3>
<PRE>
long <B>getIdleTimeInMillis</B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status)</PRE>
<DL>
<DD>Returns idle time for the specified type of idleness in milliseconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setIdleTime(org.apache.mina.core.session.IdleStatus, int)"><!-- --></A><H3>
setIdleTime</H3>
<PRE>
void <B>setIdleTime</B>(<A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html" title="class in org.apache.mina.core.session">IdleStatus</A>&nbsp;status,
int&nbsp;idleTime)</PRE>
<DL>
<DD>Sets idle time for the specified type of idleness in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getReaderIdleTime()"><!-- --></A><H3>
getReaderIdleTime</H3>
<PRE>
int <B>getReaderIdleTime</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getReaderIdleTimeInMillis()"><!-- --></A><H3>
getReaderIdleTimeInMillis</H3>
<PRE>
long <B>getReaderIdleTimeInMillis</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in milliseconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setReaderIdleTime(int)"><!-- --></A><H3>
setReaderIdleTime</H3>
<PRE>
void <B>setReaderIdleTime</B>(int&nbsp;idleTime)</PRE>
<DL>
<DD>Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWriterIdleTime()"><!-- --></A><H3>
getWriterIdleTime</H3>
<PRE>
int <B>getWriterIdleTime</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWriterIdleTimeInMillis()"><!-- --></A><H3>
getWriterIdleTimeInMillis</H3>
<PRE>
long <B>getWriterIdleTimeInMillis</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in milliseconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setWriterIdleTime(int)"><!-- --></A><H3>
setWriterIdleTime</H3>
<PRE>
void <B>setWriterIdleTime</B>(int&nbsp;idleTime)</PRE>
<DL>
<DD>Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBothIdleTime()"><!-- --></A><H3>
getBothIdleTime</H3>
<PRE>
int <B>getBothIdleTime</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#BOTH_IDLE"><CODE>IdleStatus.BOTH_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBothIdleTimeInMillis()"><!-- --></A><H3>
getBothIdleTimeInMillis</H3>
<PRE>
long <B>getBothIdleTimeInMillis</B>()</PRE>
<DL>
<DD>Returns idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#BOTH_IDLE"><CODE>IdleStatus.BOTH_IDLE</CODE></A> in milliseconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setBothIdleTime(int)"><!-- --></A><H3>
setBothIdleTime</H3>
<PRE>
void <B>setBothIdleTime</B>(int&nbsp;idleTime)</PRE>
<DL>
<DD>Sets idle time for <A HREF="../../../../../org/apache/mina/core/session/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A> in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWriteTimeout()"><!-- --></A><H3>
getWriteTimeout</H3>
<PRE>
int <B>getWriteTimeout</B>()</PRE>
<DL>
<DD>Returns write timeout in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWriteTimeoutInMillis()"><!-- --></A><H3>
getWriteTimeoutInMillis</H3>
<PRE>
long <B>getWriteTimeoutInMillis</B>()</PRE>
<DL>
<DD>Returns write timeout in milliseconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setWriteTimeout(int)"><!-- --></A><H3>
setWriteTimeout</H3>
<PRE>
void <B>setWriteTimeout</B>(int&nbsp;writeTimeout)</PRE>
<DL>
<DD>Sets write timeout in seconds.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isUseReadOperation()"><!-- --></A><H3>
isUseReadOperation</H3>
<PRE>
boolean <B>isUseReadOperation</B>()</PRE>
<DL>
<DD>Returns <tt>true</tt> if and only if <A HREF="../../../../../org/apache/mina/core/session/IoSession.html#read()"><CODE>IoSession.read()</CODE></A> operation
is enabled. If enabled, all received messages are stored in an internal
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent"><CODE>BlockingQueue</CODE></A> so you can read received messages in more
convenient way for client applications. Enabling this option is not
useful to server applications and can cause unintended memory leak, and
therefore it's disabled by default.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setUseReadOperation(boolean)"><!-- --></A><H3>
setUseReadOperation</H3>
<PRE>
void <B>setUseReadOperation</B>(boolean&nbsp;useReadOperation)</PRE>
<DL>
<DD>Enables or disabled <A HREF="../../../../../org/apache/mina/core/session/IoSession.html#read()"><CODE>IoSession.read()</CODE></A> operation. If enabled, all
received messages are stored in an internal <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent"><CODE>BlockingQueue</CODE></A> so you
can read received messages in more convenient way for client
applications. Enabling this option is not useful to server applications
and can cause unintended memory leak, and therefore it's disabled by
default.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setAll(org.apache.mina.core.session.IoSessionConfig)"><!-- --></A><H3>
setAll</H3>
<PRE>
void <B>setAll</B>(<A HREF="../../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</A>&nbsp;config)</PRE>
<DL>
<DD>Sets all configuration properties retrieved from the specified
<tt>config</tt>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IoSessionConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/mina/core/session/IoSessionAttributeMap.html" title="interface in org.apache.mina.core.session"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/mina/core/session/IoSessionDataStructureFactory.html" title="interface in org.apache.mina.core.session"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/mina/core/session/IoSessionConfig.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IoSessionConfig.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2004-2011 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.
</BODY>
</HTML>