Package io.micronaut.http.netty.channel

Class DefaultEventLoopGroupConfiguration

java.lang.Object

io.micronaut.http.netty.channel.DefaultEventLoopGroupConfiguration

All Implemented Interfaces:

Named, EventLoopGroupConfiguration

@EachProperty(value="micronaut.netty.event-loops",
              primary="default")
public class DefaultEventLoopGroupConfiguration
extends Object
implements EventLoopGroupConfiguration

Configuration interface for event loop configuration.

Since:

2.0

Author:

graemerocher

Field Summary

Fields inherited from interface io.micronaut.http.netty.channel.EventLoopGroupConfiguration

DEFAULT, DEFAULT_LOOP, DEFAULT_SHUTDOWN_QUIET_PERIOD, DEFAULT_SHUTDOWN_TIMEOUT, DEFAULT_THREAD_CORE_RATIO, EVENT_LOOPS

Constructor Summary

Constructors

Constructor	Description
DefaultEventLoopGroupConfiguration()	Default constructor.
DefaultEventLoopGroupConfiguration(String name, int numThreads, double threadCoreRatio, @Nullable Integer ioRatio, boolean preferNativeTransport, @Nullable List<String> transport, @Nullable String executor, @Nullable Duration shutdownQuietPeriod, @Nullable Duration shutdownTimeout, boolean loomCarrier)	Default constructor.
DefaultEventLoopGroupConfiguration(String name, int numThreads, double threadCoreRatio, Integer ioRatio, boolean preferNativeTransport, String executor, Duration shutdownQuietPeriod, Duration shutdownTimeout, boolean loomCarrier)	Deprecated.
DefaultEventLoopGroupConfiguration(String name, int numThreads, Integer ioRatio, boolean preferNativeTransport, String executor, Duration shutdownQuietPeriod, Duration shutdownTimeout)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getExecutorName()
Optional<Integer>	getIoRatio()
@NonNull String	getName()
int	getNumThreads()
Duration	getShutdownQuietPeriod()
Duration	getShutdownTimeout()
double	getThreadCoreRatio()	The number of threads per core to use if EventLoopGroupConfiguration.getNumThreads() is set to 0.
@NonNull List<String>	getTransport()	The transports to use for this event loop, in order of preference.
boolean	isLoomCarrier()
boolean	isPreferNativeTransport()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventLoopGroupConfiguration

@ConfigurationInject
public DefaultEventLoopGroupConfiguration(@Parameter
 String name,
 @Bindable(defaultValue="0")
 int numThreads,
 @Bindable(defaultValue="1.0")
 double threadCoreRatio,
 @Nullable
 @Nullable Integer ioRatio,
 @Bindable(defaultValue="false")
 boolean preferNativeTransport,
 @Nullable
 @Nullable List<String> transport,
 @Nullable
 @Nullable String executor,
 @Nullable
 @Nullable Duration shutdownQuietPeriod,
 @Nullable
 @Nullable Duration shutdownTimeout,
 @Bindable(defaultValue="false")
 boolean loomCarrier)

Default constructor.

Parameters:

name - The name of the group

numThreads - The number of threads

threadCoreRatio - The number of threads per core to use if getNumThreads() is set to 0.

ioRatio - The IO ratio (optional)

preferNativeTransport - Whether native transport is to be preferred

transport - The transports to use for this event loop, in order of preference. Supported values are io_uring,epoll,kqueue,nio. The first available transport out of those listed will be used (nio is always available). If no listed transport is available, an exception will be thrown.

By default, only nio is used, even if native transports are available. If the legacy prefer-native-transport property is set to true, this defaults to io_uring,epoll,kqueue,nio.

executor - A named executor service to use for event loop threads (optional). This property is very specialized. In particular, it will not solve read timeouts or fix blocking operations on the event loop, in fact it may do the opposite. Don't use unless you really know what this does.

shutdownQuietPeriod - The shutdown quiet period

shutdownTimeout - The shutdown timeout (must be >= shutdownQuietPeriod)

loomCarrier - When set to true, use a special experimental event loop that can also execute virtual threads, in order to improve virtual thread performance.

DefaultEventLoopGroupConfiguration

@Deprecated
public DefaultEventLoopGroupConfiguration(String name,
 int numThreads,
 double threadCoreRatio,
 Integer ioRatio,
 boolean preferNativeTransport,
 String executor,
 Duration shutdownQuietPeriod,
 Duration shutdownTimeout,
 boolean loomCarrier)

Deprecated.

DefaultEventLoopGroupConfiguration

@Deprecated
public DefaultEventLoopGroupConfiguration(String name,
 int numThreads,
 Integer ioRatio,
 boolean preferNativeTransport,
 String executor,
 Duration shutdownQuietPeriod,
 Duration shutdownTimeout)

Deprecated.

DefaultEventLoopGroupConfiguration

public DefaultEventLoopGroupConfiguration()

Default constructor.

Method Details

getNumThreads

public int getNumThreads()

Specified by:

getNumThreads in interface EventLoopGroupConfiguration

Returns:

The number of threads for the event loop

getThreadCoreRatio

public double getThreadCoreRatio()

Description copied from interface: EventLoopGroupConfiguration

The number of threads per core to use if EventLoopGroupConfiguration.getNumThreads() is set to 0.

Specified by:

getThreadCoreRatio in interface EventLoopGroupConfiguration

Returns:

The thread-to-core ratio

getIoRatio

public Optional<Integer> getIoRatio()

Specified by:

getIoRatio in interface EventLoopGroupConfiguration

Returns:

The I/O ratio.

getExecutorName

public Optional<String> getExecutorName()

Specified by:

getExecutorName in interface EventLoopGroupConfiguration

Returns:

The name of the executor to use.

isPreferNativeTransport

public boolean isPreferNativeTransport()

Specified by:

isPreferNativeTransport in interface EventLoopGroupConfiguration

Returns:

Whether to prefer the native transport

getTransport

@NonNull
public @NonNull List<String> getTransport()

Description copied from interface: EventLoopGroupConfiguration

The transports to use for this event loop, in order of preference. Supported values are io_uring,epoll,kqueue,nio. The first available transport out of those listed will be used (nio is always available). If no listed transport is available, an exception will be thrown.

By default, only nio is used, even if native transports are available. If the legacy prefer-native-transport property is set to true, this defaults to io_uring,epoll,kqueue,nio.

Specified by:

getTransport in interface EventLoopGroupConfiguration

Returns:

The available transports, in order of preference

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface Named

Returns:

The name of the component

getShutdownQuietPeriod

public Duration getShutdownQuietPeriod()

Specified by:

getShutdownQuietPeriod in interface EventLoopGroupConfiguration

Returns:

The shutdown quiet period

getShutdownTimeout

public Duration getShutdownTimeout()

Specified by:

getShutdownTimeout in interface EventLoopGroupConfiguration

Returns:

The shutdown timeout (must be >= shutdownQuietPeriod)

isLoomCarrier

public boolean isLoomCarrier()

Specified by:

isLoomCarrier in interface EventLoopGroupConfiguration

Returns:

When set to true, use a special experimental event loop that can also execute virtual threads, in order to improve virtual thread performance.