Debian Codegraph @

src/main/java/io/reactivex/rxjava3/processors/package-info.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 /**
15 * Classes representing so-called hot backpressure-aware sources, aka <strong>processors</strong>,
16 * that implement the {@link io.reactivex.rxjava3.processors.FlowableProcessor FlowableProcessor} class,
17 * the Reactive Streams {@link org.reactivestreams.Processor Processor} interface
18 * to allow forms of multicasting events to one or more subscribers as well as consuming another
19 * Reactive Streams {@link org.reactivestreams.Publisher Publisher}.
20 * <p>
21 * Available processor implementations:
22 * <br>
23 * <ul>
24 * <li>{@link io.reactivex.rxjava3.processors.AsyncProcessor AsyncProcessor} - replays the very last item</li>
25 * <li>{@link io.reactivex.rxjava3.processors.BehaviorProcessor BehaviorProcessor} - remembers the latest item</li>
26 * <li>{@link io.reactivex.rxjava3.processors.MulticastProcessor MulticastProcessor} - coordinates its source with its consumers</li>
27 * <li>{@link io.reactivex.rxjava3.processors.PublishProcessor PublishProcessor} - dispatches items to current consumers</li>
28 * <li>{@link io.reactivex.rxjava3.processors.ReplayProcessor ReplayProcessor} - remembers some or all items and replays them to consumers</li>
29 * <li>{@link io.reactivex.rxjava3.processors.UnicastProcessor UnicastProcessor} - remembers or relays items to a single consumer</li>
30 * </ul>
31 * <p>
32 * The non-backpressured variants of the {@code FlowableProcessor} class are called
33 * {@link io.reactivex.rxjava3.subjects.Subject}s and reside in the {@code io.reactivex.subjects} package.
34 * @see io.reactivex.rxjava3.subjects
35 */
36 package io.reactivex.rxjava3.processors;