org.snf4j.core

Class ImmutableSctpMessageInfo

java.lang.Object

com.sun.nio.sctp.MessageInfo

org.snf4j.core.ImmutableSctpMessageInfo

public abstract class ImmutableSctpMessageInfo
extends com.sun.nio.sctp.MessageInfo

An immutable implementation of the com.sun.nio.sctp.MessageInfo.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, int streamNumber) Creates an immutable MessageInfo with specified association, stream number, and the peer primary address as the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, int streamNumber, int payloadProtocolID) Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier and the peer primary address as the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, int streamNumber, int payloadProtocolID, boolean unordered) Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier, unordered flag and the peer primary address as the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, SocketAddress address, int streamNumber) Creates an immutable MessageInfo with specified association, stream number and the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, SocketAddress address, int streamNumber, int payloadProtocolID) Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier and the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.Association association, SocketAddress address, int streamNumber, int payloadProtocolID, boolean unordered) Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier, unordered flag and the preferred peer address of the association to send the message to.
static ImmutableSctpMessageInfo	create(int streamNumber) Creates an immutable MessageInfo with specified stream number and the peer primary address as the preferred peer address.
static ImmutableSctpMessageInfo	create(int streamNumber, int payloadProtocolID) Creates an immutable MessageInfo with specified stream number, payload protocol identifier and the peer primary address as the preferred peer address.
static ImmutableSctpMessageInfo	create(int streamNumber, int payloadProtocolID, boolean unordered) Creates an immutable MessageInfo with specified stream number, payload protocol identifier, unordered flag and the peer primary address as the preferred peer address.
static ImmutableSctpMessageInfo	create(com.sun.nio.sctp.MessageInfo msgInfo) Creates an immutable MessageInfo that is cloned from the specified MessageInfo instance.
static ImmutableSctpMessageInfo	create(SocketAddress address, int streamNumber) Creates an immutable MessageInfo with specified stream number and the preferred peer address.
static ImmutableSctpMessageInfo	create(SocketAddress address, int streamNumber, int payloadProtocolID) Creates an immutable MessageInfo with specified stream number, payload protocol identifier and the preferred peer address.
static ImmutableSctpMessageInfo	create(SocketAddress address, int streamNumber, int payloadProtocolID, boolean unordered) Creates an immutable MessageInfo with specified stream number, payload protocol identifier, unordered flag and the preferred peer address.
static ImmutableSctpMessageInfo	wrap(com.sun.nio.sctp.MessageInfo msgInfo) Wraps the specified MessageInfo instance.

Methods inherited from class com.sun.nio.sctp.MessageInfo

address, association, bytes, complete, createOutgoing, createOutgoing, isComplete, isUnordered, payloadProtocolID, payloadProtocolID, streamNumber, streamNumber, timeToLive, timeToLive, unordered

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ImmutableSctpMessageInfo create(int streamNumber)

Creates an immutable MessageInfo with specified stream number and the peer primary address as the preferred peer address.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, its complete value set to true, and its payloadProtocolID value set to 0.

Parameters:

streamNumber - the stream number that the message will be sent on

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(SocketAddress address,
                                              int streamNumber)

Creates an immutable MessageInfo with specified stream number and the preferred peer address.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, its complete value set to true, and its payloadProtocolID value set to 0.

Parameters:

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              int streamNumber)

Creates an immutable MessageInfo with specified association, stream number, and the peer primary address as the preferred peer address of the association to send the message to.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, its complete value set to true, and its payloadProtocolID value set to 0.

Parameters:

association - the association to send the message on

streamNumber - the stream number that the message will be sent on

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              SocketAddress address,
                                              int streamNumber)

Creates an immutable MessageInfo with specified association, stream number and the preferred peer address of the association to send the message to.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, its complete value set to true, and its payloadProtocolID value set to 0.

Parameters:

association - the association to send the message on

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(int streamNumber,
                                              int payloadProtocolID)

Creates an immutable MessageInfo with specified stream number, payload protocol identifier and the peer primary address as the preferred peer address.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, and its complete value set to true.

Parameters:

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(SocketAddress address,
                                              int streamNumber,
                                              int payloadProtocolID)

Creates an immutable MessageInfo with specified stream number, payload protocol identifier and the preferred peer address.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, and its complete value set to true.

Parameters:

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              int streamNumber,
                                              int payloadProtocolID)

Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier and the peer primary address as the preferred peer address of the association to send the message to.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, and its complete value set to true.

Parameters:

association - the association to send the message on

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              SocketAddress address,
                                              int streamNumber,
                                              int payloadProtocolID)

Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier and the preferred peer address of the association to send the message to.

The returned instance will have its unordered flag set to false, its timeToLive value set to 0, and its complete value set to true.

Parameters:

association - the association to send the message on

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(int streamNumber,
                                              int payloadProtocolID,
                                              boolean unordered)

Creates an immutable MessageInfo with specified stream number, payload protocol identifier, unordered flag and the peer primary address as the preferred peer address.

The returned instance will have its timeToLive value set to 0, and its complete value set to true.

Parameters:

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

unordered - true requests the un-ordered delivery of the message, false indicates that the message is ordered.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(SocketAddress address,
                                              int streamNumber,
                                              int payloadProtocolID,
                                              boolean unordered)

Creates an immutable MessageInfo with specified stream number, payload protocol identifier, unordered flag and the preferred peer address.

The returned instance will have its timeToLive value set to 0, and its complete value set to true.

Parameters:

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

unordered - true requests the un-ordered delivery of the message, false indicates that the message is ordered.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              int streamNumber,
                                              int payloadProtocolID,
                                              boolean unordered)

Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier, unordered flag and the peer primary address as the preferred peer address of the association to send the message to.

The returned instance will have its timeToLive value set to 0, and its complete value set to true.

Parameters:

association - the association to send the message on

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

unordered - true requests the un-ordered delivery of the message, false indicates that the message is ordered.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.Association association,
                                              SocketAddress address,
                                              int streamNumber,
                                              int payloadProtocolID,
                                              boolean unordered)

Creates an immutable MessageInfo with specified association, stream number, payload protocol identifier, unordered flag and the preferred peer address of the association to send the message to.

The returned instance will have its timeToLive value set to 0, and its complete value set to true.

Parameters:

association - the association to send the message on

address - the preferred peer address of the association to send the message to, or null to use the peer primary address

streamNumber - the stream number that the message will be sent on

payloadProtocolID - The payload protocol identifier.

unordered - true requests the un-ordered delivery of the message, false indicates that the message is ordered.

Returns:

the immutable MessageInfo

create

public static ImmutableSctpMessageInfo create(com.sun.nio.sctp.MessageInfo msgInfo)

Creates an immutable MessageInfo that is cloned from the specified MessageInfo instance.

Parameters:

msgInfo - the instance from which the immutable MessageInfo should be cloned

Returns:

the immutable MessageInfo

wrap

public static ImmutableSctpMessageInfo wrap(com.sun.nio.sctp.MessageInfo msgInfo)

Wraps the specified MessageInfo instance.

Caution: The return instance is not immutable and have to be handled carefully after passing it to ISctpSession's write methods. The internal state of the wrapped instance should not be change as it may affect the result of the write methods.

Parameters:

msgInfo - the MessageInfo instance to be wrapped

Returns:

the immutable MessageInfo