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 java.lang.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, EVENT_LOOPS

Constructor Summary

Constructors

Constructor and Description
DefaultEventLoopGroupConfiguration() Default constructor.
DefaultEventLoopGroupConfiguration(java.lang.String name, int numThreads, java.lang.Integer ioRatio, boolean preferNativeTransport, java.lang.String executor, java.time.Duration shutdownQuietPeriod, java.time.Duration shutdownTimeout) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getExecutorName()
java.util.Optional<java.lang.Integer>	getIoRatio()
java.lang.String	getName()
int	getNumThreads()
java.time.Duration	getShutdownQuietPeriod()
java.time.Duration	getShutdownTimeout()
boolean	isPreferNativeTransport()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEventLoopGroupConfiguration

@ConfigurationInject
public DefaultEventLoopGroupConfiguration(@Parameter
                                                               java.lang.String name,
                                                               @Bindable(defaultValue="0")
                                                               int numThreads,
                                                               @Nullable
                                                               java.lang.Integer ioRatio,
                                                               @Bindable(defaultValue="false")
                                                               boolean preferNativeTransport,
                                                               @Nullable
                                                               java.lang.String executor,
                                                               @Nullable
                                                               java.time.Duration shutdownQuietPeriod,
                                                               @Nullable
                                                               java.time.Duration shutdownTimeout)

Default constructor.

Parameters:

name - The name of the group

numThreads - The number of threads

ioRatio - The IO ratio (optional)

preferNativeTransport - Whether native transport is to be preferred

executor - A named executor service to use (optional)

shutdownQuietPeriod - The shutdown quiet period

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

DefaultEventLoopGroupConfiguration

public DefaultEventLoopGroupConfiguration()

Default constructor.

Method Detail

getNumThreads

public int getNumThreads()

Specified by:

getNumThreads in interface EventLoopGroupConfiguration

Returns:

The number of threads for the event loop

getIoRatio

public java.util.Optional<java.lang.Integer> getIoRatio()

Specified by:

getIoRatio in interface EventLoopGroupConfiguration

Returns:

The I/O ratio.

getExecutorName

public java.util.Optional<java.lang.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

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface Named

Returns:

The name of the component

getShutdownQuietPeriod

public java.time.Duration getShutdownQuietPeriod()

Specified by:

getShutdownQuietPeriod in interface EventLoopGroupConfiguration

Returns:

The shutdown quiet period

getShutdownTimeout

public java.time.Duration getShutdownTimeout()

Specified by:

getShutdownTimeout in interface EventLoopGroupConfiguration

Returns:

The shutdown timeout (must be >= shutdownQuietPeriod)