Skip to content

docs: clarify executor configuration after policy composition #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Boulea7 wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −2
Open

docs: clarify executor configuration after policy composition #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions core/src/main/java/dev/failsafe/FailsafeExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,18 @@ public List<? extends Policy<R>> getPolicies() {
* <pre>
* Failsafe.with(fallback).compose(retryPolicy).compose(circuitBreaker);
* </pre>
* </p>
* This results in the following internal composition when executing a {@code runnable} or {@code supplier} and
* handling its result:
* <p>
* <pre>
* Fallback(RetryPolicy(CircuitBreaker(Supplier)))
* </pre>
* </p>
* This means the {@code CircuitBreaker} is first to evaluate the {@code Supplier}'s result, then the {@code
* RetryPolicy}, then the {@code Fallback}. Each policy makes its own determination as to whether the result
* represents a failure. This allows different policies to be used for handling different types of failures.
* <p>
* The returned executor does not inherit the executor, scheduler, or execution listeners configured on this
* executor. Configure these settings on the returned executor after composing policies.
*
* @throws NullPointerException if {@code innerPolicy} is null
* @see #getPolicies()
Expand Down