StompBrokerRelayRegistration

Constructors

this

this(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, string[] destinationPrefixes)

Undocumented in source.

Members

Functions

getMessageHandler

AbstractBrokerMessageHandler getMessageHandler(SubscribableChannel brokerChannel)

Undocumented in source. Be warned that the author may not have intended to support it.

getUserDestinationBroadcast

string getUserDestinationBroadcast()

Undocumented in source. Be warned that the author may not have intended to support it.

getUserRegistryBroadcast

string getUserRegistryBroadcast()

Undocumented in source. Be warned that the author may not have intended to support it.

setAutoStartup

StompBrokerRelayRegistration setAutoStartup(bool autoStartup)

Configure whether the {@link StompBrokerRelayMessageHandler} should start automatically when the Spring ApplicationContext is refreshed. <p>The default setting is {@code true}.

setClientLogin

StompBrokerRelayRegistration setClientLogin(string login)

Set the login to use when creating connections to the STOMP broker on behalf of connected clients. <p>By default this is set to "guest".

setClientPasscode

StompBrokerRelayRegistration setClientPasscode(string passcode)

Set the passcode to use when creating connections to the STOMP broker on behalf of connected clients. <p>By default this is set to "guest".

setRelayHost

StompBrokerRelayRegistration setRelayHost(string relayHost)

Set the STOMP message broker host.

setRelayPort

StompBrokerRelayRegistration setRelayPort(int relayPort)

Set the STOMP message broker port.

setSystemHeartbeatReceiveInterval

StompBrokerRelayRegistration setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval)

Set the maximum interval, in milliseconds, at which the "system" relay session expects, in the absence of any other data, to receive a heartbeat from the STOMP broker. A value of zero will configure the relay session to expect not to receive heartbeats from the broker. <p>The default value is 10000.

setSystemHeartbeatSendInterval

StompBrokerRelayRegistration setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval)

Set the interval, in milliseconds, at which the "system" relay session will, in the absence of any other data being sent, send a heartbeat to the STOMP broker. A value of zero will prevent heartbeats from being sent to the broker. <p>The default value is 10000.

setSystemLogin

StompBrokerRelayRegistration setSystemLogin(string login)

Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method). <p>By default this is set to "guest".

setSystemPasscode

StompBrokerRelayRegistration setSystemPasscode(string passcode)

Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method). <p>By default this is set to "guest".

setUserDestinationBroadcast

StompBrokerRelayRegistration setUserDestinationBroadcast(string destination)

Set a destination to broadcast messages to user destinations that remain unresolved because the user appears not to be connected. In a multi-application server scenario this gives other application servers a chance to try. <p>By default this is not set. @param destination the destination to broadcast unresolved messages to, e.g. "/topic/unresolved-user-destination"

setUserRegistryBroadcast

StompBrokerRelayRegistration setUserRegistryBroadcast(string destination)

Set a destination to broadcast the content of the local user registry to and to listen for such broadcasts from other servers. In a multi-application server scenarios this allows each server's user registry to be aware of users connected to other servers. <p>By default this is not set. @param destination the destination for broadcasting user registry details, e.g. "/topic/simp-user-registry".

setVirtualHost

StompBrokerRelayRegistration setVirtualHost(string virtualHost)

Set the value of the "host" header to use in STOMP CONNECT frames. When this property is configured, a "host" header will be added to every STOMP frame sent to the STOMP broker. This may be useful for example in a cloud environment where the actual host to which the TCP connection is established is different from the host providing the cloud-based STOMP service. <p>By default this property is not set.

Inherited Members

From AbstractBrokerRegistration

getClientInboundChannel

SubscribableChannel getClientInboundChannel()

Undocumented in source. Be warned that the author may not have intended to support it.

getClientOutboundChannel

MessageChannel getClientOutboundChannel()

Undocumented in source. Be warned that the author may not have intended to support it.

getDestinationPrefixes

string[] getDestinationPrefixes()

Undocumented in source. Be warned that the author may not have intended to support it.

getMessageHandler

AbstractBrokerMessageHandler getMessageHandler(SubscribableChannel brokerChannel)

Undocumented in source.

• StompBrokerRelayRegistration