co.paralleluniverse.strands.channels

Class SplitSendPort<Message>

java.lang.Object

co.paralleluniverse.strands.channels.SplitSendPort<Message>

All Implemented Interfaces:

Port<Message>, PortAutoCloseable, SendPort<Message>, java.lang.AutoCloseable

public abstract class SplitSendPort<Message>
extends java.lang.Object
implements SendPort<Message>

SendPort that will send messages it receives to a target SendPort. Concrete subclasses will need to implement select yielding SendPort to send the message to.

Constructor Summary

Constructors

Constructor and Description
SplitSendPort()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the channel so that no more messages could be sent to it.
void	close(java.lang.Throwable t) Closes the channel so that no more messages could be sent to it, and signifies an exception occurred in the producer.
protected abstract SendPort<? super Message>	select(Message message) Subclasses will implement this method to select the target SendPort.
void	send(Message message) Sends a message to the channel, possibly blocking until there's room available in the channel.
boolean	send(Message message, long timeout, java.util.concurrent.TimeUnit unit) Sends a message to the channel, possibly blocking until there's room available in the channel, but never longer than the specified timeout.
boolean	send(Message message, Timeout timeout) Sends a message to the channel, possibly blocking until there's room available in the channel, but never longer than the specified timeout.
boolean	trySend(Message message) Sends a message to the channel if the channel has room available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.paralleluniverse.strands.channels.PortAutoCloseable

isClosed

Constructor Detail

SplitSendPort

public SplitSendPort()

Method Detail

select

protected abstract SendPort<? super Message> select(Message message)

Subclasses will implement this method to select the target SendPort.

close

public void close(java.lang.Throwable t)

Description copied from interface: SendPort

Closes the channel so that no more messages could be sent to it, and signifies an exception occurred in the producer. The exception will be thrown when the consumer calls ReceivePort's receive or tryReceive, wrapped by a ProducerException. Messages already sent to the channel prior to calling this method will still be received.

Specified by:

close in interface SendPort<Message>

close

public void close()

Description copied from interface: PortAutoCloseable

Closes the channel so that no more messages could be sent to it. Messages already sent to the channel will still be received.

Specified by:

close in interface PortAutoCloseable

Specified by:

close in interface java.lang.AutoCloseable

trySend

public boolean trySend(Message message)

Description copied from interface: SendPort

Sends a message to the channel if the channel has room available. This method never blocks.

Specified by:

trySend in interface SendPort<Message>

Returns:

true if the message has been sent; false otherwise.

send

public void send(Message message)
          throws SuspendExecution,
                 java.lang.InterruptedException

Description copied from interface: SendPort

Sends a message to the channel, possibly blocking until there's room available in the channel. If the channel is full, this method may block, throw an exception, silently drop the message, or displace an old message from the channel. The behavior is determined by the channel's OverflowPolicy, set at construction time.

Specified by:

send in interface SendPort<Message>

Throws:

java.lang.InterruptedException

SuspendExecution

send

public boolean send(Message message,
                    Timeout timeout)
             throws SuspendExecution,
                    java.lang.InterruptedException

Description copied from interface: SendPort

Sends a message to the channel, possibly blocking until there's room available in the channel, but never longer than the specified timeout. If the channel is full, this method may block, throw an exception, silently drop the message, or displace an old message from the channel. The behavior is determined by the channel's OverflowPolicy, set at construction time.

Specified by:

send in interface SendPort<Message>

timeout - the method will not block for longer than the amount remaining in the Timeout

Returns:

true if the message has been sent successfully; false if the timeout has expired.

Throws:

SuspendExecution

java.lang.InterruptedException

send

public boolean send(Message message,
                    long timeout,
                    java.util.concurrent.TimeUnit unit)
             throws SuspendExecution,
                    java.lang.InterruptedException

Description copied from interface: SendPort

Sends a message to the channel, possibly blocking until there's room available in the channel, but never longer than the specified timeout. If the channel is full, this method may block, throw an exception, silently drop the message, or displace an old message from the channel. The behavior is determined by the channel's OverflowPolicy, set at construction time.

Specified by:

send in interface SendPort<Message>

timeout - the maximum duration this method is allowed to wait.

unit - the timeout's time unit

Returns:

true if the message has been sent successfully; false if the timeout has expired.

Throws:

SuspendExecution

java.lang.InterruptedException