Class DefaultSocketSessionConfig

java.lang.Object

org.apache.mina.core.session.AbstractIoSessionConfig

org.apache.mina.transport.socket.AbstractSocketSessionConfig

org.apache.mina.transport.socket.DefaultSocketSessionConfig

All Implemented Interfaces:

IoSessionConfig, SocketSessionConfig

public class DefaultSocketSessionConfig
extends AbstractSocketSessionConfig

A default implementation of SocketSessionConfig.

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DEFAULT_KEEP_ALIVE
private static final boolean	DEFAULT_OOB_INLINE
private static final boolean	DEFAULT_REUSE_ADDRESS
private static final int	DEFAULT_SO_LINGER
private static final boolean	DEFAULT_TCP_NO_DELAY
private static final int	DEFAULT_TRAFFIC_CLASS
private boolean	defaultReuseAddress
private boolean	keepAlive
private boolean	oobInline
protected IoService	parent
private int	receiveBufferSize
private boolean	reuseAddress
private int	sendBufferSize
private int	soLinger
private boolean	tcpNoDelay
private int	trafficClass

Constructor Summary

Constructors

Constructor	Description
DefaultSocketSessionConfig()	Creates a new instance.

Method Summary

Modifier and Type	Method	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()
void	init(IoService parent)	Initialize this configuration.
boolean	isKeepAlive()
protected boolean	isKeepAliveChanged()
boolean	isOobInline()
protected boolean	isOobInlineChanged()
protected boolean	isReceiveBufferSizeChanged()
boolean	isReuseAddress()
protected boolean	isReuseAddressChanged()
protected boolean	isSendBufferSizeChanged()
protected boolean	isSoLingerChanged()
boolean	isTcpNoDelay()
protected boolean	isTcpNoDelayChanged()
protected boolean	isTrafficClassChanged()
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 behavior and unexpected blocking of I/O thread.
void	setTcpNoDelay(boolean tcpNoDelay)
void	setTrafficClass(int trafficClass)

Methods inherited from class AbstractSocketSessionConfig

setAll

Methods inherited from class AbstractIoSessionConfig

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IoSessionConfig

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

Field Details

DEFAULT_REUSE_ADDRESS

private static final boolean DEFAULT_REUSE_ADDRESS

See Also:

• Constant Field Values

DEFAULT_TRAFFIC_CLASS

private static final int DEFAULT_TRAFFIC_CLASS

See Also:

• Constant Field Values

DEFAULT_KEEP_ALIVE

private static final boolean DEFAULT_KEEP_ALIVE

See Also:

• Constant Field Values

DEFAULT_OOB_INLINE

private static final boolean DEFAULT_OOB_INLINE

See Also:

• Constant Field Values

DEFAULT_SO_LINGER

private static final int DEFAULT_SO_LINGER

See Also:

• Constant Field Values

DEFAULT_TCP_NO_DELAY

private static final boolean DEFAULT_TCP_NO_DELAY

See Also:

• Constant Field Values

parent

protected IoService parent

defaultReuseAddress

private boolean defaultReuseAddress

reuseAddress

private boolean reuseAddress

receiveBufferSize

private int receiveBufferSize

sendBufferSize

private int sendBufferSize

trafficClass

private int trafficClass

keepAlive

private boolean keepAlive

oobInline

private boolean oobInline

soLinger

private int soLinger

tcpNoDelay

private boolean tcpNoDelay

Constructor Details

DefaultSocketSessionConfig

public DefaultSocketSessionConfig()

Creates a new instance.

Method Details

init

public void init(IoService parent)

Initialize this configuration.

Parameters:

parent - The parent IoService.

isReuseAddress

public boolean isReuseAddress()

Returns:

true if SO_REUSEADDR is enabled.

See Also:

• Socket.getReuseAddress()

setReuseAddress

public void setReuseAddress(boolean reuseAddress)

Parameters:

reuseAddress - Tells if SO_REUSEADDR is enabled or disabled

See Also:

• Socket.setReuseAddress(boolean)

getReceiveBufferSize

public int getReceiveBufferSize()

Returns:

the size of the receive buffer

See Also:

• Socket.getReceiveBufferSize()

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)

Parameters:

receiveBufferSize - The size of the receive buffer

See Also:

• Socket.setReceiveBufferSize(int)

getSendBufferSize

public int getSendBufferSize()

Returns:

the size of the send buffer

See Also:

• Socket.getSendBufferSize()

setSendBufferSize

public void setSendBufferSize(int sendBufferSize)

Parameters:

sendBufferSize - The size of the send buffer

See Also:

• Socket.setSendBufferSize(int)

getTrafficClass

public int getTrafficClass()

Returns:

the traffic class

See Also:

• Socket.getTrafficClass()

setTrafficClass

public 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

public boolean isKeepAlive()

Returns:

true if SO_KEEPALIVE is enabled.

See Also:

• Socket.getKeepAlive()

setKeepAlive

public void setKeepAlive(boolean keepAlive)

Parameters:

keepAlive - if SO_KEEPALIVE is to be enabled

See Also:

• Socket.setKeepAlive(boolean)

isOobInline

public boolean isOobInline()

Returns:

true if SO_OOBINLINE is enabled.

See Also:

• Socket.getOOBInline()

setOobInline

public void setOobInline(boolean oobInline)

Parameters:

oobInline - if SO_OOBINLINE is to be enabled

See Also:

• Socket.setOOBInline(boolean)

getSoLinger

public 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

public void setSoLinger(int soLinger)

Please note that enabling SO_LINGER in Java NIO can result in platform-dependent behavior 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

public boolean isTcpNoDelay()

Returns:

true if TCP_NODELAY is enabled.

See Also:

• Socket.getTcpNoDelay()

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

Parameters:

tcpNoDelay - true if TCP_NODELAY is to be enabled

See Also:

• Socket.setTcpNoDelay(boolean)

isKeepAliveChanged

protected boolean isKeepAliveChanged()

Overrides:

isKeepAliveChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the keepAlive property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isOobInlineChanged

protected boolean isOobInlineChanged()

Overrides:

isOobInlineChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the oobInline property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isReceiveBufferSizeChanged

protected boolean isReceiveBufferSizeChanged()

Overrides:

isReceiveBufferSizeChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the receiveBufferSize property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isReuseAddressChanged

protected boolean isReuseAddressChanged()

Overrides:

isReuseAddressChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the reuseAddress property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isSendBufferSizeChanged

protected boolean isSendBufferSizeChanged()

Overrides:

isSendBufferSizeChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the sendBufferSize property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isSoLingerChanged

protected boolean isSoLingerChanged()

Overrides:

isSoLingerChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the soLinger property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isTcpNoDelayChanged

protected boolean isTcpNoDelayChanged()

Overrides:

isTcpNoDelayChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the tcpNoDelay property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.

isTrafficClassChanged

protected boolean isTrafficClassChanged()

Overrides:

isTrafficClassChanged in class AbstractSocketSessionConfig

Returns:

true if and only if the trafficClass property has been changed by its setter method. The system call related with the property is made only when this method returns true. By default, this method always returns true to simplify implementation of subclasses, but overriding the default behavior is always encouraged.