org.springframework.messaging.tcp.reactor

Class ReactorNettyTcpClient<P>

java.lang.Object

org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient<P>

All Implemented Interfaces:

TcpOperations<P>

public class ReactorNettyTcpClient<P>
extends Object
implements TcpOperations<P>

Reactor Netty based implementation of TcpOperations.

Since:

5.0

Author:

Rossen Stoyanchev, Stephane Maldini

Constructor Summary

Constructors

Constructor and Description
ReactorNettyTcpClient(Consumer<reactor.ipc.netty.options.ClientOptions.Builder<?>> optionsConsumer, ReactorNettyCodec<P> codec) Constructor with a ClientOptions.Builder that can be used to customize Reactor Netty client options.
ReactorNettyTcpClient(String host, int port, ReactorNettyCodec<P> codec) Simple constructor with a host and a port.
ReactorNettyTcpClient(reactor.ipc.netty.tcp.TcpClient tcpClient, ReactorNettyCodec<P> codec) Constructor with an externally created TcpClient instance whose lifecycle is expected to be managed externally.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<Void>	connect(TcpConnectionHandler<P> handler) Open a new connection.
ListenableFuture<Void>	connect(TcpConnectionHandler<P> handler, ReconnectStrategy strategy) Open a new connection and a strategy for reconnecting if the connection fails.
ListenableFuture<Void>	shutdown() Shut down and close any open connections.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactorNettyTcpClient

public ReactorNettyTcpClient(String host,
                             int port,
                             ReactorNettyCodec<P> codec)

Simple constructor with a host and a port.

Parameters:

host - the host to connect to

port - the port to connect to

codec - the code to use

See Also:

StompReactorNettyCodec

ReactorNettyTcpClient

public ReactorNettyTcpClient(Consumer<reactor.ipc.netty.options.ClientOptions.Builder<?>> optionsConsumer,
                             ReactorNettyCodec<P> codec)

Constructor with a ClientOptions.Builder that can be used to customize Reactor Netty client options.

Note: this constructor manages the lifecycle of the TcpClient and its underlying resources. Please do not customize any of the following options: ClientOptions.Builder#channelGroup(ChannelGroup) ChannelGroup, ClientOptions.Builder#loopResources(LoopResources) LoopResources, and ClientOptions.Builder#poolResources(PoolResources) PoolResources. You may set the ClientOptions.Builder#disablePool() disablePool option if you simply want to turn off pooling.

For full control over the initialization and lifecycle of the TcpClient, see ReactorNettyTcpClient(TcpClient, ReactorNettyCodec).

Parameters:

optionsConsumer - consumer to customize client options

codec - the code to use

See Also:

StompReactorNettyCodec

ReactorNettyTcpClient

public ReactorNettyTcpClient(reactor.ipc.netty.tcp.TcpClient tcpClient,
                             ReactorNettyCodec<P> codec)

Constructor with an externally created TcpClient instance whose lifecycle is expected to be managed externally.

Parameters:

tcpClient - the TcpClient instance to use

codec - the code to use

See Also:

StompReactorNettyCodec

Method Detail

connect

public ListenableFuture<Void> connect(TcpConnectionHandler<P> handler)

Description copied from interface: TcpOperations

Open a new connection.

Specified by:

connect in interface TcpOperations<P>

Parameters:

handler - a handler to manage the connection

Returns:

a ListenableFuture that can be used to determine when and if the connection is successfully established

connect

public ListenableFuture<Void> connect(TcpConnectionHandler<P> handler,
                                      ReconnectStrategy strategy)

Description copied from interface: TcpOperations

Open a new connection and a strategy for reconnecting if the connection fails.

Specified by:

connect in interface TcpOperations<P>

Parameters:

handler - a handler to manage the connection

strategy - a strategy for reconnecting

Returns:

a ListenableFuture that can be used to determine when and if the initial connection is successfully established

shutdown

public ListenableFuture<Void> shutdown()

Description copied from interface: TcpOperations

Shut down and close any open connections.

Specified by:

shutdown in interface TcpOperations<P>

Returns:

a ListenableFuture that can be used to determine when and if the connection is successfully closed

toString

public String toString()

Overrides:

toString in class Object