Module com.softwaremill.jox

Package com.softwaremill.jox

Interface Sink<T>

All Superinterfaces:

CloseableChannel

All Known Implementing Classes:

Channel

public interface Sink<T>
extends CloseableChannel

A channel sink, which can be used to send values to the channel. See Channel for more details.

Method Summary

Modifier and Type	Method	Description
void	send(T value)	Send a value to the channel.
SelectClause<Void>	sendClause(T value)	Create a clause which can be used in Select.select(SelectClause[]).
<U> SelectClause<U>	sendClause(T value, Supplier<U> callback)	Create a clause which can be used in Select.select(SelectClause[]).
Object	sendOrClosed(T value)	Send a value to the channel.

Methods inherited from interface com.softwaremill.jox.CloseableChannel

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

Method Details

send

void send(T value)
   throws InterruptedException

Send a value to the channel.

Parameters:

value - The value to send. Not null.

Throws:

ChannelClosedException - When the channel is closed.

InterruptedException

sendOrClosed

Object sendOrClosed(T value)
             throws InterruptedException

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

Parameters:

value - The value to send. Not null.

Returns:

Either null, or ChannelClosed, when the channel is closed.

Throws:

InterruptedException

sendClause

SelectClause<Void> sendClause(T value)

Create a clause which can be used in Select.select(SelectClause[]). The clause will send the given value to the current channel, and return null as the clause's result.

sendClause

<U> SelectClause<U> sendClause(T value,
 Supplier<U> callback)

Create a clause which can be used in Select.select(SelectClause[]). The clause will send the given value to the current channel, and return the value of the provided callback as the clause's result.