org.apache.mina.core.future

接口 ConnectFuture

所有超级接口:

IoFuture

所有已知实现类:

AbstractPollingIoConnector.ConnectionRequest, DefaultConnectFuture

public interface ConnectFuture
extends IoFuture

An IoFuture for asynchronous connect requests.

Example

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

作者:

Apache MINA Project

方法概要

方法

限定符和类型	方法和说明
ConnectFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
ConnectFuture	await() Wait for the asynchronous operation to complete.
ConnectFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
boolean	cancel() Cancels the connection attempt and notifies all threads waiting for this future.
java.lang.Throwable	getException() Returns the cause of the connection failure.
IoSession	getSession() Returns IoSession which is the result of connect operation.
boolean	isCanceled()
boolean	isConnected()
ConnectFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setException(java.lang.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.

从接口继承的方法 org.apache.mina.core.future.IoFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, isDone, join, join

方法详细资料

getSession

IoSession getSession()

Returns IoSession which is the result of connect operation.

指定者:

getSession 在接口中 IoFuture

返回:

The {link IoSession} instance that has been associated with the connection, if the connection was successful, null otherwise

getException

java.lang.Throwable getException()

Returns the cause of the connection failure.

返回:

null if the connect operation is not finished yet, or if the connection attempt is successful, otherwise returns teh cause of the exception

isConnected

boolean isConnected()

返回:

true if the connect operation is finished successfully.

isCanceled

boolean isCanceled()

返回:

true if the connect operation has been canceled by cancel() method.

setSession

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.

参数:

session - The created session to store in the ConnectFuture insteance

setException

void setException(java.lang.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.

参数:

exception - The exception to store in the ConnectFuture instance

cancel

boolean cancel()

Cancels the connection attempt and notifies all threads waiting for this future.

返回:

true if the future has been cancelled by this call, false if the future was already cancelled.

await

ConnectFuture await()
                    throws java.lang.InterruptedException

Wait for the asynchronous operation to complete. The attached listeners will be notified when the operation is completed.

指定者:

await 在接口中 IoFuture

返回:

The instance of IoFuture that we are waiting for

抛出:

java.lang.InterruptedException - If the thread is interrupted while waiting

awaitUninterruptibly

ConnectFuture awaitUninterruptibly()

Wait for the asynchronous operation to complete uninterruptibly. The attached listeners will be notified when the operation is completed.

指定者:

awaitUninterruptibly 在接口中 IoFuture

返回:

the current IoFuture

addListener

ConnectFuture addListener(IoFutureListener<?> listener)

Adds an event listener which is notified when this future is completed. If the listener is added after the completion, the listener is directly notified.

指定者:

addListener 在接口中 IoFuture

参数:

listener - The listener to add

返回:

the current IoFuture

removeListener

ConnectFuture removeListener(IoFutureListener<?> listener)

Removes an existing event listener so it won't be notified when the future is completed.

指定者:

removeListener 在接口中 IoFuture

参数:

listener - The listener to remove

返回:

the current IoFuture