io.servicetalk.concurrent.api

Interface BlockingProcessorSignalsHolder<T>

Type Parameters:

T - Type of items stored in this holder.

public interface BlockingProcessorSignalsHolder<T>

A holder of items for a BlockingIterable.Processor.

Multi-threaded access

Implementations may assume that the consumption of the items (methods consume(ProcessorSignalsConsumer) and consume(ProcessorSignalsConsumer, long, TimeUnit)) is always done serially however the production (methods add(Object), terminate(Throwable) and terminate()) may be done concurrently.

Method Summary

Modifier and Type	Method and Description
void	add(T item) Adds an item to this holder.
boolean	consume(ProcessorSignalsConsumer<T> consumer) Consumes the next item stored in this holder.
boolean	consume(ProcessorSignalsConsumer<T> consumer, long waitFor, TimeUnit waitForUnit) Consumes the next item stored in this holder.
void	terminate() Terminates this holder, such that no further modifications of this holder are expected.
void	terminate(Throwable cause) Terminates this holder, such that no further modifications of this holder are expected.

Method Detail

add

void add(@Nullable
         T item)
  throws InterruptedException

Adds an item to this holder.

Parameters:

item - to add.

Throws:

InterruptedException - If the add was interrupted.

terminate

void terminate()
        throws InterruptedException

Terminates this holder, such that no further modifications of this holder are expected. Subsequent consumptions must first consume all previously added items and then ProcessorSignalsConsumer.consumeTerminal() consume termination}.

Throws:

InterruptedException - If termination was interrupted.

terminate

void terminate(Throwable cause)
        throws InterruptedException

Terminates this holder, such that no further modifications of this holder are expected. Subsequent consumptions must first consume all previously added items and then ProcessorSignalsConsumer.consumeTerminal() consume termination}.

Parameters:

cause - Throwable as a cause for termination.

Throws:

InterruptedException - If termination was interrupted.

consume

boolean consume(ProcessorSignalsConsumer<T> consumer)
         throws InterruptedException

Consumes the next item stored in this holder. If there are no items stored in the holder and the holder has terminated successfully or with an error then consume that successful or failed termination.

This method will block till an item or a terminal event is available in the holder.

Parameters:

consumer - ProcessorSignalsConsumer to consume the next item or termination in this holder

Returns:

true if any method was called on the passed ProcessorSignalsConsumer.

Throws:

InterruptedException - If the thread was interrupted while waiting for an item or terminal event.

consume

boolean consume(ProcessorSignalsConsumer<T> consumer,
                long waitFor,
                TimeUnit waitForUnit)
         throws TimeoutException,
                InterruptedException

Consumes the next item stored in this holder. If there are no items stored in the holder and the holder has terminated successfully or with an error then consume that successful or failed termination.

This method will block till an item or a terminal event is available in the holder or the passed waitFor duration has elapsed.

Parameters:

consumer - ProcessorSignalsConsumer to consume the next item or termination in this holder

waitFor - Duration to wait for an item or termination to be available.

waitForUnit - TimeUnit for waitFor.

Returns:

true if any method was called on the passed ProcessorSignalsConsumer.

Throws:

TimeoutException - If there was no item or termination available in the holder for the passed waitFor duration

InterruptedException - If the thread was interrupted while waiting for an item or terminal event.