org.springframework.messaging

Interface SubscribableChannel

All Superinterfaces:

MessageChannel

All Known Implementing Classes:

AbstractSubscribableChannel, ExecutorSubscribableChannel, ReactorSubscribableChannel

public interface SubscribableChannel
extends MessageChannel

Interface for any MessageChannel implementation that accepts subscribers. The subscribers must implement the MessageHandler interface and will be invoked when a Message is available.

Since:

4.0

Author:

Mark Fisher

Field Summary

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Method Summary

Modifier and Type	Method and Description
boolean	subscribe(MessageHandler handler) Register a MessageHandler as a subscriber to this channel.
boolean	unsubscribe(MessageHandler handler) Remove a MessageHandler from the subscribers of this channel.

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

Method Detail

subscribe

boolean subscribe(MessageHandler handler)

Register a MessageHandler as a subscriber to this channel.

Returns:

true if the channel was not already subscribed to the specified handler

unsubscribe

boolean unsubscribe(MessageHandler handler)

Remove a MessageHandler from the subscribers of this channel.

Returns:

true if the channel was previously subscribed to the specified handler