co.paralleluniverse.strands.channels

Class TickerChannelConsumer<Message>

java.lang.Object

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

All Implemented Interfaces:

Port<Message>, PortAutoCloseable, ReceivePort<Message>, Selectable<Message>, java.lang.AutoCloseable

Direct Known Subclasses:

TickerChannelConsumer.TickerChannelFloatConsumer

public class TickerChannelConsumer<Message>
extends java.lang.Object
implements ReceivePort<Message>, Selectable<Message>

A ReceivePort which is a view of a ticker channel. Each ticker-consumer will yield monotonic messages, namely no message will be received more than once, and the messages will be received in the order they're sent, but if the consumer is too slow, messages could be lost.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TickerChannelConsumer.TickerChannelFloatConsumer

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

ReceivePort.EOFException

Method Summary

Modifier and Type	Method and Description
protected void	checkClosed()
void	close() Closes the channel so that no more messages could be sent to it.
long	getLastIndexRead()
boolean	hasMessage()
boolean	isClosed() Tests whether the channel has been closed and no more messages await in the channel.
Message	receive() Retrieves a message from the channels, possibly blocking until one becomes available.
Message	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.
Message	receive(Timeout timeout) Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.
java.lang.Object	register(SelectAction<Message> action)
boolean	tryNow(java.lang.Object token)
Message	tryReceive() Retrieves a message from the channel if one is available.
void	unregister(java.lang.Object token)

Methods inherited from class java.lang.Object

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

Method Detail

checkClosed

protected void checkClosed()
                    throws ReceivePort.EOFException

Throws:

ReceivePort.EOFException

hasMessage

public boolean hasMessage()

getLastIndexRead

public final long getLastIndexRead()

tryReceive

public Message 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<Message>

Returns:

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

receive

public Message 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<Message>

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 Message receive(long timeout,
                       java.util.concurrent.TimeUnit unit)
                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<Message>

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

receive

public Message 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<Message>

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

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.

register

public java.lang.Object register(SelectAction<Message> action)

Specified by:

register in interface Selectable<Message>

tryNow

public boolean tryNow(java.lang.Object token)

Specified by:

tryNow in interface Selectable<Message>

unregister

public void unregister(java.lang.Object token)

Specified by:

unregister in interface Selectable<Message>