reactor.netty.resources

Interface LoopResources

All Superinterfaces:

Disposable

All Known Implementing Classes:

HttpResources, TcpResources, UdpResources

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface LoopResources
extends Disposable

An EventLoopGroup selector with associated Channel factories.

Since:

0.6

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_IO_SELECT_COUNT Default selector thread count, fallback to -1 (no selector thread)
static int	DEFAULT_IO_WORKER_COUNT Default worker thread count, fallback to available processor (but with a minimum value of 4)
static boolean	DEFAULT_NATIVE Default value whether the native transport (epoll, kqueue) will be preferred, fallback it will be preferred when available
static long	DEFAULT_SHUTDOWN_QUIET_PERIOD Default quite period that guarantees that the disposal of the underlying LoopResources will not happen, fallback to 2 seconds.
static long	DEFAULT_SHUTDOWN_TIMEOUT Default maximum amount of time to wait until the disposal of the underlying LoopResources regardless if a task was submitted during the quiet period, fallback to 15 seconds.

Method Summary

Modifier and Type	Method and Description
static EventLoopGroup	colocate(EventLoopGroup group) Create a delegating EventLoopGroup which reuse local event loop if already working inside one.
static LoopResources	create(String prefix) Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories
static LoopResources	create(String prefix, int workerCount, boolean daemon) Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories
static LoopResources	create(String prefix, int selectCount, int workerCount, boolean daemon) Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories
default boolean	daemon() return true if EventLoopGroup should not be shutdown
default void	dispose() Dispose the underlying LoopResources.
default Mono<Void>	disposeLater() Returns a Mono that triggers the disposal of the underlying LoopResources when subscribed to.
default Mono<Void>	disposeLater(java.time.Duration quietPeriod, java.time.Duration timeout) Returns a Mono that triggers the disposal of the underlying LoopResources when subscribed to.
static boolean	hasNativeSupport() Returns true if native transport is available.
default <CHANNEL extends Channel> CHANNEL	onChannel(Class<CHANNEL> channelType, EventLoopGroup group) Callback for a Channel selection.
default Class<? extends Channel>	onChannel(EventLoopGroup group) Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)
default <CHANNEL extends Channel> Class<? extends CHANNEL>	onChannelClass(Class<CHANNEL> channelType, EventLoopGroup group) Callback for a Channel class selection.
default EventLoopGroup	onClient(boolean useNative) Callback for client EventLoopGroup creation.
default Class<? extends DatagramChannel>	onDatagramChannel(EventLoopGroup group) Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)
EventLoopGroup	onServer(boolean useNative) Callback for server EventLoopGroup creation, this is the EventLoopGroup for the child channel.
default Class<? extends ServerChannel>	onServerChannel(EventLoopGroup group) Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)
default EventLoopGroup	onServerSelect(boolean useNative) Callback for server select EventLoopGroup creation, this is the EventLoopGroup for the acceptor channel.
default boolean	preferNative() Deprecated. as of 0.9.8. Use hasNativeSupport()

Methods inherited from interface reactor.core.Disposable

isDisposed

Field Detail

DEFAULT_IO_WORKER_COUNT

static final int DEFAULT_IO_WORKER_COUNT

Default worker thread count, fallback to available processor (but with a minimum value of 4)

DEFAULT_IO_SELECT_COUNT

static final int DEFAULT_IO_SELECT_COUNT

Default selector thread count, fallback to -1 (no selector thread)

DEFAULT_NATIVE

static final boolean DEFAULT_NATIVE

Default value whether the native transport (epoll, kqueue) will be preferred, fallback it will be preferred when available

DEFAULT_SHUTDOWN_QUIET_PERIOD

static final long DEFAULT_SHUTDOWN_QUIET_PERIOD

Default quite period that guarantees that the disposal of the underlying LoopResources will not happen, fallback to 2 seconds.

DEFAULT_SHUTDOWN_TIMEOUT

static final long DEFAULT_SHUTDOWN_TIMEOUT

Default maximum amount of time to wait until the disposal of the underlying LoopResources regardless if a task was submitted during the quiet period, fallback to 15 seconds.

Method Detail

colocate

static EventLoopGroup colocate(EventLoopGroup group)

Create a delegating EventLoopGroup which reuse local event loop if already working inside one.

Parameters:

group - the EventLoopGroup to decorate

Returns:

a decorated EventLoopGroup that will colocate executions on the same thread stack

create

static LoopResources create(String prefix,
                            int workerCount,
                            boolean daemon)

Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories

Parameters:

prefix - the event loop thread name prefix

workerCount - number of worker threads

daemon - should the thread be released on jvm shutdown

Returns:

a new LoopResources to provide automatically for EventLoopGroup and Channel factories

create

static LoopResources create(String prefix,
                            int selectCount,
                            int workerCount,
                            boolean daemon)

Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories

Parameters:

prefix - the event loop thread name prefix

selectCount - number of selector threads

workerCount - number of worker threads

daemon - should the thread be released on jvm shutdown

Returns:

a new LoopResources to provide automatically for EventLoopGroup and Channel factories

create

static LoopResources create(String prefix)

Create a simple LoopResources to provide automatically for EventLoopGroup and Channel factories

Parameters:

prefix - the event loop thread name prefix

Returns:

a new LoopResources to provide automatically for EventLoopGroup and Channel factories

onChannel

@Deprecated
default Class<? extends Channel> onChannel(EventLoopGroup group)

Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)

Callback for client or generic channel factory selection.

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying Channel factory

onChannel

default <CHANNEL extends Channel> CHANNEL onChannel(Class<CHANNEL> channelType,
                                                    EventLoopGroup group)

Callback for a Channel selection.

Type Parameters:

CHANNEL - the Channel implementation

Parameters:

channelType - the channel type

group - the source EventLoopGroup to assign a loop from

Returns:

a Channel instance

onChannelClass

default <CHANNEL extends Channel> Class<? extends CHANNEL> onChannelClass(Class<CHANNEL> channelType,
                                                                          EventLoopGroup group)

Callback for a Channel class selection.

Type Parameters:

CHANNEL - the Channel implementation

Parameters:

channelType - the channel type

group - the source EventLoopGroup to assign a loop from

Returns:

a Channel class

onClient

default EventLoopGroup onClient(boolean useNative)

Callback for client EventLoopGroup creation.

Parameters:

useNative - should use native group if current environment supports it

Returns:

a new EventLoopGroup

onDatagramChannel

@Deprecated
default Class<? extends DatagramChannel> onDatagramChannel(EventLoopGroup group)

Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)

Callback for UDP channel factory selection.

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying Channel factory

onServer

EventLoopGroup onServer(boolean useNative)

Callback for server EventLoopGroup creation, this is the EventLoopGroup for the child channel.

Parameters:

useNative - should use native group if current environment supports it

Returns:

a new EventLoopGroup

onServerChannel

@Deprecated
default Class<? extends ServerChannel> onServerChannel(EventLoopGroup group)

Deprecated. as of 0.9.8. See onChannel(Class, EventLoopGroup)

Callback for server channel factory selection.

Parameters:

group - the source EventLoopGroup to assign a loop from

Returns:

a Class target for the underlying ServerChannel factory

onServerSelect

default EventLoopGroup onServerSelect(boolean useNative)

Callback for server select EventLoopGroup creation, this is the EventLoopGroup for the acceptor channel.

Parameters:

useNative - should use native group if current environment supports it

Returns:

a new EventLoopGroup

preferNative

@Deprecated
default boolean preferNative()

Deprecated. as of 0.9.8. Use hasNativeSupport()

Return true if should default to native EventLoopGroup and Channel

Returns:

true if should default to native EventLoopGroup and Channel

daemon

default boolean daemon()

return true if EventLoopGroup should not be shutdown

Returns:

true if EventLoopGroup should not be shutdown

dispose

default void dispose()

Dispose the underlying LoopResources. This method is NOT blocking. It is implemented as fire-and-forget. Use disposeLater() when you need to observe the final status of the operation, combined with Mono.block() if you need to synchronously wait for the underlying resources to be disposed.

Specified by:

dispose in interface Disposable

disposeLater

default Mono<Void> disposeLater()

Returns a Mono that triggers the disposal of the underlying LoopResources when subscribed to. The quiet period will be 2s and the timeout will be 15s

Returns:

a Mono representing the completion of the LoopResources disposal.

disposeLater

default Mono<Void> disposeLater(java.time.Duration quietPeriod,
                                java.time.Duration timeout)

Returns a Mono that triggers the disposal of the underlying LoopResources when subscribed to. It is guaranteed that the disposal of the underlying LoopResources will not happen before quietPeriod is over. If a task is submitted during the quietPeriod, it is guaranteed to be accepted and the quietPeriod will start over.

Parameters:

quietPeriod - the quiet period as described above

timeout - the maximum amount of time to wait until the disposal of the underlying LoopResources regardless if a task was submitted during the quiet period

Returns:

a Mono representing the completion of the LoopResources disposal.

Since:

0.9.3

hasNativeSupport

static boolean hasNativeSupport()

Returns true if native transport is available.

Returns:

true if native transport is available