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) Alternate constructor with a ClientOptions.Builder consumer providing additional control beyond a host and a port.
ReactorNettyTcpClient(String host, int port, ReactorNettyCodec<P> codec) Basic constructor with a host and a port.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactorNettyTcpClient

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

Basic constructor with a host and a port.

ReactorNettyTcpClient

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

Alternate constructor with a ClientOptions.Builder consumer providing additional control beyond a host and a port.

Method Detail

connect

public org.springframework.util.concurrent.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 org.springframework.util.concurrent.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 org.springframework.util.concurrent.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