Package org.apache.sshd.netty

Class NettyIoSession

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.netty.NettyIoSession

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Closeable, IoSession, org.apache.sshd.common.util.net.ConnectionEndpointsIndicator

public class NettyIoSession
extends org.apache.sshd.common.util.closeable.AbstractCloseable
implements IoSession

The Netty based IoSession implementation.

Author:

Julien Viet, Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	NettyIoSession.Adapter	Netty adapter to use as a bridge, with extra handling for suspending reads.
protected static class	NettyIoSession.DefaultIoWriteFuture

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.netty.channel.ChannelInboundHandlerAdapter	adapter
protected final Map<Object,Object>	attributes
protected io.netty.channel.ChannelHandlerContext	context
protected final IoHandler	handler
protected final long	id
protected io.netty.channel.ChannelFuture	prev
protected final AtomicBoolean	readSuspended
protected SocketAddress	remoteAddr
protected final NettyIoService	service

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
NettyIoSession(NettyIoService service, IoHandler handler, SocketAddress acceptanceAddress)

Method Summary

Modifier and Type	Method	Description
protected void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
protected void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
protected void	channelRead(io.netty.channel.ChannelHandlerContext ctx, org.apache.sshd.common.util.Readable msg)
protected CloseFuture	doCloseGracefully()
protected void	doCloseImmediately()
protected void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
SocketAddress	getAcceptanceAddress()
Object	getAttribute(Object key)
long	getId()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
IoService	getService()
Object	removeAttribute(Object key)
void	resumeRead()
Object	setAttribute(Object key, Object value)
Object	setAttributeIfAbsent(Object key, Object value)
void	shutdownOutputStream()
void	suspend()	Intended for tests simulating a sudden connection drop only!
void	suspendRead()
String	toString()
IoWriteFuture	writeBuffer(org.apache.sshd.common.util.buffer.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

attributes

protected final Map<Object,Object> attributes

service

protected final NettyIoService service

handler

protected final IoHandler handler

id

protected final long id

context

protected volatile io.netty.channel.ChannelHandlerContext context

remoteAddr

protected SocketAddress remoteAddr

prev

protected io.netty.channel.ChannelFuture prev

adapter

protected final io.netty.channel.ChannelInboundHandlerAdapter adapter

readSuspended

protected final AtomicBoolean readSuspended

Constructor Details

NettyIoSession

public NettyIoSession(NettyIoService service,
 IoHandler handler,
 SocketAddress acceptanceAddress)

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 org.apache.sshd.common.util.net.ConnectionEndpointsIndicator

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.apache.sshd.common.util.net.ConnectionEndpointsIndicator

getAcceptanceAddress

public SocketAddress getAcceptanceAddress()

Specified by:

getAcceptanceAddress in interface IoSession

writeBuffer

public IoWriteFuture writeBuffer(org.apache.sshd.common.util.buffer.Buffer buffer)

Specified by:

writeBuffer in interface IoSession

getService

public IoService getService()

Specified by:

getService in interface IoSession

suspendRead

public void suspendRead()

Specified by:

suspendRead in interface IoSession

resumeRead

public void resumeRead()

Specified by:

resumeRead in interface IoSession

shutdownOutputStream

public void shutdownOutputStream()
                          throws IOException

Specified by:

shutdownOutputStream in interface IoSession

Throws:

IOException

suspend

public void suspend()

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

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class org.apache.sshd.common.util.closeable.AbstractCloseable

doCloseImmediately

protected void doCloseImmediately()

Overrides:

doCloseImmediately in class org.apache.sshd.common.util.closeable.AbstractCloseable

channelActive

protected void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                      throws Exception

Throws:

Exception

channelInactive

protected void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

Throws:

Exception

channelRead

protected void channelRead(io.netty.channel.ChannelHandlerContext ctx,
 org.apache.sshd.common.util.Readable msg)
                    throws Exception

Throws:

Exception

exceptionCaught

protected void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
 Throwable cause)
                        throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object