org.springframework.messaging.simp.broker

Class OrderedMessageSender

java.lang.Object

org.springframework.messaging.simp.broker.OrderedMessageSender

All Implemented Interfaces:

MessageChannel

class OrderedMessageSender
extends java.lang.Object
implements MessageChannel

Submit messages to an ExecutorSubscribableChannel, one at a time. The channel must have been configured with configureOutboundChannel(org.springframework.messaging.MessageChannel, boolean).

Since:

5.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OrderedMessageSender.CallbackInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
private MessageChannel	channel
(package private) static java.lang.String	COMPLETION_TASK_HEADER
private Log	logger
private java.util.Queue<Message<?>>	messages
private java.util.concurrent.atomic.AtomicBoolean	sendInProgress

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OrderedMessageSender(MessageChannel channel, Log logger)

Method Summary

Modifier and Type	Method and Description
private void	addCompletionCallback(Message<?> msg)
(package private) static void	configureOutboundChannel(MessageChannel channel, boolean preservePublishOrder) Install or remove an ExecutorChannelInterceptor that invokes a completion task once the message is handled.
boolean	send(Message<?> message) Send a Message to this channel.
boolean	send(Message<?> message, long timeout) Send a message, blocking until either the message is accepted or the specified timeout period elapses.
private void	sendNextMessage()
private void	trySend()

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETION_TASK_HEADER

static final java.lang.String COMPLETION_TASK_HEADER

See Also:

Constant Field Values

channel

private final MessageChannel channel

logger

private final Log logger

messages

private final java.util.Queue<Message<?>> messages

sendInProgress

private final java.util.concurrent.atomic.AtomicBoolean sendInProgress

Constructor Detail

OrderedMessageSender

public OrderedMessageSender(MessageChannel channel,
                            Log logger)

Method Detail

send

public boolean send(Message<?> message)

Description copied from interface: MessageChannel

Send a Message to this channel. If the message is sent successfully, the method returns true. If the message cannot be sent due to a non-fatal reason, the method returns false. The method may also throw a RuntimeException in case of non-recoverable errors.

This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use MessageChannel.send(Message, long).

Specified by:

send in interface MessageChannel

Parameters:

message - the message to send

Returns:

whether or not the message was sent

send

public boolean send(Message<?> message,
                    long timeout)

Description copied from interface: MessageChannel

Send a message, blocking until either the message is accepted or the specified timeout period elapses.

Specified by:

send in interface MessageChannel

Parameters:

message - the message to send

timeout - the timeout in milliseconds or MessageChannel.INDEFINITE_TIMEOUT

Returns:

true if the message is sent, false if not including a timeout of an interrupt of the send

trySend

private void trySend()

sendNextMessage

private void sendNextMessage()

addCompletionCallback

private void addCompletionCallback(Message<?> msg)

configureOutboundChannel

static void configureOutboundChannel(MessageChannel channel,
                                     boolean preservePublishOrder)

Install or remove an ExecutorChannelInterceptor that invokes a completion task once the message is handled.

Parameters:

channel - the channel to configure

preservePublishOrder - whether preserve order is on or off based on which an interceptor is either added or removed.