co.paralleluniverse.strands.channels

Class QueueLongChannel

java.lang.Object

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

co.paralleluniverse.strands.channels.QueuePrimitiveChannel<java.lang.Long>

co.paralleluniverse.strands.channels.QueueLongChannel

All Implemented Interfaces:

Channel<java.lang.Long>, LongChannel, LongReceivePort, LongSendPort, Port<java.lang.Long>, PortAutoCloseable, ReceivePort<java.lang.Long>, Selectable<java.lang.Long>, SendPort<java.lang.Long>, StandardChannel<java.lang.Long>, Stranded, Synchronization, java.io.Serializable, java.lang.AutoCloseable

public class QueueLongChannel
extends QueuePrimitiveChannel<java.lang.Long>
implements LongChannel

See Also:

Serialized Form

Nested Class Summary

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

ReceivePort.EOFException

Field Summary

Fields inherited from class co.paralleluniverse.strands.channels.QueueChannel

RECORDER

Constructor Summary

Constructors

Constructor and Description
QueueLongChannel(BasicSingleConsumerLongQueue queue, Channels.OverflowPolicy policy)

Method Summary

Modifier and Type	Method and Description
protected BasicSingleConsumerLongQueue	queue()
long	receiveLong() Retrieves a message from the channels, possibly blocking until one becomes available.
long	receiveLong(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.
long	receiveLong(Timeout timeout) Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout.
void	send(long message) Sends a message to the channel, possibly blocking until there's room available in the channel.
boolean	send(long 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(long 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(long message) Sends a message to the channel if the channel has room available.

Methods inherited from class co.paralleluniverse.strands.channels.QueuePrimitiveChannel

checkClosed, getStrand, hasMessage, maybeSetCurrentStrandAsOwner, setStrand

Methods inherited from class co.paralleluniverse.strands.channels.QueueChannel

capacity, close, close, equals, getCloseException, getOverflowPolicy, getQueueLength, isClosed, isSingleConsumer, isSingleProducer, receive, receive, receive, receiveFromThread, receiveFromThread, register, register, send, send, send, send0, sendNonSuspendable, sendSync, signalAndWait, signalReceivers, sync, toString, tryNow, tryReceive, trySend, unregister, writeReplace

Methods inherited from class java.lang.Object

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

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

close, send, send, send, trySend

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

hasMessage

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

receive, receive, receive, tryReceive

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

close, isClosed

Constructor Detail

QueueLongChannel

public QueueLongChannel(BasicSingleConsumerLongQueue queue,
                        Channels.OverflowPolicy policy)

Method Detail

receiveLong

public long receiveLong()
                 throws SuspendExecution,
                        java.lang.InterruptedException,
                        ReceivePort.EOFException

Description copied from interface: LongReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available. If the channel has been closed and no more messages await, this method throws an ReceivePort.EOFException.

Specified by:

receiveLong in interface LongReceivePort

Returns:

a message.

Throws:

java.lang.InterruptedException

ReceivePort.EOFException - if the channel has been closed and no more messages await

SuspendExecution

receiveLong

public long receiveLong(long timeout,
                        java.util.concurrent.TimeUnit unit)
                 throws SuspendExecution,
                        java.lang.InterruptedException,
                        java.util.concurrent.TimeoutException,
                        ReceivePort.EOFException

Description copied from interface: LongReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout. If the channel has been closed and no more messages await, this method throws an ReceivePort.EOFException.

Specified by:

receiveLong in interface LongReceivePort

Parameters:

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

unit - the time unit of the timeout.

Returns:

a message. (see PortAutoCloseable.isClosed()), or if the timeout has expired.

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException - if the timeout has expired

ReceivePort.EOFException - if the channel has been closed and no more messages await

SuspendExecution

receiveLong

public long receiveLong(Timeout timeout)
                 throws SuspendExecution,
                        java.lang.InterruptedException,
                        java.util.concurrent.TimeoutException,
                        ReceivePort.EOFException

Description copied from interface: LongReceivePort

Retrieves a message from the channels, possibly blocking until one becomes available, but no longer than the specified timeout. If the channel has been closed and no more messages await, this method throws an ReceivePort.EOFException.

Specified by:

receiveLong in interface LongReceivePort

Parameters:

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

Returns:

a message. (see PortAutoCloseable.isClosed()), or if the timeout has expired.

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException - if the timeout has expired

ReceivePort.EOFException - if the channel has been closed and no more messages await

SuspendExecution

trySend

public boolean trySend(long message)

Description copied from interface: LongSendPort

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

Specified by:

trySend in interface LongSendPort

Returns:

true if the message has been sent; false otherwise.

send

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

Description copied from interface: LongSendPort

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 LongSendPort

Throws:

SuspendExecution

java.lang.InterruptedException

send

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

Description copied from interface: LongSendPort

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 LongSendPort

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

send

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

Description copied from interface: LongSendPort

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 LongSendPort

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

queue

protected BasicSingleConsumerLongQueue queue()

Overrides:

queue in class QueuePrimitiveChannel<java.lang.Long>