Class ReactorResourceFactory
- All Implemented Interfaces:
org.springframework.beans.factory.DisposableBean
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.Lifecycle
- Direct Known Subclasses:
ReactorResourceFactory
LoopResources
for
event loop threads, and ConnectionProvider
for the connection pool,
within the lifecycle of a Spring ApplicationContext
.
This factory implements InitializingBean
, DisposableBean
and Lifecycle
and is expected typically to be declared as a
Spring-managed bean.
Notice that after a Lifecycle
stop/restart, new instances of
the configured LoopResources
and ConnectionProvider
are
created, so any references to those should be updated.
- Since:
- 6.1
- Author:
- Rossen Stoyanchev, Brian Clozel, Sebastien Deleuze
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addGlobalResourcesConsumer
(Consumer<reactor.netty.http.HttpResources> consumer) Add a Consumer for configuring the global Reactor Netty resources on startup.void
void
destroy()
reactor.netty.resources.ConnectionProvider
Return the configuredConnectionProvider
.reactor.netty.resources.LoopResources
Return the configuredLoopResources
.boolean
boolean
Whether this factory exposes the globalHttpResources
holder.void
setConnectionProvider
(reactor.netty.resources.ConnectionProvider connectionProvider) Use this when you want to provide an externally managedConnectionProvider
instance.void
setConnectionProviderSupplier
(Supplier<reactor.netty.resources.ConnectionProvider> supplier) Use this when you don't want to participate in global resources and you want to customize the creation of the managedConnectionProvider
.void
setLoopResources
(reactor.netty.resources.LoopResources loopResources) Use this option when you want to provide an externally managedLoopResources
instance.void
setLoopResourcesSupplier
(Supplier<reactor.netty.resources.LoopResources> supplier) Use this when you don't want to participate in global resources and you want to customize the creation of the managedLoopResources
.void
setShutdownQuietPeriod
(Duration shutdownQuietPeriod) Configure the amount of time we'll wait before shutting down resources.void
setShutdownTimeout
(Duration shutdownTimeout) Configure the maximum amount of time to wait until the disposal of the underlying resources regardless if a task was submitted during theshutdownQuietPeriod
.void
setUseGlobalResources
(boolean useGlobalResources) Whether to use global Reactor Netty resources viaHttpResources
.void
start()
void
stop()
-
Constructor Details
-
ReactorResourceFactory
public ReactorResourceFactory()
-
-
Method Details
-
setUseGlobalResources
public void setUseGlobalResources(boolean useGlobalResources) Whether to use global Reactor Netty resources viaHttpResources
.Default is "true" in which case this factory initializes and stops the global Reactor Netty resources within Spring's
ApplicationContext
lifecycle. If set to "false" the factory manages its resources independent of the global ones.- Parameters:
useGlobalResources
- whether to expose and manage the global resources- See Also:
-
isUseGlobalResources
public boolean isUseGlobalResources()Whether this factory exposes the globalHttpResources
holder. -
addGlobalResourcesConsumer
Add a Consumer for configuring the global Reactor Netty resources on startup. When this option is used,setUseGlobalResources(boolean)
is also enabled.- Parameters:
consumer
- the consumer to apply- See Also:
-
setConnectionProviderSupplier
public void setConnectionProviderSupplier(Supplier<reactor.netty.resources.ConnectionProvider> supplier) Use this when you don't want to participate in global resources and you want to customize the creation of the managedConnectionProvider
.By default,
ConnectionProvider.elastic("http")
is used.Note that this option is ignored if
userGlobalResources=false
orsetConnectionProvider(ConnectionProvider)
is set.- Parameters:
supplier
- the supplier to use
-
setConnectionProvider
public void setConnectionProvider(reactor.netty.resources.ConnectionProvider connectionProvider) Use this when you want to provide an externally managedConnectionProvider
instance.- Parameters:
connectionProvider
- the connection provider to use as is
-
getConnectionProvider
public reactor.netty.resources.ConnectionProvider getConnectionProvider()Return the configuredConnectionProvider
. -
setLoopResourcesSupplier
Use this when you don't want to participate in global resources and you want to customize the creation of the managedLoopResources
.By default,
LoopResources.create("reactor-http")
is used.Note that this option is ignored if
userGlobalResources=false
orsetLoopResources(LoopResources)
is set.- Parameters:
supplier
- the supplier to use
-
setLoopResources
public void setLoopResources(reactor.netty.resources.LoopResources loopResources) Use this option when you want to provide an externally managedLoopResources
instance.- Parameters:
loopResources
- the loop resources to use as is
-
getLoopResources
public reactor.netty.resources.LoopResources getLoopResources()Return the configuredLoopResources
. -
setShutdownQuietPeriod
Configure the amount of time we'll wait before shutting down resources. If a task is submitted during theshutdownQuietPeriod
, it is guaranteed to be accepted and theshutdownQuietPeriod
will start over.By default, this is set to
LoopResources.DEFAULT_SHUTDOWN_QUIET_PERIOD
which is 2 seconds but can also be overridden with the system propertyReactorNetty.SHUTDOWN_QUIET_PERIOD
.- See Also:
-
setShutdownTimeout
Configure the maximum amount of time to wait until the disposal of the underlying resources regardless if a task was submitted during theshutdownQuietPeriod
.By default, this is set to
LoopResources.DEFAULT_SHUTDOWN_TIMEOUT
which is 15 seconds but can also be overridden with the system propertyReactorNetty.SHUTDOWN_TIMEOUT
.- See Also:
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
destroy
public void destroy()- Specified by:
destroy
in interfaceorg.springframework.beans.factory.DisposableBean
-
start
public void start()- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
stop
public void stop()- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
isRunning
public boolean isRunning()- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-