org.apache.sshd.common.io.nio2

Class Nio2Session

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.io.nio2.Nio2Session

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IoSession, ConnectionEndpointsIndicator

public class Nio2Session
extends AbstractCloseable
implements IoSession

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_READBUF_SIZE

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
Nio2Session(Nio2Service service, PropertyResolver propertyResolver, IoHandler handler, AsynchronousSocketChannel socket, SocketAddress acceptanceAddress)

Method Summary

Modifier and Type	Method and Description
protected Nio2CompletionHandler<Integer,Object>	createReadCycleCompletionHandler(ByteBuffer buffer, Readable bufReader)
protected Nio2CompletionHandler<Integer,Object>	createWriteCycleCompletionHandler(Nio2DefaultIoWriteFuture future, AsynchronousSocketChannel socket, ByteBuffer buffer)
protected CloseFuture	doCloseGracefully()
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate
protected void	doReadCycle(ByteBuffer buffer, Nio2CompletionHandler<Integer,Object> completion)
protected void	doReadCycle(ByteBuffer buffer, Readable bufReader)
protected void	doShutdownOutputStream(Nio2DefaultIoWriteFuture future, AsynchronousSocketChannel socket)
protected void	doWriteCycle(ByteBuffer buffer, Nio2CompletionHandler<Integer,Object> completion)
protected void	exceptionCaught(Throwable exc)
protected void	finishWrite(Nio2DefaultIoWriteFuture future)
SocketAddress	getAcceptanceAddress()
Object	getAttribute(Object key) Returns the value of the user-defined attribute of this session.
long	getId()
IoHandler	getIoHandler()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
Nio2Service	getService()
AsynchronousSocketChannel	getSocket()
protected void	handleCompletedWriteCycle(Nio2DefaultIoWriteFuture future, AsynchronousSocketChannel socket, ByteBuffer buffer, int writeLen, Nio2CompletionHandler<Integer,Object> completionHandler, Integer result, Object attachment)
protected void	handleReadCycleCompletion(ByteBuffer buffer, Readable bufReader, Nio2CompletionHandler<Integer,Object> completionHandler, Integer result, Object attachment)
protected void	handleReadCycleFailure(ByteBuffer buffer, Readable bufReader, Throwable exc, Object attachment)
protected void	handleWriteCycleFailure(Nio2DefaultIoWriteFuture future, AsynchronousSocketChannel socket, ByteBuffer buffer, int writeLen, Throwable exc, Object attachment)
Object	removeAttribute(Object key) Removes a user-defined attribute with the specified key.
void	resumeRead() Resume read operations on this session.
Object	setAttribute(Object key, Object value) Sets a user-defined attribute.
Object	setAttributeIfAbsent(Object key, Object value) Sets a user defined attribute if the attribute with the specified key is not set yet.
void	shutdownOutputStream() Handle received EOF.
void	startReading()
void	startReading(byte[] buf)
void	startReading(byte[] buf, int offset, int len)
void	startReading(ByteBuffer buffer)
void	startReading(int bufSize)
protected void	startWriting()
void	suspend() Intended for tests simulating a sudden connection drop only! Do not call otherwise.
void	suspendRead() Suspend read operations on this session.
String	toString()
IoWriteFuture	writeBuffer(Buffer buffer) Write a packet on the socket.

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, preClose, removeCloseFutureListener

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.io.IoSession

close

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

DEFAULT_READBUF_SIZE

public static final int DEFAULT_READBUF_SIZE

See Also:

Constant Field Values

Constructor Detail

Nio2Session

public Nio2Session(Nio2Service service,
                   PropertyResolver propertyResolver,
                   IoHandler handler,
                   AsynchronousSocketChannel socket,
                   SocketAddress acceptanceAddress)
            throws IOException

Throws:

IOException

Method Detail

getId

public long getId()

Specified by:

getId in interface IoSession

Returns:

a unique identifier for this session. Every session has its own ID which is different from any other.

getAttribute

public Object getAttribute(Object key)

Description copied from interface: IoSession

Returns the value of the user-defined attribute of this session.

Specified by:

getAttribute in interface IoSession

Parameters:

key - the key of the attribute

Returns:

null if there is no attribute with the specified key

setAttribute

public Object setAttribute(Object key,
                           Object value)

Description copied from interface: IoSession

Sets a user-defined attribute.

Specified by:

setAttribute in interface IoSession

Parameters:

key - the key of the attribute

value - the value of the attribute

Returns:

The old value of the attribute - null if it is new.

setAttributeIfAbsent

public Object setAttributeIfAbsent(Object key,
                                   Object value)

Description copied from interface: IoSession

Sets a user defined attribute if the attribute with the specified key is not set yet. This method is same with the following code except that the operation is performed atomically.

 
 if (containsAttribute(key)) {
     return getAttribute(key);
 } else {
     return setAttribute(key, value);
 }
 
 

Specified by:

setAttributeIfAbsent in interface IoSession

Parameters:

key - The key of the attribute we want to set

value - The value we want to set

Returns:

The old value of the attribute - null if not found.

removeAttribute

public Object removeAttribute(Object key)

Description copied from interface: IoSession

Removes a user-defined attribute with the specified key.

Specified by:

removeAttribute in interface IoSession

Parameters:

key - The key of the attribute we want to remove

Returns:

The old value of the attribute - null if not found.

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface ConnectionEndpointsIndicator

Returns:

the socket address of remote peer.

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface ConnectionEndpointsIndicator

Returns:

the socket address of local machine which is associated with this session.

getAcceptanceAddress

public SocketAddress getAcceptanceAddress()

Specified by:

getAcceptanceAddress in interface IoSession

Returns:

The service address through which this session was accepted - null if session was initiated by this peer instead of being accepted

getSocket

public AsynchronousSocketChannel getSocket()

getIoHandler

public IoHandler getIoHandler()

suspend

public void suspend()

Intended for tests simulating a sudden connection drop only! Do not call otherwise.

writeBuffer

public IoWriteFuture writeBuffer(Buffer buffer)
                          throws IOException

Description copied from interface: IoSession

Write a packet on the socket. Multiple writes can be issued concurrently and will be queued.

Specified by:

writeBuffer in interface IoSession

Parameters:

buffer - the buffer send. NOTE: the buffer must not be touched until the returned write future is completed.

Returns:

An IoWriteFuture that can be used to check when the packet has actually been sent

Throws:

IOException - if an error occurred when sending the packet

exceptionCaught

protected void exceptionCaught(Throwable exc)

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class AbstractCloseable

doCloseImmediately

protected void doCloseImmediately()

Description copied from class: AbstractCloseable

doCloseImmediately is called once and only once with state == Immediate

Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

Overrides:

doCloseImmediately in class AbstractCloseable

getService

public Nio2Service getService()

Specified by:

getService in interface IoSession

Returns:

the IoService that created this session.

shutdownOutputStream

public void shutdownOutputStream()
                          throws IOException

Description copied from interface: IoSession

Handle received EOF.

Specified by:

shutdownOutputStream in interface IoSession

Throws:

IOException - If failed to shutdown the stream

doShutdownOutputStream

protected void doShutdownOutputStream(Nio2DefaultIoWriteFuture future,
                                      AsynchronousSocketChannel socket)
                               throws IOException

Throws:

IOException

startReading

public void startReading()

startReading

public void startReading(int bufSize)

startReading

public void startReading(byte[] buf)

startReading

public void startReading(byte[] buf,
                         int offset,
                         int len)

startReading

public void startReading(ByteBuffer buffer)

doReadCycle

protected void doReadCycle(ByteBuffer buffer,
                           Readable bufReader)

createReadCycleCompletionHandler

protected Nio2CompletionHandler<Integer,Object> createReadCycleCompletionHandler(ByteBuffer buffer,
                                                                                 Readable bufReader)

handleReadCycleCompletion

protected void handleReadCycleCompletion(ByteBuffer buffer,
                                         Readable bufReader,
                                         Nio2CompletionHandler<Integer,Object> completionHandler,
                                         Integer result,
                                         Object attachment)

handleReadCycleFailure

protected void handleReadCycleFailure(ByteBuffer buffer,
                                      Readable bufReader,
                                      Throwable exc,
                                      Object attachment)

suspendRead

public void suspendRead()

Description copied from interface: IoSession

Suspend read operations on this session. If the session usage includes a graceful shutdown with messages being exchanged, the caller needs to take care of resuming reading the input in order to actually be able to carry on the conversation with the peer.

Specified by:

suspendRead in interface IoSession

resumeRead

public void resumeRead()

Description copied from interface: IoSession

Resume read operations on this session.

Specified by:

resumeRead in interface IoSession

doReadCycle

protected void doReadCycle(ByteBuffer buffer,
                           Nio2CompletionHandler<Integer,Object> completion)

startWriting

protected void startWriting()

doWriteCycle

protected void doWriteCycle(ByteBuffer buffer,
                            Nio2CompletionHandler<Integer,Object> completion)

createWriteCycleCompletionHandler

protected Nio2CompletionHandler<Integer,Object> createWriteCycleCompletionHandler(Nio2DefaultIoWriteFuture future,
                                                                                  AsynchronousSocketChannel socket,
                                                                                  ByteBuffer buffer)

handleCompletedWriteCycle

protected void handleCompletedWriteCycle(Nio2DefaultIoWriteFuture future,
                                         AsynchronousSocketChannel socket,
                                         ByteBuffer buffer,
                                         int writeLen,
                                         Nio2CompletionHandler<Integer,Object> completionHandler,
                                         Integer result,
                                         Object attachment)

handleWriteCycleFailure

protected void handleWriteCycleFailure(Nio2DefaultIoWriteFuture future,
                                       AsynchronousSocketChannel socket,
                                       ByteBuffer buffer,
                                       int writeLen,
                                       Throwable exc,
                                       Object attachment)

finishWrite

protected void finishWrite(Nio2DefaultIoWriteFuture future)

toString

public String toString()

Overrides:

toString in class Object