org.springframework.messaging

Interface MessageChannel

All Known Subinterfaces:

PollableChannel, SubscribableChannel

All Known Implementing Classes:

AbstractSubscribableChannel, ExecutorSubscribableChannel, GenericMessagingTemplate.TemporaryReplyChannel, ReactorSubscribableChannel

public interface MessageChannel

Base channel interface defining common behavior for sending messages.

Since:

4.0

Author:

Mark Fisher

Field Summary

Fields

Modifier and Type	Field and Description
static long	INDEFINITE_TIMEOUT Constant for sending a message without a prescribed timeout.

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

INDEFINITE_TIMEOUT

static final long INDEFINITE_TIMEOUT

Constant for sending a message without a prescribed timeout.

See Also:

Constant Field Values

Method Detail

send

boolean send(Message<?> message)

Send a Message to this channel. May throw a RuntimeException for non-recoverable errors. Otherwise, if the Message cannot be sent for a non-fatal reason this method will return 'false', and if the Message is sent successfully, it will return 'true'.

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

Parameters:

message - the Message to send

Returns:

whether or not the Message has been sent successfully

send

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

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

Parameters:

message - the Message to send

timeout - the timeout in milliseconds or #INDEFINITE_TIMEOUT

Returns:

true if the message is sent successfully, false if the specified timeout period elapses or the send is interrupted