io.servicetalk.concurrent.internal

Interface SignalOffloader

public interface SignalOffloader

A contract to offload signals to and from any asynchronous source.

Caution

A SignalOffloader instance MUST only be used for a single asynchronous execution chain at any given time. Reusing it across different execution chains concurrently may result in deadlock. Concurrent invocation of any SignalOffloader methods may result in deadlock.

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.

Method Detail

offloadSubscriber

<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.

Caution

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

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

<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.

Caution

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

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

CompletableSource.Subscriber offloadSubscriber(CompletableSource.Subscriber subscriber)

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.

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

<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. 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.

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

<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. 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.

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

CompletableSource.Subscriber offloadCancellable(CompletableSource.Subscriber subscriber)

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.

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

<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.

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.

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

<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.

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.

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

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

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.

Parameters:

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

handleSubscribe - Consumer to handle the offloaded subscribe call.

offloadSignal

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

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.

Type Parameters:

T - Type of signal.

Parameters:

signal - signal to send to the Consumer.

signalConsumer - Consumer of the signal.