Module lettuce.core

Package io.lettuce.core.resource

Class DefaultEventLoopGroupProvider

java.lang.Object

io.lettuce.core.resource.DefaultEventLoopGroupProvider

All Implemented Interfaces:

EventLoopGroupProvider

public class DefaultEventLoopGroupProvider
extends Object
implements EventLoopGroupProvider

Default implementation which manages one event loop group instance per type.

Since:

3.4

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultEventLoopGroupProvider.ThreadFactoryProvider	Interface to provide a custom ThreadFactory.

Field Summary

Fields

Modifier and Type	Field	Description
protected static InternalLogger	logger

Constructor Summary

Constructors

Constructor	Description
DefaultEventLoopGroupProvider(int numberOfThreads)	Creates a new instance of DefaultEventLoopGroupProvider.
DefaultEventLoopGroupProvider(int numberOfThreads, DefaultEventLoopGroupProvider.ThreadFactoryProvider threadFactoryProvider)	Creates a new instance of DefaultEventLoopGroupProvider.
DefaultEventLoopGroupProvider(int numberOfThreads, ThreadFactoryProvider threadFactoryProvider)	Creates a new instance of DefaultEventLoopGroupProvider.

Method Summary

Modifier and Type	Method	Description
<T extends EventLoopGroup> T	allocate(Class<T> type)	Retrieve a EventLoopGroup for the channel type.
static <T extends EventExecutorGroup> EventExecutorGroup	createEventLoopGroup(Class<T> type, int numberOfThreads)	Create an instance of a EventExecutorGroup using the default DefaultEventLoopGroupProvider.ThreadFactoryProvider.
protected <T extends EventLoopGroup> EventExecutorGroup	doCreateEventLoopGroup(Class<T> type, int numberOfThreads, ThreadFactoryProvider threadFactoryProvider)	Customization hook for EventLoopGroup creation.
Promise<Boolean>	release(EventExecutorGroup eventLoopGroup, long quietPeriod, long timeout, TimeUnit unit)	Release a eventLoopGroup instance.
Future<Boolean>	shutdown(long quietPeriod, long timeout, TimeUnit timeUnit)	Shutdown the provider and release all instances.
int	threadPoolSize()	Returns the pool size (number of threads) for IO threads.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected static final InternalLogger logger

Constructor Details

DefaultEventLoopGroupProvider

public DefaultEventLoopGroupProvider(int numberOfThreads)

Creates a new instance of DefaultEventLoopGroupProvider.

Parameters:

numberOfThreads - number of threads (pool size)

DefaultEventLoopGroupProvider

public DefaultEventLoopGroupProvider(int numberOfThreads,
DefaultEventLoopGroupProvider.ThreadFactoryProvider threadFactoryProvider)

Creates a new instance of DefaultEventLoopGroupProvider.

Parameters:

numberOfThreads - number of threads (pool size)

threadFactoryProvider - provides access to ThreadFactory.

Since:

6.0

DefaultEventLoopGroupProvider

public DefaultEventLoopGroupProvider(int numberOfThreads,
ThreadFactoryProvider threadFactoryProvider)

Creates a new instance of DefaultEventLoopGroupProvider.

Parameters:

numberOfThreads - number of threads (pool size)

threadFactoryProvider - provides access to ThreadFactoryProvider.

Since:

6.1.1

Method Details

allocate

public <T extends EventLoopGroup> T allocate(Class<T> type)

Description copied from interface: EventLoopGroupProvider

Retrieve a EventLoopGroup for the channel type. Do not terminate or shutdown the instance. Call the EventLoopGroupProvider.release(EventExecutorGroup, long, long, TimeUnit) to release an individual instance or EventLoopGroupProvider.shutdown(long, long, TimeUnit) method to free the all resources.

Specified by:

allocate in interface EventLoopGroupProvider

Type Parameters:

T - type of the EventLoopGroup

Parameters:

type - class of the EventLoopGroup, must not be null

Returns:

the EventLoopGroup.

doCreateEventLoopGroup

protected <T extends EventLoopGroup>
EventExecutorGroup doCreateEventLoopGroup(Class<T> type,
int numberOfThreads,
ThreadFactoryProvider threadFactoryProvider)

Customization hook for EventLoopGroup creation.

Type Parameters:

T -

Parameters:

type - requested event loop group type.

numberOfThreads - number of threads to create.

threadFactoryProvider - provider for ThreadFactory.

Returns:

Since:

6.0

createEventLoopGroup

public static <T extends EventExecutorGroup>
EventExecutorGroup createEventLoopGroup(Class<T> type,
int numberOfThreads)

Create an instance of a EventExecutorGroup using the default DefaultEventLoopGroupProvider.ThreadFactoryProvider. Supported types are:

• DefaultEventExecutorGroup
• NioEventLoopGroup
• EpollEventLoopGroup
• KqueueEventLoopGroup

Type Parameters:

T - type parameter

Parameters:

type - the type

numberOfThreads - the number of threads to use for the EventExecutorGroup

Returns:

a new instance of a EventExecutorGroup

Throws:

IllegalArgumentException - if the type is not supported.

release

public Promise<Boolean> release(EventExecutorGroup eventLoopGroup,
long quietPeriod,
long timeout,
TimeUnit unit)

Description copied from interface: EventLoopGroupProvider

Release a eventLoopGroup instance. The method will shutdown/terminate the EventExecutorGroup if it is no longer needed.

Specified by:

release in interface EventLoopGroupProvider

Parameters:

eventLoopGroup - the eventLoopGroup instance, must not be null

quietPeriod - the quiet period

timeout - the timeout

unit - time unit for the quiet period/the timeout

Returns:

a close future to synchronize the called for shutting down.

threadPoolSize

public int threadPoolSize()

Description copied from interface: EventLoopGroupProvider

Returns the pool size (number of threads) for IO threads. The indicated size does not reflect the number for all IO threads, it is the number of threads that are used to create a particular thread pool.

Specified by:

threadPoolSize in interface EventLoopGroupProvider

Returns:

the pool size (number of threads) for all IO tasks.

shutdown

public Future<Boolean> shutdown(long quietPeriod,
long timeout,
TimeUnit timeUnit)

Description copied from interface: EventLoopGroupProvider

Shutdown the provider and release all instances.

Specified by:

shutdown in interface EventLoopGroupProvider

Parameters:

quietPeriod - the quiet period

timeout - the timeout

timeUnit - the unit of quietPeriod and timeout

Returns:

a close future to synchronize the called for shutting down.