hu.akarnokd.reactive4java.util

Class Producer<T>

java.lang.Object

hu.akarnokd.reactive4java.util.Producer<T>

Type Parameters:

T - the produced value type

All Implemented Interfaces:

Observable<T>

Direct Known Subclasses:

Delay.ByObservable, GroupJoin, Join, RefCountObservable

public abstract class Producer<T>
extends java.lang.Object
implements Observable<T>

Base class to help implement various operators for observable sequences.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Producer.State<U> The internal state of the observer registrations.

Constructor Summary

Constructors

Constructor and Description
Producer()

Method Summary

Modifier and Type	Method and Description
java.io.Closeable	register(Observer<? super T> observer) Registers an observer for the notification of Ts.
protected java.io.Closeable	registerRaw(Observer<? super T> observer, boolean safeguard) Performs the registration and wiring up cancellation handlers for the given observer.
protected abstract java.io.Closeable	run(Observer<? super T> observer, java.io.Closeable cancel, Action1<java.io.Closeable> setSink) The core implementation of the operator, called upon registration to the producer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Producer

public Producer()

Method Detail

register

@Nonnull
public java.io.Closeable register(@Nonnull
                                            Observer<? super T> observer)

Description copied from interface: Observable

Registers an observer for the notification of Ts.

Specified by:

register in interface Observable<T>

Parameters:

observer - the observer of Ts or any supertype of it

Returns:

the way of deregister the observer from this provider

registerRaw

protected java.io.Closeable registerRaw(@Nonnull
                                        Observer<? super T> observer,
                                        boolean safeguard)

Performs the registration and wiring up cancellation handlers for the given observer.

Parameters:

observer - the observer that wants to register

safeguard - apply safeguards around the observer?

Returns:

the closeable handle to stop the entire processing

run

protected abstract java.io.Closeable run(Observer<? super T> observer,
                                         java.io.Closeable cancel,
                                         Action1<java.io.Closeable> setSink)

The core implementation of the operator, called upon registration to the producer.

Note that the observer is not automatically detached in case of error or finish cases. Implementations should ensure proper termination.

Parameters:

observer - the observer to send notifications on

cancel - the cancellation handler from the run() call, allows self cancellations

setSink - communicates the sink to the registering party which allows consumers to tunnel close calls into the sink, which can stop processing

Returns:

the closeable representing all resources and/or registrations to cancel at once.