reactor.netty.udp

Class UdpClient

java.lang.Object

reactor.netty.udp.UdpClient

public abstract class UdpClient
extends Object

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

Internally, materialization happens in two phases, first configure() is called to retrieve a ready to use Bootstrap then connect(Bootstrap) is called.

Example:

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

Author:

Stephane Maldini

Constructor Summary

Constructors

Constructor and Description
UdpClient()

Method Summary

Modifier and Type	Method and Description
UdpClient	addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectingAddressSupplier) Deprecated. as of 0.9.7. Use remoteAddress(Supplier)
<T> UdpClient	attr(AttributeKey<T> key, T value) Inject default attribute to the future child Channel connections.
UdpClient	bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier) The address to which this client should bind on subscribe.
UdpClient	bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper) Deprecated. as of 0.9.10. Use the methods exposed on UdpClient level. The method will be removed in version 1.0.0.
protected Bootstrap	configure() Materialize a Bootstrap from the parent UdpClient chain to use with connect(Bootstrap) or separately
Mono<? extends Connection>	connect() Connect the UdpClient and return a Mono of Connection.
protected abstract Mono<? extends Connection>	connect(Bootstrap b) Connect the UdpClient and return a Mono of Connection
Connection	connectNow(java.time.Duration timeout) Block the UdpClient and return a Connection.
static UdpClient	create() Prepare a UdpClient
UdpClient	doOnConnect(java.util.function.Consumer<? super Bootstrap> doOnConnect) Setup a callback called when Channel is about to connect.
UdpClient	doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected) Setup a callback called when Channel is connected.
UdpClient	doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected) Setup a callback called when Channel is disconnected.
UdpClient	doOnLifecycle(java.util.function.Consumer<? super Bootstrap> doOnConnect, java.util.function.Consumer<? super Connection> doOnConnected, java.util.function.Consumer<? super Connection> doOnDisconnected) Deprecated. as of 0.9.7. Use doOnConnect(Consumer), doOnConnected(Consumer) or doOnDisconnected(Consumer)
UdpClient	handle(java.util.function.BiFunction<? super UdpInbound,? super UdpOutbound,? extends Publisher<Void>> handler) Attach an IO handler to react on connected client
UdpClient	host(String host) The host to which this client should connect.
UdpClient	metrics(boolean metricsEnabled) Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.UDP_CLIENT_PREFIX.
UdpClient	metrics(boolean metricsEnabled, ChannelMetricsRecorder recorder) Deprecated. as of 0.9.7. Use metrics(boolean, Supplier)
UdpClient	metrics(boolean metricsEnabled, java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder) Specifies whether the metrics are enabled on the UdpClient.
UdpClient	observe(ConnectionObserver observer) Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.
<T> UdpClient	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
UdpClient	port(int port) The port to which this client should connect.
UdpClient	remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier) The address to which this client should connect on subscribe.
UdpClient	runOn(EventLoopGroup eventLoopGroup) Run IO loops on the given EventLoopGroup.
UdpClient	runOn(LoopResources channelResources) Run IO loops on a supplied EventLoopGroup from the LoopResources container.
UdpClient	runOn(LoopResources channelResources, boolean preferNative) Run IO loops on a supplied EventLoopGroup from the LoopResources container.
UdpClient	runOn(LoopResources channelResources, InternetProtocolFamily family) Run IO loops on a supplied EventLoopGroup from the LoopResources container.
UdpClient	wiretap(boolean enable) Apply or remove a wire logger configuration using UdpClient category and DEBUG logger level
UdpClient	wiretap(String category) Apply a wire logger configuration using the specified category and DEBUG logger level
UdpClient	wiretap(String category, LogLevel level) Apply a wire logger configuration using the specified category and logger level

Methods inherited from class java.lang.Object

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

Constructor Detail

UdpClient

public UdpClient()

Method Detail

create

public static UdpClient create()

Prepare a UdpClient

Returns:

a UdpClient

addressSupplier

@Deprecated
public final UdpClient addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectingAddressSupplier)

Deprecated. as of 0.9.7. Use remoteAddress(Supplier)

The address to which this client should connect on subscribe.

Parameters:

connectingAddressSupplier - A supplier of the address to connect to.

Returns:

a new UdpClient

remoteAddress

public final UdpClient remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier)

The address to which this client should connect on subscribe.

Parameters:

remoteAddressSupplier - A supplier of the address to connect to.

Returns:

a new UdpClient

Since:

0.9.7

attr

public final <T> UdpClient attr(AttributeKey<T> key,
                                T value)

Inject default attribute to the future child Channel connections. They will be available via AttributeMap.attr(AttributeKey).

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

a new UdpClient

See Also:

AbstractBootstrap.attr(AttributeKey, Object)

bindAddress

public final UdpClient bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier)

The address to which this client should bind on subscribe.

Parameters:

bindAddressSupplier - A supplier of the address to bind to.

Returns:

a new UdpClient

Since:

0.9.10

bootstrap

@Deprecated
public final UdpClient bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper)

Deprecated. as of 0.9.10. Use the methods exposed on UdpClient level. The method will be removed in version 1.0.0.

Apply Bootstrap configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.

Configuration will apply during configure() phase.

Parameters:

bootstrapMapper - A bootstrap mapping function to update configuration and return an enriched bootstrap.

Returns:

a new UdpClient

connect

public final Mono<? extends Connection> connect()

Connect the UdpClient 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 main client loop must be done by the user via DisposableChannel.dispose(). If update configuration phase fails, a Mono.error(Throwable) will be returned

Returns:

a Mono of Connection

connectNow

public final Connection connectNow(java.time.Duration timeout)

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

Parameters:

timeout - connect timeout

Returns:

a Mono of Connection

doOnConnect

public final UdpClient doOnConnect(java.util.function.Consumer<? super Bootstrap> doOnConnect)

Setup a callback called when Channel is about to connect.

Parameters:

doOnConnect - a consumer observing client start event

Returns:

a new UdpClient

doOnConnected

public final UdpClient doOnConnected(java.util.function.Consumer<? super Connection> doOnConnected)

Setup a callback called when Channel is connected.

Parameters:

doOnConnected - a consumer observing client started event

Returns:

a new UdpClient

doOnDisconnected

public final UdpClient doOnDisconnected(java.util.function.Consumer<? super Connection> doOnDisconnected)

Setup a callback called when Channel is disconnected.

Parameters:

doOnDisconnected - a consumer observing client stop event

Returns:

a new UdpClient

doOnLifecycle

@Deprecated
public final UdpClient doOnLifecycle(java.util.function.Consumer<? super Bootstrap> doOnConnect,
                                                 java.util.function.Consumer<? super Connection> doOnConnected,
                                                 java.util.function.Consumer<? super Connection> doOnDisconnected)

Deprecated. as of 0.9.7. Use doOnConnect(Consumer), doOnConnected(Consumer) or doOnDisconnected(Consumer)

Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.

Parameters:

doOnConnect - a consumer observing client start event

doOnConnected - a consumer observing client started event

doOnDisconnected - a consumer observing client stop event

Returns:

a new UdpClient

host

public final UdpClient host(String host)

The host to which this client should connect.

Parameters:

host - The host to connect to.

Returns:

a new UdpClient

handle

public final UdpClient handle(java.util.function.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

observe

public final UdpClient observe(ConnectionObserver observer)

Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.

Parameters:

observer - a consumer observing state changes

Returns:

a new UdpClient

option

public final <T> UdpClient option(ChannelOption<T> key,
                                  T value)

Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE. This will apply to each new channel from remote peer.

Type Parameters:

T - the option type

Parameters:

key - the option key

value - the option value

Returns:

new UdpClient

See Also:

AbstractBootstrap.option(ChannelOption, Object)

port

public final UdpClient port(int port)

The port to which this client should connect.

Parameters:

port - The port to connect to.

Returns:

a new UdpClient

runOn

public final UdpClient runOn(EventLoopGroup eventLoopGroup)

Run IO loops on the given EventLoopGroup.

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

a new UdpClient

runOn

public final UdpClient runOn(LoopResources channelResources)

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

Parameters:

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

Returns:

a new UdpClient

runOn

public final UdpClient runOn(LoopResources channelResources,
                             boolean preferNative)

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

Parameters:

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

preferNative - Should the connector prefer native (epoll/kqueue) if available.

Returns:

a new UdpClient

runOn

public final UdpClient runOn(LoopResources channelResources,
                             InternetProtocolFamily family)

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

Parameters:

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

family - a specific InternetProtocolFamily to run with

Returns:

a new UdpClient

metrics

public final UdpClient metrics(boolean metricsEnabled)

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

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

By default this is not enabled.

Parameters:

metricsEnabled - true enables metrics collection; false disables it

Returns:

a new UdpClient

metrics

@Deprecated
public final UdpClient metrics(boolean metricsEnabled,
                                           ChannelMetricsRecorder recorder)

Deprecated. as of 0.9.7. Use metrics(boolean, Supplier)

Specifies whether the metrics are enabled on the UdpClient. All generated metrics are provided to the specified recorder.

Parameters:

metricsEnabled - if true enables the metrics on the client.

recorder - the ChannelMetricsRecorder

Returns:

a new UdpClient

metrics

public final UdpClient metrics(boolean metricsEnabled,
                               java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)

Specifies whether the metrics are enabled on the UdpClient. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.

Parameters:

metricsEnabled - if true enables the metrics on the client.

recorder - a supplier for the ChannelMetricsRecorder

Returns:

a new UdpClient

Since:

0.9.7

wiretap

public final UdpClient wiretap(boolean enable)

Apply or remove a wire logger configuration using UdpClient category and DEBUG logger level

Parameters:

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

Returns:

a new UdpClient

wiretap

public final UdpClient wiretap(String category)

Apply a wire logger configuration using the specified category and DEBUG logger level

Parameters:

category - the logger category

Returns:

a new UdpClient

wiretap

public final UdpClient wiretap(String category,
                               LogLevel level)

Apply a wire logger configuration using the specified category and logger level

Parameters:

category - the logger category

level - the logger level

Returns:

a new UdpClient

configure

protected Bootstrap configure()

Materialize a Bootstrap from the parent UdpClient chain to use with connect(Bootstrap) or separately

Returns:

a configured Bootstrap

connect

protected abstract Mono<? extends Connection> connect(Bootstrap b)

Connect the UdpClient and return a Mono of Connection

Parameters:

b - the Bootstrap to connect

Returns:

a Mono of Connection