StreamSession (SNF4J/Core 1.7.0 API)

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

All Implemented Interfaces:

ISession, IStreamSession

Direct Known Subclasses:

EngineStreamSession
```
public class StreamSession
extends AbstractSession
implements IStreamSession
```
The core implementation of the IStreamSession interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Constructor and Description
`StreamSession(IStreamHandler handler)` Constructs a stream-oriented session associated with a handler.
`StreamSession(String name, IStreamHandler handler)` Constructs a named stream-oriented session associated with a handler.

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.
`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>`	`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.
`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.
`IStreamHandler`	`getHandler()` Gets the stream-oriented 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()` Return the local address this session is bound to.
`IFuture<Void>`	`getOpenFuture()` Gets the future that can be use to wait for the completion of the opening phase.
`IStreamSession`	`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 the remote address to which this session is connected.
`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`	`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.
`void`	`suspendRead()` Suspends read operations for this session.
`void`	`suspendWrite()` Suspends write operations for this session.
`IFuture<Void>`	`write(byte[] data)` Writes `data.length` bytes from the specified byte array to the stream-oriented channel associated with this session.
`IFuture<Void>`	`write(byte[] data, int offset, int length)` Writes `length` bytes from the specified byte array to the stream-oriented channel associated with this session.
`IFuture<Void>`	`write(ByteBuffer data)` Writes `data.remaining()` bytes from the specified byte buffer to the stream-oriented channel associated with this session.
`IFuture<Void>`	`write(ByteBuffer data, int length)` Writes `length` bytes from the specified byte buffer to the stream-oriented channel associated with this session.
`IFuture<Void>`	`write(Object msg)` Writes a message to the stream-oriented channel associated with this session.
`void`	`writenf(byte[] data)` Writes `data.length` bytes from the specified byte array to the stream-oriented channel associated with this session.
`void`	`writenf(byte[] data, int offset, int length)` Writes `length` bytes from the specified byte array to the stream-oriented channel associated with this session.
`void`	`writenf(ByteBuffer data)` Writes `data.remaining()` bytes from the specified byte buffer to the stream-oriented channel associated with this session.
`void`	`writenf(ByteBuffer data, int length)` Writes `length` bytes from the specified byte buffer to the stream-oriented channel associated with this session.
`void`	`writenf(Object msg)` Writes a message to the stream-oriented channel 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.ISession
allocate, dirtyClose, getAttributes, getCloseFuture, getCodecPipeline, getConfig, getCreateFuture, getCreationTime, getEndFuture, getId, getLastIoTime, getLastReadTime, getLastWriteTime, getName, getOpenFuture, getReadBytes, getReadBytesThroughput, getReadyFuture, getState, getTimer, getWrittenBytes, getWrittenBytesThroughput, isOpen, isReadSuspended, isWriteSuspended, quickClose, release, resumeRead, resumeWrite, suspendRead, suspendWrite

- Constructor Detail
  - StreamSession
```
public StreamSession(String name,
                     IStreamHandler handler)
```
    Constructs a named stream-oriented session associated with a handler.
    
    Parameters:
    
    name - the name for this session, or null if the handler's name should be used for this session's name
    
    handler - the handler that should be associated with this session
  - StreamSession
```
public StreamSession(IStreamHandler handler)
```
    Constructs a stream-oriented session associated with a handler.
    
    Parameters:
    
    handler - the handler that should be associated with this session
- Method Detail
  - getHandler
```
public IStreamHandler getHandler()
```
    Description copied from interface: IStreamSession
    
    Gets the stream-oriented handler associated with this session
    
    Specified by:
    
    getHandler in interface ISession
    
    Specified by:
    
    getHandler in interface IStreamSession
    
    Returns:
    
    the stream-oriented handler
  - getParent
```
public IStreamSession 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 ISession
    
    Specified by:
    
    getParent in interface IStreamSession
    
    Returns:
    
    the parent session or null if it does not exist.
  - write
```
public IFuture<Void> write(byte[] data)
```
    Description copied from interface: IStreamSession
    
    Writes data.length bytes from the specified byte array to the stream-oriented channel associated with this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface IStreamSession
    
    Parameters:
    
    data - bytes to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(byte[] data)
```
    Description copied from interface: IStreamSession
    
    Writes data.length bytes from the specified byte array to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    data - bytes to be written
  - write
```
public IFuture<Void> write(byte[] data,
                           int offset,
                           int length)
```
    Description copied from interface: IStreamSession
    
    Writes length bytes from the specified byte array to the stream-oriented channel associated with this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface IStreamSession
    
    Parameters:
    
    data - bytes 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[] data,
                    int offset,
                    int length)
```
    Description copied from interface: IStreamSession
    
    Writes length bytes from the specified byte array to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    data - bytes 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 data)
```
    Description copied from interface: IStreamSession
    
    Writes data.remaining() bytes from the specified byte buffer to the stream-oriented channel associated with this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface IStreamSession
    
    Parameters:
    
    data - bytes to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(ByteBuffer data)
```
    Description copied from interface: IStreamSession
    
    Writes data.remaining() bytes from the specified byte buffer to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    data - bytes to be written
  - write
```
public IFuture<Void> write(ByteBuffer data,
                           int length)
```
    Description copied from interface: IStreamSession
    
    Writes length bytes from the specified byte buffer to the stream-oriented channel associated with this session.
    The operation is asynchronous.
    
    Specified by:
    
    write in interface IStreamSession
    
    Parameters:
    
    data - bytes to be written
    
    length - number of bytes to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(ByteBuffer data,
                    int length)
```
    Description copied from interface: IStreamSession
    
    Writes length bytes from the specified byte buffer to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    data - bytes to be written
    
    length - number of bytes to be written
  - write
```
public IFuture<Void> write(Object msg)
```
    Description copied from interface: IStreamSession
    
    Writes a message to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    msg - the message to be written
    
    Returns:
    
    the future associated with this write operation
  - writenf
```
public void writenf(Object msg)
```
    Description copied from interface: IStreamSession
    
    Writes a message to the stream-oriented channel associated with 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 IStreamSession
    
    Parameters:
    
    msg - the message to be written
  - 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
  - getLocalAddress
```
public SocketAddress getLocalAddress()
```
    Description copied from interface: ISession
    
    Return the local address this session is bound to.
    
    Specified by:
    
    getLocalAddress in interface ISession
    
    Returns:
    
    the local address or null if this session is not bound yet
    
    See Also:
    
    Socket
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    Description copied from interface: ISession
    
    Returns the remote address to which this session is connected.
    
    Specified by:
    
    getRemoteAddress in interface ISession
    
    Returns:
    
    the remote address or null if this session is not connected yet
    
    See Also:
    
    Socket
  - 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.
  - 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
  - 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
  - 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

Class StreamSession

Constructor Summary

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.ISession

Constructor Detail

StreamSession

StreamSession

Method Detail

getHandler

getParent

write

writenf

write

writenf

write

writenf

write

writenf

write

writenf

close

getLocalAddress

getRemoteAddress

getCreateFuture

getOpenFuture

getReadyFuture

getCloseFuture

getEndFuture

getConfig

getCodecPipeline

getState

isOpen

quickClose

dirtyClose

suspendRead

suspendWrite

resumeRead

resumeWrite

isReadSuspended

isWriteSuspended

getReadBytes

getWrittenBytes

getReadBytesThroughput

getWrittenBytesThroughput

getCreationTime

getLastIoTime

getLastReadTime

getLastWriteTime

getTimer

allocate

release