reactor.netty.tcp

Class TcpResources

java.lang.Object

reactor.netty.tcp.TcpResources

All Implemented Interfaces:

reactor.core.Disposable, ConnectionProvider, LoopResources

Direct Known Subclasses:

HttpResources

public class TcpResources
extends java.lang.Object
implements ConnectionProvider, LoopResources

Hold the default Tcp resources

Since:

0.6

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.netty.resources.ConnectionProvider

ConnectionProvider.Builder, ConnectionProvider.ConnectionPoolSpec<SPEC extends ConnectionProvider.ConnectionPoolSpec<SPEC>>, ConnectionProvider.HostSpecificSpec, ConnectionProvider.MeterRegistrar

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

reactor.core.Disposable.Composite, reactor.core.Disposable.Swap

Field Summary

Fields inherited from interface reactor.netty.resources.ConnectionProvider

DEFAULT_POOL_ACQUIRE_TIMEOUT, DEFAULT_POOL_LEASING_STRATEGY, DEFAULT_POOL_MAX_CONNECTIONS, DEFAULT_POOL_MAX_IDLE_TIME, DEFAULT_POOL_MAX_LIFE_TIME, LEASING_STRATEGY_FIFO, LEASING_STRATEGY_LIFO

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 reactor.core.publisher.Mono<java.lang.Void>	_disposeLater(java.time.Duration quietPeriod, java.time.Duration timeout) Dispose underlying resources in a listenable fashion.
reactor.core.publisher.Mono<? extends Connection>	acquire(TransportConfig config, ConnectionObserver observer, java.util.function.Supplier<? extends java.net.SocketAddress> remoteAddress, io.netty.resolver.AddressResolverGroup<?> resolverGroup) Return an existing or new Connection on subscribe.
boolean	daemon() return true if EventLoopGroup should not be shutdown
void	dispose() Use disposeLoopsAndConnections()
reactor.core.publisher.Mono<java.lang.Void>	disposeLater() Use disposeLoopsAndConnectionsLater()
static void	disposeLoopsAndConnections() Shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones.
static reactor.core.publisher.Mono<java.lang.Void>	disposeLoopsAndConnectionsLater() Prepare to shutdown the global TcpResources without resetting them, effectively cleaning up associated resources without creating new ones.
static reactor.core.publisher.Mono<java.lang.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(java.net.SocketAddress address)
static TcpResources	get() Return the global TCP resources for event loops and pooling
protected static <T extends TcpResources> T	getOrCreate(java.util.concurrent.atomic.AtomicReference<T> ref, LoopResources loops, ConnectionProvider provider, java.util.function.BiFunction<LoopResources,ConnectionProvider,T> onNew, java.lang.String name) Safely check if existing resource exist and proceed to update/cleanup if new resources references are passed.
boolean	isDisposed()
int	maxConnections() Returns the maximum number of connections before starting pending
java.util.Map<java.net.SocketAddress,java.lang.Integer>	maxConnectionsPerHost() Returns the maximum number of connections per host before starting pending
<CHANNEL extends io.netty.channel.Channel> CHANNEL	onChannel(java.lang.Class<CHANNEL> channelType, io.netty.channel.EventLoopGroup group) Callback for a Channel selection.
<CHANNEL extends io.netty.channel.Channel> java.lang.Class<? extends CHANNEL>	onChannelClass(java.lang.Class<CHANNEL> channelType, io.netty.channel.EventLoopGroup group) Callback for a Channel class selection.
io.netty.channel.EventLoopGroup	onClient(boolean useNative) Callback for client EventLoopGroup creation.
io.netty.channel.EventLoopGroup	onServer(boolean useNative) Callback for server EventLoopGroup creation, this is the EventLoopGroup for the child channel.
io.netty.channel.EventLoopGroup	onServerSelect(boolean useNative) Callback for server select EventLoopGroup creation, this is the EventLoopGroup for the acceptor channel.
static TcpResources	reset() Reset TCP resources to default and return its instance
static TcpResources	set(ConnectionProvider provider) Update pooling resources and return the global TCP resources.
static TcpResources	set(LoopResources loops) Update event loops resources and return the global TCP 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

builder, create, create, newConnection

Methods inherited from interface reactor.netty.resources.LoopResources

colocate, create, create, create, disposeLater, hasNativeSupport

Constructor Detail

TcpResources

protected TcpResources(LoopResources defaultLoops,
                       ConnectionProvider defaultProvider)

Method Detail

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 reactor.core.publisher.Mono<java.lang.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 reactor.core.publisher.Mono<java.lang.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.

Since:

0.9.3

get

public static TcpResources get()

Return the global TCP resources for event loops and pooling

Returns:

the global TCP resources for event loops and pooling

reset

public static TcpResources reset()

Reset TCP resources to default and return its instance

Returns:

the global TCP resources

set

public static TcpResources set(ConnectionProvider provider)

Update pooling resources and return the global TCP resources. Note: The previous ConnectionProvider will be disposed.

Parameters:

provider - a new ConnectionProvider to replace the current

Returns:

the global TCP resources

set

public static TcpResources set(LoopResources loops)

Update event loops resources and return the global TCP resources. Note: The previous LoopResources will be disposed.

Parameters:

loops - a new LoopResources to replace the current

Returns:

the global TCP resources

acquire

public reactor.core.publisher.Mono<? extends Connection> acquire(TransportConfig config,
                                                                 ConnectionObserver observer,
                                                                 @Nullable
                                                                 java.util.function.Supplier<? extends java.net.SocketAddress> remoteAddress,
                                                                 @Nullable
                                                                 io.netty.resolver.AddressResolverGroup<?> resolverGroup)

Description copied from interface: ConnectionProvider

Return an existing or new Connection on subscribe.

Specified by:

acquire in interface ConnectionProvider

Parameters:

config - the transport configuration

observer - the ConnectionObserver

remoteAddress - the SocketAddress to connect to

resolverGroup - the resolver which will resolve the address of the unresolved named address

Returns:

an existing or new Mono of Connection

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

dispose

public void dispose()

Use disposeLoopsAndConnections()

Specified by:

dispose in interface reactor.core.Disposable

Specified by:

dispose in interface ConnectionProvider

Specified by:

dispose in interface LoopResources

disposeLater

public reactor.core.publisher.Mono<java.lang.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.

disposeWhen

public void disposeWhen(java.net.SocketAddress address)

Specified by:

disposeWhen in interface ConnectionProvider

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface reactor.core.Disposable

maxConnections

public int maxConnections()

Description copied from interface: ConnectionProvider

Returns the maximum number of connections before starting pending

Specified by:

maxConnections in interface ConnectionProvider

Returns:

the maximum number of connections before starting pending

maxConnectionsPerHost

public java.util.Map<java.net.SocketAddress,java.lang.Integer> maxConnectionsPerHost()

Description copied from interface: ConnectionProvider

Returns the maximum number of connections per host before starting pending

Specified by:

maxConnectionsPerHost in interface ConnectionProvider

Returns:

the maximum number of connections per host before starting pending

onChannel

public <CHANNEL extends io.netty.channel.Channel> CHANNEL onChannel(java.lang.Class<CHANNEL> channelType,
                                                                    io.netty.channel.EventLoopGroup group)

Description copied from interface: LoopResources

Callback for a Channel selection.

Specified by:

onChannel in interface LoopResources

Type Parameters:

CHANNEL - the Channel implementation

Parameters:

channelType - the channel type

group - the source EventLoopGroup to assign a loop from

Returns:

a Channel instance

onChannelClass

public <CHANNEL extends io.netty.channel.Channel> java.lang.Class<? extends CHANNEL> onChannelClass(java.lang.Class<CHANNEL> channelType,
                                                                                                    io.netty.channel.EventLoopGroup group)

Description copied from interface: LoopResources

Callback for a Channel class selection.

Specified by:

onChannelClass in interface LoopResources

Type Parameters:

CHANNEL - the Channel implementation

Parameters:

channelType - the channel type

group - the source EventLoopGroup to assign a loop from

Returns:

a Channel class

onClient

public io.netty.channel.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 environment supports it

Returns:

a new EventLoopGroup

onServer

public io.netty.channel.EventLoopGroup onServer(boolean useNative)

Description copied from interface: LoopResources

Callback for server EventLoopGroup creation, this is the EventLoopGroup for the child channel.

Specified by:

onServer in interface LoopResources

Parameters:

useNative - should use native group if current environment supports it

Returns:

a new EventLoopGroup

onServerSelect

public io.netty.channel.EventLoopGroup onServerSelect(boolean useNative)

Description copied from interface: LoopResources

Callback for server select EventLoopGroup creation, this is the EventLoopGroup for the acceptor channel.

Specified by:

onServerSelect in interface LoopResources

Parameters:

useNative - should use native group if current environment supports it

Returns:

a new EventLoopGroup

_dispose

protected void _dispose()

Dispose underlying resources

_disposeLater

protected reactor.core.publisher.Mono<java.lang.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

getOrCreate

protected static <T extends TcpResources> T getOrCreate(java.util.concurrent.atomic.AtomicReference<T> ref,
                                                        @Nullable
                                                        LoopResources loops,
                                                        @Nullable
                                                        ConnectionProvider provider,
                                                        java.util.function.BiFunction<LoopResources,ConnectionProvider,T> onNew,
                                                        java.lang.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