Package io.camunda.zeebe.util.sched.future

Class CompletableActorFuture<V>

java.lang.Object

io.camunda.zeebe.util.sched.future.CompletableActorFuture<V>

All Implemented Interfaces:

ActorFuture<V>, Future<V>, BiConsumer<V,Throwable>

public final class CompletableActorFuture<V>
extends Object
implements ActorFuture<V>

Completable future implementation that is garbage free and reusable

Constructor Summary

Constructors

Constructor	Description
CompletableActorFuture()

Method Summary

Modifier and Type	Method	Description
void	block(ActorTask onCompletion)	To be used by scheduler only
boolean	cancel(boolean mayInterruptIfRunning)
boolean	close()	future is reusable after close
void	complete(V value)
static <V> CompletableActorFuture<V>	completed(V result)
static <V> CompletableActorFuture<V>	completedExceptionally(Throwable throwable)
void	completeExceptionally(String failure, Throwable throwable)
void	completeExceptionally(Throwable throwable)
void	completeWith(CompletableActorFuture<V> otherFuture)
V	get()
V	get(long timeout, TimeUnit unit)
Throwable	getException()
boolean	isAwaitingResult()
boolean	isCancelled()
boolean	isClosed()
boolean	isCompletedExceptionally()
boolean	isDone()
V	join()
V	join(long timeout, TimeUnit timeUnit)
void	onComplete(BiConsumer<V,Throwable> consumer)	Registers an consumer, which is executed after the future was completed.
void	setAwaitingResult()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.util.sched.future.ActorFuture

accept

Methods inherited from interface java.util.function.BiConsumer

andThen

Constructor Details

CompletableActorFuture

public CompletableActorFuture()

Method Details

setAwaitingResult

public void setAwaitingResult()

completed

public static <V> CompletableActorFuture<V> completed(V result)

completedExceptionally

public static <V> CompletableActorFuture<V> completedExceptionally(Throwable throwable)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

get

public V get()
      throws ExecutionException,
InterruptedException

Specified by:

get in interface Future<V>

Throws:

ExecutionException

InterruptedException

get

public V get(long timeout,
 TimeUnit unit)
      throws ExecutionException,
TimeoutException,
InterruptedException

Specified by:

get in interface Future<V>

Throws:

ExecutionException

TimeoutException

InterruptedException

isAwaitingResult

public boolean isAwaitingResult()

complete

public void complete(V value)

Specified by:

complete in interface ActorFuture<V>

completeExceptionally

public void completeExceptionally(String failure,
 Throwable throwable)

Specified by:

completeExceptionally in interface ActorFuture<V>

completeExceptionally

public void completeExceptionally(Throwable throwable)

Specified by:

completeExceptionally in interface ActorFuture<V>

join

public V join()

Specified by:

join in interface ActorFuture<V>

join

public V join(long timeout,
 TimeUnit timeUnit)

Specified by:

join in interface ActorFuture<V>

block

public void block(ActorTask onCompletion)

Description copied from interface: ActorFuture

To be used by scheduler only

Specified by:

block in interface ActorFuture<V>

onComplete

public void onComplete(BiConsumer<V,Throwable> consumer)

Description copied from interface: ActorFuture

Registers an consumer, which is executed after the future was completed. The consumer is executed in the current actor thread, which is used to register the consumer.

Example:

Actor A calls Actor B to retrieve an value. Actor B returns an future, which will be completed later with the right value. Actor A wants to do some work, after B returns the value. For that Actor A calls `#onComplete`, at this returned future, to register an consumer. After the future is completed, the registered consumer is called in the Actor A context.

Running in Actor A context:

  final ActorFuture future = ActorB.getValue();
  future.onComplete(value, throwable -> { // do things - runs in Actor A context again
  });
 

Specified by:

onComplete in interface ActorFuture<V>

Parameters:

consumer - the consumer which should be called after the future was completed

isCompletedExceptionally

public boolean isCompletedExceptionally()

Specified by:

isCompletedExceptionally in interface ActorFuture<V>

getException

public Throwable getException()

Specified by:

getException in interface ActorFuture<V>

close

public boolean close()

future is reusable after close

isClosed

public boolean isClosed()

completeWith

public void completeWith(CompletableActorFuture<V> otherFuture)

toString

public String toString()

Overrides:

toString in class Object