org.springframework.messaging.tcp.reactor

Class ReactorTcpClient<P>

java.lang.Object

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

All Implemented Interfaces:

TcpOperations<P>

public class ReactorTcpClient<P>
extends java.lang.Object
implements TcpOperations<P>

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

Since:

4.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ReactorTcpClient.SynchronousDispatcherConfigReader A ConfigurationReader that enforces the use of a SynchronousDispatcher.

Field Summary

Fields

Modifier and Type	Field and Description
private Environment	environment
static java.lang.Class<NettyTcpClient>	REACTOR_TCP_CLIENT_TYPE
private <any>	tcpClient

Constructor Summary

Constructors

Constructor and Description
ReactorTcpClient(<any> tcpClient) A constructor with a pre-configured reactor.tcp.TcpClient.
ReactorTcpClient(java.lang.String host, int port, <any> codec) A constructor that creates a reactor.tcp.netty.NettyTcpClient with a reactor.event.dispatch.SynchronousDispatcher as a result of which network I/O is handled in Netty threads.

Method Summary

Modifier and Type	Method and Description
private static void	checkReactorVersion()
private void	composeConnectionHandling(<any> composable, TcpConnectionHandler<P> connectionHandler)
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> connectionHandler) Open a new connection.
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy) Open a new connection and a strategy for reconnecting if the connection fails.
ListenableFuture<java.lang.Boolean>	shutdown() Shut down and close any open connections.
private <any>	toPromise(<any> stream)

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 java.lang.Class<NettyTcpClient> REACTOR_TCP_CLIENT_TYPE

tcpClient

private final <any> tcpClient

environment

private final Environment environment

Constructor Detail

ReactorTcpClient

public ReactorTcpClient(java.lang.String host,
                        int port,
                        <any> codec)

A constructor that creates a reactor.tcp.netty.NettyTcpClient with a reactor.event.dispatch.SynchronousDispatcher as a result of which network I/O is handled in Netty threads.

Also see the constructor accepting a pre-configured Reactor reactor.tcp.TcpClient.

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

ReactorTcpClient

public ReactorTcpClient(<any> tcpClient)

A constructor with a pre-configured reactor.tcp.TcpClient.

NOTE: if the client is configured with a thread-creating dispatcher, you are responsible for shutting down the reactor.core.Environment instance with which the client is configured.

Parameters:

tcpClient - the TcpClient to use

Method Detail

checkReactorVersion

private static void checkReactorVersion()

connect

public ListenableFuture<java.lang.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<java.lang.Void> connect(TcpConnectionHandler<P> connectionHandler,
                                                ReconnectStrategy reconnectStrategy)

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

reconnectStrategy - a strategy for reconnecting

Returns:

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

composeConnectionHandling

private void composeConnectionHandling(<any> composable,
                                       TcpConnectionHandler<P> connectionHandler)

toPromise

private <any> toPromise(<any> stream)

shutdown

public ListenableFuture<java.lang.Boolean> 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