org.apache.mina.core.session
Interface IoSessionConfig

All Known Subinterfaces:

DatagramSessionConfig, SerialSessionConfig, SocketSessionConfig, VmPipeSessionConfig

All Known Implementing Classes:

AbstractDatagramSessionConfig, AbstractIoSessionConfig, AbstractSocketSessionConfig, DefaultDatagramSessionConfig, DefaultSocketSessionConfig

public interface IoSessionConfig

The configuration of IoSession.

Version:

$Rev: 597940 $, $Date: 2007-11-25 02:00:09 +0100 (Sun, 25 Nov 2007) $

Author:

The Apache MINA Project (dev@mina.apache.org)

Method Summary

int	getBothIdleTime() Returns idle time for IdleStatus.BOTH_IDLE in seconds.
long	getBothIdleTimeInMillis() Returns idle time for IdleStatus.BOTH_IDLE in milliseconds.
int	getIdleTime(IdleStatus status) Returns idle time for the specified type of idleness in seconds.
long	getIdleTimeInMillis(IdleStatus status) Returns idle time for the specified type of idleness in milliseconds.
int	getMaxReadBufferSize() Returns the maximum size of the read buffer that I/O processor allocates per each read.
int	getMinReadBufferSize() Returns the minimum size of the read buffer that I/O processor allocates per each read.
int	getReadBufferSize() Returns the size of the read buffer that I/O processor allocates per each read.
int	getReaderIdleTime() Returns idle time for IdleStatus.READER_IDLE in seconds.
long	getReaderIdleTimeInMillis() Returns idle time for IdleStatus.READER_IDLE in milliseconds.
int	getThroughputCalculationInterval() Returns the interval (seconds) between each throughput calculation.
long	getThroughputCalculationIntervalInMillis() Returns the interval (milliseconds) between each throughput calculation.
int	getWriterIdleTime() Returns idle time for IdleStatus.WRITER_IDLE in seconds.
long	getWriterIdleTimeInMillis() Returns idle time for IdleStatus.WRITER_IDLE in milliseconds.
int	getWriteTimeout() Returns write timeout in seconds.
long	getWriteTimeoutInMillis() Returns write timeout in milliseconds.
boolean	isUseReadOperation() Returns true if and only if IoSession.read() operation is enabled.
void	setAll(IoSessionConfig config) Sets all configuration properties retrieved from the specified config.
void	setBothIdleTime(int idleTime) Sets idle time for IdleStatus.WRITER_IDLE in seconds.
void	setIdleTime(IdleStatus status, int idleTime) Sets idle time for the specified type of idleness in seconds.
void	setMaxReadBufferSize(int maxReadBufferSize) Sets the maximum size of the read buffer that I/O processor allocates per each read.
void	setMinReadBufferSize(int minReadBufferSize) Sets the minimum size of the read buffer that I/O processor allocates per each read.
void	setReadBufferSize(int readBufferSize) Sets the size of the read buffer that I/O processor allocates per each read.
void	setReaderIdleTime(int idleTime) Sets idle time for IdleStatus.READER_IDLE in seconds.
void	setThroughputCalculationInterval(int throughputCalculationInterval) Sets the interval (seconds) between each throughput calculation.
void	setUseReadOperation(boolean useReadOperation) Enables or disabled IoSession.read() operation.
void	setWriterIdleTime(int idleTime) Sets idle time for IdleStatus.WRITER_IDLE in seconds.
void	setWriteTimeout(int writeTimeout) Sets write timeout in seconds.

Method Detail

getReadBufferSize

int getReadBufferSize()

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.

setReadBufferSize

void setReadBufferSize(int readBufferSize)

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.

getMinReadBufferSize

int getMinReadBufferSize()

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.

setMinReadBufferSize

void setMinReadBufferSize(int minReadBufferSize)

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.

getMaxReadBufferSize

int getMaxReadBufferSize()

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.

setMaxReadBufferSize

void setMaxReadBufferSize(int maxReadBufferSize)

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.

getThroughputCalculationInterval

int getThroughputCalculationInterval()

Returns the interval (seconds) between each throughput calculation. The default value is 3 seconds.

getThroughputCalculationIntervalInMillis

long getThroughputCalculationIntervalInMillis()

Returns the interval (milliseconds) between each throughput calculation. The default value is 3 seconds.

setThroughputCalculationInterval

void setThroughputCalculationInterval(int throughputCalculationInterval)

Sets the interval (seconds) between each throughput calculation. The default value is 3 seconds.

getIdleTime

int getIdleTime(IdleStatus status)

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

getIdleTimeInMillis

long getIdleTimeInMillis(IdleStatus status)

Returns 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.

getReaderIdleTime

int getReaderIdleTime()

Returns idle time for IdleStatus.READER_IDLE in seconds.

getReaderIdleTimeInMillis

long getReaderIdleTimeInMillis()

Returns idle time for IdleStatus.READER_IDLE in milliseconds.

setReaderIdleTime

void setReaderIdleTime(int idleTime)

Sets idle time for IdleStatus.READER_IDLE in seconds.

getWriterIdleTime

int getWriterIdleTime()

Returns idle time for IdleStatus.WRITER_IDLE in seconds.

getWriterIdleTimeInMillis

long getWriterIdleTimeInMillis()

Returns idle time for IdleStatus.WRITER_IDLE in milliseconds.

setWriterIdleTime

void setWriterIdleTime(int idleTime)

Sets idle time for IdleStatus.WRITER_IDLE in seconds.

getBothIdleTime

int getBothIdleTime()

Returns idle time for IdleStatus.BOTH_IDLE in seconds.

getBothIdleTimeInMillis

long getBothIdleTimeInMillis()

Returns idle time for IdleStatus.BOTH_IDLE in milliseconds.

setBothIdleTime

void setBothIdleTime(int idleTime)

Sets idle time for IdleStatus.WRITER_IDLE 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.

isUseReadOperation

boolean isUseReadOperation()

Returns true if and only if IoSession.read() operation is enabled. If enabled, all received messages are stored in an internal BlockingQueue 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.

setUseReadOperation

void setUseReadOperation(boolean useReadOperation)

Enables or disabled IoSession.read() operation. If enabled, all received messages are stored in an internal BlockingQueue 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.

setAll

void setAll(IoSessionConfig config)

Sets all configuration properties retrieved from the specified config.