Class Reactor2TcpStompClient
- java.lang.Object
- org.springframework.messaging.simp.stomp.StompClientSupport
- org.springframework.messaging.simp.stomp.Reactor2TcpStompClient
- All Implemented Interfaces:
Lifecycle
public class Reactor2TcpStompClient extends StompClientSupport implements Lifecycle
A STOMP over TCP client that usesReactor2TcpClient
.- Since:
- 4.2
- Author:
- Rossen Stoyanchev
Field Summary
Fields inherited from class org.springframework.messaging.simp.stomp.StompClientSupport
logger
Constructor Summary
Constructors Constructor Description Reactor2TcpStompClient()
Create an instance with host "127.0.0.1" and port 61613.Reactor2TcpStompClient(String host, int port)
Create an instance with the given host and port to connect toReactor2TcpStompClient(TcpOperations<byte[]> tcpClient)
Create an instance with a pre-configured TCP client.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListenableFuture<StompSession>
connect(StompHeaders connectHeaders, StompSessionHandler handler)
An overloaded version ofconnect(StompSessionHandler)
that accepts headers to use for the STOMP CONNECT frame.ListenableFuture<StompSession>
connect(StompSessionHandler handler)
Connect and notify the givenStompSessionHandler
when connected on the STOMP level.boolean
isRunning()
Check whether this component is currently running.void
shutdown()
Shut down the client and release resources.void
start()
Start this component.void
stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.Methods inherited from class org.springframework.messaging.simp.stomp.StompClientSupport
createSession, getDefaultHeartbeat, getMessageConverter, getReceiptTimeLimit, getTaskScheduler, isDefaultHeartbeatEnabled, processConnectHeaders, setDefaultHeartbeat, setMessageConverter, setReceiptTimeLimit, setTaskScheduler
Constructor Detail
Reactor2TcpStompClient
public Reactor2TcpStompClient()
Create an instance with host "127.0.0.1" and port 61613.
Reactor2TcpStompClient
public Reactor2TcpStompClient(String host, int port)
Create an instance with the given host and port to connect to
Reactor2TcpStompClient
public Reactor2TcpStompClient(TcpOperations<byte[]> tcpClient)
Create an instance with a pre-configured TCP client.- Parameters:
tcpClient
- the client to use
Method Detail
start
public void start()
Description copied from interface:Lifecycle
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.
- Specified by:
start
in interfaceLifecycle
- See Also:
SmartLifecycle.isAutoStartup()
stop
public void stop()
Description copied from interface:Lifecycle
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(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.
- Specified by:
stop
in interfaceLifecycle
- See Also:
SmartLifecycle.stop(Runnable)
,DisposableBean.destroy()
isRunning
public boolean isRunning()
Description copied from interface:Lifecycle
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.
connect
public ListenableFuture<StompSession> connect(StompSessionHandler handler)
Connect and notify the givenStompSessionHandler
when connected on the STOMP level.- Parameters:
handler
- the handler for the STOMP session- Returns:
- ListenableFuture for access to the session when ready for use
connect
public ListenableFuture<StompSession> connect(StompHeaders connectHeaders, StompSessionHandler handler)
An overloaded version ofconnect(StompSessionHandler)
that accepts headers to use for the STOMP CONNECT frame.- Parameters:
connectHeaders
- headers to add to the CONNECT framehandler
- the handler for the STOMP session- Returns:
- ListenableFuture for access to the session when ready for use
shutdown
public void shutdown()
Shut down the client and release resources.