reactor.netty.resources

Interface ConnectionProvider

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

A ConnectionProvider will produce Connection

Since:

0.8

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 (milliseconds) before error.
static int	DEFAULT_POOL_MAX_CONNECTIONS Default max connections.

Method Summary

Modifier and Type	Method and Description
Mono<? extends Connection>	acquire(Bootstrap bootstrap) Return an existing or new Connection on subscribe.
default void	dispose()
default Mono<Void>	disposeLater() Returns a Mono that triggers the disposal of underlying resources when subscribed to.
default void	disposeWhen(SocketAddress address)
static ConnectionProvider	elastic(String name) Create a ConnectionProvider to cache and grow on demand Connection.
static ConnectionProvider	fixed(String name) a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.
static ConnectionProvider	fixed(String name, int maxConnections) Create a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.
static ConnectionProvider	fixed(String name, int maxConnections, long acquireTimeout) Create a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.
default int	maxConnections() Returns the maximum number of connections before starting pending
static ConnectionProvider	newConnection() Return a ConnectionProvider that will always create a new Connection.

Methods inherited from interface reactor.core.Disposable

isDisposed

Field Detail

DEFAULT_POOL_MAX_CONNECTIONS

static final int DEFAULT_POOL_MAX_CONNECTIONS

Default max connections. Fallback to available number of processors (but with a minimum value of 16)

DEFAULT_POOL_ACQUIRE_TIMEOUT

static final long DEFAULT_POOL_ACQUIRE_TIMEOUT

Default acquisition timeout (milliseconds) before error. If -1 will never wait to acquire before opening a new connection in an unbounded fashion. Fallback 45 seconds

Method Detail

newConnection

static ConnectionProvider newConnection()

Return a ConnectionProvider that will always create a new Connection.

Returns:

a ConnectionProvider that will always create a new Connection.

elastic

static ConnectionProvider elastic(String name)

Create a ConnectionProvider to cache and grow on demand Connection.

An elastic ConnectionProvider 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 ConnectionProvider to cache and grow on demand Connection

fixed

static ConnectionProvider fixed(String name)

a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.

A Fixed ConnectionProvider 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 connection pool name

Returns:

a new ConnectionProvider to cache and reuse a fixed maximum number of Connection

fixed

static ConnectionProvider fixed(String name,
                                int maxConnections)

Create a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.

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

Parameters:

name - the connection pool name

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

Returns:

a new ConnectionProvider to cache and reuse a fixed maximum number of Connection

fixed

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

Create a new ConnectionProvider to cache and reuse a fixed maximum number of Connection.

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

Parameters:

name - the connection pool name

maxConnections - the maximum number of connections before starting pending

acquireTimeout - the maximum time in millis to wait for acquiring

Returns:

a new ConnectionProvider to cache and reuse a fixed maximum number of Connection

acquire

Mono<? extends Connection> acquire(Bootstrap bootstrap)

Return an existing or new Connection on subscribe.

Parameters:

bootstrap - the client connection Bootstrap

Returns:

an existing or new Mono of Connection

disposeWhen

default void disposeWhen(@NonNull
                         SocketAddress address)

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.

maxConnections

default int maxConnections()

Returns the maximum number of connections before starting pending

Returns:

the maximum number of connections before starting pending