Package org.springframework.messaging.simp.stomp

Class ReactorNettyTcpStompClient

java.lang.Object

org.springframework.messaging.simp.stomp.StompClientSupport

org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient

public class ReactorNettyTcpStompClient
extends StompClientSupport

A STOMP over TCP client, configurable with either ReactorNettyTcpClient or ReactorNetty2TcpClient.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
ReactorNettyTcpStompClient()	Create an instance with host "127.0.0.1" and port 61613.
ReactorNettyTcpStompClient(String host, int port)	Create an instance with the given host and port.
ReactorNettyTcpStompClient(TcpOperations<byte[]> tcpClient)	Create an instance with a pre-configured TCP client.

Method Summary

Modifier and Type	Method	Description
ListenableFuture<StompSession>	connect(StompHeaders connectHeaders, StompSessionHandler handler)	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.0, in favor of connectAsync(StompHeaders, StompSessionHandler)
ListenableFuture<StompSession>	connect(StompSessionHandler handler)	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.0, in favor of connectAsync(StompSessionHandler)
CompletableFuture<StompSession>	connectAsync(StompHeaders connectHeaders, StompSessionHandler handler)	An overloaded version of connectAsync(StompSessionHandler) that accepts headers to use for the STOMP CONNECT frame.
CompletableFuture<StompSession>	connectAsync(StompSessionHandler handler)	Connect and notify the given StompSessionHandler when connected on the STOMP level.
void	shutdown()	Shut down the client and release resources.
String	toString()

Methods inherited from class org.springframework.messaging.simp.stomp.StompClientSupport

createSession, getDefaultHeartbeat, getMessageConverter, getReceiptTimeLimit, getTaskScheduler, isDefaultHeartbeatEnabled, processConnectHeaders, setDefaultHeartbeat, setMessageConverter, setReceiptTimeLimit, setTaskScheduler

Methods inherited from class java.lang.Object

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

Constructor Details

ReactorNettyTcpStompClient

public ReactorNettyTcpStompClient()

Create an instance with host "127.0.0.1" and port 61613.

ReactorNettyTcpStompClient

public ReactorNettyTcpStompClient(String host,
 int port)

Create an instance with the given host and port.

Parameters:

host - the host

port - the port

ReactorNettyTcpStompClient

public ReactorNettyTcpStompClient(TcpOperations<byte[]> tcpClient)

Create an instance with a pre-configured TCP client.

Parameters:

tcpClient - the client to use

Method Details

connect

@Deprecated(since="6.0",
            forRemoval=true)
public ListenableFuture<StompSession> connect(StompSessionHandler handler)

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.0, in favor of connectAsync(StompSessionHandler)

Connect and notify the given StompSessionHandler when connected on the STOMP level.

Parameters:

handler - the handler for the STOMP session

Returns:

a ListenableFuture for access to the session when ready for use

connectAsync

public CompletableFuture<StompSession> connectAsync(StompSessionHandler handler)

Connect and notify the given StompSessionHandler when connected on the STOMP level.

Parameters:

handler - the handler for the STOMP session

Returns:

a CompletableFuture for access to the session when ready for use

Since:

6.0

connect

@Deprecated(since="6.0",
            forRemoval=true)
public ListenableFuture<StompSession> connect(@Nullable
 StompHeaders connectHeaders,
 StompSessionHandler handler)

Deprecated, for removal: This API element is subject to removal in a future version.

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

An overloaded version of connect(StompSessionHandler) that accepts headers to use for the STOMP CONNECT frame.

Parameters:

connectHeaders - headers to add to the CONNECT frame

handler - the handler for the STOMP session

Returns:

a ListenableFuture for access to the session when ready for use

connectAsync

public CompletableFuture<StompSession> connectAsync(@Nullable
 StompHeaders connectHeaders,
 StompSessionHandler handler)

An overloaded version of connectAsync(StompSessionHandler) that accepts headers to use for the STOMP CONNECT frame.

Parameters:

connectHeaders - headers to add to the CONNECT frame

handler - the handler for the STOMP session

Returns:

a CompletableFuture for access to the session when ready for use

shutdown

public void shutdown()

Shut down the client and release resources.

toString

public String toString()

Overrides:

toString in class Object