org.apache.sshd.common.io

Interface IoSession

All Superinterfaces:

Closeable

All Known Implementing Classes:

MinaSession, Nio2Session

public interface IoSession
extends Closeable

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Closes this session immediately or after all queued write requests are flushed.
java.lang.Object	getAttribute(java.lang.Object key) Returns the value of the user-defined attribute of this session.
long	getId() Returns a unique identifier for this session.
java.net.SocketAddress	getLocalAddress() Returns the socket address of local machine which is associated with this session.
java.net.SocketAddress	getRemoteAddress() Returns the socket address of remote peer.
IoService	getService() Returns the IoService that created this session.
java.lang.Object	setAttribute(java.lang.Object key, java.lang.Object value) Sets a user-defined attribute.
IoWriteFuture	write(Buffer buffer) Write a packet on the socket.

Method Detail

getId

long getId()

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

getAttribute

java.lang.Object getAttribute(java.lang.Object key)

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

Parameters:

key - the key of the attribute

Returns:

null if there is no attribute with the specified key

setAttribute

java.lang.Object setAttribute(java.lang.Object key,
                            java.lang.Object value)

Sets a user-defined attribute.

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

java.net.SocketAddress getRemoteAddress()

Returns the socket address of remote peer.

getLocalAddress

java.net.SocketAddress getLocalAddress()

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

write

IoWriteFuture write(Buffer buffer)

Write a packet on the socket.

close

CloseFuture close(boolean immediately)

Closes this session immediately or after all queued write requests are flushed. This operation is asynchronous. Wait for the returned CloseFuture if you want to wait for the session actually closed.

Specified by:

close in interface Closeable

Parameters:

immediately - true to close this session immediately. The pending write requests will simply be discarded. false to close this session after all queued write requests are flushed.

Returns:

a future

getService

IoService getService()

Returns the IoService that created this session.