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 java.lang.Object
implements TcpOperations<P>

Reactor Netty based implementation of TcpOperations.

Since:

5.0

Author:

Rossen Stoyanchev, Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ReactorNettyTcpClient.ReactorNettyHandler
private static class	ReactorNettyTcpClient.StompMessageDecoder<P>

Field Summary

Fields

Modifier and Type	Field and Description
private ChannelGroup	channelGroup
private ReactorNettyCodec<P>	codec
private LoopResources	loopResources
private PoolResources	poolResources
private Scheduler	scheduler
private boolean	stopping
private TcpClient	tcpClient

Constructor Summary

Constructors

Constructor and Description
ReactorNettyTcpClient(java.util.function.Consumer<ClientOptions> optionsConsumer, ReactorNettyCodec<P> codec) Alternate constructor with a ClientOptions consumer providing additional control beyond a host and a port.
ReactorNettyTcpClient(java.lang.String host, int port, ReactorNettyCodec<P> codec) Basic constructor with a host and a port.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> handler) Open a new connection.
ListenableFuture<java.lang.Void>	connect(TcpConnectionHandler<P> handler, ReconnectStrategy strategy) Open a new connection and a strategy for reconnecting if the connection fails.
private ListenableFuture<java.lang.Void>	handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)
private <T> java.util.function.Function<<any>,<any>>	reconnectFunction(ReconnectStrategy reconnectStrategy)
ListenableFuture<java.lang.Void>	shutdown() Shut down and close any open connections.
private void	shutdownGlobalResources()
private <T> java.util.function.Consumer<T>	updateConnectMono(<any> connectMono)

Methods inherited from class java.lang.Object

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

Field Detail

tcpClient

private final TcpClient tcpClient

codec

private final ReactorNettyCodec<P> codec

channelGroup

private final ChannelGroup channelGroup

loopResources

private final LoopResources loopResources

poolResources

private final PoolResources poolResources

scheduler

private final Scheduler scheduler

stopping

private volatile boolean stopping

Constructor Detail

ReactorNettyTcpClient

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

Basic constructor with a host and a port.

ReactorNettyTcpClient

public ReactorNettyTcpClient(java.util.function.Consumer<ClientOptions> optionsConsumer,
                             ReactorNettyCodec<P> codec)

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

Method Detail

connect

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

handleShuttingDownConnectFailure

private ListenableFuture<java.lang.Void> handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)

updateConnectMono

private <T> java.util.function.Consumer<T> updateConnectMono(<any> connectMono)

reconnectFunction

private <T> java.util.function.Function<<any>,<any>> reconnectFunction(ReconnectStrategy reconnectStrategy)

shutdown

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

shutdownGlobalResources

private void shutdownGlobalResources()