UdpServer (Reactor Netty 0.9.15.RELEASE)

java.lang.Object
- reactor.netty.udp.UdpServer

```
public abstract class UdpServer
extends Object
```
A UdpServer allows to build in a safe immutable way a UDP server that is materialized and connecting when bind(Bootstrap) is ultimately called.

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

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

Stephane Maldini

Constructor Summary

Constructors
Constructor and Description

UdpServer()

Constructors
Constructor and Description
`UdpServer()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`UdpServer`	`addressSupplier(java.util.function.Supplier<? extends SocketAddress> bindingAddressSupplier)` Deprecated. as of 0.9.7. Use `bindAddress(Supplier)`
`<T> UdpServer`	`attr(AttributeKey<T> key, T value)` Inject default attribute to the future child `Channel` connections.
`Mono<? extends Connection>`	`bind()` Bind the `UdpServer` and return a `Mono` of `Connection`.
`protected abstract Mono<? extends Connection>`	`bind(Bootstrap b)` Bind the `UdpServer` and return a `Mono` of `Connection`
`UdpServer`	`bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier)` The address to which this server should bind on subscribe.
`Connection`	`bindNow(java.time.Duration timeout)` Start a Server in a blocking fashion, and wait for it to finish initializing.
`UdpServer`	`bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper)` Deprecated. as of 0.9.10. Use the methods exposed on `UdpServer` level. The method will be removed in version 1.0.0.
`protected Bootstrap`	`configure()` Materialize a Bootstrap from the parent `UdpServer` chain to use with `bind(Bootstrap)` or separately
`static UdpServer`	`create()` Prepare a `UdpServer`
`UdpServer`	`doOnBind(java.util.function.Consumer<? super Bootstrap> doOnBind)` Setup a callback called when `Channel` is about to bind.
`UdpServer`	`doOnBound(java.util.function.Consumer<? super Connection> doOnBound)` Setup a callback called when `Channel` is bound.
`UdpServer`	`doOnLifecycle(java.util.function.Consumer<? super Bootstrap> onBind, java.util.function.Consumer<? super Connection> onBound, java.util.function.Consumer<? super Connection> onUnbound)` Deprecated. as of 0.9.7. Use `doOnBind(Consumer)`, `doOnBound(Consumer)` or `doOnUnbound(Consumer)`
`UdpServer`	`doOnUnbound(java.util.function.Consumer<? super Connection> doOnUnbound)` Setup a callback called when `Channel` is unbound.
`UdpServer`	`handle(java.util.function.BiFunction<? super UdpInbound,? super UdpOutbound,? extends Publisher<Void>> handler)` Attach an IO handler to react on connected client
`UdpServer`	`host(String host)` The host to which this server should bind.
`UdpServer`	`metrics(boolean metricsEnabled)` Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry` under the name `Metrics.UDP_SERVER_PREFIX`.
`UdpServer`	`metrics(boolean metricsEnabled, ChannelMetricsRecorder recorder)` Deprecated. as of 0.9.7. Use `metrics(boolean, Supplier)`
`UdpServer`	`metrics(boolean metricsEnabled, java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)` Specifies whether the metrics are enabled on the `UdpServer`.
`UdpServer`	`observe(ConnectionObserver observer)` Setup all lifecycle callbacks called on or after `Channel` has been connected and after it has been disconnected.
`<T> UdpServer`	`option(ChannelOption<T> key, T value)` Set a `ChannelOption` value for low level connection settings like `SO_TIMEOUT` or `SO_KEEPALIVE`.
`UdpServer`	`port(int port)` The port to which this server should bind.
`UdpServer`	`runOn(EventLoopGroup eventLoopGroup)` Run IO loops on the given `EventLoopGroup`.
`UdpServer`	`runOn(LoopResources channelResources)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`UdpServer`	`runOn(LoopResources channelResources, boolean preferNative)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`UdpServer`	`runOn(LoopResources channelResources, InternetProtocolFamily family)` Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
`UdpServer`	`wiretap(boolean enable)` Apply or remove a wire logger configuration using `UdpServer` category and `DEBUG` logger level
`UdpServer`	`wiretap(String category)` Apply a wire logger configuration using the specified category and `DEBUG` logger level
`UdpServer`	`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
  - UdpServer
```
public UdpServer()
```
- Method Detail
  - create
```
public static UdpServer create()
```
    Prepare a UdpServer
    
    Returns:
    
    a UdpServer
  - addressSupplier
```
@Deprecated
public final UdpServer addressSupplier(java.util.function.Supplier<? extends SocketAddress> bindingAddressSupplier)
```
    Deprecated. as of 0.9.7. Use bindAddress(Supplier)
    
    The address to which this server should bind on subscribe.
    
    Parameters:
    
    bindingAddressSupplier - A supplier of the address to bind to.
    
    Returns:
    
    a new UdpServer
  - bindAddress
```
public final UdpServer bindAddress(java.util.function.Supplier<? extends SocketAddress> bindAddressSupplier)
```
    The address to which this server should bind on subscribe.
    
    Parameters:
    
    bindAddressSupplier - A supplier of the address to bind to.
    
    Returns:
    
    a new UdpServer
    
    Since:
    
    0.9.7
  - attr
```
public final <T> UdpServer 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 UdpServer
    
    See Also:
    
    AbstractBootstrap.attr(AttributeKey, Object)
  - bootstrap
```
@Deprecated
public final UdpServer bootstrap(java.util.function.Function<? super Bootstrap,? extends Bootstrap> bootstrapMapper)
```
    Deprecated. as of 0.9.10. Use the methods exposed on UdpServer 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 UdpServer
  - bind
```
public final Mono<? extends Connection> bind()
```
    Bind the UdpServer and return 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 main server 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
  - bindNow
```
public final Connection bindNow(java.time.Duration timeout)
```
    Start a Server in a blocking fashion, and wait for it to finish initializing. The returned Connection offers simple server API, including to DisposableChannel.disposeNow() shut it down in a blocking fashion.
    
    Parameters:
    
    timeout - max startup timeout
    
    Returns:
    
    a Connection
  - doOnBind
```
public final UdpServer doOnBind(java.util.function.Consumer<? super Bootstrap> doOnBind)
```
    Setup a callback called when Channel is about to bind.
    
    Parameters:
    
    doOnBind - a consumer observing server start event
    
    Returns:
    
    a new UdpServer
  - doOnBound
```
public final UdpServer doOnBound(java.util.function.Consumer<? super Connection> doOnBound)
```
    Setup a callback called when Channel is bound.
    
    Parameters:
    
    doOnBound - a consumer observing server started event
    
    Returns:
    
    a new UdpServer
  - doOnUnbound
```
public final UdpServer doOnUnbound(java.util.function.Consumer<? super Connection> doOnUnbound)
```
    Setup a callback called when Channel is unbound.
    
    Parameters:
    
    doOnUnbound - a consumer observing server stop event
    
    Returns:
    
    a new UdpServer
  - doOnLifecycle
```
@Deprecated
public final UdpServer doOnLifecycle(java.util.function.Consumer<? super Bootstrap> onBind,
                                                 java.util.function.Consumer<? super Connection> onBound,
                                                 java.util.function.Consumer<? super Connection> onUnbound)
```
    Deprecated. as of 0.9.7. Use doOnBind(Consumer), doOnBound(Consumer) or doOnUnbound(Consumer)
    
    Setup all lifecycle callbacks called on or after Channel has been bound and after it has been unbound.
    
    Parameters:
    
    onBind - a consumer observing server start event
    
    onBound - a consumer observing server started event
    
    onUnbound - a consumer observing server stop event
    
    Returns:
    
    a new UdpServer
  - handle
```
public final UdpServer 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 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
  - observe
```
public final UdpServer 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 UdpServer
  - option
```
public final <T> UdpServer 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 UdpServer
    
    See Also:
    
    AbstractBootstrap.option(ChannelOption, Object)
  - port
```
public final UdpServer port(int port)
```
    The port to which this server should bind.
    
    Parameters:
    
    port - The port to bind to.
    
    Returns:
    
    a new UdpServer
  - runOn
```
public final UdpServer runOn(EventLoopGroup eventLoopGroup)
```
    Run IO loops on the given EventLoopGroup.
    
    Parameters:
    
    eventLoopGroup - an eventLoopGroup to share
    
    Returns:
    
    a new UdpServer
  - runOn
```
public final UdpServer 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 UdpServer
  - runOn
```
public final UdpServer 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 UdpServer
  - runOn
```
public final UdpServer 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 UdpServer
  - metrics
```
public final UdpServer metrics(boolean metricsEnabled)
```
    Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.UDP_SERVER_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_SERVER_PREFIX, 100, filter));
 
```
    By default this is not enabled.
    Parameters:
    
    metricsEnabled - true enables metrics collection; false disables it
    
    Returns:
    
    a new UdpServer
  - metrics
```
@Deprecated
public final UdpServer metrics(boolean metricsEnabled,
                                           ChannelMetricsRecorder recorder)
```
    Deprecated. as of 0.9.7. Use metrics(boolean, Supplier)
    
    Specifies whether the metrics are enabled on the UdpServer. All generated metrics are provided to the specified recorder.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the server.
    
    recorder - the ChannelMetricsRecorder
    
    Returns:
    
    a new UdpServer
  - metrics
```
public final UdpServer metrics(boolean metricsEnabled,
                               java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)
```
    Specifies whether the metrics are enabled on the UdpServer. 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 server.
    
    recorder - a supplier for the ChannelMetricsRecorder
    
    Returns:
    
    a new UdpServer
    
    Since:
    
    0.9.7
  - wiretap
```
public final UdpServer wiretap(boolean enable)
```
    Apply or remove a wire logger configuration using UdpServer category and DEBUG logger level
    
    Parameters:
    
    enable - Specifies whether the wire logger configuration will be added to the pipeline
    
    Returns:
    
    a new UdpServer
  - wiretap
```
public final UdpServer wiretap(String category)
```
    Apply a wire logger configuration using the specified category and DEBUG logger level
    
    Parameters:
    
    category - the logger category
    
    Returns:
    
    a new UdpServer
  - wiretap
```
public final UdpServer 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 UdpServer
  - configure
```
protected Bootstrap configure()
```
    Materialize a Bootstrap from the parent UdpServer chain to use with bind(Bootstrap) or separately
    
    Returns:
    
    a configured Bootstrap
  - bind
```
protected abstract Mono<? extends Connection> bind(Bootstrap b)
```
    Bind the UdpServer and return a Mono of Connection
    
    Parameters:
    
    b - the Bootstrap to bind
    
    Returns:
    
    a Mono of Connection

Class UdpServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UdpServer

Method Detail

create

addressSupplier

bindAddress

attr

bootstrap

bind

bindNow

doOnBind

doOnBound

doOnUnbound

doOnLifecycle

handle

host

observe

option

port

runOn

runOn

runOn

runOn

metrics

metrics

metrics

wiretap

wiretap

wiretap

configure

bind