org.apache.mina.common

Interface ConnectFuture

All Superinterfaces:
IoFuture
Known Implementing Classes:
DefaultConnectFuture

public interface ConnectFuture
extends IoFuture

An IoFuture for asynchronous connect requests.

Example

 IoConnector connector = ...;
 ConnectFuture future = connector.connect(...);
 future.join(); // Wait until the connection attempt is finished.
 IoSession session = future.getSession();
 session.write(...);
 

Method Summary

IoSession
getSession()
Returns IoSession which is the result of connect operation.
boolean
isConnected()
Returns true if the connect operation is finished successfully.
void
setException(Throwable exception)
Sets the exception caught due to connection failure and notifies all threads waiting for this future.
void
setSession(IoSession session)
Sets the newly connected session and notifies all threads waiting for this future.

Methods inherited from interface org.apache.mina.common.IoFuture

addListener, getLock, getSession, isReady, join, join, removeListener

Method Details

getSession

public IoSession getSession()
            throws RuntimeIOException
Returns IoSession which is the result of connect operation.
Specified by:
getSession in interface IoFuture
Returns:
null if the connect operation is not finished yet
Throws:
RuntimeIOException - if connection attempt failed by an exception

isConnected

public boolean isConnected()
Returns true if the connect operation is finished successfully.

setException

public void setException(Throwable exception)
Sets the exception caught due to connection failure and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.

setSession

public void setSession(IoSession session)
Sets the newly connected session and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.