类 SimpleBrokerMessageHandler

构造器详细资料

• SimpleBrokerMessageHandler

  public SimpleBrokerMessageHandler​(SubscribableChannel clientInboundChannel,
                                    MessageChannel clientOutboundChannel,
                                    SubscribableChannel brokerChannel,
                                    Collection<String> destinationPrefixes)

  Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes.

  参数:

  clientInboundChannel - the channel for receiving messages from clients (e.g. WebSocket clients)

  clientOutboundChannel - the channel for sending messages to clients (e.g. WebSocket clients)

  brokerChannel - the channel for the application to send messages to the broker

  destinationPrefixes - prefixes to use to filter out messages

方法详细资料

• setSubscriptionRegistry

  public void setSubscriptionRegistry​(SubscriptionRegistry subscriptionRegistry)

  Configure a custom SubscriptionRegistry to use for storing subscriptions.

  Note that when a custom PathMatcher is configured via setPathMatcher(org.springframework.util.PathMatcher), if the custom registry is not an instance of DefaultSubscriptionRegistry, the provided PathMatcher is not used and must be configured directly on the custom registry.

• getSubscriptionRegistry

  public SubscriptionRegistry getSubscriptionRegistry()

• setPathMatcher

  public void setPathMatcher​(@Nullable
                             PathMatcher pathMatcher)

  When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.

  Default is a standard AntPathMatcher.

  从以下版本开始:

  4.1

  另请参阅:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setPathMatcher(org.springframework.util.PathMatcher), AntPathMatcher

• setCacheLimit

  public void setCacheLimit​(@Nullable
                            Integer cacheLimit)

  When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.

  With a standard DefaultSubscriptionRegistry, the default cache limit is 1024.

  从以下版本开始:

  4.3.2

  另请参阅:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setCacheLimit(int), DefaultSubscriptionRegistry.DEFAULT_CACHE_LIMIT

• setSelectorHeaderName

  public void setSelectorHeaderName​(@Nullable
                                    String selectorHeaderName)

  Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription. The header value is expected to be a Spring EL boolean expression to be applied to the headers of messages matched to the subscription.

  For example:

   headers.foo == 'bar'
   

  By default this is set to "selector". You can set it to a different name, or to null to turn off support for a selector header.

  参数:

  selectorHeaderName - the name to use for a selector header

  从以下版本开始:

  4.3.17

  另请参阅:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setSelectorHeaderName(String)

• setTaskScheduler

  public void setTaskScheduler​(@Nullable
                               TaskScheduler taskScheduler)

  Configure the TaskScheduler to use for providing heartbeat support. Setting this property also sets the heartbeatValue to "10000, 10000".

  By default this is not set.

  从以下版本开始:

  4.2

• getTaskScheduler

  @Nullable
  public TaskScheduler getTaskScheduler()

  Return the configured TaskScheduler.

  从以下版本开始:

  4.2

• setHeartbeatValue

  public void setHeartbeatValue​(@Nullable
                                long[] heartbeat)

  Configure the value for the heart-beat settings. The first number represents how often the server will write or send a heartbeat. The second is how often the client should write. 0 means no heartbeats.

  By default this is set to "0, 0" unless the taskScheduler in which case the default becomes "10000,10000" (in milliseconds).

  从以下版本开始:

  4.2

• getHeartbeatValue

  @Nullable
  public long[] getHeartbeatValue()

  The configured value for the heart-beat settings.

  从以下版本开始:

  4.2

• setHeaderInitializer

  public void setHeaderInitializer​(@Nullable
                                   MessageHeaderInitializer headerInitializer)

  Configure a MessageHeaderInitializer to apply to the headers of all messages sent to the client outbound channel.

  By default this property is not set.

  从以下版本开始:

  4.1

• getHeaderInitializer

  @Nullable
  public MessageHeaderInitializer getHeaderInitializer()

  Return the configured header initializer.

  从以下版本开始:

  4.1

• startInternal

  public void startInternal()

  覆盖:

  startInternal 在类中 AbstractBrokerMessageHandler

• stopInternal

  public void stopInternal()

  覆盖:

  stopInternal 在类中 AbstractBrokerMessageHandler

• handleMessageInternal

  protected void handleMessageInternal​(Message<?> message)

  指定者:

  handleMessageInternal 在类中 AbstractBrokerMessageHandler

• sendMessageToSubscribers

  protected void sendMessageToSubscribers​(@Nullable
                                          String destination,
                                          Message<?> message)

• toString

  public String toString()

  覆盖:

  toString 在类中 Object