co.paralleluniverse.strands.channels

Class ReceivePortGroup<M>

java.lang.Object

co.paralleluniverse.strands.channels.ReceivePortGroup<M>

All Implemented Interfaces:

Mix<M>, Port<M>, PortAutoCloseable, ReceivePort<M>, java.lang.AutoCloseable

public class ReceivePortGroup<M>
extends java.lang.Object
implements Mix<M>

Nested Class Summary

Nested classes/interfaces inherited from interface co.paralleluniverse.strands.channels.Mix

Mix.Mode, Mix.SoloEffect, Mix.State

Nested classes/interfaces inherited from interface co.paralleluniverse.strands.channels.ReceivePort

ReceivePort.EOFException

Constructor Summary

Constructors

Constructor and Description
ReceivePortGroup()
ReceivePortGroup(boolean alwaysOpen)
ReceivePortGroup(java.util.Collection<? extends ReceivePort<? extends M>> ports)
ReceivePortGroup(java.util.Collection<? extends ReceivePort<? extends M>> ports, boolean alwaysOpen)
ReceivePortGroup(ReceivePort<? extends M>... ports)

Method Summary

Modifier and Type	Method and Description
<T extends ReceivePort<? extends M>> void	add(T... items)
void	close() Closes the channel so that no more messages could be sent to it.
Mix.SoloEffect	getSoloEffect()
<T extends ReceivePort<? extends M>> java.util.Map<T,Mix.State>	getState(T... items)
boolean	isClosed() Tests whether the channel has been closed and no more messages await in the channel.
M	receive() Retrieves a message from the channels, possibly blocking until one becomes available.
M	receive(long timeout, java.util.concurrent.TimeUnit unit) Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.
M	receive(Timeout timeout) Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.
<T extends ReceivePort<? extends M>> void	remove(T... items)
void	setSoloEffect(Mix.SoloEffect effect)
<T extends ReceivePort<? extends M>> void	setState(java.util.Map<T,Mix.State> newStates)
<T extends ReceivePort<? extends M>> void	setState(Mix.State state, T... items)
M	tryReceive() Retrieves a message from the channel if one is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceivePortGroup

public ReceivePortGroup(java.util.Collection<? extends ReceivePort<? extends M>> ports,
                        boolean alwaysOpen)

ReceivePortGroup

public ReceivePortGroup(java.util.Collection<? extends ReceivePort<? extends M>> ports)

ReceivePortGroup

public ReceivePortGroup(ReceivePort<? extends M>... ports)

ReceivePortGroup

public ReceivePortGroup(boolean alwaysOpen)

ReceivePortGroup

public ReceivePortGroup()

Method Detail

tryReceive

public M tryReceive()

Description copied from interface: ReceivePort

Retrieves a message from the channel if one is available. This method never blocks.

Specified by:

tryReceive in interface ReceivePort<M>

Returns:

a message, or null if one is not immediately available.

receive

public M receive()
          throws SuspendExecution,
                 java.lang.InterruptedException

Description copied from interface: ReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available.

Specified by:

receive in interface ReceivePort<M>

Returns:

a message, or null if the channel has been closed and no more messages await (see PortAutoCloseable.isClosed()).

Throws:

java.lang.InterruptedException

SuspendExecution

receive

public M receive(Timeout timeout)
          throws SuspendExecution,
                 java.lang.InterruptedException

Description copied from interface: ReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.

Specified by:

receive in interface ReceivePort<M>

Parameters:

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

Returns:

a message, or null if the channel has been closed and no more messages await (see PortAutoCloseable.isClosed()), or if the timeout has expired.

Throws:

java.lang.InterruptedException

SuspendExecution

receive

public M receive(long timeout,
                 java.util.concurrent.TimeUnit unit)
          throws java.lang.InterruptedException,
                 SuspendExecution

Description copied from interface: ReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.

Specified by:

receive in interface ReceivePort<M>

Parameters:

timeout - the maximum duration to block waiting for a message.

unit - the time unit of the timeout.

Returns:

a message, or null if the channel has been closed and no more messages await (see PortAutoCloseable.isClosed()), or if the timeout has expired.

Throws:

java.lang.InterruptedException

SuspendExecution

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

isClosed

public boolean isClosed()

Description copied from interface: PortAutoCloseable

Tests whether the channel has been closed and no more messages await in the channel. If this method returns true all future calls to receive are guaranteed to return null, and calls to receive on a primitive channel will throw a EOFException.

Specified by:

isClosed in interface PortAutoCloseable

Returns:

true if the channels has been closed and no more messages will be received; false otherwise.

add

public <T extends ReceivePort<? extends M>> void add(T... items)
                                              throws SuspendExecution,
                                                     java.lang.InterruptedException

Specified by:

add in interface Mix<M>

Throws:

SuspendExecution

java.lang.InterruptedException

remove

public <T extends ReceivePort<? extends M>> void remove(T... items)
                                                 throws SuspendExecution,
                                                        java.lang.InterruptedException

Specified by:

remove in interface Mix<M>

Parameters:

items - If null or empty, all items will be removed.

Throws:

SuspendExecution

java.lang.InterruptedException

getState

public <T extends ReceivePort<? extends M>> java.util.Map<T,Mix.State> getState(T... items)

Specified by:

getState in interface Mix<M>

Parameters:

items - If null or empty, all items will be removed.

setState

public <T extends ReceivePort<? extends M>> void setState(Mix.State state,
                                                          T... items)
                                                   throws SuspendExecution,
                                                          java.lang.InterruptedException

Specified by:

setState in interface Mix<M>

items - If null or empty, all items state will be set to state.

Throws:

SuspendExecution

java.lang.InterruptedException

setState

public <T extends ReceivePort<? extends M>> void setState(java.util.Map<T,Mix.State> newStates)
                                                   throws SuspendExecution,
                                                          java.lang.InterruptedException

Specified by:

setState in interface Mix<M>

Throws:

SuspendExecution

java.lang.InterruptedException

getSoloEffect

public Mix.SoloEffect getSoloEffect()

Specified by:

getSoloEffect in interface Mix<M>

setSoloEffect

public void setSoloEffect(Mix.SoloEffect effect)
                   throws SuspendExecution,
                          java.lang.InterruptedException

Specified by:

setSoloEffect in interface Mix<M>

Throws:

SuspendExecution

java.lang.InterruptedException