Debian Codegraph @

src/main/java/io/reactivex/rxjava3/core/ObservableOnSubscribe.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 * an {@link ObservableEmitter} instance that allows pushing
21 * events in a cancellation-safe manner.
22 *
23 * @param <T> the value type pushed
24 */
25 @FunctionalInterface
26 public interface ObservableOnSubscribe<@NonNull T> {
27
28 /**
29 * Called for each {@link Observer} that subscribes.
30 * @param emitter the safe emitter instance, never {@code null}
31 * @throws Throwable on error
32 */
33 void subscribe(@NonNull ObservableEmitter<T> emitter) throws Throwable;
34 }
35