org.apache.sshd.common.io.mina

Class MinaSession

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.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.io.mina.MinaSession

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IoSession

public class MinaSession
extends AbstractInnerCloseable
implements IoSession

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MinaSession.Future

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

AbstractCloseable.State

Field Summary

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

closeFuture, lock, state

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

log

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
MinaSession(MinaService service, org.apache.mina.core.session.IoSession session)

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(Object key) Returns the value of the user-defined attribute of this session.
long	getId()
protected Closeable	getInnerCloseable()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
IoService	getService()
org.apache.mina.core.session.IoSession	getSession()
Object	setAttribute(Object key, Object value) Sets a user-defined attribute.
void	suspend()
String	toString()
IoWriteFuture	write(Buffer buffer) Write a packet on the socket.
IoWriteFuture	write(byte[] data)
IoWriteFuture	write(byte[] data, int offset, int len)
IoWriteFuture	write(org.apache.mina.core.buffer.IoBuffer buffer)

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

doCloseGracefully, doCloseImmediately

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

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

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

getSimplifiedLogger

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

Constructor Detail

MinaSession

public MinaSession(MinaService service,
                   org.apache.mina.core.session.IoSession session)

Method Detail

getSession

public org.apache.mina.core.session.IoSession getSession()

suspend

public void suspend()

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.

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.

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

write

public IoWriteFuture write(byte[] data)

write

public IoWriteFuture write(byte[] data,
                           int offset,
                           int len)

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

write

public IoWriteFuture write(org.apache.mina.core.buffer.IoBuffer buffer)

getService

public IoService getService()

Specified by:

getService in interface IoSession

Returns:

the IoService that created this session.

toString

public String toString()

Overrides:

toString in class Object