org.apache.mina.core.future

类 DefaultConnectFuture

java.lang.Object

org.apache.mina.core.future.DefaultIoFuture

org.apache.mina.core.future.DefaultConnectFuture

所有已实现的接口:

ConnectFuture, IoFuture

直接已知子类:

AbstractPollingIoConnector.ConnectionRequest

public class DefaultConnectFuture
extends DefaultIoFuture
implements ConnectFuture

A default implementation of ConnectFuture.

作者:

Apache MINA Project

构造器概要

构造器

构造器和说明
DefaultConnectFuture() Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
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()
boolean	isCanceled()
boolean	isConnected()
static ConnectFuture	newFailedFuture(java.lang.Throwable exception) Creates a new instance of a Connection Failure, with the associated cause.
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.DefaultIoFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, getValue, isDone, join, join, setValue

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

构造器详细资料

DefaultConnectFuture

public DefaultConnectFuture()

Creates a new instance.

方法详细资料

newFailedFuture

public static ConnectFuture newFailedFuture(java.lang.Throwable exception)

Creates a new instance of a Connection Failure, with the associated cause.

参数:

exception - The exception that caused the failure

返回:

a new ConnectFuture which is already marked as 'failed to connect'.

getSession

public IoSession getSession()

指定者:

getSession 在接口中 ConnectFuture

指定者:

getSession 在接口中 IoFuture

覆盖:

getSession 在类中 DefaultIoFuture

返回:

the IoSession which is associated with this future.

getException

public java.lang.Throwable getException()

Returns the cause of the connection failure.

指定者:

getException 在接口中 ConnectFuture

返回:

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

isConnected

public boolean isConnected()

指定者:

isConnected 在接口中 ConnectFuture

返回:

true if the connect operation is finished successfully.

isCanceled

public boolean isCanceled()

指定者:

isCanceled 在接口中 ConnectFuture

返回:

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

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.

指定者:

setSession 在接口中 ConnectFuture

参数:

session - The created session to store in the ConnectFuture insteance

setException

public 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.

指定者:

setException 在接口中 ConnectFuture

参数:

exception - The exception to store in the ConnectFuture instance

cancel

public boolean cancel()

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

指定者:

cancel 在接口中 ConnectFuture

返回:

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

await

public 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 在接口中 ConnectFuture

指定者:

await 在接口中 IoFuture

覆盖:

await 在类中 DefaultIoFuture

返回:

The instance of IoFuture that we are waiting for

抛出:

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

awaitUninterruptibly

public ConnectFuture awaitUninterruptibly()

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

指定者:

awaitUninterruptibly 在接口中 ConnectFuture

指定者:

awaitUninterruptibly 在接口中 IoFuture

覆盖:

awaitUninterruptibly 在类中 DefaultIoFuture

返回:

the current IoFuture

addListener

public 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 在接口中 ConnectFuture

指定者:

addListener 在接口中 IoFuture

覆盖:

addListener 在类中 DefaultIoFuture

参数:

listener - The listener to add

返回:

the current IoFuture

removeListener

public ConnectFuture removeListener(IoFutureListener<?> listener)

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

指定者:

removeListener 在接口中 ConnectFuture

指定者:

removeListener 在接口中 IoFuture

覆盖:

removeListener 在类中 DefaultIoFuture

参数:

listener - The listener to remove

返回:

the current IoFuture