Package 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, Closeable, 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	Description
static final 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	Description
Nio2Session(Nio2Service service, PropertyResolver propertyResolver, IoHandler handler, AsynchronousSocketChannel socket, SocketAddress acceptanceAddress)

Method Summary

Modifier and Type	Method	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()
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)
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)
void	resumeRead()
Object	setAttribute(Object key, Object value)
Object	setAttributeIfAbsent(Object key, Object value)
void	shutdownOutputStream()
void	startReading()
void	startReading(byte[] buf)
void	startReading(byte[] buf, int offset, int len)
void	startReading(int bufSize)
void	startReading(ByteBuffer buffer)
protected void	startWriting()
void	suspend()	Intended for tests simulating a sudden connection drop only! Do not call otherwise.
void	suspendRead()
String	toString()
IoWriteFuture	writeBuffer(Buffer buffer)

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

addCloseFutureListener, close, isClosed, isClosing, isOpen, removeCloseFutureListener

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

close

Field Details

DEFAULT_READBUF_SIZE

public static final int DEFAULT_READBUF_SIZE

See Also:

• Constant Field Values

Constructor Details

Nio2Session

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

Throws:

IOException

Method Details

getId

public long getId()

Specified by:

getId in interface IoSession

getAttribute

public Object getAttribute(Object key)

Specified by:

getAttribute in interface IoSession

setAttribute

public Object setAttribute(Object key,
 Object value)

Specified by:

setAttribute in interface IoSession

setAttributeIfAbsent

public Object setAttributeIfAbsent(Object key,
 Object value)

Specified by:

setAttributeIfAbsent in interface IoSession

removeAttribute

public Object removeAttribute(Object key)

Specified by:

removeAttribute in interface IoSession

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface ConnectionEndpointsIndicator

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface ConnectionEndpointsIndicator

getAcceptanceAddress

public SocketAddress getAcceptanceAddress()

Specified by:

getAcceptanceAddress in interface IoSession

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

Specified by:

writeBuffer in interface IoSession

Throws:

IOException

exceptionCaught

protected void exceptionCaught(Throwable exc)

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class AbstractCloseable

doCloseImmediately

protected void doCloseImmediately()

Overrides:

doCloseImmediately in class AbstractCloseable

getService

public Nio2Service getService()

Specified by:

getService in interface IoSession

shutdownOutputStream

public void shutdownOutputStream()
                          throws IOException

Specified by:

shutdownOutputStream in interface IoSession

Throws:

IOException

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()

Specified by:

suspendRead in interface IoSession

resumeRead

public void resumeRead()

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