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

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()
default Mono<Void>	disposeLater() Returns a Mono that triggers the disposal of underlying resources when subscribed to.
default Class<? extends Channel>	onChannel(EventLoopGroup group) Callback for client or generic channel factory selection.
default EventLoopGroup	onClient(boolean useNative) Callback for client EventLoopGroup creation.
default Class<? extends DatagramChannel>	onDatagramChannel(EventLoopGroup group) Callback for UDP channel factory selection.
EventLoopGroup	onServer(boolean useNative) Callback for server EventLoopGroup creation.
default Class<? extends ServerChannel>	onServerChannel(EventLoopGroup group) Callback for server channel factory selection.
default EventLoopGroup	onServerSelect(boolean useNative) Create a server select EventLoopGroup for servers to be used
default boolean	preferNative() Return true if should default to native EventLoopGroup and Channel

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

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

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

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

onClient

default EventLoopGroup onClient(boolean useNative)

Callback for client EventLoopGroup creation.

Parameters:

useNative - should use native group if current preferNative() is also true

Returns:

a new EventLoopGroup

onDatagramChannel

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

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.

Parameters:

useNative - should use native group if current preferNative() is also true

Returns:

a new EventLoopGroup

onServerChannel

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

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)

Create a server select EventLoopGroup for servers to be used

Parameters:

useNative - should use native group if current preferNative() is also true

Returns:

a new EventLoopGroup

preferNative

default boolean preferNative()

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()

Specified by:

dispose in interface Disposable

disposeLater

default Mono<Void> disposeLater()

Returns a Mono that triggers the disposal of underlying resources when subscribed to.

Returns:

a Mono representing the completion of resources disposal.