org.apache.mina.common
Interface SessionConfig

All Known Implementing Classes:

BaseSessionConfig, DatagramSessionConfig, SocketSessionConfig, VmPipeSessionConfig

public interface SessionConfig

Provides general or TransportType-specific configuration.

• idleTime (secs) - sessionIdle event is enabled if this value is greater than 0.
• writeTimeout (secs) - WriteTimeoutException is thrown when the write buffer of session is full for the specified time.

Please refer to SocketSessionConfig and DatagramSessionConfig for TransportType-specific configurations.

SessionConfig can be obtained by Session.getConfig() and by Session.getConfig(). To adjust TransportType-specific settings, please downcast it:

 public void sessionOpened( IoSession s )
 {
     ( ( SocketSessionConfig ) s.getConfig() ).setReuseAddress( true );
 }
 

Version:

$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $

Author:

The Apache Directory Project (dev@directory.apache.org)

Method Summary

int	getIdleTime(IdleStatus status) Returns idle time for the specified type of idleness in seconds.
long	getIdleTimeInMillis(IdleStatus status) Returnd idle time for the specified type of idleness in milliseconds.
int	getWriteTimeout() Returns write timeout in seconds.
long	getWriteTimeoutInMillis() Returns write timeout in milliseconds.
void	setIdleTime(IdleStatus status, int idleTime) Sets idle time for the specified type of idleness in seconds.
void	setWriteTimeout(int writeTimeout) Sets write timeout in seconds.

Method Detail

getIdleTime

int getIdleTime(IdleStatus status)

Returns idle time for the specified type of idleness in seconds.

getIdleTimeInMillis

long getIdleTimeInMillis(IdleStatus status)

Returnd idle time for the specified type of idleness in milliseconds.

setIdleTime

void setIdleTime(IdleStatus status,
                 int idleTime)

Sets idle time for the specified type of idleness in seconds.

getWriteTimeout

int getWriteTimeout()

Returns write timeout in seconds.

getWriteTimeoutInMillis

long getWriteTimeoutInMillis()

Returns write timeout in milliseconds.

setWriteTimeout

void setWriteTimeout(int writeTimeout)

Sets write timeout in seconds.