org.springframework.messaging.tcp.reactor

Class Reactor2TcpClient<P>

java.lang.Object

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

All Implemented Interfaces:

TcpOperations<P>

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

An implementation of TcpOperations based on the TCP client support of the Reactor project.

This implementation wraps N (Reactor) clients for N connect(org.springframework.messaging.tcp.TcpConnectionHandler<P>) calls, i.e. a separate (Reactor) client instance for each connection.

Since:

4.2

Author:

Rossen Stoyanchev, Stephane Maldini

Field Summary

Fields

Modifier and Type	Field and Description
static Class<reactor.io.net.impl.netty.tcp.NettyTcpClient>	REACTOR_TCP_CLIENT_TYPE

Constructor Summary

Constructors

Constructor and Description
Reactor2TcpClient(reactor.io.net.NetStreams.TcpClientFactory<Message<P>,Message<P>> tcpClientSpecFactory) A constructor with a pre-configured Spec.TcpClientSpec Function factory.
Reactor2TcpClient(String host, int port, reactor.io.codec.Codec<reactor.io.buffer.Buffer,Message<P>,Message<P>> codec) A constructor that creates a TcpClientSpec factory with a default SynchronousDispatcher, i.e.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<Void>	connect(TcpConnectionHandler<P> connectionHandler) Open a new connection.
ListenableFuture<Void>	connect(TcpConnectionHandler<P> connectionHandler, 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.

Methods inherited from class java.lang.Object

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

Field Detail

REACTOR_TCP_CLIENT_TYPE

public static final Class<reactor.io.net.impl.netty.tcp.NettyTcpClient> REACTOR_TCP_CLIENT_TYPE

Constructor Detail

Reactor2TcpClient

public Reactor2TcpClient(String host,
                         int port,
                         reactor.io.codec.Codec<reactor.io.buffer.Buffer,Message<P>,Message<P>> codec)

A constructor that creates a TcpClientSpec factory with a default SynchronousDispatcher, i.e. relying on Netty threads. The number of Netty threads can be tweaked with the reactor.tcp.ioThreadCount System property. The network I/O threads will be shared amongst the active clients.

Also see the constructor accepting a ready Reactor Spec.TcpClientSpec Function factory.

Parameters:

host - the host to connect to

port - the port to connect to

codec - the codec to use for encoding and decoding the TCP stream

Reactor2TcpClient

public Reactor2TcpClient(reactor.io.net.NetStreams.TcpClientFactory<Message<P>,Message<P>> tcpClientSpecFactory)

A constructor with a pre-configured Spec.TcpClientSpec Function factory. This might be used to add SSL or specific network parameters to the generated client configuration.

NOTE: if the client is configured with a thread-creating dispatcher, you are responsible for cleaning them, e.g. using Resource.shutdown().

Parameters:

tcpClientSpecFactory - the TcpClientSpec Function to use for each client creation

Method Detail

connect

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

Description copied from interface: TcpOperations

Open a new connection.

Specified by:

connect in interface TcpOperations<P>

Parameters:

connectionHandler - 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> connectionHandler,
                                      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:

connectionHandler - 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