dev.failsafe.retrofit

Class FailsafeCall<R>

java.lang.Object

dev.failsafe.retrofit.FailsafeCall<R>

Type Parameters:

R - response type

public final class FailsafeCall<R>
extends Object

A Failsafe wrapped Retrofit Call. Supports synchronous and asynchronous executions, and cancellation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FailsafeCall.FailsafeCallBuilder<R>

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the call.
FailsafeCall<R>	clone() Returns a clone of the FailsafeCall.
retrofit2.Response<R>	execute() Executes the call until a successful response is returned or the configured policies are exceeded.
CompletableFuture<retrofit2.Response<R>>	executeAsync() Executes the call asynchronously until a successful result is returned or the configured policies are exceeded.
boolean	isCancelled() Returns whether the call has been cancelled.
boolean	isExecuted() Returns whether the call has been executed.
static <R> FailsafeCall.FailsafeCallBuilder<R>	with(FailsafeExecutor<retrofit2.Response<R>> failsafeExecutor) Returns a FailsafeCallBuilder for the failsafeExecutor.
static <R,P extends Policy<retrofit2.Response<R>>> FailsafeCall.FailsafeCallBuilder<R>	with(P outerPolicy, P... policies) Returns a FailsafeCallBuilder for the outerPolicy and policies.

Methods inherited from class java.lang.Object

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

Method Detail

with

@SafeVarargs
public static <R,P extends Policy<retrofit2.Response<R>>> FailsafeCall.FailsafeCallBuilder<R> with(P outerPolicy,
                                                                                                                P... policies)

Returns a FailsafeCallBuilder for the outerPolicy and policies. See Failsafe.with(Policy, Policy[]) for docs on how policy composition works.

Type Parameters:

R - result type

P - policy type

Throws:

NullPointerException - if call or outerPolicy are null

with

public static <R> FailsafeCall.FailsafeCallBuilder<R> with(FailsafeExecutor<retrofit2.Response<R>> failsafeExecutor)

Returns a FailsafeCallBuilder for the failsafeExecutor.

Type Parameters:

R - result type

Throws:

NullPointerException - if failsafeExecutor is null

cancel

public void cancel()

Cancels the call.

clone

public FailsafeCall<R> clone()

Returns a clone of the FailsafeCall.

Overrides:

clone in class Object

execute

public retrofit2.Response<R> execute()
                              throws IOException

Executes the call until a successful response is returned or the configured policies are exceeded.

Throws:

IllegalStateException - if the call has already been executed

IOException - if the request could not be executed due to cancellation, a connectivity problem, or timeout

FailsafeException - if the execution fails with a checked Exception. Throwable.getCause() can be used to learn the underlying checked exception.

executeAsync

public CompletableFuture<retrofit2.Response<R>> executeAsync()

Executes the call asynchronously until a successful result is returned or the configured policies are exceeded.

isCancelled

public boolean isCancelled()

Returns whether the call has been cancelled.

isExecuted

public boolean isExecuted()

Returns whether the call has been executed.