public class TcpResources extends Object implements ConnectionProvider, LoopResources
ConnectionProvider.Builder, ConnectionProvider.ConnectionPoolSpec<SPEC extends ConnectionProvider.ConnectionPoolSpec<SPEC>>, ConnectionProvider.HostSpecificSpec, ConnectionProvider.MeterRegistrarDisposable.Composite, Disposable.SwapDEFAULT_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_LIFODEFAULT_IO_SELECT_COUNT, DEFAULT_IO_WORKER_COUNT, DEFAULT_NATIVE, DEFAULT_SHUTDOWN_QUIET_PERIOD, DEFAULT_SHUTDOWN_TIMEOUT| Modifier | Constructor and Description |
|---|---|
protected |
TcpResources(LoopResources defaultLoops,
ConnectionProvider defaultProvider) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_dispose()
Dispose underlying resources
|
protected Mono<Void> |
_disposeLater()
Deprecated.
as of 0.9.3. 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()
|
Mono<Void> |
disposeLater()
|
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 TCP resources for event loops and pooling
|
protected static <T extends TcpResources> |
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() |
<CHANNEL extends Channel> |
onChannel(Class<CHANNEL> channelType,
EventLoopGroup group)
Callback for a
Channel selection. |
Class<? extends Channel> |
onChannel(EventLoopGroup group)
Callback for client or generic channel factory selection.
|
<CHANNEL extends Channel> |
onChannelClass(Class<CHANNEL> channelType,
EventLoopGroup group)
Callback for a
Channel class 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,
this is the EventLoopGroup for the child channel. |
Class<? extends ServerChannel> |
onServerChannel(EventLoopGroup group)
Callback for server channel factory selection.
|
EventLoopGroup |
onServerSelect(boolean useNative)
Callback for server select
EventLoopGroup creation,
this is the EventLoopGroup for the acceptor channel. |
boolean |
preferNative()
Return true if should default to native
EventLoopGroup and 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbuilder, create, create, elastic, elastic, elastic, fixed, fixed, fixed, fixed, fixed, maxConnections, newConnectioncolocate, create, create, create, disposeLater, hasNativeSupportprotected TcpResources(LoopResources defaultLoops, ConnectionProvider defaultProvider)
public static TcpResources get()
public static TcpResources set(ConnectionProvider provider)
ConnectionProvider will be disposed.provider - a new ConnectionProvider to replace the currentpublic static TcpResources set(LoopResources loops)
LoopResources will be disposed.loops - a new LoopResources to replace the currentpublic static TcpResources reset()
public static void disposeLoopsAndConnections()
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.public static Mono<Void> disposeLoopsAndConnectionsLater()
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 15sMono triggering the disposeLoopsAndConnections() when subscribed to.public static Mono<Void> disposeLoopsAndConnectionsLater(java.time.Duration quietPeriod, java.time.Duration timeout)
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.quietPeriod - the quiet period as described abovetimeout - the maximum amount of time to wait until the disposal of the underlying
LoopResources regardless if a task was submitted during the quiet periodMono triggering the disposeLoopsAndConnections() when subscribed to.public void dispose()
dispose in interface Disposabledispose in interface ConnectionProviderdispose in interface LoopResourcespublic Mono<Void> disposeLater()
disposeLater in interface ConnectionProviderdisposeLater in interface LoopResourcesprotected void _dispose()
@Deprecated protected Mono<Void> _disposeLater()
_disposeLater(Duration, Duration)2s and the timeout will be 15sprotected Mono<Void> _disposeLater(java.time.Duration quietPeriod, java.time.Duration timeout)
quietPeriod is over. If a task is submitted during the quietPeriod,
it is guaranteed to be accepted and the quietPeriod will start over.quietPeriod - the quiet period as described abovetimeout - the maximum amount of time to wait until the disposal of the underlying
LoopResources regardless if a task was submitted during the quiet periodpublic boolean isDisposed()
isDisposed in interface Disposablepublic void disposeWhen(@NonNull SocketAddress address)
disposeWhen in interface ConnectionProviderpublic Mono<? extends Connection> acquire(Bootstrap bootstrap)
ConnectionProviderConnection on subscribe.acquire in interface ConnectionProviderbootstrap - the client connection BootstrapMono of Connectionpublic Class<? extends Channel> onChannel(EventLoopGroup group)
LoopResourcesonChannel in interface LoopResourcesgroup - the source EventLoopGroup to assign a loop fromClass target for the underlying Channel factorypublic <CHANNEL extends Channel> CHANNEL onChannel(Class<CHANNEL> channelType, EventLoopGroup group)
LoopResourcesChannel selection.onChannel in interface LoopResourcesCHANNEL - the Channel implementationchannelType - the channel typegroup - the source EventLoopGroup to assign a loop fromChannel instancepublic <CHANNEL extends Channel> Class<? extends CHANNEL> onChannelClass(Class<CHANNEL> channelType, EventLoopGroup group)
LoopResourcesChannel class selection.onChannelClass in interface LoopResourcesCHANNEL - the Channel implementationchannelType - the channel typegroup - the source EventLoopGroup to assign a loop fromChannel classpublic EventLoopGroup onClient(boolean useNative)
LoopResourcesEventLoopGroup creation.onClient in interface LoopResourcesuseNative - should use native group if current environment supports itEventLoopGrouppublic Class<? extends DatagramChannel> onDatagramChannel(EventLoopGroup group)
LoopResourcesonDatagramChannel in interface LoopResourcesgroup - the source EventLoopGroup to assign a loop fromClass target for the underlying Channel factorypublic EventLoopGroup onServer(boolean useNative)
LoopResourcesEventLoopGroup creation,
this is the EventLoopGroup for the child channel.onServer in interface LoopResourcesuseNative - should use native group if current environment supports itEventLoopGrouppublic Class<? extends ServerChannel> onServerChannel(EventLoopGroup group)
LoopResourcesonServerChannel in interface LoopResourcesgroup - the source EventLoopGroup to assign a loop fromClass target for the underlying ServerChannel factorypublic EventLoopGroup onServerSelect(boolean useNative)
LoopResourcesEventLoopGroup creation,
this is the EventLoopGroup for the acceptor channel.onServerSelect in interface LoopResourcesuseNative - should use native group if current environment supports itEventLoopGrouppublic boolean preferNative()
LoopResourcesEventLoopGroup and ChannelpreferNative in interface LoopResourcesEventLoopGroup and Channelpublic boolean daemon()
LoopResourcesEventLoopGroup should not be shutdowndaemon in interface LoopResourcesEventLoopGroup should not be shutdownprotected 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)
T - the reified type of TcpResourcesref - the resources atomic referenceloops - the eventual new LoopResourcesprovider - the eventual new ConnectionProvideronNew - a TcpResources factoryname - a name for resourcesTcpResources