org.snf4j.core.session

Class DefaultSessionConfig

java.lang.Object

org.snf4j.core.session.DefaultSessionConfig

All Implemented Interfaces:

ISessionConfig

Direct Known Subclasses:

DefaultSctpSessionConfig, DefaultWebSocketSessionConfig, SessionConfig, SessionConfig, SessionConfig

public class DefaultSessionConfig
extends Object
implements ISessionConfig

Default configuration for the session.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
DefaultSessionConfig()

Method Summary

Modifier and Type	Method and Description
DefaultSessionConfig	addSSLEngineBuilder(SSLEngineBuilder builder) Adds a SSLEngine builder that will be used to create the SSLengine for sessions associated with this configuration object.
boolean	alwaysNotifiedBeingInPipeline() Determines if the session being associated with the session pipeline should be notified in a situation when the connection is closed and the processing of the session was not initiated yet.
ICodecExecutor	createCodecExecutor() Creates a new codec executor that will be responsible for decoding and encoding data read/received and written/send in the associated session.
SSLEngine	createSSLEngine(boolean clientMode) Creates a new SSLEngine for the SSL/DTLS session.
SSLEngine	createSSLEngine(SocketAddress remoteAddress, boolean clientMode) Creates a new SSLEngine for the SSL/DTLS session with known remote peer.
long	getDatagramServerSessionNoReopenPeriod() Determines how long the DatagramServerHandler should block re-opening of a new session for the remote peer which session has just been closed.
EndingAction	getEndingAction() Gets the action that should be performed by the selector loop after ending of the associated session.
long	getEngineHandshakeTimeout() Determines how long the SNF4J framework should wait for completion of the handshake phase for engine-driven sessions.
int	getMaxInBufferCapacity() Gets the maximum capacity for the session's input buffer.
int	getMaxSSLApplicationBufferSizeRatio() Gets the ratio that is used to calculate the maximum size of the SSL application buffers.
int	getMaxSSLNetworkBufferSizeRatio() Gets the ratio that is used to calculate the maximum size of the SSL network buffers.
int	getMaxWriteSpinCount() Returns the maximum loop count for write operations performed by the selector loop before returning control to the NIO selector or to other channel ready for I/O operations.
int	getMinInBufferCapacity() Gets the minimum capacity for the session's input buffer.
int	getMinOutBufferCapacity() Gets the minimum capacity for the session's output buffer.
SSLEngineBuilder	getSSLEngineBuilder(boolean clientMode) Returns the SSLEngine builder configured for specified handshaking mode.
long	getThroughputCalculationInterval() Gets the interval in milliseconds between each throughput calculation.
boolean	ignorePossiblyIncompleteDatagrams() Determines if possibly incomplete datagrams should be ignored.
boolean	optimizeDataCopying() Determines if the processing of data should be optimized to reduce data copying between byte buffers.
DefaultSessionConfig	removeSSLEngineBuilder(boolean clientMode) Removes the SSLEngine builder configured for specified handshaking mode.
DefaultSessionConfig	setAlwaysNotifiedBeingInPipeline(boolean notify) Configures if the session being associated with the session pipeline should be notified in a situation when the connection is closed and the processing of the session was not initiated yet.
DefaultSessionConfig	setDatagramServerSessionNoReopenPeriod(long period) Configures how long the DatagramServerHandler should block re-opening of a new session for the remote peer which session has just been closed.
DefaultSessionConfig	setEndingAction(EndingAction action) Sets an action that should be performed by the selector loop after ending of the associated session.
DefaultSessionConfig	setEngineHandshakeTimeout(long timeout) Configures how long the SNF4J framework should wait for completion of the handshake phase for engine-driven sessions.
DefaultSessionConfig	setIgnorePossiblyIncompleteDatagrams(boolean ignore) Configures the behavior after receiving possibly incomplete datagrams.
DefaultSessionConfig	setMaxInBufferCapacity(int capacity) Sets the maximum capacity for the session's input buffer.
DefaultSessionConfig	setMaxSSLApplicationBufferSizeRatio(int ratio) Sets the ratio that is used to calculate the maximum size of the SSL application buffers.
DefaultSessionConfig	setMaxSSLNetworkBufferSizeRatio(int ratio) Sets the ratio that is used to calculate the maximum size of the SSL network buffers.
DefaultSessionConfig	setMaxWriteSpinCount(int count) Configures the maximum loop count for write operations performed by the selector loop before returning control to the NIO selector or to other channel ready for I/O operations.
DefaultSessionConfig	setMinInBufferCapacity(int capacity) Sets the minimum capacity for the session's input buffer.
DefaultSessionConfig	setMinOutBufferCapacity(int capacity) Sets the minimum capacity for the session's output buffer.
DefaultSessionConfig	setOptimizeDataCopying(boolean optimize) Configures if the processing of data should be optimized to reduce data copying between byte buffers.
DefaultSessionConfig	setThroughputCalculationInterval(long interval) Sets the interval in milliseconds between each throughput calculation.
DefaultSessionConfig	setWaitForInboundCloseMessage(boolean waitForCloseMessage) Configures if the SNF4J framework should wait for the peer's corresponding close message in situation when the closing was initiated by calling the EngineStreamSession.close() or EngineStreamSession.quickClose() method.
boolean	waitForInboundCloseMessage() Determines if the SNF4J framework should wait for the peer's corresponding close message in situation when the closing was initiated by calling the EngineStreamSession.close() or EngineStreamSession.quickClose() method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSessionConfig

public DefaultSessionConfig()

Method Detail

setMinInBufferCapacity

public DefaultSessionConfig setMinInBufferCapacity(int capacity)

Sets the minimum capacity for the session's input buffer.

Parameters:

capacity - the minimum capacity in bytes

Returns:

this session config object

getMinInBufferCapacity

public int getMinInBufferCapacity()

Gets the minimum capacity for the session's input buffer. The current capacity is adjusted automatically and will never be decreased below this value.

This value also determines the initial capacity of the input buffer.

Changing it once an associated session is created has no effect for the session.

The default value is 2048

Specified by:

getMinInBufferCapacity in interface ISessionConfig

Returns:

the minimum capacity in bytes.

setMaxInBufferCapacity

public DefaultSessionConfig setMaxInBufferCapacity(int capacity)

Sets the maximum capacity for the session's input buffer.

Parameters:

capacity - the maximum capacity in bytes

Returns:

this session config object

getMaxInBufferCapacity

public int getMaxInBufferCapacity()

Gets the maximum capacity for the session's input buffer. The current capacity is adjusted automatically and will never be increased above this value.

Changing it once an associated session is created has no effect for the session.

The default value is 8192

Specified by:

getMaxInBufferCapacity in interface ISessionConfig

Returns:

the maximum capacity in bytes.

setMinOutBufferCapacity

public DefaultSessionConfig setMinOutBufferCapacity(int capacity)

Sets the minimum capacity for the session's output buffer.

Parameters:

capacity - the minimum capacity in bytes

Returns:

this session config object

getMinOutBufferCapacity

public int getMinOutBufferCapacity()

Gets the minimum capacity for the session's output buffer. The current capacity is adjusted automatically and will never be decreased below this value.

This configuration parameter is only valid for stream-oriented transmissions.

Changing it once an associated session is created has no effect for the session.

The default value is 2048

Specified by:

getMinOutBufferCapacity in interface ISessionConfig

Returns:

the minimum capacity in bytes.

setThroughputCalculationInterval

public DefaultSessionConfig setThroughputCalculationInterval(long interval)

Sets the interval in milliseconds between each throughput calculation.

Parameters:

interval - the interval in milliseconds.

Returns:

this session config object

getThroughputCalculationInterval

public long getThroughputCalculationInterval()

Gets the interval in milliseconds between each throughput calculation.

The default value is 3000

Specified by:

getThroughputCalculationInterval in interface ISessionConfig

Returns:

the interval in milliseconds.

setIgnorePossiblyIncompleteDatagrams

public DefaultSessionConfig setIgnorePossiblyIncompleteDatagrams(boolean ignore)

Configures the behavior after receiving possibly incomplete datagrams.

Parameters:

ignore - true if possibly incomplete datagrams should be ignored.

Returns:

this session config object

ignorePossiblyIncompleteDatagrams

public boolean ignorePossiblyIncompleteDatagrams()

Determines if possibly incomplete datagrams should be ignored.

If the size of received datagram is bigger than the size of session's input buffer the remainder of the datagram is silently discarded by the NIO API. In some protocols (e.g. TFTP) such situations would lead to erroneous processing of the received datagram.

To solve such situations we can ignore each datagram that fully filled up the session's input buffer. Considering that after detecting such datagram the size of the input buffer will be extended up to the max limit there is a big chance that there will be enough room in the buffer when the ignored (i.e. lost) datagram will be retransmitted by the remote end-point.

Changing it once an associated session is created has no effect for the session.

The default value is true

Specified by:

ignorePossiblyIncompleteDatagrams in interface ISessionConfig

Returns:

true if possibly incomplete datagrams should be ignored

See Also:

DatagramChannel.read(java.nio.ByteBuffer)

setOptimizeDataCopying

public DefaultSessionConfig setOptimizeDataCopying(boolean optimize)

Configures if the processing of data should be optimized to reduce data copying between byte buffers.

Parameters:

optimize - true if the processing of data should be optimized

Returns:

this session config object

See Also:

optimizeDataCopying()

optimizeDataCopying

public boolean optimizeDataCopying()

Determines if the processing of data should be optimized to reduce data copying between byte buffers.

Setting this parameter to true instructs the write and send methods that the passed data will be no longer used by the caller. In such situation the write and send methods may, if possible, eliminate not needed copy operations what can improve the performance.

In addition, setting this parameter to true when the allocator associated with the session supports releasing of no longer used buffers will also cause data copy optimization between session's internal byte buffers. In such situation user's implementation is responsible for releasing (calling ISession.release(java.nio.ByteBuffer)) of no longer used buffers that was passed to session handlers or codecs.

The default value is false

Specified by:

optimizeDataCopying in interface ISessionConfig

Returns:

true if the data copy optimization should be enabled

setEndingAction

public DefaultSessionConfig setEndingAction(EndingAction action)

Sets an action that should be performed by the selector loop after ending of the associated session.

Parameters:

action - en ending action

Returns:

this session config object

getEndingAction

public EndingAction getEndingAction()

Gets the action that should be performed by the selector loop after ending of the associated session.

The default value is DEFAULT

Specified by:

getEndingAction in interface ISessionConfig

Returns:

the ending action

addSSLEngineBuilder

public DefaultSessionConfig addSSLEngineBuilder(SSLEngineBuilder builder)

Adds a SSLEngine builder that will be used to create the SSLengine for sessions associated with this configuration object.

Only two builders can be stored. One per handshaking mode: client or server.

Parameters:

builder - an SSLEngine builder to add

Returns:

this session config object

getSSLEngineBuilder

public SSLEngineBuilder getSSLEngineBuilder(boolean clientMode)

Returns the SSLEngine builder configured for specified handshaking mode.

Parameters:

clientMode - true to return the builder for SSL engines handshaking in the client mode

Returns:

the SSL engine builder, or null if the builder is not configured

removeSSLEngineBuilder

public DefaultSessionConfig removeSSLEngineBuilder(boolean clientMode)

Removes the SSLEngine builder configured for specified handshaking mode.

Parameters:

clientMode - true to remove the builder for SSL engines handshaking in the client mode

Returns:

this session config object

createSSLEngine

public SSLEngine createSSLEngine(boolean clientMode)
                          throws SSLEngineCreateException

Creates a new SSLEngine for the SSL/DTLS session.

By default, if no SSLEngine builder is configured for the specified handshaking mode, it returns the engine created by calling the SSLContext.getDefault().createSSLEngine()

Specified by:

createSSLEngine in interface ISessionConfig

Parameters:

clientMode - true if the engine should start its handshaking in client mode

Returns:

the SSLEngine object

Throws:

SSLEngineCreateException - when the SSL engine could not be created

createSSLEngine

public SSLEngine createSSLEngine(SocketAddress remoteAddress,
                                 boolean clientMode)
                          throws SSLEngineCreateException

Creates a new SSLEngine for the SSL/DTLS session with known remote peer. It is called when the remote address is known at the moment a session object is created.

By default it returns the engine created by calling the createSSLEngine(boolean) method.

Specified by:

createSSLEngine in interface ISessionConfig

Parameters:

remoteAddress - the address of the remote peer

clientMode - true if the engine should start its handshaking in client mode

Returns:

the SSLEngine object

Throws:

SSLEngineCreateException - when the SSL engine could not be created

setMaxSSLApplicationBufferSizeRatio

public DefaultSessionConfig setMaxSSLApplicationBufferSizeRatio(int ratio)

Sets the ratio that is used to calculate the maximum size of the SSL application buffers.

Parameters:

ratio - the ratio

Returns:

this session config object

Throws:

IllegalArgumentException - if the ratio is less than 100

See Also:

getMaxSSLApplicationBufferSizeRatio()

getMaxSSLApplicationBufferSizeRatio

public int getMaxSSLApplicationBufferSizeRatio()

Gets the ratio that is used to calculate the maximum size of the SSL application buffers. The base for the calculation is the maximum SSL application packet size that is determined by the SSLEngine.

As the maximum size of the SSL application buffers cannot be less than the maximum SSL application packet size all values less than 100 will be silently ignored and treated as 100.

The default value is 100

Specified by:

getMaxSSLApplicationBufferSizeRatio in interface ISessionConfig

Returns:

the ratio

See Also:

SSLSession.getApplicationBufferSize()

setMaxSSLNetworkBufferSizeRatio

public DefaultSessionConfig setMaxSSLNetworkBufferSizeRatio(int ratio)

Sets the ratio that is used to calculate the maximum size of the SSL network buffers.

Parameters:

ratio - the ratio

Returns:

this session config object

Throws:

IllegalArgumentException - if the ratio is less than 100

See Also:

getMaxSSLNetworkBufferSizeRatio()

getMaxSSLNetworkBufferSizeRatio

public int getMaxSSLNetworkBufferSizeRatio()

Gets the ratio that is used to calculate the maximum size of the SSL network buffers. The base for the calculation is the maximum SSL network packet size that is determined by the SSLEngine.

As the maximum size of the SSL network buffers cannot be less than the maximum SSL network packet size all values less than 100 will be silently ignored and treated as 100.

The default value is 100

Specified by:

getMaxSSLNetworkBufferSizeRatio in interface ISessionConfig

Returns:

the ratio

See Also:

SSLSession.getPacketBufferSize()

waitForInboundCloseMessage

public boolean waitForInboundCloseMessage()

Determines if the SNF4J framework should wait for the peer's corresponding close message in situation when the closing was initiated by calling the EngineStreamSession.close() or EngineStreamSession.quickClose() method.

NOTE: Setting this value to true may delay the closing of the connection for an indefinite period of time. Usually it is not required to wait for the close message (e.g. the TLS specification (RFC 2246))

The default value is false

Specified by:

waitForInboundCloseMessage in interface ISessionConfig

Returns:

true to wait for the peer's corresponding close message.

setWaitForInboundCloseMessage

public DefaultSessionConfig setWaitForInboundCloseMessage(boolean waitForCloseMessage)

Configures if the SNF4J framework should wait for the peer's corresponding close message in situation when the closing was initiated by calling the EngineStreamSession.close() or EngineStreamSession.quickClose() method.

Parameters:

waitForCloseMessage - true to wait for the peer's corresponding close message.

Returns:

this session config object

See Also:

waitForInboundCloseMessage()

createCodecExecutor

public ICodecExecutor createCodecExecutor()

Creates a new codec executor that will be responsible for decoding and encoding data read/received and written/send in the associated session.

The default value is null

Specified by:

createCodecExecutor in interface ISessionConfig

Returns:

the codec executor, or null if decoding and encoding is not required.

setEngineHandshakeTimeout

public DefaultSessionConfig setEngineHandshakeTimeout(long timeout)

Configures how long the SNF4J framework should wait for completion of the handshake phase for engine-driven sessions.

Parameters:

timeout - the timeout in milliseconds

Returns:

this session config object

See Also:

getEngineHandshakeTimeout()

getEngineHandshakeTimeout

public long getEngineHandshakeTimeout()

Determines how long the SNF4J framework should wait for completion of the handshake phase for engine-driven sessions. If the handshake does not complete within the timeout interval the HandshakeTimeoutException will be thrown and the session will be quickly closed.

The default value is 60000

Specified by:

getEngineHandshakeTimeout in interface ISessionConfig

Returns:

the timeout in milliseconds

setDatagramServerSessionNoReopenPeriod

public DefaultSessionConfig setDatagramServerSessionNoReopenPeriod(long period)

Configures how long the DatagramServerHandler should block re-opening of a new session for the remote peer which session has just been closed. The purpose of it is to prevent opening of a new session as a result of receiving some delayed or retransmitted datagrams.

Parameters:

period - the period in milliseconds or zero if the re-opening should be allowed immediately

Returns:

this session config object

See Also:

getDatagramServerSessionNoReopenPeriod()

getDatagramServerSessionNoReopenPeriod

public long getDatagramServerSessionNoReopenPeriod()

Determines how long the DatagramServerHandler should block re-opening of a new session for the remote peer which session has just been closed. The purpose of it is to prevent opening of a new session as a result of receiving some delayed or retransmitted datagrams.

The default value is 60000

Specified by:

getDatagramServerSessionNoReopenPeriod in interface ISessionConfig

Returns:

the period in milliseconds or zero if the re-opening should be allowed immediately

setMaxWriteSpinCount

public DefaultSessionConfig setMaxWriteSpinCount(int count)

Configures the maximum loop count for write operations performed by the selector loop before returning control to the NIO selector or to other channel ready for I/O operations. The write operations are performed in the loop until the channel's write method returns a non-zero value and there is still pending data to be written or the maximum loop count is reached.

It improves write throughput depending on the platform that JVM runs on.

Parameters:

count - the maximum loop count

Returns:

this session config object

See Also:

getMaxWriteSpinCount()

getMaxWriteSpinCount

public int getMaxWriteSpinCount()

Returns the maximum loop count for write operations performed by the selector loop before returning control to the NIO selector or to other channel ready for I/O operations. The write operations are performed in the loop until the channel's write method returns a non-zero value and there is still pending data to be written or the maximum loop count is reached.

It improves write throughput depending on the platform that JVM runs on.

The default value is 16

Specified by:

getMaxWriteSpinCount in interface ISessionConfig

Returns:

the maximum loop count for write operations

setAlwaysNotifiedBeingInPipeline

public DefaultSessionConfig setAlwaysNotifiedBeingInPipeline(boolean notify)

Configures if the session being associated with the session pipeline should be notified in a situation when the connection is closed and the processing of the session was not initiated yet.

If the returned value is false the session that was not processed yet will not be notified (i.e. session events will not be fired). However, this does not apply to the session that owns the pipeline as it will always be notified.

Parameters:

notify - true to always notify the session being associated with the pipeline

Returns:

this session config object

See Also:

alwaysNotifiedBeingInPipeline()

alwaysNotifiedBeingInPipeline

public boolean alwaysNotifiedBeingInPipeline()

Determines if the session being associated with the session pipeline should be notified in a situation when the connection is closed and the processing of the session was not initiated yet.

If the returned value is false the session that was not processed yet will not be notified (i.e. session events will not be fired). However, this does not apply to the session that owns the pipeline as it will always be notified.

The default value is false

Specified by:

alwaysNotifiedBeingInPipeline in interface ISessionConfig

Returns:

true to always notify the session being associated with the pipeline