Package reactor.netty.udp

Class UdpServer

java.lang.Object

reactor.netty.transport.Transport<UdpServer,UdpServerConfig>

reactor.netty.udp.UdpServer

public abstract class UdpServer
extends Transport<UdpServer,UdpServerConfig>

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

Example:

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

Author:

Stephane Maldini, Violeta Georgieva

Constructor Summary

Constructors

Constructor	Description
UdpServer()

Method Summary

Modifier and Type	Method	Description
final <A> UdpServer	attr(AttributeKey<A> key, @Nullable A value)	Update the given attribute key or remove it if the value is null.
abstract Mono<? extends Connection>	bind()	Binds the UdpServer and returns a Mono of Connection.
final UdpServer	bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)	Set a new local address to which this transport should bind on subscribe.
final Connection	bindNow()	Starts the server in a blocking fashion, and waits for it to finish initializing or the startup timeout expires (the startup timeout is 45 seconds).
final Connection	bindNow(Duration timeout)	Start the server in a blocking fashion, and wait for it to finish initializing or the provided startup timeout expires.
static UdpServer	create()	Prepare a UdpServer.
final UdpServer	doOnBind(Consumer<? super UdpServerConfig> doOnBind)	Set or add a callback called when UdpServer is about to start listening for incoming traffic.
final UdpServer	doOnBound(Consumer<? super Connection> doOnBound)	Set or add a callback called after UdpServer has been started.
final UdpServer	doOnUnbound(Consumer<? super Connection> doOnUnbound)	Set or add a callback called after UdpServer has been shutdown.
final UdpServer	handle(BiFunction<? super UdpInbound,? super UdpOutbound,? extends Publisher<Void>> handler)	Attach an IO handler to react on connected client.
final UdpServer	host(String host)	The host to which this server should bind.
final UdpServer	metrics(boolean enable)	Whether to enable metrics to be collected and registered in Micrometer's globalRegistry.
final UdpServer	metrics(boolean enable, Supplier<? extends ChannelMetricsRecorder> recorder)	Specifies whether the metrics are enabled on the Transport.
final UdpServer	observe(ConnectionObserver observer)	Set or add the given ConnectionObserver to observe the connection state changes.
final <O> UdpServer	option(ChannelOption<O> key, @Nullable O value)	Update the given option key or remove it if the value is null.
final UdpServer	port(int port)	The port to which this server should bind.
final UdpServer	runOn(EventLoopGroup eventLoopGroup)	Run IO loops on the given EventLoopGroup.
final UdpServer	runOn(LoopResources channelResources)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final UdpServer	runOn(LoopResources loopResources, boolean preferNative)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final UdpServer	runOn(LoopResources loopResources, InternetProtocolFamily family)	Deprecated. as of 1.3.0.
final UdpServer	runOn(LoopResources loopResources, SocketProtocolFamily family)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final Mono<Void>	warmup()	Based on the actual configuration, returns a Mono that triggers: an initialization of the event loop group loads the necessary native libraries for the transport By default, when method is not used, the bind operation absorbs the extra time needed to load resources.
final UdpServer	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.
final UdpServer	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.
final UdpServer	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.Transport

channelGroup, configuration, doOnChannelInit, duplicate, wiretap, wiretap

Methods inherited from class java.lang.Object

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

Constructor Details

UdpServer

public UdpServer()

Method Details

create

public static UdpServer create()

Prepare a UdpServer.

Returns:

a UdpServer

attr

public final <A> UdpServer attr(AttributeKey<A> key,
 @Nullable A value)

Description copied from class: Transport

Update the given attribute key or remove it if the value is null.

Overrides:

attr in class Transport<UdpServer,UdpServerConfig>

Type Parameters:

A - the attribute type

Parameters:

key - the AttributeKey key

value - the AttributeKey value

Returns:

a new Transport reference

bind

public abstract Mono<? extends Connection> bind()

Binds the UdpServer and returns a Mono of Connection. If Mono is cancelled, the underlying binding will be aborted. Once the Connection has been emitted and is not necessary anymore, disposing the main server loop must be done by the user via DisposableChannel.dispose().

Returns:

a Mono of Connection

bindAddress

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

bindAddressSupplier - A supplier of the address to bind to.

Returns:

a new Transport

bindNow

public final Connection bindNow()

Starts the server in a blocking fashion, and waits for it to finish initializing or the startup timeout expires (the startup timeout is 45 seconds). The returned Connection offers simple server API, including to DisposableChannel.disposeNow() shut it down in a blocking fashion.

Returns:

a Connection

bindNow

public final Connection bindNow(Duration timeout)

Start the server in a blocking fashion, and wait for it to finish initializing or the provided startup timeout expires. The returned Connection offers simple server API, including to DisposableChannel.disposeNow() shut it down in a blocking fashion.

Parameters:

timeout - max startup timeout (resolution: ns)

Returns:

a Connection

doOnBind

public final UdpServer doOnBind(Consumer<? super UdpServerConfig> doOnBind)

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

Parameters:

doOnBind - a consumer observing connected events

Returns:

a new UdpServer reference

doOnBound

public final UdpServer doOnBound(Consumer<? super Connection> doOnBound)

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

Parameters:

doOnBound - a consumer observing connected events

Returns:

a new UdpServer reference

doOnUnbound

public final UdpServer doOnUnbound(Consumer<? super Connection> doOnUnbound)

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

Parameters:

doOnUnbound - a consumer observing unbound events

Returns:

a new UdpServer reference

handle

public final UdpServer handle(BiFunction<? super UdpInbound,? super UdpOutbound,? extends Publisher<Void>> handler)

Attach an IO handler to react on connected client.

Parameters:

handler - an IO handler that can dispose underlying connection when Publisher terminates.

Returns:

a new UdpServer

host

public final UdpServer host(String host)

The host to which this server should bind.

Parameters:

host - the host to bind to.

Returns:

a new UdpServer reference

metrics

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

enable - true enables metrics collection; false disables it

Returns:

a new Transport reference

metrics

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

enable - if true enables the metrics on the Transport.

recorder - a supplier for the ChannelMetricsRecorder

Returns:

a new Transport reference

observe

public final UdpServer observe(ConnectionObserver observer)

Description copied from class: Transport

Set or add the given ConnectionObserver to observe the connection state changes.

Overrides:

observe in class Transport<UdpServer,UdpServerConfig>

Parameters:

observer - the ConnectionObserver to be set or add

Returns:

a new Transport reference

option

public final <O> UdpServer option(ChannelOption<O> key,
 @Nullable O value)

Description copied from class: Transport

Update the given option key or remove it if the value is null. Note: Setting ChannelOption.AUTO_READ option will be ignored. It is configured to be false.

Overrides:

option in class Transport<UdpServer,UdpServerConfig>

Type Parameters:

O - the option type

Parameters:

key - the ChannelOption key

value - the ChannelOption value or null

Returns:

a new Transport reference

port

public final UdpServer port(int port)

The port to which this server should bind. If a port is not specified, the default port 12012 is used.

Note: The port can be specified also with PORT environment variable.

Parameters:

port - The port to bind to.

Returns:

a new UdpServer reference

runOn

public final UdpServer runOn(EventLoopGroup eventLoopGroup)

Description copied from class: Transport

Run IO loops on the given EventLoopGroup.

Overrides:

runOn in class Transport<UdpServer,UdpServerConfig>

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

a new Transport reference

runOn

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

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

Returns:

a new Transport reference

runOn

public final UdpServer runOn(LoopResources loopResources,
 boolean preferNative)

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

Overrides:

runOn in class Transport<UdpServer,UdpServerConfig>

Parameters:

loopResources - a new loop resources

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

Returns:

a new UdpServer reference

runOn

@Deprecated
public final UdpServer runOn(LoopResources loopResources,
 InternetProtocolFamily family)

Deprecated.

as of 1.3.0. Prefer runOn(LoopResources, SocketProtocolFamily). This method will be removed in version 1.4.0.

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

Parameters:

loopResources - a new loop resources

family - a specific InternetProtocolFamily to run with

Returns:

a new UdpServer reference

runOn

public final UdpServer runOn(LoopResources loopResources,
 SocketProtocolFamily family)

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

Parameters:

loopResources - a new loop resources

family - a specific SocketProtocolFamily to run with

Returns:

a new UdpServer reference

Since:

1.3.0

warmup

public final Mono<Void> warmup()

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

• an initialization of the event loop group
• loads the necessary native libraries for the transport

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

Returns:

a Mono representing the completion of the warmup

Since:

1.0.3

wiretap

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

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

Returns:

a new Transport reference

wiretap

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

category - the logger category

Returns:

a new Transport reference

wiretap

public final UdpServer 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<UdpServer,UdpServerConfig>

Parameters:

category - the logger category

level - the logger level

Returns:

a new Transport reference