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

Modifier and Type	Field and Description
private final ChannelGroup	channelGroup
private final ReactorNettyCodec<P>	codec
private Log	logger
private final LoopResources	loopResources
private final ConnectionProvider	poolResources
private static final int	PUBLISH_ON_BUFFER_SIZE
private final Scheduler	scheduler
private volatile boolean	stopping
private final TcpClient	tcpClient

Constructor Summary

Access	Constructor and Description
public	ReactorNettyTcpClient(String the host to connect to host, int the port to connect to port, ReactorNettyCodec<P> for encoding and decoding the input/output byte streams codec) Simple constructor with the host and port to use to connect to.
public	ReactorNettyTcpClient(Function<TcpClient, TcpClient> the configurer function clientConfigurer, ReactorNettyCodec<P> for encoding and decoding the input/output byte streams codec) A variant of `ReactorNettyTcpClient(String, int, ReactorNettyCodec)` that still manages the lifecycle of the `TcpClient` and underlying resources, but allows for direct configuration of other properties of the client through a `Function<TcpClient, TcpClient>`.
public	ReactorNettyTcpClient(TcpClient the TcpClient instance to use tcpClient, ReactorNettyCodec<P> for encoding and decoding the input/output byte streams codec) Constructor with an externally created `TcpClient` instance whose lifecycle is expected to be managed externally.

Method Summary

Modifier and Type	Method and Description
public CompletableFuture<Void>	connectAsync(TcpConnectionHandler<P> a handler to manage the connection handler) Implements org.springframework.messaging.tcp.TcpOperations.connectAsync. Open a new connection.
public CompletableFuture<Void>	connectAsync(TcpConnectionHandler<P> a handler to manage the connection handler, ReconnectStrategy a strategy for reconnecting strategy) Implements org.springframework.messaging.tcp.TcpOperations.connectAsync. Open a new connection and a strategy for reconnecting if the connection fails.
protected TcpClient	Returns: the same handler or an updated instance extendTcpClient(TcpClient the candidate TcpClient tcpClient, TcpConnectionHandler<P> the handler for the TCP connection handler) Provides an opportunity to initialize the `TcpClient` for the given `TcpConnectionHandler` which may implement sub-interfaces such as `org.springframework.messaging.simp.stomp.StompTcpConnectionHandler` that expose further information.
public Log	getLogger() Return the currently configured Logger.
private CompletableFuture<Void>	handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)
private Publisher<? extends Long>	reconnect(Integer attempt, ReconnectStrategy reconnectStrategy)
public void	setLogger(Log the logger to use logger) Set an alternative logger to use than the one based on the class name.
public CompletableFuture<Void>	shutdownAsync() Implements org.springframework.messaging.tcp.TcpOperations.shutdownAsync. Shut down and close any open connections.
private Mono<Void>	stopScheduler()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

channelGroup	back to summary
private final ChannelGroup channelGroup Annotations @Nullable

codec	back to summary
private final ReactorNettyCodec<P> codec

logger	back to summary
private Log logger

loopResources	back to summary
private final LoopResources loopResources Annotations @Nullable

poolResources	back to summary
private final ConnectionProvider poolResources Annotations @Nullable

PUBLISH_ON_BUFFER_SIZE	back to summary
private static final int PUBLISH_ON_BUFFER_SIZE

scheduler	back to summary
private final Scheduler scheduler

stopping	back to summary
private volatile boolean stopping

tcpClient	back to summary
private final TcpClient tcpClient

Constructor Detail

ReactorNettyTcpClient back to summary

ReactorNettyTcpClient	back to summary
public ReactorNettyTcpClient(String host, int port, ReactorNettyCodec<P> codec) Simple constructor with the host and port to use to connect to. This constructor manages the lifecycle of the `TcpClient` and underlying resources such as `ConnectionProvider`, `LoopResources`, and `ChannelGroup`. For full control over the initialization and lifecycle of the TcpClient, use `ReactorNettyTcpClient(TcpClient, ReactorNettyCodec)`. Parameters host:String the host to connect to port:int the port to connect to codec:ReactorNettyCodec<P> for encoding and decoding the input/output byte streams See Also `org.springframework.messaging.simp.stomp.StompReactorNettyCodec`

public ReactorNettyTcpClient(String host, int port, ReactorNettyCodec codec)

Simple constructor with the host and port to use to connect to.

This constructor manages the lifecycle of the TcpClient and underlying resources such as ConnectionProvider, LoopResources, and ChannelGroup.

For full control over the initialization and lifecycle of the TcpClient, use ReactorNettyTcpClient(TcpClient, ReactorNettyCodec).

Parameters

host:String: the host to connect to
port:int: the port to connect to
codec:ReactorNettyCodec: for encoding and decoding the input/output byte streams

ReactorNettyTcpClient back to summary

ReactorNettyTcpClient	back to summary
public ReactorNettyTcpClient(Function<TcpClient, TcpClient> clientConfigurer, ReactorNettyCodec<P> codec) A variant of `ReactorNettyTcpClient(String, int, ReactorNettyCodec)` that still manages the lifecycle of the `TcpClient` and underlying resources, but allows for direct configuration of other properties of the client through a `Function<TcpClient, TcpClient>`. Parameters clientConfigurer:Function<TcpClient, TcpClient> the configurer function codec:ReactorNettyCodec<P> for encoding and decoding the input/output byte streams Since 5.1.3 See Also `org.springframework.messaging.simp.stomp.StompReactorNettyCodec`

public ReactorNettyTcpClient(Function<TcpClient, TcpClient> clientConfigurer, ReactorNettyCodec codec)

A variant of ReactorNettyTcpClient(String, int, ReactorNettyCodec) that still manages the lifecycle of the TcpClient and underlying resources, but allows for direct configuration of other properties of the client through a Function<TcpClient, TcpClient>.

Parameters

clientConfigurer:Function<TcpClient, TcpClient>: the configurer function
codec:ReactorNettyCodec: for encoding and decoding the input/output byte streams

Since

5.1.3

ReactorNettyTcpClient back to summary

ReactorNettyTcpClient	back to summary
public ReactorNettyTcpClient(TcpClient tcpClient, ReactorNettyCodec<P> codec) Constructor with an externally created `TcpClient` instance whose lifecycle is expected to be managed externally. Parameters tcpClient:TcpClient the TcpClient instance to use codec:ReactorNettyCodec<P> for encoding and decoding the input/output byte streams See Also `org.springframework.messaging.simp.stomp.StompReactorNettyCodec`

public ReactorNettyTcpClient(TcpClient tcpClient, ReactorNettyCodec codec)

Constructor with an externally created TcpClient instance whose lifecycle is expected to be managed externally.

Parameters

tcpClient:TcpClient: the TcpClient instance to use
codec:ReactorNettyCodec: for encoding and decoding the input/output byte streams

Method Detail

connectAsync	back to summary
public CompletableFuture<Void> connectAsync(TcpConnectionHandler<P> handler) Implements org.springframework.messaging.tcp.TcpOperations.connectAsync. Doc from org.springframework.messaging.tcp.TcpOperations.connectAsync. Open a new connection. Parameters handler:TcpConnectionHandler<P> a handler to manage the connection Returns:CompletableFuture<Void> a CompletableFuture that can be used to determine when and if the connection is successfully established Annotations @Override

connectAsync

back to summary

public CompletableFuture<Void> connectAsync(TcpConnectionHandler handler)

Implements org.springframework.messaging.tcp.TcpOperations.connectAsync.

Doc from org.springframework.messaging.tcp.TcpOperations.connectAsync.

Open a new connection.

Parameters

handler:TcpConnectionHandler: a handler to manage the connection

Returns:CompletableFuture<Void>

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

Annotations

@Override

connectAsync	back to summary
public CompletableFuture<Void> connectAsync(TcpConnectionHandler<P> handler, ReconnectStrategy strategy) Implements org.springframework.messaging.tcp.TcpOperations.connectAsync. Doc from org.springframework.messaging.tcp.TcpOperations.connectAsync. Open a new connection and a strategy for reconnecting if the connection fails. Parameters handler:TcpConnectionHandler<P> a handler to manage the connection strategy:ReconnectStrategy a strategy for reconnecting Returns:CompletableFuture<Void> a CompletableFuture that can be used to determine when and if the initial connection is successfully established Annotations @Override

connectAsync

back to summary

public CompletableFuture<Void> connectAsync(TcpConnectionHandler handler, ReconnectStrategy strategy)

Implements org.springframework.messaging.tcp.TcpOperations.connectAsync.

Doc from org.springframework.messaging.tcp.TcpOperations.connectAsync.

Open a new connection and a strategy for reconnecting if the connection fails.

Parameters

handler:TcpConnectionHandler: a handler to manage the connection
strategy:ReconnectStrategy: a strategy for reconnecting

Returns:CompletableFuture<Void>

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

Annotations

@Override

extendTcpClient back to summary

extendTcpClient	back to summary
protected TcpClient extendTcpClient(TcpClient tcpClient, TcpConnectionHandler<P> handler) Provides an opportunity to initialize the `TcpClient` for the given `TcpConnectionHandler` which may implement sub-interfaces such as `org.springframework.messaging.simp.stomp.StompTcpConnectionHandler` that expose further information. Parameters tcpClient:TcpClient the candidate TcpClient handler:TcpConnectionHandler<P> the handler for the TCP connection Returns:TcpClient the same handler or an updated instance

protected TcpClient extendTcpClient(TcpClient tcpClient, TcpConnectionHandler handler)

Provides an opportunity to initialize the TcpClient for the given TcpConnectionHandler which may implement sub-interfaces such as org.springframework.messaging.simp.stomp.StompTcpConnectionHandler that expose further information.

Parameters

tcpClient:TcpClient: the candidate TcpClient
handler:TcpConnectionHandler: the handler for the TCP connection

Returns:TcpClient

the same handler or an updated instance

getLogger	back to summary
public Log getLogger() Return the currently configured Logger. Since 5.1

getLogger

back to summary

public Log getLogger()

Return the currently configured Logger.

Since: 5.1

handleShuttingDownConnectFailure	back to summary
private CompletableFuture<Void> handleShuttingDownConnectFailure(TcpConnectionHandler<P> handler)

reconnect	back to summary
private Publisher<? extends Long> reconnect(Integer attempt, ReconnectStrategy reconnectStrategy)

setLogger	back to summary
public void setLogger(Log logger) Set an alternative logger to use than the one based on the class name. Parameters logger:Log the logger to use Since 5.1

setLogger

back to summary

public void setLogger(Log logger)

Set an alternative logger to use than the one based on the class name.

Parameters

logger:Log: the logger to use

Since

5.1

shutdownAsync	back to summary
public CompletableFuture<Void> shutdownAsync() Implements org.springframework.messaging.tcp.TcpOperations.shutdownAsync. Doc from org.springframework.messaging.tcp.TcpOperations.shutdownAsync. Shut down and close any open connections. Returns:CompletableFuture<Void> a CompletableFuture that can be used to determine when and if the connection is successfully closed Annotations @Override

shutdownAsync

back to summary

public CompletableFuture<Void> shutdownAsync()

Implements org.springframework.messaging.tcp.TcpOperations.shutdownAsync.

Doc from org.springframework.messaging.tcp.TcpOperations.shutdownAsync.

Shut down and close any open connections.

Returns:CompletableFuture<Void>

a CompletableFuture that can be used to determine when and if the connection is successfully closed

Annotations

@Override

stopScheduler	back to summary
private Mono<Void> stopScheduler()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.springframework.messaging.tcp.reactor back to summary

private Class ReactorNettyTcpClient.ReactorNettyHandler

Class Inheritance

extends Object
implements BiFunction<NettyInbound, NettyOutbound, Publisher<Void>>

java.lang.Object
org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient.ReactorNettyHandler

All Implemented Interfaces

java.util.function.BiFunction

Field Summary

Modifier and Type	Field and Description
private final TcpConnectionHandler<P>	connectionHandler

Constructor Summary

Access	Constructor and Description
pack-priv	ReactorNettyHandler(TcpConnectionHandler<P> handler)

Method Summary

Modifier and Type	Method and Description
public Publisher<Void>	apply(NettyInbound the first function argument inbound, NettyOutbound the second function argument outbound) Implements java.util.function.BiFunction.apply. Applies this function to the given arguments.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connectionHandler	back to summary
private final TcpConnectionHandler<P> connectionHandler

Constructor Detail

ReactorNettyHandler	back to summary
pack-priv ReactorNettyHandler(TcpConnectionHandler<P> handler)

Method Detail

apply	back to summary
public Publisher<Void> apply(NettyInbound inbound, NettyOutbound outbound) Implements java.util.function.BiFunction.apply. Doc from java.util.function.BiFunction.apply. Applies this function to the given arguments. Parameters inbound:NettyInbound the first function argument outbound:NettyOutbound the second function argument Returns:Publisher<Void> the function result Annotations @Override @SuppressWarnings:unchecked

apply

back to summary

public Publisher<Void> apply(NettyInbound inbound, NettyOutbound outbound)

Implements java.util.function.BiFunction.apply.

Doc from java.util.function.BiFunction.apply.

Applies this function to the given arguments.

Parameters

inbound:NettyInbound: the first function argument
outbound:NettyOutbound: the second function argument

Returns:Publisher<Void>

the function result

Annotations

@Override
@SuppressWarnings:unchecked

org.springframework.messaging.tcp.reactor back to summary

private Class ReactorNettyTcpClient.StompMessageDecoder

Class Inheritance

extends ByteToMessageDecoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.ByteToMessageDecoder
org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient.StompMessageDecoder

Field Summary

Modifier and Type	Field and Description
private final ReactorNettyCodec<P>	codec

Inherited from io.netty.handler.codec.ByteToMessageDecoder:: COMPOSITE_CUMULATOR MERGE_CUMULATOR

Constructor Summary

Access	Constructor and Description
pack-priv	StompMessageDecoder(ReactorNettyCodec<P> codec)

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, ByteBuf the `ByteBuf` from which to read data in, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other.

Inherited from io.netty.handler.codec.ByteToMessageDecoder:: actualReadableBytes callDecode channelInactive channelRead channelReadComplete decodeLast discardSomeReadBytes handlerRemoved handlerRemoved0 internalBuffer isSingleDecode setCumulator setDiscardAfterReads setSingleDecode userEventTriggered

Field Detail

codec	back to summary
private final ReactorNettyCodec<P> codec

Constructor Detail

StompMessageDecoder	back to summary
pack-priv StompMessageDecoder(ReactorNettyCodec<P> codec)

Method Detail

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Doc from io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other. This method will be called till either the input `ByteBuf` has nothing to read when return from this method or till nothing was read from the input `ByteBuf`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to in:ByteBuf the `ByteBuf` from which to read data out:List<Object> the `List` to which decoded messages should be added Annotations @Override

protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)

Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode.

Doc from io.netty.handler.codec.ByteToMessageDecoder.decode.

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
in:ByteBuf: the ByteBuf from which to read data
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

public Class ReactorNettyTcpClient<P>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReactorNettyTcpClient.ReactorNettyHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReactorNettyTcpClient.StompMessageDecoder<P>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail