reactor.netty.udp

Class UdpResources

java.lang.Object

reactor.netty.udp.UdpResources

All Implemented Interfaces:

Disposable, LoopResources

public class UdpResources
extends Object
implements LoopResources

Hold the default UDP resources

Author:

Violeta Georgieva

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Field Summary

Fields inherited from interface reactor.netty.resources.LoopResources

DEFAULT_IO_SELECT_COUNT, DEFAULT_IO_WORKER_COUNT, DEFAULT_NATIVE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UdpResources(LoopResources defaultLoops)

Method Summary

Modifier and Type	Method and Description
protected void	_dispose() Dispose underlying resources
protected Mono<Void>	_disposeLater() Dispose underlying resources in a listenable fashion.
boolean	daemon() return true if EventLoopGroup should not be shutdown
void	dispose()
Mono<Void>	disposeLater() Returns a Mono that triggers the disposal of underlying resources when subscribed to.
static UdpResources	get() Return the global UDP resources for pooling
protected static UdpResources	getOrCreate(LoopResources loops, java.util.function.Function<LoopResources,UdpResources> onNew, String name) Safely check if existing resource exist and proceed to update/cleanup if new resources references are passed.
boolean	isDisposed()
Class<? extends Channel>	onChannel(EventLoopGroup group) Callback for client or generic channel factory selection.
EventLoopGroup	onClient(boolean useNative) Callback for client EventLoopGroup creation.
Class<? extends DatagramChannel>	onDatagramChannel(EventLoopGroup group) Callback for UDP channel factory selection.
EventLoopGroup	onServer(boolean useNative) Callback for server EventLoopGroup creation.
Class<? extends ServerChannel>	onServerChannel(EventLoopGroup group) Callback for server channel factory selection.
EventLoopGroup	onServerSelect(boolean useNative) Create a server select EventLoopGroup for servers to be used
boolean	preferNative() Return true if should default to native EventLoopGroup and Channel
static UdpResources	reset() Reset UDP resources to default and return its instance
static UdpResources	set(LoopResources loops) Update pooling resources and return the global UDP resources
static void	shutdown() Shutdown the global UdpResources without resetting them, effectively cleaning up associated resources without creating new ones.
static Mono<Void>	shutdownLater() Prepare to shutdown the global UdpResources without resetting them, effectively cleaning up associated resources without creating new ones.

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.netty.resources.LoopResources

colocate, create, create, create

Constructor Detail

UdpResources

protected UdpResources(LoopResources defaultLoops)

Method Detail

get

public static UdpResources get()

Return the global UDP resources for pooling

Returns:

the global UDP resources for pooling

set

public static UdpResources set(LoopResources loops)

Update pooling resources and return the global UDP resources

Parameters:

loops - the eventual new LoopResources

Returns:

the global UDP resources

reset

public static UdpResources reset()

Reset UDP resources to default and return its instance

Returns:

the global UDP resources

shutdown

public static void shutdown()

Shutdown the global UdpResources without resetting them, effectively cleaning up associated resources without creating new ones.

shutdownLater

public static Mono<Void> shutdownLater()

Prepare to shutdown the global UdpResources without resetting them, effectively cleaning up associated resources without creating new ones. This only occurs when the returned Mono is subscribed to.

Returns:

a Mono triggering the shutdown() when subscribed to.

dispose

public void dispose()

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface LoopResources

disposeLater

public Mono<Void> disposeLater()

Description copied from interface: LoopResources

Returns a Mono that triggers the disposal of underlying resources when subscribed to.

Specified by:

disposeLater in interface LoopResources

Returns:

a Mono representing the completion of resources disposal.

_dispose

protected void _dispose()

Dispose underlying resources

_disposeLater

protected Mono<Void> _disposeLater()

Dispose underlying resources in a listenable fashion.

Returns:

the Mono that represents the end of disposal

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Disposable

onChannel

public Class<? extends Channel> onChannel(EventLoopGroup group)

Description copied from interface: LoopResources

Callback for client or generic channel factory selection.

Specified by:

onChannel in interface LoopResources

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying Channel factory

onClient

public EventLoopGroup onClient(boolean useNative)

Description copied from interface: LoopResources

Callback for client EventLoopGroup creation.

Specified by:

onClient in interface LoopResources

Parameters:

useNative - should use native group if current LoopResources.preferNative() is also true

Returns:

a new EventLoopGroup

onDatagramChannel

public Class<? extends DatagramChannel> onDatagramChannel(EventLoopGroup group)

Description copied from interface: LoopResources

Callback for UDP channel factory selection.

Specified by:

onDatagramChannel in interface LoopResources

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying Channel factory

onServer

public EventLoopGroup onServer(boolean useNative)

Description copied from interface: LoopResources

Callback for server EventLoopGroup creation.

Specified by:

onServer in interface LoopResources

Parameters:

useNative - should use native group if current LoopResources.preferNative() is also true

Returns:

a new EventLoopGroup

onServerChannel

public Class<? extends ServerChannel> onServerChannel(EventLoopGroup group)

Description copied from interface: LoopResources

Callback for server channel factory selection.

Specified by:

onServerChannel in interface LoopResources

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying ServerChannel factory

onServerSelect

public EventLoopGroup onServerSelect(boolean useNative)

Description copied from interface: LoopResources

Create a server select EventLoopGroup for servers to be used

Specified by:

onServerSelect in interface LoopResources

Parameters:

useNative - should use native group if current LoopResources.preferNative() is also true

Returns:

a new EventLoopGroup

preferNative

public boolean preferNative()

Description copied from interface: LoopResources

Return true if should default to native EventLoopGroup and Channel

Specified by:

preferNative in interface LoopResources

Returns:

true if should default to native EventLoopGroup and Channel

daemon

public boolean daemon()

Description copied from interface: LoopResources

return true if EventLoopGroup should not be shutdown

Specified by:

daemon in interface LoopResources

Returns:

true if EventLoopGroup should not be shutdown

getOrCreate

protected static UdpResources getOrCreate(@Nullable
                                          LoopResources loops,
                                          java.util.function.Function<LoopResources,UdpResources> onNew,
                                          String name)

Safely check if existing resource exist and proceed to update/cleanup if new resources references are passed.

Parameters:

loops - the eventual new LoopResources

onNew - a UdpResources factory

name - a name for resources

Returns:

an existing or new UdpResources