io.servicetalk.concurrent.internal

Class DelegatingSignalOffloader

java.lang.Object

io.servicetalk.concurrent.internal.DelegatingSignalOffloader

All Implemented Interfaces:

SignalOffloader

public class DelegatingSignalOffloader
extends java.lang.Object
implements SignalOffloader

A SignalOffloader that delegates all calls to another SignalOffloader.

Constructor Summary

Constructors

Constructor and Description
DelegatingSignalOffloader(SignalOffloader delegate) Create a new instance.

Method Summary

Modifier and Type	Method and Description
CompletableSource.Subscriber	offloadCancellable(CompletableSource.Subscriber subscriber) Decorates the passed CompletableSource.Subscriber such that all method calls to its Cancellable will be offloaded.
<T> SingleSource.Subscriber<? super T>	offloadCancellable(SingleSource.Subscriber<? super T> subscriber) Decorates the passed SingleSource.Subscriber such that all method calls to its Cancellable will be offloaded.
<T> void	offloadSignal(T signal, java.util.function.Consumer<T> signalConsumer) Offloads the consumption of the passed signal by the passed Consumer.
void	offloadSubscribe(CompletableSource.Subscriber subscriber, java.util.function.Consumer<CompletableSource.Subscriber> handleSubscribe) Offloads the subscribe call for the passed PublisherSource.Subscriber.
<T> void	offloadSubscribe(PublisherSource.Subscriber<? super T> subscriber, java.util.function.Consumer<PublisherSource.Subscriber<? super T>> handleSubscribe) Offloads subscribe call for the passed PublisherSource.Subscriber.
<T> void	offloadSubscribe(SingleSource.Subscriber<? super T> subscriber, java.util.function.Consumer<SingleSource.Subscriber<? super T>> handleSubscribe) Offloads subscribe call for the passed PublisherSource.Subscriber.
CompletableSource.Subscriber	offloadSubscriber(CompletableSource.Subscriber subscriber) Decorates the passed CompletableSource.Subscriber such that all method calls to it will be offloaded.
<T> PublisherSource.Subscriber<? super T>	offloadSubscriber(PublisherSource.Subscriber<? super T> subscriber) Decorates the passed PublisherSource.Subscriber such that all method calls to it will be offloaded.
<T> SingleSource.Subscriber<? super T>	offloadSubscriber(SingleSource.Subscriber<? super T> subscriber) Decorates the passed SingleSource.Subscriber such that all method calls to it will be offloaded.
<T> PublisherSource.Subscriber<? super T>	offloadSubscription(PublisherSource.Subscriber<? super T> subscriber) Decorates the passed PublisherSource.Subscriber such that all method calls to its PublisherSource.Subscription will be offloaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingSignalOffloader

public DelegatingSignalOffloader(SignalOffloader delegate)

Create a new instance.

Parameters:

delegate - SignalOffloader to delegate all calls.

Method Detail

offloadSubscriber

public <T> PublisherSource.Subscriber<? super T> offloadSubscriber(PublisherSource.Subscriber<? super T> subscriber)

Description copied from interface: SignalOffloader

Decorates the passed PublisherSource.Subscriber such that all method calls to it will be offloaded.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscriber in interface SignalOffloader

Type Parameters:

T - Type of items received by the passed and returned PublisherSource.Subscriber.

Parameters:

subscriber - PublisherSource.Subscriber for which the signals are to be offloaded.

Returns:

New PublisherSource.Subscriber that will offload signals to the passed PublisherSource.Subscriber.

offloadSubscriber

public <T> SingleSource.Subscriber<? super T> offloadSubscriber(SingleSource.Subscriber<? super T> subscriber)

Description copied from interface: SignalOffloader

Decorates the passed SingleSource.Subscriber such that all method calls to it will be offloaded.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscriber in interface SignalOffloader

Type Parameters:

T - Type of items received by the passed and returned SingleSource.Subscriber.

Parameters:

subscriber - SingleSource.Subscriber for which the signals are to be offloaded.

Returns:

New SingleSource.Subscriber that will offload signals to the passed SingleSource.Subscriber.

offloadSubscriber

public CompletableSource.Subscriber offloadSubscriber(CompletableSource.Subscriber subscriber)

Description copied from interface: SignalOffloader

Decorates the passed CompletableSource.Subscriber such that all method calls to it will be offloaded.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscriber in interface SignalOffloader

Parameters:

subscriber - CompletableSource.Subscriber for which the signals are to be offloaded.

Returns:

New CompletableSource.Subscriber that will offload signals to the passed CompletableSource.Subscriber.

offloadSubscription

public <T> PublisherSource.Subscriber<? super T> offloadSubscription(PublisherSource.Subscriber<? super T> subscriber)

Description copied from interface: SignalOffloader

Decorates the passed PublisherSource.Subscriber such that all method calls to its PublisherSource.Subscription will be offloaded. None of the PublisherSource.Subscriber methods will be offloaded.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscription in interface SignalOffloader

Type Parameters:

T - Type of items received by the passed and returned PublisherSource.Subscriber.

Parameters:

subscriber - PublisherSource.Subscriber for which the signals are to be offloaded.

Returns:

New PublisherSource.Subscriber that will offload signals to the passed PublisherSource.Subscriber.

offloadCancellable

public <T> SingleSource.Subscriber<? super T> offloadCancellable(SingleSource.Subscriber<? super T> subscriber)

Description copied from interface: SignalOffloader

Decorates the passed SingleSource.Subscriber such that all method calls to its Cancellable will be offloaded. None of the SingleSource.Subscriber methods will be offloaded.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadCancellable in interface SignalOffloader

Type Parameters:

T - Type of items received by the passed and returned SingleSource.Subscriber.

Parameters:

subscriber - SingleSource.Subscriber for which the signals are to be offloaded.

Returns:

New SingleSource.Subscriber that will offload signals to the passed SingleSource.Subscriber.

offloadCancellable

public CompletableSource.Subscriber offloadCancellable(CompletableSource.Subscriber subscriber)

Description copied from interface: SignalOffloader

Decorates the passed CompletableSource.Subscriber such that all method calls to its Cancellable will be offloaded. None of the CompletableSource.Subscriber methods will be offloaded.

Caution

LoadBalancerReadyHttpClientTest This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadCancellable in interface SignalOffloader

Parameters:

subscriber - CompletableSource.Subscriber for which the signals are to be offloaded.

Returns:

New CompletableSource.Subscriber that will offload signals to the passed CompletableSource.Subscriber.

offloadSubscribe

public <T> void offloadSubscribe(PublisherSource.Subscriber<? super T> subscriber,
                                 java.util.function.Consumer<PublisherSource.Subscriber<? super T>> handleSubscribe)

Description copied from interface: SignalOffloader

Offloads subscribe call for the passed PublisherSource.Subscriber.

Offloading Failures

Implementations are expected to handle failure to offload, e.g. If a thread pool is used to offload and it rejects task submissions. In such situations, it is expected that the passed PublisherSource.Subscriber will be correctly terminated.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscribe in interface SignalOffloader

Type Parameters:

T - Type of signal.

Parameters:

subscriber - PublisherSource.Subscriber for which subscribe call has to be offloaded.

handleSubscribe - Consumer to handle the offloaded subscribe call.

offloadSubscribe

public <T> void offloadSubscribe(SingleSource.Subscriber<? super T> subscriber,
                                 java.util.function.Consumer<SingleSource.Subscriber<? super T>> handleSubscribe)

Description copied from interface: SignalOffloader

Offloads subscribe call for the passed PublisherSource.Subscriber.

Offloading Failures

Implementations are expected to handle failure to offload, e.g. If a thread pool is used to offload and it rejects task submissions. In such situations, it is expected that the passed PublisherSource.Subscriber will be correctly terminated.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscribe in interface SignalOffloader

Type Parameters:

T - Type of signal.

Parameters:

subscriber - SingleSource.Subscriber for which subscribe call has to be offloaded.

handleSubscribe - Consumer to handle the offloaded subscribe call.

offloadSubscribe

public void offloadSubscribe(CompletableSource.Subscriber subscriber,
                             java.util.function.Consumer<CompletableSource.Subscriber> handleSubscribe)

Description copied from interface: SignalOffloader

Offloads the subscribe call for the passed PublisherSource.Subscriber.

Offloading Failures

Implementations are expected to handle failure to offload, e.g. If a thread pool is used to offload and it rejects task submissions. In such situations, it is expected that the passed PublisherSource.Subscriber will be correctly terminated.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSubscribe in interface SignalOffloader

Parameters:

subscriber - PublisherSource.Subscriber for which for which subscribe call has to be offloaded.

handleSubscribe - Consumer to handle the offloaded subscribe call.

offloadSignal

public <T> void offloadSignal(T signal,
                              java.util.function.Consumer<T> signalConsumer)

Description copied from interface: SignalOffloader

Offloads the consumption of the passed signal by the passed Consumer.

Caution

This method MUST not be called concurrently with itself or other offload methods here on the same SignalOffloader instance.

Specified by:

offloadSignal in interface SignalOffloader

Type Parameters:

T - Type of signal.

Parameters:

signal - signal to send to the Consumer.

signalConsumer - Consumer of the signal.