Modifier and Type	Class and Description
private static class	WebSocketStompClient.StompWebSocketMessageCodec Encode and decode STOMP WebSocket messages.
private class	WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter Adapt WebSocket to the TcpConnectionHandler and TcpConnection contracts.

Modifier and Type	Field and Description
private boolean	autoStartup
private int	inboundMessageSizeLimit
private static final Log	logger
private int	phase
private volatile boolean	running
private final WebSocketClient	webSocketClient

Access	Constructor and Description
public	WebSocketStompClient(WebSocketClient the WebSocket client to connect with webSocketClient) Class constructor.

Method Summary

Modifier and Type	Method and Description
public ListenableFuture<StompSession>	Returns: a `ListenableFuture` for access to the session when ready for use connect(String the url to connect to url, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVars) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, StompSessionHandler, Object...)` Connect to the given WebSocket URL and notify the given `org.springframework.messaging.simp.stomp.StompSessionHandler` when connected on the STOMP level after the CONNECTED frame is received.
public ListenableFuture<StompSession>	Returns: a `ListenableFuture` for access to the session when ready for use connect(String the url to connect to url, WebSocketHttpHeaders the headers for the WebSocket handshake handshakeHeaders, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVariables) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake.
public ListenableFuture<StompSession>	Returns: a `ListenableFuture` for access to the session when ready for use connect(String the url to connect to url, WebSocketHttpHeaders headers for the WebSocket handshake handshakeHeaders, StompHeaders headers for the STOMP CONNECT frame connectHeaders, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVariables) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...)` An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake and `StompHeaders` for the STOMP CONNECT frame.
public ListenableFuture<StompSession>	Returns: a `ListenableFuture` for access to the session when ready for use connect(URI the url to connect to url, WebSocketHttpHeaders the headers for the WebSocket handshake handshakeHeaders, StompHeaders headers for the STOMP CONNECT frame connectHeaders, StompSessionHandler the STOMP session handler sessionHandler) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler)` An overloaded version of `connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` that accepts a fully prepared `java.net.URI`.
public CompletableFuture<StompSession>	Returns: a CompletableFuture for access to the session when ready for use connectAsync(String the url to connect to url, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVars) Connect to the given WebSocket URL and notify the given `org.springframework.messaging.simp.stomp.StompSessionHandler` when connected on the STOMP level after the CONNECTED frame is received.
public CompletableFuture<StompSession>	Returns: a `ListenableFuture` for access to the session when ready for use connectAsync(String the url to connect to url, WebSocketHttpHeaders the headers for the WebSocket handshake handshakeHeaders, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVariables) An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake.
public CompletableFuture<StompSession>	Returns: a CompletableFuture for access to the session when ready for use connectAsync(String the url to connect to url, WebSocketHttpHeaders headers for the WebSocket handshake handshakeHeaders, StompHeaders headers for the STOMP CONNECT frame connectHeaders, StompSessionHandler the session handler handler, Object... the URI variables to expand into the URL uriVariables) An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake and `StompHeaders` for the STOMP CONNECT frame.
public CompletableFuture<StompSession>	Returns: a CompletableFuture for access to the session when ready for use connectAsync(URI the url to connect to url, WebSocketHttpHeaders the headers for the WebSocket handshake handshakeHeaders, StompHeaders headers for the STOMP CONNECT frame connectHeaders, StompSessionHandler the STOMP session handler sessionHandler) An overloaded version of `connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` that accepts a fully prepared `java.net.URI`.
public int	getInboundMessageSizeLimit() Get the configured inbound message buffer size in bytes.
public int	getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Return the configured phase.
public WebSocketClient	getWebSocketClient() Return the configured WebSocketClient.
public boolean	isAutoStartup() Overrides default org.springframework.context.SmartLifecycle.isAutoStartup. Return the value for the 'autoStartup' property.
public boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running.
protected StompHeaders	processConnectHeaders(StompHeaders the headers to modify connectHeaders) Overrides org.springframework.messaging.simp.stomp.StompClientSupport.processConnectHeaders. Further initialize the StompHeaders, for example setting the heart-beat header if necessary.
public void	setAutoStartup(boolean autoStartup) Set whether to auto-start the contained WebSocketClient when the Spring context has been refreshed.
public void	setInboundMessageSizeLimit(int inboundMessageSizeLimit) Configure the maximum size allowed for inbound STOMP message.
public void	setPhase(int phase) Specify the phase in which the WebSocket client should be started and subsequently closed.
public void	setTaskScheduler(TaskScheduler taskScheduler) Overrides org.springframework.messaging.simp.stomp.StompClientSupport.setTaskScheduler. Configure a scheduler to use for heartbeats and for receipt tracking.
public void	start() Implements org.springframework.context.Lifecycle.start. Start this component.
public void	stop() Implements org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.

Inherited from org.springframework.messaging.simp.stomp.StompClientSupport:: createSession getDefaultHeartbeat getMessageConverter getReceiptTimeLimit getTaskScheduler isDefaultHeartbeatEnabled setDefaultHeartbeat setMessageConverter setReceiptTimeLimit

Field Detail

autoStartup	back to summary
private boolean autoStartup

inboundMessageSizeLimit	back to summary
private int inboundMessageSizeLimit

logger	back to summary
private static final Log logger

phase	back to summary
private int phase

running	back to summary
private volatile boolean running

webSocketClient	back to summary
private final WebSocketClient webSocketClient

Constructor Detail

WebSocketStompClient back to summary

WebSocketStompClient	back to summary
public WebSocketStompClient(WebSocketClient webSocketClient) Class constructor. Sets `setDefaultHeartbeat` to "0,0" but will reset it back to the preferred "10000,10000" when a `setTaskScheduler` is configured. Parameters webSocketClient:WebSocketClient the WebSocket client to connect with

public WebSocketStompClient(WebSocketClient webSocketClient)

Class constructor. Sets setDefaultHeartbeat to "0,0" but will reset it back to the preferred "10000,10000" when a setTaskScheduler is configured.

Parameters

webSocketClient:WebSocketClient: the WebSocket client to connect with

Method Detail

connect back to summary

connect	back to summary
public ListenableFuture<StompSession> connect(String url, StompSessionHandler handler, Object... uriVars) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, StompSessionHandler, Object...)` Connect to the given WebSocket URL and notify the given `org.springframework.messaging.simp.stomp.StompSessionHandler` when connected on the STOMP level after the CONNECTED frame is received. Parameters url:String the url to connect to handler:StompSessionHandler the session handler uriVars:Object[] the URI variables to expand into the URL Returns:ListenableFuture<StompSession> a `ListenableFuture` for access to the session when ready for use Annotations @Deprecated since:6.0

public ListenableFuture<StompSession> connect(String url, StompSessionHandler handler, Object... uriVars)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(String, StompSessionHandler, Object...)

Connect to the given WebSocket URL and notify the given org.springframework.messaging.simp.stomp.StompSessionHandler when connected on the STOMP level after the CONNECTED frame is received.

Parameters

url:String: the url to connect to
handler:StompSessionHandler: the session handler
uriVars:Object[]: the URI variables to expand into the URL

Returns:ListenableFuture<StompSession>

a ListenableFuture for access to the session when ready for use

Annotations

@Deprecated
since:6.0

connect back to summary

connect	back to summary
public ListenableFuture<StompSession> connect(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake. Parameters url:String the url to connect to handshakeHeaders:WebSocketHttpHeaders the headers for the WebSocket handshake handler:StompSessionHandler the session handler uriVariables:Object[] the URI variables to expand into the URL Returns:ListenableFuture<StompSession> a `ListenableFuture` for access to the session when ready for use Annotations @Deprecated since:6.0

public ListenableFuture<StompSession> connect(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)

An overloaded version of connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake.

Parameters

url:String: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: the headers for the WebSocket handshake
handler:StompSessionHandler: the session handler
uriVariables:Object[]: the URI variables to expand into the URL

Returns:ListenableFuture<StompSession>

a ListenableFuture for access to the session when ready for use

Annotations

@Deprecated
since:6.0

connect back to summary

connect	back to summary
public ListenableFuture<StompSession> connect(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...)` An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake and `StompHeaders` for the STOMP CONNECT frame. Parameters url:String the url to connect to handshakeHeaders:WebSocketHttpHeaders headers for the WebSocket handshake connectHeaders:StompHeaders headers for the STOMP CONNECT frame handler:StompSessionHandler the session handler uriVariables:Object[] the URI variables to expand into the URL Returns:ListenableFuture<StompSession> a `ListenableFuture` for access to the session when ready for use Annotations @Deprecated since:6.0

public ListenableFuture<StompSession> connect(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...)

An overloaded version of connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake and StompHeaders for the STOMP CONNECT frame.

Parameters

url:String: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: headers for the WebSocket handshake
connectHeaders:StompHeaders: headers for the STOMP CONNECT frame
handler:StompSessionHandler: the session handler
uriVariables:Object[]: the URI variables to expand into the URL

Returns:ListenableFuture<StompSession>

a ListenableFuture for access to the session when ready for use

Annotations

@Deprecated
since:6.0

connect back to summary

connect	back to summary
public ListenableFuture<StompSession> connect(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler)` An overloaded version of `connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` that accepts a fully prepared `java.net.URI`. Parameters url:URI the url to connect to handshakeHeaders:WebSocketHttpHeaders the headers for the WebSocket handshake connectHeaders:StompHeaders headers for the STOMP CONNECT frame sessionHandler:StompSessionHandler the STOMP session handler Returns:ListenableFuture<StompSession> a `ListenableFuture` for access to the session when ready for use Annotations @Deprecated since:6.0

public ListenableFuture<StompSession> connect(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler)

An overloaded version of connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...) that accepts a fully prepared java.net.URI.

Parameters

url:URI: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: the headers for the WebSocket handshake
connectHeaders:StompHeaders: headers for the STOMP CONNECT frame
sessionHandler:StompSessionHandler: the STOMP session handler

Returns:ListenableFuture<StompSession>

a ListenableFuture for access to the session when ready for use

Annotations

@Deprecated
since:6.0

connectAsync back to summary

connectAsync	back to summary
public CompletableFuture<StompSession> connectAsync(String url, StompSessionHandler handler, Object... uriVars) Connect to the given WebSocket URL and notify the given `org.springframework.messaging.simp.stomp.StompSessionHandler` when connected on the STOMP level after the CONNECTED frame is received. Parameters url:String the url to connect to handler:StompSessionHandler the session handler uriVars:Object[] the URI variables to expand into the URL Returns:CompletableFuture<StompSession> a CompletableFuture for access to the session when ready for use Since 6.0

public CompletableFuture<StompSession> connectAsync(String url, StompSessionHandler handler, Object... uriVars)

Connect to the given WebSocket URL and notify the given org.springframework.messaging.simp.stomp.StompSessionHandler when connected on the STOMP level after the CONNECTED frame is received.

Parameters

url:String: the url to connect to
handler:StompSessionHandler: the session handler
uriVars:Object[]: the URI variables to expand into the URL

Returns:CompletableFuture<StompSession>

a CompletableFuture for access to the session when ready for use

Since

6.0

connectAsync back to summary

connectAsync	back to summary
public CompletableFuture<StompSession> connectAsync(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake. Parameters url:String the url to connect to handshakeHeaders:WebSocketHttpHeaders the headers for the WebSocket handshake handler:StompSessionHandler the session handler uriVariables:Object[] the URI variables to expand into the URL Returns:CompletableFuture<StompSession> a `ListenableFuture` for access to the session when ready for use Since 6.0

public CompletableFuture<StompSession> connectAsync(String url, WebSocketHttpHeaders handshakeHeaders, StompSessionHandler handler, Object... uriVariables)

An overloaded version of connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake.

Parameters

url:String: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: the headers for the WebSocket handshake
handler:StompSessionHandler: the session handler
uriVariables:Object[]: the URI variables to expand into the URL

Returns:CompletableFuture<StompSession>

a ListenableFuture for access to the session when ready for use

Since

6.0

connectAsync back to summary

connectAsync	back to summary
public CompletableFuture<StompSession> connectAsync(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version of `connect(String, StompSessionHandler, Object...)` that also accepts `WebSocketHttpHeaders` to use for the WebSocket handshake and `StompHeaders` for the STOMP CONNECT frame. Parameters url:String the url to connect to handshakeHeaders:WebSocketHttpHeaders headers for the WebSocket handshake connectHeaders:StompHeaders headers for the STOMP CONNECT frame handler:StompSessionHandler the session handler uriVariables:Object[] the URI variables to expand into the URL Returns:CompletableFuture<StompSession> a CompletableFuture for access to the session when ready for use Since 6.0

public CompletableFuture<StompSession> connectAsync(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables)

An overloaded version of connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake and StompHeaders for the STOMP CONNECT frame.

Parameters

url:String: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: headers for the WebSocket handshake
connectHeaders:StompHeaders: headers for the STOMP CONNECT frame
handler:StompSessionHandler: the session handler
uriVariables:Object[]: the URI variables to expand into the URL

Returns:CompletableFuture<StompSession>

a CompletableFuture for access to the session when ready for use

Since

6.0

connectAsync back to summary

connectAsync	back to summary
public CompletableFuture<StompSession> connectAsync(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) An overloaded version of `connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)` that accepts a fully prepared `java.net.URI`. Parameters url:URI the url to connect to handshakeHeaders:WebSocketHttpHeaders the headers for the WebSocket handshake connectHeaders:StompHeaders headers for the STOMP CONNECT frame sessionHandler:StompSessionHandler the STOMP session handler Returns:CompletableFuture<StompSession> a CompletableFuture for access to the session when ready for use Since 6.0

public CompletableFuture<StompSession> connectAsync(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler)

An overloaded version of connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...) that accepts a fully prepared java.net.URI.

Parameters

url:URI: the url to connect to
handshakeHeaders:WebSocketHttpHeaders: the headers for the WebSocket handshake
connectHeaders:StompHeaders: headers for the STOMP CONNECT frame
sessionHandler:StompSessionHandler: the STOMP session handler

Returns:CompletableFuture<StompSession>

a CompletableFuture for access to the session when ready for use

Since

6.0

getInboundMessageSizeLimit	back to summary
public int getInboundMessageSizeLimit() Get the configured inbound message buffer size in bytes.

getPhase	back to summary
public int getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Return the configured phase. Annotations @Override

getPhase

back to summary

public int getPhase()

Overrides default org.springframework.context.SmartLifecycle.getPhase.

Return the configured phase.

Annotations

@Override

getWebSocketClient	back to summary
public WebSocketClient getWebSocketClient() Return the configured WebSocketClient.

isAutoStartup	back to summary
public boolean isAutoStartup() Overrides default org.springframework.context.SmartLifecycle.isAutoStartup. Return the value for the 'autoStartup' property. If "true", this client will automatically start and stop the contained WebSocketClient. Annotations @Override

isAutoStartup

back to summary

public boolean isAutoStartup()

Overrides default org.springframework.context.SmartLifecycle.isAutoStartup.

Return the value for the 'autoStartup' property. If "true", this client will automatically start and stop the contained WebSocketClient.

Annotations

@Override

isRunning back to summary

isRunning	back to summary
public boolean isRunning() Implements org.springframework.context.Lifecycle.isRunning. Doc from org.springframework.context.Lifecycle.isRunning. Check whether this component is currently running. In the case of a container, this will return `true` only if all components that apply are currently running. Returns:boolean whether the component is currently running Annotations @Override

public boolean isRunning()

Implements org.springframework.context.Lifecycle.isRunning.

Doc from org.springframework.context.Lifecycle.isRunning.

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

Returns:boolean

whether the component is currently running

Annotations

@Override

processConnectHeaders	back to summary
protected StompHeaders processConnectHeaders(StompHeaders connectHeaders) Overrides org.springframework.messaging.simp.stomp.StompClientSupport.processConnectHeaders. Doc from org.springframework.messaging.simp.stomp.StompClientSupport.processConnectHeaders. Further initialize the StompHeaders, for example setting the heart-beat header if necessary. Parameters connectHeaders:StompHeaders the headers to modify Returns:StompHeaders the modified headers Annotations @Override

processConnectHeaders

back to summary

protected StompHeaders processConnectHeaders(StompHeaders connectHeaders)

Overrides org.springframework.messaging.simp.stomp.StompClientSupport.processConnectHeaders.

Doc from org.springframework.messaging.simp.stomp.StompClientSupport.processConnectHeaders.

Further initialize the StompHeaders, for example setting the heart-beat header if necessary.

Parameters

connectHeaders:StompHeaders: the headers to modify

Returns:StompHeaders

the modified headers

Annotations

@Override

setAutoStartup	back to summary
public void setAutoStartup(boolean autoStartup) Set whether to auto-start the contained WebSocketClient when the Spring context has been refreshed. Default is "true".

setAutoStartup

back to summary

public void setAutoStartup(boolean autoStartup)

Set whether to auto-start the contained WebSocketClient when the Spring context has been refreshed.

Default is "true".

setInboundMessageSizeLimit	back to summary
public void setInboundMessageSizeLimit(int inboundMessageSizeLimit) Configure the maximum size allowed for inbound STOMP message. Since a STOMP message can be received in multiple WebSocket messages, buffering may be required and this property determines the maximum buffer size per message. By default this is set to 64 * 1024 (64K).

setInboundMessageSizeLimit

back to summary

public void setInboundMessageSizeLimit(int inboundMessageSizeLimit)

Configure the maximum size allowed for inbound STOMP message. Since a STOMP message can be received in multiple WebSocket messages, buffering may be required and this property determines the maximum buffer size per message.

By default this is set to 64 * 1024 (64K).

setPhase	back to summary
public void setPhase(int phase) Specify the phase in which the WebSocket client should be started and subsequently closed. The startup order proceeds from lowest to highest, and the shutdown order is the reverse of that. By default this is Integer.MAX_VALUE meaning that the WebSocket client is started as late as possible and stopped as soon as possible.

setPhase

back to summary

public void setPhase(int phase)

Specify the phase in which the WebSocket client should be started and subsequently closed. The startup order proceeds from lowest to highest, and the shutdown order is the reverse of that.

By default this is Integer.MAX_VALUE meaning that the WebSocket client is started as late as possible and stopped as soon as possible.

setTaskScheduler back to summary

setTaskScheduler	back to summary
public void setTaskScheduler(TaskScheduler taskScheduler) Overrides org.springframework.messaging.simp.stomp.StompClientSupport.setTaskScheduler. Doc from org.springframework.messaging.simp.stomp.StompClientSupport.setTaskScheduler. Configure a scheduler to use for heartbeats and for receipt tracking. Note Some transports have built-in support to work with heartbeats and therefore do not require a TaskScheduler. Receipts however, if needed, do require a TaskScheduler to be configured. By default, this is not set. Also automatically sets the `defaultHeartbeat` property to "10000,10000" if it is currently set to "0,0". Annotations @Override

public void setTaskScheduler(TaskScheduler taskScheduler)

Overrides org.springframework.messaging.simp.stomp.StompClientSupport.setTaskScheduler.

Doc from org.springframework.messaging.simp.stomp.StompClientSupport.setTaskScheduler.

Configure a scheduler to use for heartbeats and for receipt tracking.

Note

Some transports have built-in support to work with heartbeats and therefore do not require a TaskScheduler. Receipts however, if needed, do require a TaskScheduler to be configured.

By default, this is not set.

Also automatically sets the defaultHeartbeat property to "10000,10000" if it is currently set to "0,0".

Annotations

@Override

start	back to summary
public void start() Implements org.springframework.context.Lifecycle.start. Doc from org.springframework.context.Lifecycle.start. Start this component. Should not throw an exception if the component is already running. In the case of a container, this will propagate the start signal to all components that apply. Annotations @Override

start

back to summary

public void start()

Implements org.springframework.context.Lifecycle.start.

Doc from org.springframework.context.Lifecycle.start.

Start this component.

Should not throw an exception if the component is already running.

In the case of a container, this will propagate the start signal to all components that apply.

Annotations

@Override

stop back to summary

stop	back to summary
public void stop() Implements org.springframework.context.Lifecycle.stop. Doc from org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing `SmartLifecycle` and its `stop(Runnable)` variant when asynchronous stop behavior is necessary. Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, `Lifecycle` beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront. Should not throw an exception if the component is not running (not started yet). In the case of a container, this will propagate the stop signal to all components that apply. Annotations @Override

public void stop()

Implements org.springframework.context.Lifecycle.stop.

Doc from org.springframework.context.Lifecycle.stop.

Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

Should not throw an exception if the component is not running (not started yet).

In the case of a container, this will propagate the stop signal to all components that apply.

Annotations

@Override

Modifier and Type	Field and Description
private final BufferingStompDecoder	bufferingDecoder
private static final StompDecoder	DECODER
private static final StompEncoder	ENCODER

Access	Constructor and Description
public	StompWebSocketMessageCodec(int messageSizeLimit)

Modifier and Type	Method and Description
public List<Message<byte[]>>	decode(WebSocketMessage<?> webSocketMessage)
public WebSocketMessage<?>	encode(Message<byte[]> message, Class<? extends WebSocketSession> sessionType)

bufferingDecoder	back to summary
private final BufferingStompDecoder bufferingDecoder

DECODER	back to summary
private static final StompDecoder DECODER

ENCODER	back to summary
private static final StompEncoder ENCODER

StompWebSocketMessageCodec	back to summary
public StompWebSocketMessageCodec(int messageSizeLimit)

decode	back to summary
public List<Message<byte[]>> decode(WebSocketMessage<?> webSocketMessage)

encode	back to summary
public WebSocketMessage<?> encode(Message<byte[]> message, Class<? extends WebSocketSession> sessionType)

org.springframework.web.socket.messaging back to summary

private Class WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

Class Inheritance

extends Object
implements BiConsumer<WebSocketSession, Throwable>, WebSocketHandler, TcpConnection<byte[]>

java.lang.Object
org.springframework.web.socket.messaging.WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

All Implemented Interfaces

org.springframework.messaging.tcp.TcpConnection, java.io.Closeable, java.lang.AutoCloseable, org.springframework.web.socket.WebSocketHandler, java.util.function.BiConsumer

Adapt WebSocket to the TcpConnectionHandler and TcpConnection contracts.

Field Summary

Modifier and Type	Field and Description
private final WebSocketStompClient.StompWebSocketMessageCodec	codec
private volatile long	lastReadTime
private volatile long	lastWriteTime
private ScheduledFuture<?>	readInactivityFuture
private volatile WebSocketSession	session
private final TcpConnectionHandler<byte[]>	stompSession
private ScheduledFuture<?>	writeInactivityFuture

Constructor Summary

Access	Constructor and Description
public	WebSocketTcpConnectionHandlerAdapter(TcpConnectionHandler<byte[]> stompSession)

Method Summary

Modifier and Type	Method and Description
public void	accept(WebSocketSession the first input argument webSocketSession, Throwable the second input argument throwable) Implements java.util.function.BiConsumer.accept. Performs this operation on the given arguments.
public void	afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) Implements org.springframework.web.socket.WebSocketHandler.afterConnectionClosed. Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.
public void	afterConnectionEstablished(WebSocketSession session) Implements org.springframework.web.socket.WebSocketHandler.afterConnectionEstablished. Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.
private static void	cancelFuture(ScheduledFuture<?> future)
private void	cancelInactivityTasks()
public void	close() Implements org.springframework.messaging.tcp.TcpConnection.close. Close the connection.
public void	handleMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage) Implements org.springframework.web.socket.WebSocketHandler.handleMessage. Invoked when a new WebSocket message arrives.
public void	handleTransportError(WebSocketSession session, Throwable ex) Implements org.springframework.web.socket.WebSocketHandler.handleTransportError. Handle an error from the underlying WebSocket message transport.
public void	onReadInactivity(final Runnable the task to invoke runnable, final long the amount of inactive time in milliseconds duration) Implements org.springframework.messaging.tcp.TcpConnection.onReadInactivity. Register a task to invoke after a period of read inactivity.
public void	onWriteInactivity(final Runnable the task to invoke runnable, final long the amount of inactive time in milliseconds duration) Implements org.springframework.messaging.tcp.TcpConnection.onWriteInactivity. Register a task to invoke after a period of write inactivity.
public CompletableFuture<Void>	sendAsync(Message<byte[]> the message message) Implements org.springframework.messaging.tcp.TcpConnection.sendAsync. Send the given message.
public boolean	supportsPartialMessages() Implements org.springframework.web.socket.WebSocketHandler.supportsPartialMessages. Whether the WebSocketHandler handles partial messages.
private void	updateLastWriteTime()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

codec	back to summary
private final WebSocketStompClient.StompWebSocketMessageCodec codec

lastReadTime	back to summary
private volatile long lastReadTime

lastWriteTime	back to summary
private volatile long lastWriteTime

readInactivityFuture	back to summary
private ScheduledFuture<?> readInactivityFuture Annotations @Nullable

session	back to summary
private volatile WebSocketSession session Annotations @Nullable

stompSession	back to summary
private final TcpConnectionHandler<byte[]> stompSession

writeInactivityFuture	back to summary
private ScheduledFuture<?> writeInactivityFuture Annotations @Nullable

Constructor Detail

WebSocketTcpConnectionHandlerAdapter	back to summary
public WebSocketTcpConnectionHandlerAdapter(TcpConnectionHandler<byte[]> stompSession)

Method Detail

back to summary

public void accept(WebSocketSession webSocketSession, Throwable throwable)

Implements java.util.function.BiConsumer.accept.

Doc from java.util.function.BiConsumer.accept.

Performs this operation on the given arguments.

Parameters

webSocketSession:WebSocketSession: the first input argument
throwable:Throwable: the second input argument

Annotations

@Override

afterConnectionClosed

back to summary

public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)

Implements org.springframework.web.socket.WebSocketHandler.afterConnectionClosed.

Doc from org.springframework.web.socket.WebSocketHandler.afterConnectionClosed.

Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.

Annotations

@Override

afterConnectionEstablished

back to summary

public void afterConnectionEstablished(WebSocketSession session)

Implements org.springframework.web.socket.WebSocketHandler.afterConnectionEstablished.

Doc from org.springframework.web.socket.WebSocketHandler.afterConnectionEstablished.

Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.

Annotations

@Override

cancelFuture	back to summary
private static void cancelFuture(ScheduledFuture<?> future)

cancelInactivityTasks	back to summary
private void cancelInactivityTasks()

back to summary

public void close()

Implements org.springframework.messaging.tcp.TcpConnection.close.

Doc from org.springframework.messaging.tcp.TcpConnection.close.

Close the connection.

Annotations

@Override

handleMessage

back to summary

public void handleMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage)

Implements org.springframework.web.socket.WebSocketHandler.handleMessage.

Doc from org.springframework.web.socket.WebSocketHandler.handleMessage.

Invoked when a new WebSocket message arrives.

Annotations

@Override

handleTransportError

back to summary

public void handleTransportError(WebSocketSession session, Throwable ex)

Implements org.springframework.web.socket.WebSocketHandler.handleTransportError.

Doc from org.springframework.web.socket.WebSocketHandler.handleTransportError.

Handle an error from the underlying WebSocket message transport.

Annotations

@Override

onReadInactivity

back to summary

public void onReadInactivity(final Runnable runnable, final long duration)

Implements org.springframework.messaging.tcp.TcpConnection.onReadInactivity.

Doc from org.springframework.messaging.tcp.TcpConnection.onReadInactivity.

Parameters

runnable:Runnable: the task to invoke
duration:long: the amount of inactive time in milliseconds

Annotations

@Override

onWriteInactivity

back to summary

public void onWriteInactivity(final Runnable runnable, final long duration)

Implements org.springframework.messaging.tcp.TcpConnection.onWriteInactivity.

Doc from org.springframework.messaging.tcp.TcpConnection.onWriteInactivity.

Parameters

runnable:Runnable: the task to invoke
duration:long: the amount of inactive time in milliseconds

Annotations

@Override

sendAsync

back to summary

public CompletableFuture<Void> sendAsync(Message<byte[]> message)

Implements org.springframework.messaging.tcp.TcpConnection.sendAsync.

Doc from org.springframework.messaging.tcp.TcpConnection.sendAsync.

Send the given message.

Parameters

message:Message<byte[]>: the message

Returns:CompletableFuture<Void>

a CompletableFuture that can be used to determine when and if the message was successfully sent

Annotations

@Override

supportsPartialMessages back to summary

public boolean supportsPartialMessages()

Implements org.springframework.web.socket.WebSocketHandler.supportsPartialMessages.

Doc from org.springframework.web.socket.WebSocketHandler.supportsPartialMessages.

Whether the WebSocketHandler handles partial messages. If this flag is set to true and the underlying WebSocket server supports partial messages, then a large WebSocket message, or one of an unknown size may be split and maybe received over multiple calls to handleMessage(WebSocketSession, WebSocketMessage). The flag org.springframework.web.socket.WebSocketMessage#isLast() indicates if the message is partial and whether it is the last part.

Annotations

@Override

updateLastWriteTime	back to summary
private void updateLastWriteTime()

public Class WebSocketStompClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WebSocketStompClient.StompWebSocketMessageCodec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail