org.apache.mina.transport.socket

Interface SocketSessionConfig

All Superinterfaces:

IoSessionConfig

All Known Implementing Classes:

AbstractSocketSessionConfig, DefaultSocketSessionConfig

public interface SocketSessionConfig
extends IoSessionConfig

An IoSessionConfig for socket transport type.

Author:

Apache MINA Project

Method Summary

Modifier and Type	Method and Description
int	getReceiveBufferSize()
int	getSendBufferSize()
int	getSoLinger() Please note that enabling SO_LINGER in Java NIO can result in platform-dependent behavior and unexpected blocking of I/O thread.
int	getTrafficClass()
boolean	isKeepAlive()
boolean	isOobInline()
boolean	isReuseAddress()
boolean	isTcpNoDelay()
void	setKeepAlive(boolean keepAlive)
void	setOobInline(boolean oobInline)
void	setReceiveBufferSize(int receiveBufferSize)
void	setReuseAddress(boolean reuseAddress)
void	setSendBufferSize(int sendBufferSize)
void	setSoLinger(int soLinger) Please note that enabling SO_LINGER in Java NIO can result in platform-dependent behaviour and unexpected blocking of I/O thread.
void	setTcpNoDelay(boolean tcpNoDelay)
void	setTrafficClass(int trafficClass)

Methods inherited from interface org.apache.mina.core.session.IoSessionConfig

getBothIdleTime, getBothIdleTimeInMillis, getIdleTime, getIdleTimeInMillis, getMaxReadBufferSize, getMinReadBufferSize, getReadBufferSize, getReaderIdleTime, getReaderIdleTimeInMillis, getThroughputCalculationInterval, getThroughputCalculationIntervalInMillis, getWriterIdleTime, getWriterIdleTimeInMillis, getWriteTimeout, getWriteTimeoutInMillis, isUseReadOperation, setAll, setBothIdleTime, setIdleTime, setMaxReadBufferSize, setMinReadBufferSize, setReadBufferSize, setReaderIdleTime, setThroughputCalculationInterval, setUseReadOperation, setWriterIdleTime, setWriteTimeout

Method Detail

isReuseAddress

boolean isReuseAddress()

Returns:

true if SO_REUSEADDR is enabled.

See Also:

Socket.getReuseAddress()

setReuseAddress

void setReuseAddress(boolean reuseAddress)

Parameters:

reuseAddress - Tells if SO_REUSEADDR is enabled or disabled

See Also:

Socket.setReuseAddress(boolean)

getReceiveBufferSize

int getReceiveBufferSize()

Returns:

the size of the receive buffer

See Also:

Socket.getReceiveBufferSize()

setReceiveBufferSize

void setReceiveBufferSize(int receiveBufferSize)

Parameters:

receiveBufferSize - The size of the receive buffer

See Also:

Socket.setReceiveBufferSize(int)

getSendBufferSize

int getSendBufferSize()

Returns:

the size of the send buffer

See Also:

Socket.getSendBufferSize()

setSendBufferSize

void setSendBufferSize(int sendBufferSize)

Parameters:

sendBufferSize - The size of the send buffer

See Also:

Socket.setSendBufferSize(int)

getTrafficClass

int getTrafficClass()

Returns:

the traffic class

See Also:

Socket.getTrafficClass()

setTrafficClass

void setTrafficClass(int trafficClass)

Parameters:

trafficClass - The traffic class to set, one of IPTOS_LOWCOST (0x02) IPTOS_RELIABILITY (0x04), IPTOS_THROUGHPUT (0x08) or IPTOS_LOWDELAY (0x10)

See Also:

Socket.setTrafficClass(int)

isKeepAlive

boolean isKeepAlive()

Returns:

true if SO_KEEPALIVE is enabled.

See Also:

Socket.getKeepAlive()

setKeepAlive

void setKeepAlive(boolean keepAlive)

Parameters:

keepAlive - if SO_KEEPALIVE is to be enabled

See Also:

Socket.setKeepAlive(boolean)

isOobInline

boolean isOobInline()

Returns:

true if SO_OOBINLINE is enabled.

See Also:

Socket.getOOBInline()

setOobInline

void setOobInline(boolean oobInline)

Parameters:

oobInline - if SO_OOBINLINE is to be enabled

See Also:

Socket.setOOBInline(boolean)

getSoLinger

int getSoLinger()

Please note that enabling SO_LINGER in Java NIO can result in platform-dependent behavior and unexpected blocking of I/O thread.

Returns:

The value for SO_LINGER

See Also:

Socket.getSoLinger(), Sun Bug Database

setSoLinger

void setSoLinger(int soLinger)

Please note that enabling SO_LINGER in Java NIO can result in platform-dependent behaviour and unexpected blocking of I/O thread.

Parameters:

soLinger - Please specify a negative value to disable SO_LINGER.

See Also:

Socket.setSoLinger(boolean, int), Sun Bug Database

isTcpNoDelay

boolean isTcpNoDelay()

Returns:

true if TCP_NODELAY is enabled.

See Also:

Socket.getTcpNoDelay()

setTcpNoDelay

void setTcpNoDelay(boolean tcpNoDelay)

Parameters:

tcpNoDelay - true if TCP_NODELAY is to be enabled

See Also:

Socket.setTcpNoDelay(boolean)