Interface QueueChannelOperations
- All Known Implementing Classes:
PriorityChannel,QueueChannel,RendezvousChannel
public interface QueueChannelOperations
Operations available on a channel that has queuing semantics.
- Since:
- 3.0
-
Method Summary
Modifier and Type Method Description java.util.List<org.springframework.messaging.Message<?>>clear()Remove allMessagesfrom this channel.intgetQueueSize()Obtain the current number of queuedMessagesin this channel.intgetRemainingCapacity()Obtain the remaining capacity of this channel.java.util.List<org.springframework.messaging.Message<?>>purge(MessageSelector selector)Remove anyMessagesthat are not accepted by the provided selector.
-
Method Details
-
clear
java.util.List<org.springframework.messaging.Message<?>> clear()Remove allMessagesfrom this channel.- Returns:
- The messages that were removed.
-
purge
Remove anyMessagesthat are not accepted by the provided selector.- Parameters:
selector- The message selector.- Returns:
- The list of messages that were purged.
-
getQueueSize
@ManagedAttribute(description="Queue size") int getQueueSize()Obtain the current number of queuedMessagesin this channel.- Returns:
- The current number of queued
Messagesin this channel.
-
getRemainingCapacity
@ManagedAttribute(description="Queue remaining capacity") int getRemainingCapacity()Obtain the remaining capacity of this channel.- Returns:
- The remaining capacity of this channel.
-