SubscribableChannel

A {@link MessageChannel} that maintains a registry of subscribers and invokes them to handle messages sent through this channel.

@author Mark Fisher @since 4.0

Members

Functions

subscribe
bool subscribe(MessageHandler handler)

Register a message handler. @return {@code true} if the handler was subscribed or {@code false} if it was already subscribed.

unsubscribe
bool unsubscribe(MessageHandler handler)

Un-register a message handler. @return {@code true} if the handler was un-registered, or {@code false} if was not registered.

Inherited Members

From MessageChannel

INDEFINITE_TIMEOUT
enum long INDEFINITE_TIMEOUT;

Constant for sending a message without a prescribed timeout.

send
bool send(MessageBase message)

Send a {@link Message} to this channel. If the message is sent successfully, the method returns {@code true}. If the message cannot be sent due to a non-fatal reason, the method returns {@code false}. The method may also throw a RuntimeException in case of non-recoverable errors. <p>This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use {@link #send(Message, long)}. @param message the message to send @return whether or not the message was sent

send
bool send(MessageBase message, long timeout)

Send a message, blocking until either the message is accepted or the specified timeout period elapses. @param message the message to send @param timeout the timeout in milliseconds or {@link #INDEFINITE_TIMEOUT} @return {@code true} if the message is sent, {@code false} if not including a timeout of an interrupt of the send

Meta