org.springframework.messaging.simp.config

Class SimpleBrokerRegistration

java.lang.Object

org.springframework.messaging.simp.config.AbstractBrokerRegistration

org.springframework.messaging.simp.config.SimpleBrokerRegistration

public class SimpleBrokerRegistration
extends AbstractBrokerRegistration

Registration class for configuring a SimpleBrokerMessageHandler.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private long[]	heartbeat
private TaskScheduler	taskScheduler

Constructor Summary

Constructors

Constructor and Description
SimpleBrokerRegistration(SubscribableChannel inChannel, MessageChannel outChannel, java.lang.String[] prefixes)

Method Summary

Modifier and Type	Method and Description
protected SimpleBrokerMessageHandler	getMessageHandler(SubscribableChannel brokerChannel)
SimpleBrokerRegistration	setHeartbeatValue(long[] heartbeat) Configure the value for the heartbeat settings.
SimpleBrokerRegistration	setTaskScheduler(TaskScheduler taskScheduler) Configure the TaskScheduler to use for providing heartbeat support.

Methods inherited from class org.springframework.messaging.simp.config.AbstractBrokerRegistration

getClientInboundChannel, getClientOutboundChannel, getDestinationPrefixes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

taskScheduler

private TaskScheduler taskScheduler

heartbeat

private long[] heartbeat

Constructor Detail

SimpleBrokerRegistration

public SimpleBrokerRegistration(SubscribableChannel inChannel,
                                MessageChannel outChannel,
                                java.lang.String[] prefixes)

Method Detail

setTaskScheduler

public SimpleBrokerRegistration setTaskScheduler(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.

Since:

4.2

setHeartbeatValue

public SimpleBrokerRegistration setHeartbeatValue(long[] heartbeat)

Configure the value for the heartbeat 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).

Since:

4.2

getMessageHandler

protected SimpleBrokerMessageHandler getMessageHandler(SubscribableChannel brokerChannel)

Specified by:

getMessageHandler in class AbstractBrokerRegistration