reactor.ipc.netty.resources

Interface PoolResources

All Superinterfaces:

Disposable

All Known Implementing Classes:

HttpResources, TcpResources

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 PoolResources
extends Disposable

A ChannelPool selector with associated 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 long	DEFAULT_POOL_ACQUIRE_TIMEOUT Default acquisition timeout before error.
static int	DEFAULT_POOL_MAX_CONNECTION Default max connection, if -1 will never wait to acquire before opening new connection in an unbounded fashion.

Method Summary

Modifier and Type	Method and Description
default void	dispose()
default Mono<Void>	disposeLater() Returns a Mono that triggers the disposal of underlying resources when subscribed to.
static PoolResources	elastic(String name) Create an uncapped PoolResources to provide automatically for ChannelPool.
static PoolResources	fixed(String name) Create a capped PoolResources to provide automatically for ChannelPool.
static PoolResources	fixed(String name, int maxConnections) Create a capped PoolResources to provide automatically for ChannelPool.
static PoolResources	fixed(String name, int maxConnections, long acquireTimeout) Create a capped PoolResources to provide automatically for ChannelPool.
ChannelPool	selectOrCreate(SocketAddress address, java.util.function.Supplier<? extends Bootstrap> bootstrap, java.util.function.Consumer<? super Channel> onChannelCreate, EventLoopGroup group) Return an existing or new ChannelPool.

Methods inherited from interface reactor.core.Disposable

isDisposed

Field Detail

DEFAULT_POOL_MAX_CONNECTION

static final int DEFAULT_POOL_MAX_CONNECTION

Default max connection, if -1 will never wait to acquire before opening new connection in an unbounded fashion. Fallback to available number of processors.

DEFAULT_POOL_ACQUIRE_TIMEOUT

static final long DEFAULT_POOL_ACQUIRE_TIMEOUT

Default acquisition timeout before error. If -1 will never wait to acquire before opening new connection in an unbounded fashion.

Method Detail

elastic

static PoolResources elastic(String name)

Create an uncapped PoolResources to provide automatically for ChannelPool.

An elastic PoolResources will never wait before opening a new connection. The reuse window is limited but it cannot starve an undetermined volume of clients using it.

Parameters:

name - the channel pool map name

Returns:

a new PoolResources to provide automatically for ChannelPool

fixed

static PoolResources fixed(String name)

Create a capped PoolResources to provide automatically for ChannelPool.

A Fixed PoolResources will open up to the given max number of processors observed by this jvm (minimum 4). Further connections will be pending acquisition indefinitely.

Parameters:

name - the channel pool map name

Returns:

a new PoolResources to provide automatically for ChannelPool

fixed

static PoolResources fixed(String name,
                           int maxConnections)

Create a capped PoolResources to provide automatically for ChannelPool.

A Fixed PoolResources will open up to the given max connection value. Further connections will be pending acquisition indefinitely.

Parameters:

name - the channel pool map name

maxConnections - the maximum number of connections before starting pending acquisition on existing ones

Returns:

a new PoolResources to provide automatically for ChannelPool

fixed

static PoolResources fixed(String name,
                           int maxConnections,
                           long acquireTimeout)

Create a capped PoolResources to provide automatically for ChannelPool.

A Fixed PoolResources will open up to the given max connection value. Further connections will be pending acquisition indefinitely.

Parameters:

name - the channel pool map name

maxConnections - the maximum number of connections before starting pending

acquireTimeout - the maximum time in millis to wait for aquiring

Returns:

a new PoolResources to provide automatically for ChannelPool

selectOrCreate

ChannelPool selectOrCreate(SocketAddress address,
                           java.util.function.Supplier<? extends Bootstrap> bootstrap,
                           java.util.function.Consumer<? super Channel> onChannelCreate,
                           EventLoopGroup group)

Return an existing or new ChannelPool. The implementation will take care of pulling Bootstrap lazily when a ChannelPool creation is actually needed.

Parameters:

address - the remote address to resolve for existing or new ChannelPool

bootstrap - the Bootstrap supplier if a ChannelPool must be created

onChannelCreate - callback only when new connection is made

Returns:

an existing or new ChannelPool

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.