org.apache.sshd.common.io.nio2

Class Nio2Session

java.lang.Object

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

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

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

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IoSession

public class Nio2Session
extends CloseableUtils.AbstractCloseable
implements IoSession

Nested Class Summary

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

CloseableUtils.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.CloseableUtils.AbstractCloseable

closeFuture, lock, state

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

log

Constructor Summary

Constructors

Constructor and Description
Nio2Session(Nio2Service service, FactoryManager manager, IoHandler handler, AsynchronousSocketChannel socket)

Method Summary

Modifier and Type	Method and Description
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)
Object	getAttribute(Object key) Returns the value of the user-defined attribute of this session.
long	getId()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
IoService	getService()
Object	setAttribute(Object key, Object value) Sets a user-defined attribute.
void	startReading()
void	startReading(byte[] buf)
void	startReading(byte[] buf, int offset, int len)
void	startReading(ByteBuffer buffer)
void	startReading(int bufSize)
void	suspend()
String	toString()
IoWriteFuture	write(Buffer buffer) Write a packet on the socket.

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

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

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

isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

DEFAULT_READBUF_SIZE

public static final int DEFAULT_READBUF_SIZE

See Also:

Constant Field Values

Constructor Detail

Nio2Session

public Nio2Session(Nio2Service service,
                   FactoryManager manager,
                   IoHandler handler,
                   AsynchronousSocketChannel socket)
            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 each 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.

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface IoSession

Returns:

the socket address of remote peer.

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface IoSession

Returns:

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

suspend

public void suspend()

write

public IoWriteFuture write(Buffer buffer)

Description copied from interface: IoSession

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

Specified by:

write in interface IoSession

Parameters:

buffer - The Buffer with the encoded packet data

Returns:

The IoWriteFuture for the request

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class CloseableUtils.AbstractCloseable

doCloseImmediately

protected void doCloseImmediately()

Description copied from class: CloseableUtils.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 CloseableUtils.AbstractCloseable

getService

public IoService getService()

Specified by:

getService in interface IoSession

Returns:

the IoService that created this session.

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)

doReadCycle

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

toString

public String toString()

Overrides:

toString in class Object