Package reactor.netty.udp

Class UdpClient

java.lang.Object

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

reactor.netty.transport.ClientTransport<UdpClient,UdpClientConfig>

reactor.netty.udp.UdpClient

public abstract class UdpClient
extends ClientTransport<UdpClient,UdpClientConfig>

A UdpClient allows building in a safe immutable way a UDP client that is materialized and connecting when connect() is ultimately called.

Example:

 
 UdpClient.create()
          .doOnConnect(startMetrics)
          .doOnConnected(startedMetrics)
          .doOnDisconnected(stopMetrics)
          .host("127.0.0.1")
          .port(1234)
          .connect()
          .block()
 
 

Author:

Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested classes/interfaces inherited from class reactor.netty.transport.ClientTransport

ClientTransport.ResolvedAddressSelector<CONF>

Constructor Summary

Constructors

Constructor	Description
UdpClient()

Method Summary

Modifier and Type	Method	Description
final <A> UdpClient	attr(AttributeKey<A> key, @Nullable A value)	Update the given attribute key or remove it if the value is null.
final UdpClient	bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)	Set a new local address to which this transport should bind on subscribe.
final Mono<? extends Connection>	connect()	Connect the ClientTransport and return a Mono of Connection.
final Connection	connectNow()	Block the ClientTransport and return a Connection.
final Connection	connectNow(Duration timeout)	Block the ClientTransport and return a Connection.
static UdpClient	create()	Prepare a UdpClient.
final UdpClient	doOnConnect(Consumer<? super UdpClientConfig> doOnConnect)	Set or add a callback called when ClientTransport is about to connect to the remote endpoint.
final UdpClient	doOnConnected(Consumer<? super Connection> doOnConnected)	Set or add a callback called after Connection has been connected.
final UdpClient	doOnDisconnected(Consumer<? super Connection> doOnDisconnected)	Set or add a callback called after Connection has been disconnected.
final UdpClient	handle(BiFunction<? super UdpInbound,? super UdpOutbound,? extends Publisher<Void>> handler)	Attach an IO handler to react on connected client.
final UdpClient	host(String host)	The host to which this client should connect.
final UdpClient	metrics(boolean enable)	Whether to enable metrics to be collected and registered in Micrometer's globalRegistry.
final UdpClient	metrics(boolean enable, Supplier<? extends ChannelMetricsRecorder> recorder)	Specifies whether the metrics are enabled on the Transport.
final UdpClient	observe(ConnectionObserver observer)	Set or add the given ConnectionObserver to observe the connection state changes.
final <O> UdpClient	option(ChannelOption<O> key, @Nullable O value)	Update the given option key or remove it if the value is null.
final UdpClient	port(int port)	The port to which this client should connect.
final UdpClient	remoteAddress(Supplier<? extends SocketAddress> remoteAddressSupplier)	The address to which this client should connect on each subscribe.
final UdpClient	runOn(EventLoopGroup eventLoopGroup)	Run IO loops on the given EventLoopGroup.
final UdpClient	runOn(LoopResources channelResources)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final UdpClient	runOn(LoopResources loopResources, boolean preferNative)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final UdpClient	runOn(LoopResources loopResources, InternetProtocolFamily family)	Deprecated. as of 1.3.0.
final UdpClient	runOn(LoopResources loopResources, SocketProtocolFamily family)	Run IO loops on a supplied EventLoopGroup from the LoopResources container.
final UdpClient	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 UdpClient	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 UdpClient	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.ClientTransport

doAfterResolve, doOnResolve, doOnResolveError, noProxy, proxy, proxyWithSystemProperties, resolvedAddressesSelector, resolver, resolver, warmup

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

UdpClient

public UdpClient()

Method Details

create

public static UdpClient create()

Prepare a UdpClient.

Returns:

a UdpClient

attr

public final <A> UdpClient 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<UdpClient,UdpClientConfig>

Type Parameters:

A - the attribute type

Parameters:

key - the AttributeKey key

value - the AttributeKey value

Returns:

a new Transport reference

bindAddress

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

bindAddressSupplier - A supplier of the address to bind to.

Returns:

a new Transport

connect

public final Mono<? extends Connection> connect()

Description copied from class: ClientTransport

Connect the ClientTransport and return a Mono of Connection. If Mono is cancelled, the underlying connection will be aborted. Once the Connection has been emitted and is not necessary anymore, disposing must be done by the user via DisposableChannel.dispose().

Overrides:

connect in class ClientTransport<UdpClient,UdpClientConfig>

Returns:

a Mono of Connection

connectNow

public final Connection connectNow()

Description copied from class: ClientTransport

Block the ClientTransport and return a Connection. Disposing must be done by the user via DisposableChannel.dispose(). The max connection timeout is 45 seconds.

Overrides:

connectNow in class ClientTransport<UdpClient,UdpClientConfig>

Returns:

a Connection

connectNow

public final Connection connectNow(Duration timeout)

Description copied from class: ClientTransport

Block the ClientTransport and return a Connection. Disposing must be done by the user via DisposableChannel.dispose().

Overrides:

connectNow in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

timeout - connect timeout (resolution: ns)

Returns:

a Connection

doOnConnect

public final UdpClient doOnConnect(Consumer<? super UdpClientConfig> doOnConnect)

Description copied from class: ClientTransport

Set or add a callback called when ClientTransport is about to connect to the remote endpoint.

Overrides:

doOnConnect in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

doOnConnect - a consumer observing connect events

Returns:

a new ClientTransport reference

doOnConnected

public final UdpClient doOnConnected(Consumer<? super Connection> doOnConnected)

Description copied from class: ClientTransport

Set or add a callback called after Connection has been connected.

Overrides:

doOnConnected in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

doOnConnected - a consumer observing connected events

Returns:

a new ClientTransport reference

doOnDisconnected

public final UdpClient doOnDisconnected(Consumer<? super Connection> doOnDisconnected)

Description copied from class: ClientTransport

Set or add a callback called after Connection has been disconnected.

Overrides:

doOnDisconnected in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

doOnDisconnected - a consumer observing disconnected events

Returns:

a new ClientTransport reference

handle

public final UdpClient 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 UdpClient reference

host

public final UdpClient host(String host)

Description copied from class: ClientTransport

The host to which this client should connect.

Overrides:

host in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

host - the host to connect to

Returns:

a new ClientTransport reference

metrics

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

enable - true enables metrics collection; false disables it

Returns:

a new Transport reference

metrics

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

enable - if true enables the metrics on the Transport.

recorder - a supplier for the ChannelMetricsRecorder

Returns:

a new Transport reference

observe

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

observer - the ConnectionObserver to be set or add

Returns:

a new Transport reference

option

public final <O> UdpClient 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<UdpClient,UdpClientConfig>

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 UdpClient port(int port)

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

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

Overrides:

port in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

port - the port to connect to

Returns:

a new UdpClient reference

remoteAddress

public final UdpClient remoteAddress(Supplier<? extends SocketAddress> remoteAddressSupplier)

Description copied from class: ClientTransport

The address to which this client should connect on each subscribe.

Overrides:

remoteAddress in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

remoteAddressSupplier - A supplier of the address to connect to.

Returns:

a new ClientTransport

runOn

public final UdpClient runOn(EventLoopGroup eventLoopGroup)

Description copied from class: Transport

Run IO loops on the given EventLoopGroup.

Overrides:

runOn in class Transport<UdpClient,UdpClientConfig>

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

a new Transport reference

runOn

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

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

Returns:

a new Transport reference

runOn

public final UdpClient runOn(LoopResources loopResources,
 boolean preferNative)

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

Overrides:

runOn in class ClientTransport<UdpClient,UdpClientConfig>

Parameters:

loopResources - a new loop resources

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

Returns:

a new UdpClient reference

runOn

@Deprecated
public final UdpClient 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 UdpClient reference

runOn

public final UdpClient 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 UdpClient reference

Since:

1.3.0

wiretap

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

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

Returns:

a new Transport reference

wiretap

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

category - the logger category

Returns:

a new Transport reference

wiretap

public final UdpClient 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<UdpClient,UdpClientConfig>

Parameters:

category - the logger category

level - the logger level

Returns:

a new Transport reference