Package io.servicetalk.concurrent

Interface BlockingIterable.Processor<T>

Type Parameters:

T - the type of elements returned by the BlockingIterator.

All Superinterfaces:

AutoCloseable, BlockingIterable<T>, CloseableIterable<T>, Iterable<T>

Enclosing interface:

BlockingIterable<T>

public static interface BlockingIterable.Processor<T>
extends BlockingIterable<T>, AutoCloseable

A BlockingIterable that supports to dynamically emitting items using next(Object).

If multiple BlockingIterators are created by this BlockingIterable then an implementation will choose how to distribute the items emitted from next(Object) to those BlockingIterators. There is no common guarantee about the nature of that distribution.

Lifetime

There are two aspects of the lifetime of this Processor, one from the producer side and one from the consumer side (BlockingIterator.

Producer Lifetime

A producer MUST invoke either close() (successful termination) or fail(Throwable) (unsuccessful termination) to correctly terminate the producer side of this Processor.

Consumer Lifetime

A consumer can prematurely indicate termination by calling BlockingIterator.close(). However, if a consumer receives a termination from the producer end (BlockingIterator.hasNext(long, TimeUnit) returns false), then it need not call BlockingIterator.close().

Nested Class Summary

Nested classes/interfaces inherited from interface io.servicetalk.concurrent.BlockingIterable

BlockingIterable.Processor<T>

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this BlockingIterable and all the current or future BlockingIterators.
void	fail(Throwable cause)	Terminates this BlockingIterable and all the current or future BlockingIterators with a failure.
void	next(T nextItem)	Emits the passed nextItem from the BlockingIterator when called.

Methods inherited from interface io.servicetalk.concurrent.BlockingIterable

forEach, forEach, forEach, iterator, spliterator

Method Details

next

void next(@Nullable
 T nextItem)
   throws Exception

Emits the passed nextItem from the BlockingIterator when called.

Parameters:

nextItem - to emit from the BlockingIterator when called.

Throws:

Exception - If the item could not be emitted.

fail

void fail(Throwable cause)
   throws Exception

Terminates this BlockingIterable and all the current or future BlockingIterators with a failure.

After this method returns, any subsequent calls to next(Object) MUST throw an Exception. All current and future BlockingIterators created by this BlockingIterable MUST eventually throw an Exception which is the same as passed cause or wraps the same.

Parameters:

cause - for the failure.

Throws:

Exception - If this BlockingIterable can not be terminated with a failure.

close

void close()
    throws Exception

Closes this BlockingIterable and all the current or future BlockingIterators.

After this method returns, any subsequent calls to next(Object) MUST throw an Exception. All current and future BlockingIterators created by this BlockingIterable MUST eventually return false from the various hasNext methods.

Specified by:

close in interface AutoCloseable

Throws:

Exception - If closure failed.