Debian Codegraph @

src/main/java/io/reactivex/rxjava3/core/Emitter.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 * Base interface for emitting signals in a push-fashion in various generator-like source
20 * operators (create, generate).
21 * <p>
22 * Note that the {@link Emitter#onNext}, {@link Emitter#onError} and
23 * {@link Emitter#onComplete} methods provided to the function via the {@link Emitter} instance should be called synchronously,
24 * never concurrently. Calling them from multiple threads is not supported and leads to an
25 * undefined behavior.
26 *
27 * @param <T> the value type emitted
28 */
29 public interface Emitter<@NonNull T> {
30
31 /**
32 * Signal a normal value.
33 * @param value the value to signal, not {@code null}
34 */
35 void onNext(@NonNull T value);
36
37 /**
38 * Signal a {@link Throwable} exception.
39 * @param error the {@code Throwable} to signal, not {@code null}
40 */
41 void onError(@NonNull Throwable error);
42
43 /**
44 * Signal a completion.
45 */
46 void onComplete();
47 }