Apache Mina SSHD 2.15.0 · org.apache.sshd.common.io.nio2.Nio2Session

Field Summary

Modifier and Type	Field and Description
private final SocketAddress	acceptanceAddress
private final Map<Object, Object>	attributes
private final AtomicReference<Nio2DefaultIoWriteFuture>	currentWrite
public static final int	DEFAULT_READBUF_SIZE
private final long	id
private final IoHandler	ioHandler
private final AtomicLong	lastReadCycleStart
private final AtomicLong	lastWriteCycleStart
private final SocketAddress	localAddress
private final AtomicBoolean	outputShutDown
private final PropertyResolver	propertyResolver
private final AtomicLong	readCyclesCounter
private Thread	readerThread
private volatile Runnable	readRunnable
private final SocketAddress	remoteAddress
private final Nio2Service	service
private static final AtomicLong	SESSION_ID_GENERATOR
private final AsynchronousSocketChannel	socketChannel
private volatile boolean	suspend
private final Object	suspendLock
private final AtomicLong	writeCyclesCounter
private final Queue<Nio2DefaultIoWriteFuture>	writes

Inherited from org.apache.sshd.common.util.closeable.AbstractCloseable:: closeFuture futureLock state

Constructor Summary

Access	Constructor and Description
public	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() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully.
protected void	doCloseImmediately() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
protected void	doReadCycle(ByteBuffer buffer, Readable bufReader)
protected void	doReadCycle(ByteBuffer buffer, Nio2CompletionHandler<Integer, Object> completion)
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)
public SocketAddress	getAcceptanceAddress() Implements org.apache.sshd.common.io.IoSession.getAcceptanceAddress.
public Object	getAttribute(Object the key of the attribute key) Implements org.apache.sshd.common.io.IoSession.getAttribute. Returns the value of the user-defined attribute of this session.
public long	getId() Implements org.apache.sshd.common.io.IoSession.getId.
public IoHandler	getIoHandler()
public SocketAddress	getLocalAddress() Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getLocalAddress.
public SocketAddress	getRemoteAddress() Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getRemoteAddress.
public Nio2Service	getService() Implements org.apache.sshd.common.io.IoSession.getService.
public 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)
public Object	removeAttribute(Object The key of the attribute we want to remove key) Implements org.apache.sshd.common.io.IoSession.removeAttribute. Removes a user-defined attribute with the specified key.
public void	resumeRead() Implements org.apache.sshd.common.io.IoSession.resumeRead. Resume read operations on this session.
public Object	setAttribute(Object the key of the attribute key, Object the value of the attribute value) Implements org.apache.sshd.common.io.IoSession.setAttribute. Sets a user-defined attribute.
public Object	setAttributeIfAbsent(Object The key of the attribute we want to set key, Object The value we want to set value) Implements org.apache.sshd.common.io.IoSession.setAttributeIfAbsent. Sets a user defined attribute if the attribute with the specified key is not set yet.
public void	shutdownOutputStream() Implements org.apache.sshd.common.io.IoSession.shutdownOutputStream. Handle received EOF.
public void	startReading()
public void	startReading(int bufSize)
public void	startReading(byte[] buf)
public void	startReading(byte[] buf, int offset, int len)
public void	startReading(ByteBuffer buffer)
protected void	startWriting()
public void	suspend() Intended for tests simulating a sudden connection drop only!
public void	suspendRead() Implements org.apache.sshd.common.io.IoSession.suspendRead. Suspend read operations on this session.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public IoWriteFuture	writeBuffer(Buffer the buffer send Note the buffer must not be touched until the returned write future is completed. buffer) Implements org.apache.sshd.common.io.IoSession.writeBuffer. Write a packet on the socket.

Inherited from org.apache.sshd.common.util.closeable.AbstractCloseable:: addCloseFutureListener builder close getFutureLock isClosed isClosing preClose removeCloseFutureListener

Field Detail

acceptanceAddress	back to summary
private final SocketAddress acceptanceAddress

attributes	back to summary
private final Map<Object, Object> attributes

currentWrite	back to summary
private final AtomicReference<Nio2DefaultIoWriteFuture> currentWrite

DEFAULT_READBUF_SIZE	back to summary
public static final int DEFAULT_READBUF_SIZE

id	back to summary
private final long id

ioHandler	back to summary
private final IoHandler ioHandler

lastReadCycleStart	back to summary
private final AtomicLong lastReadCycleStart

lastWriteCycleStart	back to summary
private final AtomicLong lastWriteCycleStart

localAddress	back to summary
private final SocketAddress localAddress

outputShutDown	back to summary
private final AtomicBoolean outputShutDown

propertyResolver	back to summary
private final PropertyResolver propertyResolver

readCyclesCounter	back to summary
private final AtomicLong readCyclesCounter

readerThread	back to summary
private Thread readerThread

readRunnable	back to summary
private volatile Runnable readRunnable

remoteAddress	back to summary
private final SocketAddress remoteAddress

service	back to summary
private final Nio2Service service

SESSION_ID_GENERATOR	back to summary
private static final AtomicLong SESSION_ID_GENERATOR

socketChannel	back to summary
private final AsynchronousSocketChannel socketChannel

suspend	back to summary
private volatile boolean suspend

suspendLock	back to summary
private final Object suspendLock

writeCyclesCounter	back to summary
private final AtomicLong writeCyclesCounter

writes	back to summary
private final Queue<Nio2DefaultIoWriteFuture> writes

Constructor Detail

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

Method Detail

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

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

doCloseGracefully	back to summary
protected CloseFuture doCloseGracefully() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully. Annotations @Override

doCloseGracefully

back to summary

protected CloseFuture doCloseGracefully()

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

Annotations

@Override

doCloseImmediately	back to summary
protected void doCloseImmediately() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. 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 Annotations @Override

doCloseImmediately

back to summary

protected void doCloseImmediately()

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

Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately.

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

Annotations

@Override

doReadCycle	back to summary
protected void doReadCycle(ByteBuffer buffer, Readable bufReader)

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

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

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

exceptionCaught	back to summary
protected void exceptionCaught(Throwable exc)

finishWrite	back to summary
protected void finishWrite(Nio2DefaultIoWriteFuture future)

getAcceptanceAddress back to summary

getAcceptanceAddress	back to summary
public SocketAddress getAcceptanceAddress() Implements org.apache.sshd.common.io.IoSession.getAcceptanceAddress. Returns:SocketAddress Doc from org.apache.sshd.common.io.IoSession.getAcceptanceAddress. The service address through which this session was accepted - `null` if session was initiated by this peer instead of being accepted Annotations @Override

public SocketAddress getAcceptanceAddress()

Implements org.apache.sshd.common.io.IoSession.getAcceptanceAddress.

Returns:SocketAddress

Doc from org.apache.sshd.common.io.IoSession.getAcceptanceAddress.

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

Annotations

@Override

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(Object key) Implements org.apache.sshd.common.io.IoSession.getAttribute. Doc from org.apache.sshd.common.io.IoSession.getAttribute. Returns the value of the user-defined attribute of this session. Parameters key:Object the key of the attribute Returns:Object `null` if there is no attribute with the specified key Annotations @Override

public Object getAttribute(Object key)

Implements org.apache.sshd.common.io.IoSession.getAttribute.

Doc from org.apache.sshd.common.io.IoSession.getAttribute.

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

Parameters

key:Object: the key of the attribute

Returns:Object

null if there is no attribute with the specified key

Annotations

@Override

getId	back to summary
public long getId() Implements org.apache.sshd.common.io.IoSession.getId. Returns:long Doc from org.apache.sshd.common.io.IoSession.getId. a unique identifier for this session. Every session has its own ID which is different from any other. Annotations @Override

getId

back to summary

public long getId()

Implements org.apache.sshd.common.io.IoSession.getId.

Returns:long

Doc from org.apache.sshd.common.io.IoSession.getId.

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

Annotations

@Override

getIoHandler	back to summary
public IoHandler getIoHandler()

getLocalAddress	back to summary
public SocketAddress getLocalAddress() Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getLocalAddress. Returns:SocketAddress Doc from org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getLocalAddress. the socket address of local machine which is associated with this session. Annotations @Override

getLocalAddress

back to summary

public SocketAddress getLocalAddress()

Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getLocalAddress.

Returns:SocketAddress

Doc from org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getLocalAddress.

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

Annotations

@Override

getRemoteAddress	back to summary
public SocketAddress getRemoteAddress() Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getRemoteAddress. Returns:SocketAddress Doc from org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getRemoteAddress. the socket address of remote peer. Annotations @Override

getRemoteAddress

back to summary

public SocketAddress getRemoteAddress()

Implements org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getRemoteAddress.

Returns:SocketAddress

Doc from org.apache.sshd.common.util.net.ConnectionEndpointsIndicator.getRemoteAddress.

the socket address of remote peer.

Annotations

@Override

getService back to summary

getService	back to summary
public Nio2Service getService() Implements org.apache.sshd.common.io.IoSession.getService. Returns:Nio2Service Doc from org.apache.sshd.common.io.IoSession.getService. the `IoService` that created this session. Annotations @Override

public Nio2Service getService()

Implements org.apache.sshd.common.io.IoSession.getService.

Returns:Nio2Service

Doc from org.apache.sshd.common.io.IoSession.getService.

the IoService that created this session.

Annotations

@Override

getSocket	back to summary
public AsynchronousSocketChannel getSocket()

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

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

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

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

removeAttribute back to summary

removeAttribute	back to summary
public Object removeAttribute(Object key) Implements org.apache.sshd.common.io.IoSession.removeAttribute. Doc from org.apache.sshd.common.io.IoSession.removeAttribute. Removes a user-defined attribute with the specified key. Parameters key:Object The key of the attribute we want to remove Returns:Object The old value of the attribute - `null` if not found. Annotations @Override

public Object removeAttribute(Object key)

Implements org.apache.sshd.common.io.IoSession.removeAttribute.

Doc from org.apache.sshd.common.io.IoSession.removeAttribute.

Removes a user-defined attribute with the specified key.

Parameters

key:Object: The key of the attribute we want to remove

Returns:Object

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

Annotations

@Override

resumeRead	back to summary
public void resumeRead() Implements org.apache.sshd.common.io.IoSession.resumeRead. Doc from org.apache.sshd.common.io.IoSession.resumeRead. Resume read operations on this session. Annotations @Override

resumeRead

back to summary

public void resumeRead()

Implements org.apache.sshd.common.io.IoSession.resumeRead.

Doc from org.apache.sshd.common.io.IoSession.resumeRead.

Resume read operations on this session.

Annotations

@Override

setAttribute back to summary

public Object setAttribute(Object key, Object value)

Implements org.apache.sshd.common.io.IoSession.setAttribute.

Doc from org.apache.sshd.common.io.IoSession.setAttribute.

Sets a user-defined attribute.

Parameters

key:Object: the key of the attribute
value:Object: the value of the attribute

Returns:Object

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

Annotations

@Override

setAttributeIfAbsent back to summary

public Object setAttributeIfAbsent(Object key, Object value)

Implements org.apache.sshd.common.io.IoSession.setAttributeIfAbsent.

Doc from org.apache.sshd.common.io.IoSession.setAttributeIfAbsent.

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);
}

Parameters

key:Object: The key of the attribute we want to set
value:Object: The value we want to set

Returns:Object

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

Annotations

@Override

shutdownOutputStream

back to summary

public void shutdownOutputStream() throws IOException

Implements org.apache.sshd.common.io.IoSession.shutdownOutputStream.

Doc from org.apache.sshd.common.io.IoSession.shutdownOutputStream.

Handle received EOF.

Annotations

@Override

Exceptions

IOException:: If failed to shutdown the stream

startReading	back to summary
public void startReading()

startReading	back to summary
public void startReading(int bufSize)

startReading	back to summary
public void startReading(byte[] buf)

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

startReading	back to summary
public void startReading(ByteBuffer buffer)

startWriting	back to summary
protected void startWriting()

suspend	back to summary
public void suspend() Intended for tests simulating a sudden connection drop only! Do not call otherwise.

suspendRead

back to summary

public void suspendRead()

Implements org.apache.sshd.common.io.IoSession.suspendRead.

Doc from org.apache.sshd.common.io.IoSession.suspendRead.

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.

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writeBuffer back to summary

public IoWriteFuture writeBuffer(Buffer buffer) throws IOException

Implements org.apache.sshd.common.io.IoSession.writeBuffer.

Doc from org.apache.sshd.common.io.IoSession.writeBuffer.

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

Parameters

buffer:Buffer: the buffer send
Note
the buffer must not be touched until the returned write future is completed.

Returns:IoWriteFuture

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

Annotations

@Override

Exceptions

IOException:: if an error occurred when sending the packet

public Class Nio2Session

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail