SctpMultiSession (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.IdentifiableObject
- - org.snf4j.core.session.AbstractSession
  - - org.snf4j.core.SctpMultiSession

All Implemented Interfaces:

ISctpMultiSession, ISctpSession, ISession
```
public class SctpMultiSession
extends AbstractSession
implements ISctpMultiSession
```
The Stream Control Transmission Protocol (SCTP) multi-session.
It uses the message-oriented connected SCTP socket as described in the IETF RFC 4960 "Stream Control Transmission Protocol".

Author:

SNF4J.ORG

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`allocate(int capacity)` Allocates a byte buffer by using the allocator associated with this session.
`IFuture<Void>`	`bindAddress(InetAddress address)` Adds the given address to the bound addresses for the SCTP channel's socket associated with this session
`void`	`close()` Gently closes this session after all pending data waiting for writing are fully flushed.
`void`	`dirtyClose()` Quickly closes this session without flushing any pending data and without following close procedure of an application layer (e.g.
`IFuture<Void>`	`execute(Runnable task)` Executes a task in the selector-loop's thread this session is registered with.
`void`	`executenf(Runnable task)` Executes a task in the selector-loop's thread this session is registered with.
`com.sun.nio.sctp.Association`	`getAssociation()` Returns the association on the SCTP channel's socket associated with this session
`Set<com.sun.nio.sctp.Association>`	`getAssociations()` Returns the open associations on the SCTP multi-channel's socket associated with this session.
`IFuture<Void>`	`getCloseFuture()` Gets the future that can be use to wait for the completion of the closing phase.
`ICodecPipeline`	`getCodecPipeline()` Gets the codec pipeline that is associated with this session.
`ICodecPipeline`	`getCodecPipeline(Object identifier)` Gets the codec pipeline that is associated with this session and is identified by the given identifier.
`ISessionConfig`	`getConfig()` Gets the configuration of this session.
`IFuture<Void>`	`getCreateFuture()` Gets the future that can be use to wait for the completion of the creation phase.
`long`	`getCreationTime()` Gets the session's creation time in milliseconds.
`IFuture<Void>`	`getEndFuture()` Gets the future that can be use to wait for the completion of the ending phase.
`ISctpHandler`	`getHandler()` Gets the SCTP handler associated with this session
`long`	`getLastIoTime()` Gets the time in milliseconds when I/O operation occurred lastly.
`long`	`getLastReadTime()` Gets the time in milliseconds when read operation occurred lastly.
`long`	`getLastWriteTime()` Gets the time in milliseconds when write operation occurred lastly.
`SocketAddress`	`getLocalAddress()` Returns one of the local addresses this session is bound to.
`Set<SocketAddress>`	`getLocalAddresses()` Returns all of the socket addresses to which the SCTP channel associated with this session is bound.
`IFuture<Void>`	`getOpenFuture()` Gets the future that can be use to wait for the completion of the opening phase.
`ISctpMultiSession`	`getParent()` Gets the parent session.
`long`	`getReadBytes()` Gets the total number of bytes which were read from this session.
`double`	`getReadBytesThroughput()` Gets the number of read bytes per second.
`IFuture<Void>`	`getReadyFuture()` Gets the future that can be use to wait for the completion of the ready phase.
`SocketAddress`	`getRemoteAddress()` Returns one of the remote addresses to which this session is connected.
`Set<SocketAddress>`	`getRemoteAddresses()` Returns all of the remote addresses to which the SCTP channel associated with this session is connected.
`Set<SocketAddress>`	`getRemoteAddresses(com.sun.nio.sctp.Association association)` Returns all of the remote addresses to which the given association on the SCTP multi-channel's socket associated with this session.
`SessionState`	`getState()` Gets the current state of this session.
`ISessionTimer`	`getTimer()` Gets the session timer associated with this session.
`long`	`getWrittenBytes()` Gets the total number of bytes which were written to this session.
`double`	`getWrittenBytesThroughput()` Gets the number of written bytes per second.
`boolean`	`isDataCopyingOptimized()` Tells if the processing of data is optimized to reduce data copying between byte buffers.
`boolean`	`isOpen()` Tells if this session is open.
`boolean`	`isReadSuspended()` Tells if read operations are suspended for this session.
`boolean`	`isWriteSuspended()` Tells if write operations are suspended for this session.
`void`	`quickClose()` Quickly closes this session without flushing any pending data.
`void`	`release(ByteBuffer buffer)` Release given byte buffer by the allocator associated with this session.
`void`	`resumeRead()` Resumes read operations for this session.
`void`	`resumeWrite()` Resumes write operations for this session.
`IFuture<Void>`	`shutdown(com.sun.nio.sctp.Association association)` Shutdown an association without closing this session.
`void`	`suspendRead()` Suspends read operations for this session.
`void`	`suspendWrite()` Suspends write operations for this session.
`IFuture<Void>`	`unbindAddress(InetAddress address)` Removes the given address from the bound addresses for the SCTP channel's socket associated with this session
`IFuture<Void>`	`write(byte[] msg)` Writes a message from the specified byte array to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(byte[] msg, ImmutableSctpMessageInfo msgInfo)` Writes a message from the specified byte array to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(byte[] msg, int offset, int length)` Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(byte[] msg, int offset, int length, ImmutableSctpMessageInfo msgInfo)` Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(ByteBuffer msg)` Writes a message from the specified byte buffer to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(ByteBuffer msg, ImmutableSctpMessageInfo msgInfo)` Writes a message from the specified byte buffer to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(ByteBuffer msg, int length)` Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(ByteBuffer msg, int length, ImmutableSctpMessageInfo msgInfo)` Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(Object msg)` Writes a message to the SCTP channel that is associated with this session.
`IFuture<Void>`	`write(Object msg, ImmutableSctpMessageInfo msgInfo)` Writes a message to the SCTP channel that is associated with this session.
`void`	`writenf(byte[] msg)` Writes a message from the specified byte array to the SCTP channel that is associated with this session.
`void`	`writenf(byte[] msg, ImmutableSctpMessageInfo msgInfo)` Writes a message from the specified byte array to the SCTP channel that is associated with this session.
`void`	`writenf(byte[] msg, int offset, int length)` Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session.
`void`	`writenf(byte[] msg, int offset, int length, ImmutableSctpMessageInfo msgInfo)` Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session.
`void`	`writenf(ByteBuffer msg)` Writes a message from the specified byte buffer to the SCTP channel that is associated with this session.
`void`	`writenf(ByteBuffer msg, ImmutableSctpMessageInfo msgInfo)` Writes a message from the specified byte buffer to the SCTP channel that is associated with this session.
`void`	`writenf(ByteBuffer msg, int length)` Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session.
`void`	`writenf(ByteBuffer msg, int length, ImmutableSctpMessageInfo msgInfo)` Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session.
`void`	`writenf(Object msg)` Writes a message to the SCTP channel that is associated with this session.
`void`	`writenf(Object msg, ImmutableSctpMessageInfo msgInfo)` Writes a message to the SCTP channel that is associated with this session.

Methods inherited from class org.snf4j.core.session.AbstractSession
getAttributes

Methods inherited from class org.snf4j.core.IdentifiableObject
getId, getName, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.snf4j.core.session.ISctpSession
bindAddress, getCodecPipeline, getHandler, getLocalAddress, getLocalAddresses, unbindAddress, write, write, write, write, write, writenf, writenf, writenf, writenf, writenf

Methods inherited from interface org.snf4j.core.session.ISession
allocate, close, dirtyClose, execute, executenf, getAttributes, getCloseFuture, getCodecPipeline, getConfig, getCreateFuture, getCreationTime, getEndFuture, getId, getLastIoTime, getLastReadTime, getLastWriteTime, getName, getOpenFuture, getReadBytes, getReadBytesThroughput, getReadyFuture, getState, getTimer, getWrittenBytes, getWrittenBytesThroughput, isDataCopyingOptimized, isOpen, isReadSuspended, isWriteSuspended, quickClose, release, resumeRead, resumeWrite, suspendRead, suspendWrite

- Method Detail
  - getParent
```
public ISctpMultiSession getParent()
```
    Description copied from interface: ISession
    
    Gets the parent session.
    Some sessions may not implement its own I/O functionalities and use their parent's ones instead.
    
    Specified by:
    
    getParent in interface ISctpMultiSession
    
    Specified by:
    
    getParent in interface ISctpSession
    
    Specified by:
    
    getParent in interface ISession
    
    Returns:
    
    the parent session or null if it does not exist.
  - shutdown
```
public IFuture<Void> shutdown(com.sun.nio.sctp.Association association)
```
    Description copied from interface: ISctpMultiSession
    
    Shutdown an association without closing this session.
    
    Specified by:
    
    shutdown in interface ISctpMultiSession
    
    Parameters:
    
    association - the association to shutdown
    
    Returns:
    
    the future associated with this shutdown operation
  - getAssociation
```
public com.sun.nio.sctp.Association getAssociation()
```
    Description copied from interface: ISctpSession
    
    Returns the association on the SCTP channel's socket associated with this session
    
    Specified by:
    
    getAssociation in interface ISctpSession
    
    Returns:
    
    the association, or null if the SCTP channel's socket is not connected
  - getAssociations
```
public Set<com.sun.nio.sctp.Association> getAssociations()
```
    Description copied from interface: ISctpMultiSession
    
    Returns the open associations on the SCTP multi-channel's socket associated with this session.
    
    Specified by:
    
    getAssociations in interface ISctpMultiSession
    
    Returns:
    
    the open associations, or an empty Set if there are none
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    Description copied from interface: ISctpSession
    
    Returns one of the remote addresses to which this session is connected.
    NOTE: The return address cannot be treated as the peer's primary address. It is the application's responsibility to keep track of it's peer's primary address.
    
    Specified by:
    
    getRemoteAddress in interface ISctpSession
    
    Specified by:
    
    getRemoteAddress in interface ISession
    
    Returns:
    
    the remote address or null if this session is not connected yet
    
    See Also:
    
    Socket
  - getRemoteAddresses
```
public Set<SocketAddress> getRemoteAddresses()
```
    Description copied from interface: ISctpSession
    
    Returns all of the remote addresses to which the SCTP channel associated with this session is connected.
    
    Specified by:
    
    getRemoteAddresses in interface ISctpMultiSession
    
    Specified by:
    
    getRemoteAddresses in interface ISctpSession
    
    Returns:
    
    All of the remote addresses to which the SCTP channel associated with this session is connected, or an empty Set if the channel is not connected
  - getRemoteAddresses
```
public Set<SocketAddress> getRemoteAddresses(com.sun.nio.sctp.Association association)
```
    Description copied from interface: ISctpMultiSession
    
    Returns all of the remote addresses to which the given association on the SCTP multi-channel's socket associated with this session.
    
    Specified by:
    
    getRemoteAddresses in interface ISctpMultiSession
    
    Parameters:
    
    association - the given association
    
    Returns:
    
    all of the remote addresses for the given association, or an empty Set if the association has been shutdown
  - write
```
public IFuture<Void> write(byte[] msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpMultiSession
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    Returns:
    
    the future associated with this write operation
  - write
```
public IFuture<Void> write(byte[] msg,
                           int offset,
                           int length)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpMultiSession
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    offset - offset within the array of the first byte to be written
    
    length - number of bytes to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(byte[] msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpMultiSession
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
  - writenf
```
public void writenf(byte[] msg,
                    int offset,
                    int length)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpMultiSession
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    offset - offset within the array of the first byte to be written
    
    length - number of bytes to be written
  - write
```
public IFuture<Void> write(ByteBuffer msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpMultiSession
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    Returns:
    
    the future associated with this write operation
  - write
```
public IFuture<Void> write(ByteBuffer msg,
                           int length)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpMultiSession
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    length - number of bytes to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(ByteBuffer msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpMultiSession
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
  - writenf
```
public void writenf(ByteBuffer msg,
                    int length)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpMultiSession
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    length - number of bytes to be written
  - write
```
public IFuture<Void> write(Object msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method usually requires that the session has configured a codec pipeline with at least one encoder that accepts the msg as the inbound data. If a codec pipeline is not configured or no encoder accept the msg object it still accepts messages that are of the byte[] or ByteBuffer type.
    
    Specified by:
    
    write in interface ISctpMultiSession
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(Object msg)
```
    Description copied from interface: ISctpSession
    
    Writes a message to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the default values for address, streamNumber, payloadProtocolID and unordered that were read from the session's configuration during creation of this session.
    The operation is asynchronous.
    This method usually requires that the session has configured a codec pipeline with at least one encoder that accepts the msg as the inbound data. If a codec pipeline is not configured or no encoder accept the msg object it still accepts messages that are of the byte[] or ByteBuffer type.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpMultiSession
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
  - getHandler
```
public ISctpHandler getHandler()
```
    Description copied from interface: ISctpSession
    
    Gets the SCTP handler associated with this session
    
    Specified by:
    
    getHandler in interface ISctpSession
    
    Specified by:
    
    getHandler in interface ISession
    
    Returns:
    
    the SCTP handler
  - close
```
public void close()
```
    Description copied from interface: ISession
    
    Gently closes this session after all pending data waiting for writing are fully flushed. This operation is asynchronous.
    After returning from this method any consecutive writes will be simply discarded.
    
    Specified by:
    
    close in interface ISession
  - quickClose
```
public void quickClose()
```
    Description copied from interface: ISession
    
    Quickly closes this session without flushing any pending data. This operation is asynchronous.
    After returning from this method any consecutive writes will be simply discarded.
    
    Specified by:
    
    quickClose in interface ISession
  - getCodecPipeline
```
public ICodecPipeline getCodecPipeline(Object identifier)
```
    Description copied from interface: ISctpSession
    
    Gets the codec pipeline that is associated with this session and is identified by the given identifier.
    
    Specified by:
    
    getCodecPipeline in interface ISctpSession
    
    Parameters:
    
    identifier - the identifier of the codec pipeline
    
    Returns:
    
    the codec pipeline or null if the session does not support it or it has not been created yet
  - getLocalAddress
```
public SocketAddress getLocalAddress()
```
    Description copied from interface: ISctpSession
    
    Returns one of the local addresses this session is bound to.
    NOTE: The return address cannot be treated as the local primary address. It is the application's responsibility to keep track of it's local primary address.
    
    Specified by:
    
    getLocalAddress in interface ISctpSession
    
    Specified by:
    
    getLocalAddress in interface ISession
    
    Returns:
    
    the local address or null if this session is not bound yet
    
    See Also:
    
    Socket
  - getLocalAddresses
```
public Set<SocketAddress> getLocalAddresses()
```
    Description copied from interface: ISctpSession
    
    Returns all of the socket addresses to which the SCTP channel associated with this session is bound.
    
    Specified by:
    
    getLocalAddresses in interface ISctpSession
    
    Returns:
    
    All the socket addresses that the SCTP channel associated with this session is bound to, or an empty Set if the channel is not bound
  - bindAddress
```
public IFuture<Void> bindAddress(InetAddress address)
```
    Description copied from interface: ISctpSession
    
    Adds the given address to the bound addresses for the SCTP channel's socket associated with this session
    
    Specified by:
    
    bindAddress in interface ISctpSession
    
    Parameters:
    
    address - the address to add to the bound addresses
    
    Returns:
    
    the future associated with this bind operation
  - unbindAddress
```
public IFuture<Void> unbindAddress(InetAddress address)
```
    Description copied from interface: ISctpSession
    
    Removes the given address from the bound addresses for the SCTP channel's socket associated with this session
    
    Specified by:
    
    unbindAddress in interface ISctpSession
    
    Parameters:
    
    address - the address to remove from the bound addresses
    
    Returns:
    
    the future associated with this unbind operation
  - write
```
public IFuture<Void> write(byte[] msg,
                           ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
    
    Returns:
    
    the future associated with this write operation
  - write
```
public IFuture<Void> write(byte[] msg,
                           int offset,
                           int length,
                           ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    offset - offset within the array of the first byte to be written
    
    length - number of bytes to be written
    
    msgInfo - immutable ancillary data about the message to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(byte[] msg,
                    ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
  - writenf
```
public void writenf(byte[] msg,
                    int offset,
                    int length,
                    ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte array to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    offset - offset within the array of the first byte to be written
    
    length - number of bytes to be written
    
    msgInfo - immutable ancillary data about the message to be written
  - write
```
public IFuture<Void> write(ByteBuffer msg,
                           int length,
                           ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    length - number of bytes to be written
    
    msgInfo - immutable ancillary data about the message to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(ByteBuffer msg,
                    ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
  - writenf
```
public void writenf(ByteBuffer msg,
                    int length,
                    ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message of given length from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    length - number of bytes to be written
    
    msgInfo - immutable ancillary data about the message to be written
  - write
```
public IFuture<Void> write(Object msg,
                           ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method usually requires that the session has configured a codec pipeline with at least one encoder that accepts the msg as the inbound data. If a codec pipeline is not configured or no encoder accept the msg object it still accepts messages that are of the byte[] or ByteBuffer type.
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
    
    Returns:
    
    the future associated with this write operation
  - write
```
public IFuture<Void> write(ByteBuffer msg,
                           ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message from the specified byte buffer to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(Object msg,
                    ImmutableSctpMessageInfo msgInfo)
```
    Description copied from interface: ISctpSession
    
    Writes a message to the SCTP channel that is associated with this session. The message will be written with the com.sun.nio.sctp.MessageInfo created based on the specified immutable ancillary data.
    The operation is asynchronous.
    This method usually requires that the session has configured a codec pipeline with at least one encoder that accepts the msg as the inbound data. If a codec pipeline is not configured or no encoder accept the msg object it still accepts messages that are of the byte[] or ByteBuffer type.
    This method should be used whenever there will be no need to synchronize on a future object. This will save some resources and may improve performance.
    
    Specified by:
    
    writenf in interface ISctpSession
    
    Parameters:
    
    msg - the byte array containing the message to be written
    
    msgInfo - immutable ancillary data about the message to be written
  - getCreateFuture
```
public IFuture<Void> getCreateFuture()
```
    Description copied from interface: ISession
    
    Gets the future that can be use to wait for the completion of the creation phase.
    
    Specified by:
    
    getCreateFuture in interface ISession
    
    Returns:
    
    the future associated with the creation phase of this session
  - getOpenFuture
```
public IFuture<Void> getOpenFuture()
```
    Description copied from interface: ISession
    
    Gets the future that can be use to wait for the completion of the opening phase.
    
    Specified by:
    
    getOpenFuture in interface ISession
    
    Returns:
    
    the future associated with the opening phase of this session
  - getReadyFuture
```
public IFuture<Void> getReadyFuture()
```
    Description copied from interface: ISession
    
    Gets the future that can be use to wait for the completion of the ready phase.
    
    Specified by:
    
    getReadyFuture in interface ISession
    
    Returns:
    
    the future associated with the opening phase of this session
  - getCloseFuture
```
public IFuture<Void> getCloseFuture()
```
    Description copied from interface: ISession
    
    Gets the future that can be use to wait for the completion of the closing phase.
    
    Specified by:
    
    getCloseFuture in interface ISession
    
    Returns:
    
    the future associated with the closing phase of this session
  - getEndFuture
```
public IFuture<Void> getEndFuture()
```
    Description copied from interface: ISession
    
    Gets the future that can be use to wait for the completion of the ending phase.
    
    Specified by:
    
    getEndFuture in interface ISession
    
    Returns:
    
    the future associated with the ending phase of this session
  - getConfig
```
public ISessionConfig getConfig()
```
    Description copied from interface: ISession
    
    Gets the configuration of this session.
    
    Specified by:
    
    getConfig in interface ISession
    
    Returns:
    
    the configuration
  - getCodecPipeline
```
public ICodecPipeline getCodecPipeline()
```
    Description copied from interface: ISession
    
    Gets the codec pipeline that is associated with this session.
    
    Specified by:
    
    getCodecPipeline in interface ISession
    
    Returns:
    
    the codec pipeline or null if the session does not support it
  - getState
```
public SessionState getState()
```
    Description copied from interface: ISession
    
    Gets the current state of this session.
    
    Specified by:
    
    getState in interface ISession
    
    Returns:
    
    the current state
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: ISession
    Tells if this session is open. It means that the session is able to communicate with the remote end.
    It is equal to:
```
 return getState() == SessionState.OPEN
 
```
    Specified by:
    
    isOpen in interface ISession
    
    Returns:
    
    true if the session is open.
  - dirtyClose
```
public void dirtyClose()
```
    Description copied from interface: ISession
    
    Quickly closes this session without flushing any pending data and without following close procedure of an application layer (e.g. SSL/TLS).
    
    Specified by:
    
    dirtyClose in interface ISession
  - suspendRead
```
public void suspendRead()
```
    Description copied from interface: ISession
    
    Suspends read operations for this session.
    
    Specified by:
    
    suspendRead in interface ISession
  - suspendWrite
```
public void suspendWrite()
```
    Description copied from interface: ISession
    
    Suspends write operations for this session.
    
    Specified by:
    
    suspendWrite in interface ISession
  - resumeRead
```
public void resumeRead()
```
    Description copied from interface: ISession
    
    Resumes read operations for this session.
    
    Specified by:
    
    resumeRead in interface ISession
  - resumeWrite
```
public void resumeWrite()
```
    Description copied from interface: ISession
    
    Resumes write operations for this session.
    
    Specified by:
    
    resumeWrite in interface ISession
  - isReadSuspended
```
public boolean isReadSuspended()
```
    Description copied from interface: ISession
    
    Tells if read operations are suspended for this session.
    
    Specified by:
    
    isReadSuspended in interface ISession
    
    Returns:
    
    true if suspended
  - isWriteSuspended
```
public boolean isWriteSuspended()
```
    Description copied from interface: ISession
    
    Tells if write operations are suspended for this session.
    
    Specified by:
    
    isWriteSuspended in interface ISession
    
    Returns:
    
    true if suspended
  - getReadBytes
```
public final long getReadBytes()
```
    Description copied from interface: ISession
    
    Gets the total number of bytes which were read from this session.
    
    Specified by:
    
    getReadBytes in interface ISession
    
    Returns:
    
    the total number of bytes
  - getWrittenBytes
```
public final long getWrittenBytes()
```
    Description copied from interface: ISession
    
    Gets the total number of bytes which were written to this session.
    
    Specified by:
    
    getWrittenBytes in interface ISession
    
    Returns:
    
    the total number of bytes
  - getReadBytesThroughput
```
public final double getReadBytesThroughput()
```
    Description copied from interface: ISession
    
    Gets the number of read bytes per second.
    
    Specified by:
    
    getReadBytesThroughput in interface ISession
    
    Returns:
    
    the number of read bytes per second
  - getWrittenBytesThroughput
```
public final double getWrittenBytesThroughput()
```
    Description copied from interface: ISession
    
    Gets the number of written bytes per second.
    
    Specified by:
    
    getWrittenBytesThroughput in interface ISession
    
    Returns:
    
    the number of written bytes per second
  - getCreationTime
```
public final long getCreationTime()
```
    Description copied from interface: ISession
    
    Gets the session's creation time in milliseconds.
    
    Specified by:
    
    getCreationTime in interface ISession
    
    Returns:
    
    the session's creation time
  - getLastIoTime
```
public final long getLastIoTime()
```
    Description copied from interface: ISession
    
    Gets the time in milliseconds when I/O operation occurred lastly.
    
    Specified by:
    
    getLastIoTime in interface ISession
    
    Returns:
    
    the time of the last I/O operation
  - getLastReadTime
```
public final long getLastReadTime()
```
    Description copied from interface: ISession
    
    Gets the time in milliseconds when read operation occurred lastly.
    
    Specified by:
    
    getLastReadTime in interface ISession
    
    Returns:
    
    the time of the last read operation
  - getLastWriteTime
```
public final long getLastWriteTime()
```
    Description copied from interface: ISession
    
    Gets the time in milliseconds when write operation occurred lastly.
    
    Specified by:
    
    getLastWriteTime in interface ISession
    
    Returns:
    
    the time of the last write operation
  - getTimer
```
public ISessionTimer getTimer()
```
    Description copied from interface: ISession
    
    Gets the session timer associated with this session.
    
    Specified by:
    
    getTimer in interface ISession
    
    Returns:
    
    the session timer
  - isDataCopyingOptimized
```
public boolean isDataCopyingOptimized()
```
    Description copied from interface: ISession
    
    Tells if the processing of data is optimized to reduce data copying between byte buffers.
    Checking this flag can be helpful in determining if a buffer allocated by the ISession.allocate(int) method need to be released after passing it to the session's write/send methods. For example, if the returned value is true the buffer will be released automatically and so it should not be released by a user's implementation.
    
    Specified by:
    
    isDataCopyingOptimized in interface ISession
    
    Returns:
    
    true if the processing of data is optimized
    
    See Also:
    
    ISessionConfig.optimizeDataCopying()
  - allocate
```
public ByteBuffer allocate(int capacity)
```
    Description copied from interface: ISession
    
    Allocates a byte buffer by using the allocator associated with this session.
    
    Specified by:
    
    allocate in interface ISession
    
    Parameters:
    
    capacity - minimal required capacity
    
    Returns:
    
    the allocated byte buffer
  - release
```
public void release(ByteBuffer buffer)
```
    Description copied from interface: ISession
    
    Release given byte buffer by the allocator associated with this session.
    
    Specified by:
    
    release in interface ISession
    
    Parameters:
    
    buffer - the byte buffer being released
  - execute
```
public IFuture<Void> execute(Runnable task)
```
    Description copied from interface: ISession
    
    Executes a task in the selector-loop's thread this session is registered with. If this method is called in the selector-loop's thread the task is executed synchronously.
    
    Specified by:
    
    execute in interface ISession
    
    Parameters:
    
    task - task to be executed in the selector-loop's thread
    
    Returns:
    
    the future associated with the specified task
  - executenf
```
public void executenf(Runnable task)
```
    Description copied from interface: ISession
    
    Executes a task in the selector-loop's thread this session is registered with. If this method is called in the selector-loop's thread the task is executed synchronously.
    This method should be used whenever there will be no need to synchronize on a future associated with the specified task. This will save some resources and may improve performance.
    
    Specified by:
    
    executenf in interface ISession
    
    Parameters:
    
    task - task to be executed in the selector-loop's thread

Class SctpMultiSession

Method Summary

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

Methods inherited from class org.snf4j.core.IdentifiableObject

Methods inherited from class java.lang.Object

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

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

Method Detail

getParent

shutdown

getAssociation

getAssociations

getRemoteAddress

getRemoteAddresses

getRemoteAddresses

write

write

writenf

writenf

write

write

writenf

writenf

write

writenf

getHandler

close

quickClose

getCodecPipeline

getLocalAddress

getLocalAddresses

bindAddress

unbindAddress

write

write

writenf

writenf

write

writenf

writenf

write

write

writenf

getCreateFuture

getOpenFuture

getReadyFuture

getCloseFuture

getEndFuture

getConfig

getCodecPipeline

getState

isOpen

dirtyClose

suspendRead

suspendWrite

resumeRead

resumeWrite

isReadSuspended

isWriteSuspended

getReadBytes

getWrittenBytes

getReadBytesThroughput

getWrittenBytesThroughput

getCreationTime

getLastIoTime

getLastReadTime

getLastWriteTime

getTimer

isDataCopyingOptimized

allocate

release

execute

executenf