io.joynr.messaging.routing

Class MessageQueue

java.lang.Object

io.joynr.messaging.routing.MessageQueue

public class MessageQueue
extends Object

This class holds the queued messages which are to be processed in the AbstractMessageRouter and offers the ability to attempt to wait for the queue to drain.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageQueue.MaxTimeoutHolder Helper class to enable constructor injection of an optionally configured timeout value.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_QUEUE_ID
static String	PROPERTY_MESSAGE_QUEUE_SHUTDOWN_MAX_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
MessageQueue(DelayQueue<DelayableImmutableMessage> delayableImmutableMessages, MessageQueue.MaxTimeoutHolder maxTimeoutHolder, String messageQueueId, MessagePersister messagePersister, RoutingTable routingTable)

Method Summary

Modifier and Type	Method and Description
DelayableImmutableMessage	poll(long timeout, TimeUnit unit) Polls the message queue for a period no longer than the timeout specified for a new message.
void	put(DelayableImmutableMessage delayableImmutableMessage) Add the passed in message to the queue of messages to be processed.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_QUEUE_ID

public static final String MESSAGE_QUEUE_ID

See Also:

Constant Field Values

PROPERTY_MESSAGE_QUEUE_SHUTDOWN_MAX_TIMEOUT

public static final String PROPERTY_MESSAGE_QUEUE_SHUTDOWN_MAX_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

MessageQueue

@Inject
public MessageQueue(DelayQueue<DelayableImmutableMessage> delayableImmutableMessages,
                            MessageQueue.MaxTimeoutHolder maxTimeoutHolder,
                            String messageQueueId,
                            MessagePersister messagePersister,
                            RoutingTable routingTable)

Method Detail

put

public void put(DelayableImmutableMessage delayableImmutableMessage)

Add the passed in message to the queue of messages to be processed. Also offer the message for persisting.

Parameters:

delayableImmutableMessage - the message to add.

poll

public DelayableImmutableMessage poll(long timeout,
                                      TimeUnit unit)
                               throws InterruptedException

Polls the message queue for a period no longer than the timeout specified for a new message. If a message is successfully obtained, before returning it, a message persister is called in order to remove this message from the persistence (in case it was persisted at all).

Parameters:

timeout - the maximum time to wait for a message to become available.

unit - the time unit of measurement for timeout

Returns:

a new message if one is available, or null if none became available within the specified time limit.

Throws:

InterruptedException - if the thread was interrupted while waiting for a message to become available.