| <!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.5.0_02) on Mon Jul 11 13:14:39 KST 2005 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| <TITLE> | |
| SessionConfig (MINA 0.7.3 API) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.mina.common.SessionConfig interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="SessionConfig (MINA 0.7.3 API)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= 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> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SessionConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/mina/common/SessionManager.html" title="interface in org.apache.mina.common"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/mina/common/SessionConfig.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="SessionConfig.html" target="_top"><B>NO FRAMES</B></A> | |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <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.common</FONT> | |
| <BR> | |
| Interface SessionConfig</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/mina/common/BaseSessionConfig.html" title="class in org.apache.mina.common">BaseSessionConfig</A>, <A HREF="../../../../org/apache/mina/io/datagram/DatagramSessionConfig.html" title="class in org.apache.mina.io.datagram">DatagramSessionConfig</A>, <A HREF="../../../../org/apache/mina/io/socket/SocketSessionConfig.html" title="class in org.apache.mina.io.socket">SocketSessionConfig</A>, <A HREF="../../../../org/apache/mina/protocol/vmpipe/VmPipeSessionConfig.html" title="class in org.apache.mina.protocol.vmpipe">VmPipeSessionConfig</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>SessionConfig</B></DL> | |
| </PRE> | |
| <P> | |
| Provides general or <A HREF="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common"><CODE>TransportType</CODE></A>-specific configuration. | |
| <p> | |
| <ul> | |
| <li><code>idleTime</code> (secs) - <code>sessionIdle</code> event is | |
| enabled if this value is greater than 0. | |
| <li><code>writeTimeout</code> (secs) - <A HREF="../../../../org/apache/mina/io/WriteTimeoutException.html" title="class in org.apache.mina.io"><CODE>WriteTimeoutException</CODE></A> is | |
| thrown when the write buffer of session is full for the specified | |
| time.</li> | |
| </ul> | |
| <p> | |
| Please refer to <A HREF="../../../../org/apache/mina/io/socket/SocketSessionConfig.html" title="class in org.apache.mina.io.socket"><CODE>SocketSessionConfig</CODE></A> and <A HREF="../../../../org/apache/mina/io/datagram/DatagramSessionConfig.html" title="class in org.apache.mina.io.datagram"><CODE>DatagramSessionConfig</CODE></A> | |
| for <A HREF="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common"><CODE>TransportType</CODE></A>-specific configurations. | |
| <p> | |
| <A HREF="../../../../org/apache/mina/common/SessionConfig.html" title="interface in org.apache.mina.common"><CODE>SessionConfig</CODE></A> can be obtained by <A HREF="../../../../org/apache/mina/common/Session.html#getConfig()"><CODE>Session.getConfig()</CODE></A> and | |
| by <A HREF="../../../../org/apache/mina/common/Session.html#getConfig()"><CODE>Session.getConfig()</CODE></A>. To adjust | |
| <A HREF="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common"><CODE>TransportType</CODE></A>-specific settings, please downcast it: | |
| <pre> | |
| public void sessionOpened( IoSession s ) | |
| { | |
| ( ( SocketSessionConfig ) s.getConfig() ).setReuseAddress( true ); | |
| } | |
| </pre> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Trustin Lee (trustin@apache.org)</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> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#getIdleTime(org.apache.mina.common.IdleStatus)">getIdleTime</A></B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> status)</CODE> | |
| <BR> | |
| 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> long</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#getIdleTimeInMillis(org.apache.mina.common.IdleStatus)">getIdleTimeInMillis</A></B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> status)</CODE> | |
| <BR> | |
| Returnd 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> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#getWriteTimeout()">getWriteTimeout</A></B>()</CODE> | |
| <BR> | |
| Returns write timeout in seconds.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> long</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#getWriteTimeoutInMillis()">getWriteTimeoutInMillis</A></B>()</CODE> | |
| <BR> | |
| Returns write timeout in milliseconds.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#setIdleTime(org.apache.mina.common.IdleStatus, int)">setIdleTime</A></B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> status, | |
| int idleTime)</CODE> | |
| <BR> | |
| 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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/common/SessionConfig.html#setWriteTimeout(int)">setWriteTimeout</A></B>(int writeTimeout)</CODE> | |
| <BR> | |
| Sets write timeout in seconds.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <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="getIdleTime(org.apache.mina.common.IdleStatus)"><!-- --></A><H3> | |
| getIdleTime</H3> | |
| <PRE> | |
| int <B>getIdleTime</B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> 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.common.IdleStatus)"><!-- --></A><H3> | |
| getIdleTimeInMillis</H3> | |
| <PRE> | |
| long <B>getIdleTimeInMillis</B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> status)</PRE> | |
| <DL> | |
| <DD>Returnd idle time for the specified type of idleness in milliseconds. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setIdleTime(org.apache.mina.common.IdleStatus, int)"><!-- --></A><H3> | |
| setIdleTime</H3> | |
| <PRE> | |
| void <B>setIdleTime</B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A> status, | |
| int idleTime)</PRE> | |
| <DL> | |
| <DD>Sets idle time for the specified type of idleness 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 writeTimeout)</PRE> | |
| <DL> | |
| <DD>Sets write timeout in seconds. | |
| <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> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SessionConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/mina/common/SessionManager.html" title="interface in org.apache.mina.common"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/mina/common/SessionConfig.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="SessionConfig.html" target="_top"><B>NO FRAMES</B></A> | |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright © 2004-2005 . All Rights Reserved. | |
| </BODY> | |
| </HTML> |