net.maritimecloud.net

Interface Acknowledgement

public interface Acknowledgement

An acknowledgement that a given message has been received. For example, it is used for the MMS client to indicate whether or not the MMS Server has received a message.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
Acknowledgement	handle(java.util.function.Consumer<Throwable> fn) Returns a new Acknowledgement that, when the message that was send has been acknowledged is executed.
boolean	isAcknowledged() Returns whether or not the message has been successfully acknowledge by the remote relay server.
boolean	isDone() Returns true if completed in any fashion: normally or exceptionally.
void	join() Returns once the message has been acknowledged, or throws an (unchecked) exception if completed exceptionally.
Acknowledgement	orTimeout(long timeout, TimeUnit unit) Creates a new acknowledgement that will time out via TimeoutException if the message has not been acknowledgement within the specified timeout.
Acknowledgement	thenRun(Runnable runnable) Returns a new Acknowledgement that, when the message that was send has been successfully acknowledged, executes the given action.
default Acknowledgement	timeout(long timeout, TimeUnit unit) Deprecated.
CompletableFuture<Void>	toCompletableFuture() Returns a CompletableFuture maintaining the same completion properties as this acknowledgement.

Method Detail

handle

Acknowledgement handle(java.util.function.Consumer<Throwable> fn)

Returns a new Acknowledgement that, when the message that was send has been acknowledged is executed. If the message fails to be acknowledged the specified throwable is non-null. See the CompletionStage documentation for rules covering exceptional completion.

Parameters:

fn - the consumer that will invoked before completing the returned Acknowledgement. If the message failed to be acknowledge the specified throwable is non-null

Returns:

the new Acknowledgement

isAcknowledged

boolean isAcknowledged()

Returns whether or not the message has been successfully acknowledge by the remote relay server.

Returns:

whether or not the message has been successfully acknowledge by the remote relay server

isDone

boolean isDone()

Returns true if completed in any fashion: normally or exceptionally.

Returns:

true if completed

join

void join()

Returns once the message has been acknowledged, or throws an (unchecked) exception if completed exceptionally. To better conform with the use of common functional forms, if a computation involved in the completion of this instance threw an exception, this method throws an (unchecked) CompletionException with the underlying exception as its cause.

Throws:

CompletionException - if this acknowledgement completed exceptionally or a completion computation threw an exception

thenRun

Acknowledgement thenRun(Runnable runnable)

Returns a new Acknowledgement that, when the message that was send has been successfully acknowledged, executes the given action. See the CompletionStage documentation for rules covering exceptional completion.

Parameters:

runnable - the action to perform before completing the returned Acknowledgement

Returns:

the new Acknowledgement

timeout

@Deprecated
default Acknowledgement timeout(long timeout,
                                            TimeUnit unit)

Deprecated.

use orTimeout(long, TimeUnit)

orTimeout

Acknowledgement orTimeout(long timeout,
                          TimeUnit unit)

Creates a new acknowledgement that will time out via TimeoutException if the message has not been acknowledgement within the specified timeout.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the new acknowledgement

toCompletableFuture

CompletableFuture<Void> toCompletableFuture()

Returns a CompletableFuture maintaining the same completion properties as this acknowledgement.

Returns:

the CompletableFuture