BaseSubscriber (Reactor Core 3.0.5.RELEASE)

java.lang.Object
- reactor.core.publisher.BaseSubscriber<T>

All Implemented Interfaces:

Subscriber<T>, Subscription, Cancellation, Disposable, Receiver, Trackable
```
public abstract class BaseSubscriber<T>
extends Object
implements Subscriber<T>, Subscription, Trackable, Receiver, Disposable
```
A simple base class for a Subscriber implementation that lets the user perform a request(long) and cancel() on it directly. As the targeted use case is to manually handle requests, the hookOnSubscribe(Subscription) and hookOnNext(Object) hooks are expected to be implemented.
Override the other optional hooks hookOnComplete(), hookOnError(Throwable) and hookOnCancel() to customize the base behavior. You also have a termination hook, hookFinally(SignalType).
Most of the time, exceptions triggered inside hooks are propagated to onError(Throwable) (unless there is a fatal exception). The class is in the reactor.core.publisher package, as this subscriber is tied to a single Publisher.

Author:

Simon Baslé

Field Summary
- Fields inherited from interface reactor.core.Trackable
  UNSPECIFIED

Constructor Summary

Constructors
Constructor and Description

BaseSubscriber()

Constructors
Constructor and Description
`BaseSubscriber()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()`
`void`	`dispose()` Cancel or dispose the underlying task or resource.
`protected void`	`hookFinally(SignalType type)` Optional hook executed after any of the termination events (onError, onComplete, cancel).
`protected void`	`hookOnCancel()` Optional hook executed when the subscription is cancelled by calling this Subscriber's `cancel()` method.
`protected void`	`hookOnComplete()` Optional hook for completion processing.
`protected void`	`hookOnError(Throwable throwable)` Optional hook for error processing.
`protected abstract void`	`hookOnNext(T value)` Hook for processing of onNext values.
`protected abstract void`	`hookOnSubscribe(Subscription subscription)` Hook for further processing of onSubscribe's Subscription.
`boolean`	`isDisposed()` Optionally return true when the resource or task is disposed.
`boolean`	`isStarted()` Has this upstream started or "onSubscribed" ?
`boolean`	`isTerminated()` Has this upstream finished or "completed" / "failed" ?
`void`	`onComplete()`
`void`	`onError(Throwable t)`
`void`	`onNext(T value)`
`void`	`onSubscribe(Subscription s)`
`void`	`request(long n)`
`String`	`toString()`
`Subscription`	`upstream()` Return the direct source of data, Supports reference.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.core.Trackable
expectedFromUpstream, getCapacity, getError, getPending, isCancelled, limit, requestedFromDownstream

- Constructor Detail
  - BaseSubscriber
```
public BaseSubscriber()
```
- Method Detail
  - upstream
```
public Subscription upstream()
```
    Description copied from interface: Receiver
    
    Return the direct source of data, Supports reference.
    
    Specified by:
    
    upstream in interface Receiver
    
    Returns:
    
    the direct source of data, Supports reference.
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: Trackable
    
    Has this upstream started or "onSubscribed" ?
    
    Specified by:
    
    isStarted in interface Trackable
    
    Returns:
    
    has this upstream started or "onSubscribed" ?
  - isDisposed
```
public boolean isDisposed()
```
    Description copied from interface: Disposable
    
    Optionally return true when the resource or task is disposed. The implementor does not require to track disposition and may never return true even when disposed.
    
    Specified by:
    
    isDisposed in interface Disposable
    
    Returns:
    
    true when there's a guarantee the resource or task is disposed.
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Cancel or dispose the underlying task or resource.
    Call to this method is/should be idempotent.
    
    Specified by:
    
    dispose in interface Cancellation
    
    Specified by:
    
    dispose in interface Disposable
  - hookOnSubscribe
```
protected abstract void hookOnSubscribe(Subscription subscription)
```
    Hook for further processing of onSubscribe's Subscription. Implement this method to call request(long) as an initial request. Values other than the unbounded Long.MAX_VALUE imply that you'll also call request in hookOnNext(Object).
    
    Parameters:
    
    subscription - the subscription to optionally process
  - hookOnNext
```
protected abstract void hookOnNext(T value)
```
    Hook for processing of onNext values. You can call request(long) here to further request data from the source Publisher if the initial request wasn't unbounded.
    
    Parameters:
    
    value - the emitted value to process
  - hookOnComplete
```
protected void hookOnComplete()
```
    Optional hook for completion processing. Defaults to doing nothing.
  - hookOnError
```
protected void hookOnError(Throwable throwable)
```
    Optional hook for error processing. Default is to call Exceptions.errorCallbackNotImplemented(Throwable).
    
    Parameters:
    
    throwable - the error to process
  - hookOnCancel
```
protected void hookOnCancel()
```
    Optional hook executed when the subscription is cancelled by calling this Subscriber's cancel() method. Defaults to doing nothing.
  - hookFinally
```
protected void hookFinally(SignalType type)
```
    Optional hook executed after any of the termination events (onError, onComplete, cancel). The hook is executed in addition to and after hookOnError(Throwable), hookOnComplete() and hookOnCancel() hooks, even if these callbacks fail. Defaults to doing nothing. A failure of the callback will be caught by Operators.onErrorDropped(Throwable).
    
    Parameters:
    
    type - the type of termination event that triggered the hook (SignalType.ON_ERROR, SignalType.ON_COMPLETE or SignalType.CANCEL)
  - onSubscribe
```
public final void onSubscribe(Subscription s)
```
    Specified by:
    
    onSubscribe in interface Subscriber<T>
  - onNext
```
public final void onNext(T value)
```
    Specified by:
    
    onNext in interface Subscriber<T>
  - onError
```
public final void onError(Throwable t)
```
    Specified by:
    
    onError in interface Subscriber<T>
  - onComplete
```
public final void onComplete()
```
    Specified by:
    
    onComplete in interface Subscriber<T>
  - request
```
public final void request(long n)
```
    Specified by:
    
    request in interface Subscription
  - cancel
```
public final void cancel()
```
    Specified by:
    
    cancel in interface Subscription
  - isTerminated
```
public boolean isTerminated()
```
    Description copied from interface: Trackable
    
    Has this upstream finished or "completed" / "failed" ?
    
    Specified by:
    
    isTerminated in interface Trackable
    
    Returns:
    
    has this upstream finished or "completed" / "failed" ?
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BaseSubscriber<T>

Field Summary

Fields inherited from interface reactor.core.Trackable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface reactor.core.Trackable

Constructor Detail

BaseSubscriber

Method Detail

upstream

isStarted

isDisposed

dispose

hookOnSubscribe

hookOnNext

hookOnComplete

hookOnError

hookOnCancel

hookFinally

onSubscribe

onNext

onError

onComplete

request

cancel

isTerminated

toString