org.apache.mina.core.future

Class DefaultIoFuture

java.lang.Object

org.apache.mina.core.future.DefaultIoFuture

All Implemented Interfaces:

IoFuture

Direct Known Subclasses:

AbstractIoService.ServiceOperationFuture, CompositeIoFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultReadFuture, DefaultWriteFuture

public class DefaultIoFuture
extends java.lang.Object
implements IoFuture

A default implementation of IoFuture associated with an IoSession.

Field Summary

Fields

Modifier and Type	Field and Description
private static long	DEAD_LOCK_CHECK_INTERVAL A number of seconds to wait between two deadlock controls ( 5 seconds )
private IoFutureListener<?>	firstListener
private java.lang.Object	lock A lock used by the wait() method
private java.util.List<IoFutureListener<?>>	otherListeners
private boolean	ready
private java.lang.Object	result
private IoSession	session The associated session
private int	waiters

Constructor Summary

Constructors

Constructor and Description
DefaultIoFuture(IoSession session) Creates a new instance associated with an IoSession.

Method Summary

Modifier and Type	Method and Description
IoFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
IoFuture	await() Wait for the asynchronous operation to complete.
boolean	await(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout.
boolean	await(long timeout, java.util.concurrent.TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout.
private boolean	await0(long timeoutMillis, boolean interruptable) Wait for the Future to be ready.
IoFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
boolean	awaitUninterruptibly(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
boolean	awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
private void	checkDeadLock() TODO checkDeadLock.
IoSession	getSession() Returns the IoSession which is associated with this future.
protected java.lang.Object	getValue() Returns the result of the asynchronous operation.
boolean	isDone() Returns if the asynchronous operation is completed.
void	join() Deprecated. Replaced with awaitUninterruptibly().
boolean	join(long timeoutMillis) Deprecated. Replaced with awaitUninterruptibly(long).
private void	notifyListener(IoFutureListener l)
private void	notifyListeners()
IoFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setValue(java.lang.Object newValue) Sets the result of the asynchronous operation, and mark it as finished.

Methods inherited from class java.lang.Object

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

Field Detail

DEAD_LOCK_CHECK_INTERVAL

private static final long DEAD_LOCK_CHECK_INTERVAL

A number of seconds to wait between two deadlock controls ( 5 seconds )

See Also:

Constant Field Values

session

private final IoSession session

The associated session

lock

private final java.lang.Object lock

A lock used by the wait() method

firstListener

private IoFutureListener<?> firstListener

otherListeners

private java.util.List<IoFutureListener<?>> otherListeners

result

private java.lang.Object result

ready

private boolean ready

waiters

private int waiters

Constructor Detail

DefaultIoFuture

public DefaultIoFuture(IoSession session)

Creates a new instance associated with an IoSession.

Parameters:

session - an IoSession which is associated with this future

Method Detail

getSession

public IoSession getSession()

Returns the IoSession which is associated with this future.

Specified by:

getSession in interface IoFuture

join

@Deprecated
public void join()

Deprecated. Replaced with awaitUninterruptibly().

Specified by:

join in interface IoFuture

join

@Deprecated
public boolean join(long timeoutMillis)

Deprecated. Replaced with awaitUninterruptibly(long).

Specified by:

join in interface IoFuture

await

public IoFuture await()
               throws java.lang.InterruptedException

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

Specified by:

await in interface IoFuture

Throws:

java.lang.InterruptedException

await

public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Wait for the asynchronous operation to complete with the specified timeout.

Specified by:

await in interface IoFuture

Returns:

true if the operation is completed.

Throws:

java.lang.InterruptedException

await

public boolean await(long timeoutMillis)
              throws java.lang.InterruptedException

Wait for the asynchronous operation to complete with the specified timeout.

Specified by:

await in interface IoFuture

Returns:

true if the operation is completed.

Throws:

java.lang.InterruptedException

awaitUninterruptibly

public IoFuture awaitUninterruptibly()

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

Specified by:

awaitUninterruptibly in interface IoFuture

Returns:

the current IoFuture

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
                                    java.util.concurrent.TimeUnit unit)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Specified by:

awaitUninterruptibly in interface IoFuture

Returns:

true if the operation is completed.

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Specified by:

awaitUninterruptibly in interface IoFuture

Returns:

true if the operation is finished.

await0

private boolean await0(long timeoutMillis,
                       boolean interruptable)
                throws java.lang.InterruptedException

Wait for the Future to be ready. If the requested delay is 0 or negative, this method immediately returns the value of the 'ready' flag. Every 5 second, the wait will be suspended to be able to check if there is a deadlock or not.

Parameters:

timeoutMillis - The delay we will wait for the Future to be ready

interruptable - Tells if the wait can be interrupted or not

Returns:

true if the Future is ready

Throws:

java.lang.InterruptedException - If the thread has been interrupted when it's not allowed.

checkDeadLock

private void checkDeadLock()

TODO checkDeadLock.

isDone

public boolean isDone()

Returns if the asynchronous operation is completed.

Specified by:

isDone in interface IoFuture

setValue

public void setValue(java.lang.Object newValue)

Sets the result of the asynchronous operation, and mark it as finished.

getValue

protected java.lang.Object getValue()

Returns the result of the asynchronous operation.

addListener

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

Specified by:

addListener in interface IoFuture

removeListener

public IoFuture removeListener(IoFutureListener<?> listener)

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

Specified by:

removeListener in interface IoFuture

notifyListeners

private void notifyListeners()

notifyListener

private void notifyListener(IoFutureListener l)