Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Promote Single.TerminalSignalConsumer to top level interface (#1008)
Motivation: TerminalSignalConsumer for Completable and Publisher is a top level type, but Single has an internal type for the same purpose. This makes it more challenging to expose utilities classes in a consistent manner and also may lead to naming collisions. Modifications: - Move Single.TerminalSignalConsumer to a top level interface and rename to SingleTerminalSignalConsumer to avoid naming collisions. - Expose RunnableTerminalSignalConsumer and re-use it in BeforeFinallyOnHttpResponseOperator. Result: More consistent type definition scheme for TerminalSignalConsumer and SingleTerminalSignalConsumer and ability to expose conversion/utility methods outside the scope of the Source.
- Loading branch information
1 parent
3756013
commit e53d677
Showing
11 changed files
with
166 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
...api/src/main/java/io/servicetalk/concurrent/api/RunnableSingleTerminalSignalConsumer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * Copyright © 2020 Apple Inc. and the ServiceTalk project authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.servicetalk.concurrent.api; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| final class RunnableSingleTerminalSignalConsumer<T> implements SingleTerminalSignalConsumer<T> { | ||
| private final Runnable onFinally; | ||
|
|
||
| RunnableSingleTerminalSignalConsumer(final Runnable onFinally) { | ||
| this.onFinally = requireNonNull(onFinally); | ||
| } | ||
|
|
||
| @Override | ||
| public void onSuccess(@Nullable final T result) { | ||
| onFinally.run(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(final Throwable throwable) { | ||
| onFinally.run(); | ||
| } | ||
|
|
||
| @Override | ||
| public void cancel() { | ||
| onFinally.run(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
...current-api/src/main/java/io/servicetalk/concurrent/api/SingleTerminalSignalConsumer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* | ||
| * Copyright © 2020 Apple Inc. and the ServiceTalk project authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.servicetalk.concurrent.api; | ||
|
|
||
| import io.servicetalk.concurrent.Cancellable; | ||
| import io.servicetalk.concurrent.SingleSource; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * A contract that provides discrete callbacks for various ways in which a {@link SingleSource.Subscriber} can | ||
| * terminate. | ||
| * | ||
| * @param <T> Type of the result of the {@link Single}. | ||
| */ | ||
| public interface SingleTerminalSignalConsumer<T> { | ||
| /** | ||
| * Callback to indicate termination via {@link SingleSource.Subscriber#onSuccess(Object)}. | ||
| * | ||
| * @param result the observed result of type {@link T}. | ||
| */ | ||
| void onSuccess(@Nullable T result); | ||
|
|
||
| /** | ||
| * Callback to indicate termination via {@link SingleSource.Subscriber#onError(Throwable)}. | ||
| * | ||
| * @param throwable the observed {@link Throwable}. | ||
| */ | ||
| void onError(Throwable throwable); | ||
|
|
||
| /** | ||
| * Callback to indicate termination via {@link Cancellable#cancel()}. | ||
| */ | ||
| void cancel(); | ||
|
|
||
| /** | ||
| * Create a {@link SingleTerminalSignalConsumer} where each method executes a {@link Runnable#run()}. | ||
| * @param runnable The {@link Runnable} which is invoked in each method of the returned | ||
| * {@link SingleTerminalSignalConsumer}. | ||
| * @param <X> The type of {@link SingleTerminalSignalConsumer}. | ||
| * @return a {@link SingleTerminalSignalConsumer} where each method executes a {@link Runnable#run()}. | ||
| */ | ||
| static <X> SingleTerminalSignalConsumer<X> from(Runnable runnable) { | ||
| return new RunnableSingleTerminalSignalConsumer<>(runnable); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.