Package com.consol.citrus.message
Interface MessageQueue
-
public interface MessageQueue- Author:
- Christoph Deppisch
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidpurge(MessageSelector selector)Purge messages selected by given selector.default Messagereceive()Receive any message on the queue.default Messagereceive(long timeout)Receive any message on the queue.Messagereceive(MessageSelector selector)Supports selective consumption of messages on the queue.Messagereceive(MessageSelector selector, long timeout)Consume messages on the queue via message selector.voidsend(Message message)Send new message to queue.
-
-
-
Method Detail
-
send
void send(Message message)
Send new message to queue.- Parameters:
message-
-
receive
default Message receive()
Receive any message on the queue. If no message is present return null.- Returns:
- the first message on the queue or null if no message available.
-
receive
default Message receive(long timeout)
Receive any message on the queue. Operation blocks until a message is present on the queue or the given timeout is reached.- Parameters:
timeout- time to wait for a message.- Returns:
- message or null if no matching message is available.
-
receive
Message receive(MessageSelector selector)
Supports selective consumption of messages on the queue. The first message to be accepted by given message selector is returned as result. Operation is not blocking. In case no matching message is present in the queue null is returned.- Parameters:
selector- must accept the message to consume.- Returns:
- message or null if no matching message is available.
-
receive
Message receive(MessageSelector selector, long timeout)
Consume messages on the queue via message selector. Operation blocks until a matching message is present on the queue or the given timeout is reached.- Parameters:
selector- must accept message to consume.timeout- time to wait for a matching message.- Returns:
- message or null if no matching message is available.
-
purge
void purge(MessageSelector selector)
Purge messages selected by given selector.- Parameters:
selector-
-
-