Debian Codegraph @

src/main/java/io/reactivex/rxjava3/core/CompletableOnSubscribe.java

raw
1 /*
2 * Copyright (c) 2016-present, RxJava Contributors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
5 * compliance with the License. You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software distributed under the License is
10 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
11 * the License for the specific language governing permissions and limitations under the License.
12 */
13
14 package io.reactivex.rxjava3.core;
15
16 import io.reactivex.rxjava3.annotations.NonNull;
17
18 /**
19 * A functional interface that has a {@code subscribe()} method that receives
20 * a {@link CompletableEmitter} instance that allows pushing
21 * an event in a cancellation-safe manner.
22 */
23 @FunctionalInterface
24 public interface CompletableOnSubscribe {
25
26 /**
27 * Called for each {@link CompletableObserver} that subscribes.
28 * @param emitter the safe emitter instance, never {@code null}
29 * @throws Throwable on error
30 */
31 void subscribe(@NonNull CompletableEmitter emitter) throws Throwable;
32 }
33