reactor.netty.tcp

Class TcpResources

java.lang.Object

reactor.netty.tcp.TcpResources

All Implemented Interfaces:

Disposable, ConnectionProvider, LoopResources

Direct Known Subclasses:

HttpResources

public class TcpResources
extends Object
implements ConnectionProvider, LoopResources

Hold the default Tcp resources

Since:

0.6

Author:

Stephane Maldini

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.ConnectionProvider

DEFAULT_POOL_ACQUIRE_TIMEOUT, DEFAULT_POOL_MAX_CONNECTIONS

Fields inherited from interface reactor.netty.resources.LoopResources

DEFAULT_IO_SELECT_COUNT, DEFAULT_IO_WORKER_COUNT, DEFAULT_NATIVE, DEFAULT_SHUTDOWN_QUIET_PERIOD, DEFAULT_SHUTDOWN_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TcpResources(LoopResources defaultLoops, ConnectionProvider defaultProvider)

Method Summary

Modifier and Type	Method and Description
protected void	_dispose() Dispose underlying resources
protected Mono<Void>	_disposeLater() Deprecated. Use _disposeLater(Duration, Duration)
protected Mono<Void>	_disposeLater(java.time.Duration quietPeriod, java.time.Duration timeout) Dispose underlying resources in a listenable fashion.
Mono<? extends Connection>	acquire(Bootstrap bootstrap) Return an existing or new Connection on subscribe.
boolean	daemon() return true if EventLoopGroup should not be shutdown
void	dispose() Use disposeLoopsAndConnections()
Mono<Void>	disposeLater() Use disposeLoopsAndConnectionsLater()
static void	disposeLoopsAndConnections() Shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones.
static Mono<Void>	disposeLoopsAndConnectionsLater() Prepare to shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones.
static Mono<Void>	disposeLoopsAndConnectionsLater(java.time.Duration quietPeriod, java.time.Duration timeout) Prepare to shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones.
void	disposeWhen(SocketAddress address)
static TcpResources	get() Return the global HTTP resources for event loops and pooling
protected static <T extends TcpResources> T	getOrCreate(AtomicReference<T> ref, LoopResources loops, ConnectionProvider provider, java.util.function.BiFunction<LoopResources,ConnectionProvider,T> 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 TcpResources	reset() Reset http resources to default and return its instance
static TcpResources	set(ConnectionProvider provider) Update provider resources and return the global HTTP resources
static TcpResources	set(LoopResources loops) Update pooling resources and return the global HTTP resources

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.ConnectionProvider

elastic, elastic, elastic, fixed, fixed, fixed, fixed, fixed, maxConnections, newConnection

Methods inherited from interface reactor.netty.resources.LoopResources

colocate, create, create, create, disposeLater

Constructor Detail

TcpResources

protected TcpResources(LoopResources defaultLoops,
                       ConnectionProvider defaultProvider)

Method Detail

get

public static TcpResources get()

Return the global HTTP resources for event loops and pooling

Returns:

the global HTTP resources for event loops and pooling

set

public static TcpResources set(ConnectionProvider provider)

Update provider resources and return the global HTTP resources

Returns:

the global HTTP resources

set

public static TcpResources set(LoopResources loops)

Update pooling resources and return the global HTTP resources

Returns:

the global HTTP resources

reset

public static TcpResources reset()

Reset http resources to default and return its instance

Returns:

the global HTTP resources

disposeLoopsAndConnections

public static void disposeLoopsAndConnections()

Shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones. This method is NOT blocking. It is implemented as fire-and-forget. Use disposeLoopsAndConnectionsLater() when you need to observe the final status of the operation, combined with Mono.block() if you need to synchronously wait for the underlying resources to be disposed.

disposeLoopsAndConnectionsLater

public static Mono<Void> disposeLoopsAndConnectionsLater()

Prepare to shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones. This only occurs when the returned Mono is subscribed to. The quiet period will be 2s and the timeout will be 15s

Returns:

a Mono triggering the disposeLoopsAndConnections() when subscribed to.

disposeLoopsAndConnectionsLater

public static Mono<Void> disposeLoopsAndConnectionsLater(java.time.Duration quietPeriod,
                                                         java.time.Duration timeout)

Prepare to shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones. This only occurs when the returned Mono is subscribed to. It is guaranteed that the disposal of the underlying LoopResources will not happen before quietPeriod is over. If a task is submitted during the quietPeriod, it is guaranteed to be accepted and the quietPeriod will start over.

Parameters:

quietPeriod - the quiet period as described above

timeout - the maximum amount of time to wait until the disposal of the underlying LoopResources regardless if a task was submitted during the quiet period

Returns:

a Mono triggering the disposeLoopsAndConnections() when subscribed to.

dispose

public void dispose()

Use disposeLoopsAndConnections()

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface ConnectionProvider

Specified by:

dispose in interface LoopResources

disposeLater

public Mono<Void> disposeLater()

Use disposeLoopsAndConnectionsLater()

Specified by:

disposeLater in interface ConnectionProvider

Specified by:

disposeLater in interface LoopResources

Returns:

a Mono representing the completion of the ConnectionProvider disposal.

_dispose

protected void _dispose()

Dispose underlying resources

_disposeLater

@Deprecated
protected Mono<Void> _disposeLater()

Deprecated. Use _disposeLater(Duration, Duration)

Dispose underlying resources in a listenable fashion. The quiet period will be 2s and the timeout will be 15s

Returns:

the Mono that represents the end of disposal

_disposeLater

protected Mono<Void> _disposeLater(java.time.Duration quietPeriod,
                                   java.time.Duration timeout)

Dispose underlying resources in a listenable fashion. It is guaranteed that the disposal of the underlying LoopResources will not happen before quietPeriod is over. If a task is submitted during the quietPeriod, it is guaranteed to be accepted and the quietPeriod will start over.

Parameters:

quietPeriod - the quiet period as described above

timeout - the maximum amount of time to wait until the disposal of the underlying LoopResources regardless if a task was submitted during the quiet period

Returns:

the Mono that represents the end of disposal

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Disposable

disposeWhen

public void disposeWhen(@NonNull
                        SocketAddress address)

Specified by:

disposeWhen in interface ConnectionProvider

acquire

public Mono<? extends Connection> acquire(Bootstrap bootstrap)

Description copied from interface: ConnectionProvider

Return an existing or new Connection on subscribe.

Specified by:

acquire in interface ConnectionProvider

Parameters:

bootstrap - the client connection Bootstrap

Returns:

an existing or new Mono of Connection

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 <T extends TcpResources> T getOrCreate(AtomicReference<T> ref,
                                                        @Nullable
                                                        LoopResources loops,
                                                        @Nullable
                                                        ConnectionProvider provider,
                                                        java.util.function.BiFunction<LoopResources,ConnectionProvider,T> onNew,
                                                        String name)

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

Type Parameters:

T - the reified type of TcpResources

Parameters:

ref - the resources atomic reference

loops - the eventual new LoopResources

provider - the eventual new ConnectionProvider

onNew - a TcpResources factory

name - a name for resources

Returns:

an existing or new TcpResources