org.atmosphere.cpr

Class BroadcasterFuture<E>

java.lang.Object

org.atmosphere.cpr.BroadcasterFuture<E>

All Implemented Interfaces:

java.util.concurrent.Future<E>

public class BroadcasterFuture<E>
extends java.lang.Object
implements java.util.concurrent.Future<E>

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

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
BroadcasterFuture(E msg)
BroadcasterFuture(E msg, int latchCount)
BroadcasterFuture(java.util.concurrent.Future<?> innerFuture, E msg)
BroadcasterFuture(java.util.concurrent.Future<?> innerFuture, E msg, int latchCount)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcasterFuture

public BroadcasterFuture(E msg)

BroadcasterFuture

public BroadcasterFuture(java.util.concurrent.Future<?> innerFuture,
                         E msg)

BroadcasterFuture

public BroadcasterFuture(E msg,
                         int latchCount)

BroadcasterFuture

public BroadcasterFuture(java.util.concurrent.Future<?> innerFuture,
                         E msg,
                         int latchCount)

Method Detail

cancel

public boolean cancel(boolean b)

Specified by:

cancel in interface java.util.concurrent.Future<E>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<E>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<E>

done

public BroadcasterFuture<E> done()

Invoked when a Broadcaster completed its broadcast operation.

get

public E get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<E>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public E get(long l,
             java.util.concurrent.TimeUnit tu)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<E>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException