com.linecorp.armeria.common

Interface RpcResponse

All Superinterfaces:

CompletionStage<Object>, Future<Object>, Response

All Known Implementing Classes:

DefaultRpcResponse

public interface RpcResponse
extends Response, Future<Object>, CompletionStage<Object>

An RPC Response. It is a CompletionStage whose result signifies the return value of an RPC call.

Method Summary

Modifier and Type	Method and Description
Throwable	cause() Returns the cause of the failure if this RpcResponse completed exceptionally.
static RpcResponse	from(CompletionStage<?> stage) Creates a new RpcResponse that is completed successfully or exceptionally based on the completion of the specified CompletionStage.
Object	getNow(Object valueIfAbsent) Returns the specified valueIfAbsent when not complete, or returns the result value or throws an exception when complete.
boolean	isCompletedExceptionally() Returns true if this RpcResponse completed exceptionally.
Object	join() Returns the result value if completed successfully or throws an unchecked exception if completed exceptionally.
static RpcResponse	of(Object value) Creates a new successfully complete RpcResponse.
static RpcResponse	ofFailure(Throwable cause) Creates a new exceptionally complete RpcResponse.
default CompletableFuture<?>	whenComplete() Returns a CompletableFuture which completes when this RpcResponse completes.

Methods inherited from interface com.linecorp.armeria.common.Response

closeFuture, completionFuture

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface java.util.concurrent.CompletionStage

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, exceptionally, handle, handleAsync, handleAsync, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Method Detail

of

static RpcResponse of(Object value)

Creates a new successfully complete RpcResponse.

ofFailure

static RpcResponse ofFailure(Throwable cause)

Creates a new exceptionally complete RpcResponse.

from

static RpcResponse from(CompletionStage<?> stage)

Creates a new RpcResponse that is completed successfully or exceptionally based on the completion of the specified CompletionStage.

join

Object join()

Returns the result value if completed successfully or throws an unchecked exception if completed exceptionally.

See Also:

CompletableFuture.join()

getNow

Object getNow(Object valueIfAbsent)

Returns the specified valueIfAbsent when not complete, or returns the result value or throws an exception when complete.

See Also:

CompletableFuture.getNow(Object)

cause

Throwable cause()

Returns the cause of the failure if this RpcResponse completed exceptionally.

Returns:

the cause, or null if this RpcResponse completed successfully or did not complete yet.

isCompletedExceptionally

boolean isCompletedExceptionally()

Returns true if this RpcResponse completed exceptionally.

See Also:

CompletableFuture.isCompletedExceptionally()

whenComplete

default CompletableFuture<?> whenComplete()

Returns a CompletableFuture which completes when this RpcResponse completes.

Specified by:

whenComplete in interface Response