org.snf4j.core.session

Class DefaultSctpSessionConfig

java.lang.Object

org.snf4j.core.session.DefaultSessionConfig

org.snf4j.core.session.DefaultSctpSessionConfig

All Implemented Interfaces:

ISctpSessionConfig, ISessionConfig

Direct Known Subclasses:

SessionConfig

public class DefaultSctpSessionConfig
extends DefaultSessionConfig
implements ISctpSessionConfig

Default configuration for the SCTP session.

Author:

SNF4J.ORG

Field Summary

Fields inherited from interface org.snf4j.core.session.ISctpSessionConfig

DEFAULT_CODEC_EXECUTOR_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
DefaultSctpSessionConfig()

Method Summary

Modifier and Type	Method and Description
ICodecExecutor	createCodecExecutor(Object identifier) Creates a new codec executor that should be used for decoding/encoding SCTP messages that can be identified by the given identifier.
Object	getCodecExecutorIdentifier(com.sun.nio.sctp.MessageInfo msgInfo) Returns an identifier of the codec executor that should be used for decoding/encoding SCTP messages that can be identified by the given ancillary data.
int	getDefaultSctpPayloadProtocolID() Returns the payload protocol identifier for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
SocketAddress	getDefaultSctpPeerAddress() Returns the preferred peer address for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
int	getDefaultSctpStreamNumber() Returns the stream number for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
boolean	getDefaultSctpUnorderedFlag() Returns the unordered flag for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
DefaultSctpSessionConfig	setDefaultSctpPayloadProtocolID(int defaultPayloadProtocolID) Configures the payload protocol identifier for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
DefaultSctpSessionConfig	setDefaultSctpPeerAddress(SocketAddress defaultPeerAddress) Configures the preferred peer address for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
DefaultSctpSessionConfig	setDefaultSctpStreamNumber(int defaultStreamNumber) Configures the stream number for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.
DefaultSctpSessionConfig	setDefaultSctpUnorderedFlag(boolean defaultUnorderedFlag) Configures the unordered flag for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

Methods inherited from class org.snf4j.core.session.DefaultSessionConfig

addSSLEngineBuilder, alwaysNotifiedBeingInPipeline, createCodecExecutor, createSSLEngine, createSSLEngine, getDatagramServerSessionNoReopenPeriod, getEndingAction, getEngineHandshakeTimeout, getMaxInBufferCapacity, getMaxSSLApplicationBufferSizeRatio, getMaxSSLNetworkBufferSizeRatio, getMaxWriteSpinCount, getMinInBufferCapacity, getMinOutBufferCapacity, getSSLEngineBuilder, getThroughputCalculationInterval, ignorePossiblyIncompleteDatagrams, optimizeDataCopying, removeSSLEngineBuilder, setAlwaysNotifiedBeingInPipeline, setDatagramServerSessionNoReopenPeriod, setEndingAction, setEngineHandshakeTimeout, setIgnorePossiblyIncompleteDatagrams, setMaxInBufferCapacity, setMaxSSLApplicationBufferSizeRatio, setMaxSSLNetworkBufferSizeRatio, setMaxWriteSpinCount, setMinInBufferCapacity, setMinOutBufferCapacity, setOptimizeDataCopying, setThroughputCalculationInterval, setWaitForInboundCloseMessage, waitForInboundCloseMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.session.ISessionConfig

alwaysNotifiedBeingInPipeline, createCodecExecutor, createSSLEngine, createSSLEngine, getDatagramServerSessionNoReopenPeriod, getEndingAction, getEngineHandshakeTimeout, getMaxInBufferCapacity, getMaxSSLApplicationBufferSizeRatio, getMaxSSLNetworkBufferSizeRatio, getMaxWriteSpinCount, getMinInBufferCapacity, getMinOutBufferCapacity, getThroughputCalculationInterval, ignorePossiblyIncompleteDatagrams, optimizeDataCopying, waitForInboundCloseMessage

Constructor Detail

DefaultSctpSessionConfig

public DefaultSctpSessionConfig()

Method Detail

getCodecExecutorIdentifier

public Object getCodecExecutorIdentifier(com.sun.nio.sctp.MessageInfo msgInfo)

Returns an identifier of the codec executor that should be used for decoding/encoding SCTP messages that can be identified by the given ancillary data. If the default executor (i.e. created by the ISessionConfig.createCodecExecutor()) should be used this method should return the ISctpSessionConfig.DEFAULT_CODEC_EXECUTOR_IDENTIFIER value.

If the codec executor identified by the ancillary data has not been created yet it will be created by ISctpSessionConfig.createCodecExecutor(Object) and the returned identifier will be used as the argument.

The default value is ISctpSessionConfig.DEFAULT_CODEC_EXECUTOR_IDENTIFIER

Specified by:

getCodecExecutorIdentifier in interface ISctpSessionConfig

Parameters:

msgInfo - the ancillary data about an SCTP message to be decoded/encoded

Returns:

the identifier of the codec executor, or null if decoding and encoding are not required.

createCodecExecutor

public ICodecExecutor createCodecExecutor(Object identifier)

Creates a new codec executor that should be used for decoding/encoding SCTP messages that can be identified by the given identifier.

The default value is null

Specified by:

createCodecExecutor in interface ISctpSessionConfig

Parameters:

identifier - the identifier of the codec executor to create

Returns:

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

getDefaultSctpStreamNumber

public int getDefaultSctpStreamNumber()

Returns the stream number for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

The default value is 0

Specified by:

getDefaultSctpStreamNumber in interface ISctpSessionConfig

Returns:

the default stream number

setDefaultSctpStreamNumber

public DefaultSctpSessionConfig setDefaultSctpStreamNumber(int defaultStreamNumber)

Configures the stream number for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

Parameters:

defaultStreamNumber - the default stream number

Returns:

this session config object

getDefaultSctpPayloadProtocolID

public int getDefaultSctpPayloadProtocolID()

Returns the payload protocol identifier for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

The default value is 0

Specified by:

getDefaultSctpPayloadProtocolID in interface ISctpSessionConfig

Returns:

the default payload protocol identifier

setDefaultSctpPayloadProtocolID

public DefaultSctpSessionConfig setDefaultSctpPayloadProtocolID(int defaultPayloadProtocolID)

Configures the payload protocol identifier for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

Parameters:

defaultPayloadProtocolID - the default payload protocol identifier

Returns:

this session config object

getDefaultSctpUnorderedFlag

public boolean getDefaultSctpUnorderedFlag()

Returns the unordered flag for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

The default value is false

Specified by:

getDefaultSctpUnorderedFlag in interface ISctpSessionConfig

Returns:

the default unordered flag

setDefaultSctpUnorderedFlag

public DefaultSctpSessionConfig setDefaultSctpUnorderedFlag(boolean defaultUnorderedFlag)

Configures the unordered flag for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

Parameters:

defaultUnorderedFlag - the default unordered flag

Returns:

this session config object

getDefaultSctpPeerAddress

public SocketAddress getDefaultSctpPeerAddress()

Returns the preferred peer address for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

The default value is null

Specified by:

getDefaultSctpPeerAddress in interface ISctpSessionConfig

Returns:

the preferred peer address, or null to use the peer primary address

setDefaultSctpPeerAddress

public DefaultSctpSessionConfig setDefaultSctpPeerAddress(SocketAddress defaultPeerAddress)

Configures the preferred peer address for the SCTP messages sent by the ISctpSession's write methods without specified the msgInfo argument.

Parameters:

defaultPeerAddress - the preferred peer address, or null to use the peer primary address

Returns:

this session config object