org.springframework.messaging.tcp.reactor

Class Reactor11TcpClient<P>

java.lang.Object

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

All Implemented Interfaces:

TcpOperations<P>

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

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

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Reactor11TcpClient(String host, int port, reactor.io.encoding.Codec<reactor.io.Buffer,Message<P>,Message<P>> codec) A constructor that creates a NettyTcpClient with a reactor.event.dispatch.SynchronousDispatcher as a result of which network I/O is handled in Netty threads.
Reactor11TcpClient(reactor.net.tcp.TcpClient<Message<P>,Message<P>> tcpClient) A constructor with a pre-configured TcpClient.

Method Summary

Modifier and Type	Method and Description
org.springframework.util.concurrent.ListenableFuture<Void>	connect(TcpConnectionHandler<P> connectionHandler) Open a new connection.
org.springframework.util.concurrent.ListenableFuture<Void>	connect(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy) Open a new connection and a strategy for reconnecting if the connection fails.
org.springframework.util.concurrent.ListenableFuture<Boolean>	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.net.netty.tcp.NettyTcpClient> REACTOR_TCP_CLIENT_TYPE

Constructor Detail

Reactor11TcpClient

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

A constructor that creates a 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 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

Reactor11TcpClient

public Reactor11TcpClient(reactor.net.tcp.TcpClient<Message<P>,Message<P>> tcpClient)

A constructor with a pre-configured TcpClient.

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

Parameters:

tcpClient - the TcpClient to use

Method Detail

connect

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

shutdown

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