Module com.softwaremill.jox

Package com.softwaremill.jox

Interface Source<T>

All Superinterfaces:

CloseableChannel

All Known Implementing Classes:

Channel

public interface Source<T>
extends CloseableChannel

A channel source, which can be used to receive values from the channel. See Channel for more details.

Method Summary

Modifier and Type	Method	Description
default void	forEach(Consumer<T> c)	Invokes the given function for each received element.
T	receive()	Receive a value from the channel.
SelectClause<T>	receiveClause()	Create a clause which can be used in Select.select(SelectClause[]).
<U> SelectClause<U>	receiveClause(Function<T,U> callback)	Create a clause which can be used in Select.select(SelectClause[]).
Object	receiveOrClosed()	Receive a value from the channel.
default List<T>	toList()	Accumulates all elements received from the channel into a list.

Methods inherited from interface com.softwaremill.jox.CloseableChannel

closedForReceive, closedForSend, done, doneOrClosed, error, errorOrClosed, isClosedForReceive, isClosedForSend

Method Details

receive

T receive()
   throws InterruptedException

Receive a value from the channel.

Throws:

ChannelClosedException - When the channel is closed.

InterruptedException

receiveOrClosed

Object receiveOrClosed()
                throws InterruptedException

Receive a value from the channel. Doesn't throw exceptions when the channel is closed, but returns a value.

Returns:

Either a value of type T, or ChannelClosed, when the channel is closed.

Throws:

InterruptedException

receiveClause

SelectClause<T> receiveClause()

Create a clause which can be used in Select.select(SelectClause[]). The clause will receive a value from the current channel.

receiveClause

<U> SelectClause<U> receiveClause(Function<T,U> callback)

Create a clause which can be used in Select.select(SelectClause[]). The clause will receive a value from the current channel, and transform it using the provided callback.

forEach

default void forEach(Consumer<T> c)
              throws InterruptedException

Invokes the given function for each received element. Blocks until the channel is done.

Throws:

ChannelErrorException - When there is an upstream error.

InterruptedException

toList

default List<T> toList()
                throws InterruptedException

Accumulates all elements received from the channel into a list. Blocks until the channel is done.

Throws:

ChannelErrorException - When there is an upstream error.

InterruptedException