Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.impl

Class AsyncRegistration

java.lang.Object

io.axoniq.axonserver.connector.impl.AsyncRegistration

All Implemented Interfaces:

Registration

public class AsyncRegistration
extends Object
implements Registration

Asynchronous implementation of the Registration.

Constructor Summary

Constructors

Constructor	Description
AsyncRegistration(CompletableFuture<Void> requestAck, Supplier<CompletableFuture<Void>> cancelAction)	Construct a AsyncRegistration, using the given requestAck on awaitAck(long, TimeUnit) and onAck(Runnable), and the given cancelAction on cancel().

Method Summary

Modifier and Type	Method	Description
Registration	awaitAck(long timeout, TimeUnit unit)	Wait for the acknowledgement of the original instruction this Registration corresponds to.
CompletableFuture<Void>	cancel()	Cancel the registration from which this instance was returned.
Registration	onAck(Runnable runnable)	Registers the given runnable to this Registration to be executed when the acknowledgement of this Registration is received.
Registration	onAck(Consumer<Optional<Throwable>> action)	Registers the given runnable to this Registration to be executed when the acknowledgement of this Registration is received.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncRegistration

public AsyncRegistration(CompletableFuture<Void> requestAck,
                         Supplier<CompletableFuture<Void>> cancelAction)

Construct a AsyncRegistration, using the given requestAck on awaitAck(long, TimeUnit) and onAck(Runnable), and the given cancelAction on cancel().

Parameters:

requestAck - the CompletableFuture to wait for on #awaitAck(long, TimeUnit)

cancelAction - the Supplier of the CompletableFuture to retrieve on cancel()

Method Detail

cancel

public CompletableFuture<Void> cancel()

Description copied from interface: Registration

Cancel the registration from which this instance was returned. Does nothing if the registration has already been canceled, or when the registration was undone by another mechanism (such as a new registration overriding this one).

Specified by:

cancel in interface Registration

Returns:

a CompletableFuture of Void to react when this Registration has been canceled

awaitAck

public Registration awaitAck(long timeout,
                             TimeUnit unit)
                      throws TimeoutException,
                             InterruptedException

Description copied from interface: Registration

Wait for the acknowledgement of the original instruction this Registration corresponds to. Allows for the addition of further logic to this Registration, like invoking Registration.onAck(Runnable) for example.

Specified by:

awaitAck in interface Registration

Parameters:

timeout - the duration to wait until the operation has been acknowledged

unit - the TimeUnit for the given timeout to wait until the operation has been acknowledged

Returns:

this Registration to support a fluent API

Throws:

TimeoutException - is thrown when the given timeout and unit is surpassed

InterruptedException - is thrown when the thread waiting for the acknowledgement is interrupted

onAck

public Registration onAck(Runnable runnable)

Description copied from interface: Registration

Registers the given runnable to this Registration to be executed when the acknowledgement of this Registration is received. Allows for the addition of further logic to this Registration, like invoking Registration.awaitAck(long, TimeUnit) for example.

The given runnable is invoked, regardless of successful or failed acknowledgement. Use Registration.onAck(Consumer) to register an action that needs to distinguish between successful and failed registration.

Specified by:

onAck in interface Registration

Parameters:

runnable - the Runnable to execute when the acknowledgement of this Registration is received

Returns:

this Registration to support a fluent API

onAck

public Registration onAck(Consumer<Optional<Throwable>> action)

Description copied from interface: Registration

Registers the given runnable to this Registration to be executed when the acknowledgement of this Registration is received. Allows for the addition of further logic to this Registration, like invoking Registration.awaitAck(long, TimeUnit) for example.

Specified by:

onAck in interface Registration

Parameters:

action - the action to execute when the acknowledgement of this Registration is received, either normally or exceptionally.

Returns:

this Registration to support a fluent API