Package reactor.netty.tcp

Class TcpServer

java.lang.Object

reactor.netty.transport.Transport<T,CONF>

reactor.netty.transport.ServerTransport<TcpServer,TcpServerConfig>

reactor.netty.tcp.TcpServer

public abstract class TcpServer
extends ServerTransport<TcpServer,TcpServerConfig>

A TcpServer allows building in a safe immutable way a TCP server that is materialized and connecting when ServerTransport.bind() is ultimately called.

Example:

 
 TcpServer.create()
          .doOnBind(startMetrics)
          .doOnBound(startedMetrics)
          .doOnUnbound(stopMetrics)
          .host("127.0.0.1")
          .port(1234)
          .bind()
          .block()
 
 

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors

Constructor	Description
TcpServer()

Method Summary

Modifier and Type	Method	Description
TcpServer	bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)	Set a new local address to which this transport should bind on subscribe.
TcpServer	channelGroup(ChannelGroup channelGroup)	Provide a ChannelGroup to hold all active connected channels.
static TcpServer	create()	Prepare a TcpServer.
TcpServer	doOnBind(Consumer<? super TcpServerConfig> doOnBind)	Set or add a callback called when ServerTransport is about to start listening for incoming traffic.
TcpServer	doOnBound(Consumer<? super DisposableServer> doOnBound)	Set or add a callback called after DisposableServer has been started.
TcpServer	doOnConnection(Consumer<? super Connection> doOnConnection)	Set or add a callback called on new remote Connection.
TcpServer	doOnUnbound(Consumer<? super DisposableServer> doOnUnbound)	Set or add a callback called after DisposableServer has been shutdown.
TcpServer	handle(BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<Void>> handler)	Attaches an I/O handler to react on a connected client.
TcpServer	host(String host)	The host to which this server should bind.
TcpServer	metrics(boolean enable)	Whether to enable metrics to be collected and registered in Micrometer's globalRegistry.
TcpServer	metrics(boolean enable, Supplier<? extends ChannelMetricsRecorder> recorder)	Specifies whether the metrics are enabled on the Transport.
TcpServer	noSSL()	Removes any previously applied SSL configuration customization.
TcpServer	port(int port)	The port to which this server should bind.
TcpServer	runOn(EventLoopGroup eventLoopGroup)	Run IO loops on the given EventLoopGroup.
TcpServer	runOn(LoopResources channelResources)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
TcpServer	runOn(LoopResources loopResources, boolean preferNative)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
TcpServer	secure(Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)	Apply an SSL configuration customization via the passed builder.
TcpServer	secure(SslProvider sslProvider)	Applies an SSL configuration via the passed SslProvider.
Mono<Void>	warmup()	Based on the actual configuration, returns a Mono that triggers: an initialization of the event loop groups loads the necessary native libraries for the transport loads the necessary native libraries for the security if there is such By default, when method is not used, the bind operation absorbs the extra time needed to load resources.
TcpServer	wiretap(boolean enable)	Apply or remove a wire logger configuration using Transport category (logger), DEBUG logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
TcpServer	wiretap(String category)	Apply a wire logger configuration using the specified category (logger), DEBUG logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
TcpServer	wiretap(String category, LogLevel level)	Apply a wire logger configuration using the specified category (logger), logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.

Methods inherited from class reactor.netty.transport.ServerTransport

bind, bindNow, bindNow, bindUntilJavaShutdown, childAttr, childObserve, childOption

Methods inherited from class reactor.netty.transport.Transport

attr, configuration, doOnChannelInit, duplicate, observe, option, wiretap, wiretap

Methods inherited from class java.lang.Object

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

Constructor Details

TcpServer

public TcpServer()

Method Details

create

public static TcpServer create()

Prepare a TcpServer.

Returns:

a new TcpServer

bindAddress

public TcpServer bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)

Description copied from class: Transport

Set a new local address to which this transport should bind on subscribe.

Overrides:

bindAddress in class Transport<TcpServer,TcpServerConfig>

Parameters:

bindAddressSupplier - A supplier of the address to bind to.

Returns:

a new Transport

channelGroup

public TcpServer channelGroup(ChannelGroup channelGroup)

Description copied from class: Transport

Provide a ChannelGroup to hold all active connected channels.

Graceful Shutdown:

When a ChannelGroup is set, calls to DisposableChannel.disposeNow() and DisposableChannel.disposeNow(Duration) not only stop accepting new requests but also additionally wait for all active requests, in the ChannelGroup, to complete, within the given timeout.

Overrides:

channelGroup in class Transport<TcpServer,TcpServerConfig>

Parameters:

channelGroup - a ChannelGroup

Returns:

a new Transport reference

doOnBind

public TcpServer doOnBind(Consumer<? super TcpServerConfig> doOnBind)

Description copied from class: ServerTransport

Set or add a callback called when ServerTransport is about to start listening for incoming traffic.

Overrides:

doOnBind in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

doOnBind - a consumer observing connected events

Returns:

a new ServerTransport reference

doOnBound

public TcpServer doOnBound(Consumer<? super DisposableServer> doOnBound)

Description copied from class: ServerTransport

Set or add a callback called after DisposableServer has been started.

Overrides:

doOnBound in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

doOnBound - a consumer observing connected events

Returns:

a new ServerTransport reference

doOnConnection

public TcpServer doOnConnection(Consumer<? super Connection> doOnConnection)

Description copied from class: ServerTransport

Set or add a callback called on new remote Connection.

Overrides:

doOnConnection in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

doOnConnection - a consumer observing remote connections

Returns:

a new ServerTransport reference

doOnUnbound

public TcpServer doOnUnbound(Consumer<? super DisposableServer> doOnUnbound)

Description copied from class: ServerTransport

Set or add a callback called after DisposableServer has been shutdown.

Overrides:

doOnUnbound in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

doOnUnbound - a consumer observing unbound events

Returns:

a new ServerTransport reference

handle

public TcpServer handle(BiFunction<? super NettyInbound,? super NettyOutbound,? extends Publisher<Void>> handler)

Attaches an I/O handler to react on a connected client.

Parameters:

handler - an I/O handler that can dispose underlying connection when Publisher terminates.

Returns:

a new TcpServer

host

public TcpServer host(String host)

Description copied from class: ServerTransport

The host to which this server should bind.

Overrides:

host in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

host - the host to bind to.

Returns:

a new ServerTransport reference

metrics

public TcpServer metrics(boolean enable)

Description copied from class: Transport

Whether to enable metrics to be collected and registered in Micrometer's globalRegistry. Applications can separately register their own filters. For example, to put an upper bound on the number of tags produced:

 MeterFilter filter = ... ;
 Metrics.globalRegistry.config().meterFilter(MeterFilter.maximumAllowableTags(prefix, 100, filter));
 

By default this is not enabled.

Overrides:

metrics in class Transport<TcpServer,TcpServerConfig>

Parameters:

enable - true enables metrics collection; false disables it

Returns:

a new Transport reference

metrics

public TcpServer metrics(boolean enable,
 Supplier<? extends ChannelMetricsRecorder> recorder)

Description copied from class: Transport

Specifies whether the metrics are enabled on the Transport. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled (the instantiation is not lazy, but happens immediately, while configuring the Transport).

Overrides:

metrics in class Transport<TcpServer,TcpServerConfig>

Parameters:

enable - if true enables the metrics on the Transport.

recorder - a supplier for the ChannelMetricsRecorder

Returns:

a new Transport reference

noSSL

public TcpServer noSSL()

Removes any previously applied SSL configuration customization.

Returns:

a new TcpServer

port

public TcpServer port(int port)

The port to which this server should bind. If a port is not specified, the system picks up an ephemeral port.

Overrides:

port in class ServerTransport<TcpServer,TcpServerConfig>

Parameters:

port - The port to bind to.

Returns:

a new TcpServer

runOn

public TcpServer runOn(EventLoopGroup eventLoopGroup)

Description copied from class: Transport

Run IO loops on the given EventLoopGroup.

Overrides:

runOn in class Transport<TcpServer,TcpServerConfig>

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

a new Transport reference

runOn

public TcpServer runOn(LoopResources channelResources)

Description copied from class: Transport

Run IO loops on a supplied EventLoopGroup from the LoopResources container. Will prefer native (epoll/io_uring/kqueue) implementation if available unless the environment property reactor.netty.native is set to false.

Overrides:

runOn in class Transport<TcpServer,TcpServerConfig>

Parameters:

channelResources - a LoopResources accepting native runtime expectation and returning an eventLoopGroup

Returns:

a new Transport reference

runOn

public TcpServer runOn(LoopResources loopResources,
 boolean preferNative)

Description copied from class: Transport

Run IO loops on a supplied EventLoopGroup from the LoopResources container.

Overrides:

runOn in class Transport<TcpServer,TcpServerConfig>

Parameters:

loopResources - a new loop resources

preferNative - should prefer running on epoll, io_uring, kqueue or similar instead of java NIO

Returns:

a new Transport reference

secure

public TcpServer secure(Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)

Apply an SSL configuration customization via the passed builder. The builder will produce the SslContext to be passed to with a default value of:

• 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set.
• 3 seconds close_notify flush timeout
• 0 second close_notify read timeout

If self-signed certificate needs to be used, the sample below can be used (the functionality is provided by io.netty:netty-pkitesting). Note that self-signed certificate should not be used in production.

 
     X509Bundle cert =
             new CertificateBuilder().subject("CN=localhost").setIsCertificateAuthority(true).buildSelfSigned();
     TcpSslContextSpec tcpSslContextSpec =
             TcpSslContextSpec.forServer(cert.toTempCertChainPem(), cert.toTempPrivateKeyPem());
     secure(sslContextSpec -> sslContextSpec.sslContext(tcpSslContextSpec));
 
 

Parameters:

sslProviderBuilder - builder callback for further customization of SslContext.

Returns:

a new TcpServer

secure

public TcpServer secure(SslProvider sslProvider)

Applies an SSL configuration via the passed SslProvider. If self-signed certificate needs to be used, the sample below can be used (the functionality is provided by io.netty:netty-pkitesting). Note that self-signed certificate should not be used in production.

 
     X509Bundle cert =
             new CertificateBuilder().subject("CN=localhost").setIsCertificateAuthority(true).buildSelfSigned();
     TcpSslContextSpec tcpSslContextSpec =
             TcpSslContextSpec.forServer(cert.toTempCertChainPem(), cert.toTempPrivateKeyPem());
     secure(sslContextSpec -> sslContextSpec.sslContext(tcpSslContextSpec));
 
 

Parameters:

sslProvider - The provider to set when configuring SSL

Returns:

a new TcpServer

warmup

public Mono<Void> warmup()

Based on the actual configuration, returns a Mono that triggers:

• an initialization of the event loop groups
• loads the necessary native libraries for the transport
• loads the necessary native libraries for the security if there is such

By default, when method is not used, the bind operation absorbs the extra time needed to load resources.

Overrides:

warmup in class ServerTransport<TcpServer,TcpServerConfig>

Returns:

a Mono representing the completion of the warmup

Since:

1.0.3

wiretap

public TcpServer wiretap(boolean enable)

Description copied from class: Transport

Apply or remove a wire logger configuration using Transport category (logger), DEBUG logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.

Overrides:

wiretap in class Transport<TcpServer,TcpServerConfig>

Parameters:

enable - specifies whether the wire logger configuration will be added to the pipeline

Returns:

a new Transport reference

wiretap

public TcpServer wiretap(String category)

Description copied from class: Transport

Apply a wire logger configuration using the specified category (logger), DEBUG logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.

Overrides:

wiretap in class Transport<TcpServer,TcpServerConfig>

Parameters:

category - the logger category

Returns:

a new Transport reference

wiretap

public TcpServer wiretap(String category,
 LogLevel level)

Description copied from class: Transport

Apply a wire logger configuration using the specified category (logger), logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.

Overrides:

wiretap in class Transport<TcpServer,TcpServerConfig>

Parameters:

category - the logger category

level - the logger level

Returns:

a new Transport reference