Package org.atmosphere.cpr

Class BroadcasterFuture<E>

java.lang.Object

org.atmosphere.cpr.BroadcasterFuture<E>

All Implemented Interfaces:

Future<E>

public class BroadcasterFuture<E>
extends Object
implements Future<E>

Simple Future that can be used when awaiting for a Broadcaster to finish its broadcast operation to AtmosphereHandler.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Constructor Summary

Constructors

Constructor	Description
BroadcasterFuture(E msg)
BroadcasterFuture(E msg, int latchCount)
BroadcasterFuture(Future<?> innerFuture, E msg)
BroadcasterFuture(Future<?> innerFuture, E msg, int latchCount)

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean b)
BroadcasterFuture<E>	done()	Invoked when a Broadcaster completed its broadcast operation.
E	get()
E	get(long l, TimeUnit tu)
boolean	isCancelled()
boolean	isDone()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

BroadcasterFuture

public BroadcasterFuture(E msg)

BroadcasterFuture

public BroadcasterFuture(Future<?> innerFuture,
 E msg)

BroadcasterFuture

public BroadcasterFuture(E msg,
 int latchCount)

BroadcasterFuture

public BroadcasterFuture(Future<?> innerFuture,
 E msg,
 int latchCount)

Method Details

cancel

public boolean cancel(boolean b)

Specified by:

cancel in interface Future<E>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<E>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<E>

done

public BroadcasterFuture<E> done()

Invoked when a Broadcaster completed its broadcast operation.

get

public E get()
      throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<E>

Throws:

InterruptedException

ExecutionException

get

public E get(long l,
 TimeUnit tu)
      throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<E>

Throws:

InterruptedException

ExecutionException

TimeoutException