Package io.quarkus.runtime.shutdown

Class ShutdownConfig

java.lang.Object

io.quarkus.runtime.shutdown.ShutdownConfig

@ConfigRoot(phase=RUN_TIME)
public class ShutdownConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<Duration>	delay	Delay between shutdown being requested and actually initiated.
Optional<Duration>	timeout	The timeout to wait for running requests to finish.

Constructor Summary

Constructors

Constructor	Description
ShutdownConfig()

Method Summary

Modifier and Type	Method	Description
boolean	isDelaySet()
boolean	isShutdownTimeoutSet()

Methods inherited from class java.lang.Object

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

Field Details

timeout

@ConfigItem
public Optional<Duration> timeout

The timeout to wait for running requests to finish. If this is not set then the application will exit immediately. Setting this timeout will incur a small performance penalty, as it requires active requests to be tracked.

delay

@ConfigItem
public Optional<Duration> delay

Delay between shutdown being requested and actually initiated. Also called the pre-shutdown phase. In pre-shutdown, the server continues working as usual, except a readiness probe starts reporting "down" (if the smallrye-health extension is present). This gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. Notice that this property will only take effect if quarkus.shutdown.delay-enabled is explicitly set to true.

Constructor Details

ShutdownConfig

public ShutdownConfig()

Method Details

isShutdownTimeoutSet

public boolean isShutdownTimeoutSet()

isDelaySet

public boolean isDelaySet()