Spring Framework 6.1.4 · org.springframework.messaging.MessageChannel

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

Method Summary

Modifier and Type	Method and Description
public default boolean	Returns: whether the message was sent send(Message<?> the message to send message) Send a `Message` to this channel.
public boolean	Returns: `true` if the message is sent, `false` if not including a timeout of an interrupt of the send send(Message<?> the message to send message, long the timeout in milliseconds or `INDEFINITE_TIMEOUT` timeout) Send a message, blocking until either the message is accepted or the specified timeout period elapses.

INDEFINITE_TIMEOUT	back to summary
public static final long INDEFINITE_TIMEOUT Constant for sending a message without a prescribed timeout.

Method Detail

send back to summary

send	back to summary
public default boolean send(Message<?> message) 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 `send(Message, long)`. Parameters message:Message<?> the message to send Returns:boolean whether the message was sent

public default boolean send(Message<?> message)

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 send(Message, long).

Parameters

message:Message<?>: the message to send

Returns:boolean

whether the message was sent

send back to summary

send	back to summary
public boolean send(Message<?> message, long timeout) Send a message, blocking until either the message is accepted or the specified timeout period elapses. Parameters message:Message<?> the message to send timeout:long the timeout in milliseconds or `INDEFINITE_TIMEOUT` Returns:boolean `true` if the message is sent, `false` if not including a timeout of an interrupt of the send

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

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

Parameters

message:Message<?>: the message to send
timeout:long: the timeout in milliseconds or INDEFINITE_TIMEOUT

Returns:boolean

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

public Interface MessageChannel

Field Summary

Method Summary

Field Detail

Method Detail