io.micronaut.http.client

Class HttpClientConfiguration.ConnectionPoolConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration

All Implemented Interfaces:

Toggleable

Direct Known Subclasses:

DefaultHttpClientConfiguration.DefaultConnectionPoolConfiguration, ServiceHttpClientConfiguration.ServiceConnectionPoolConfiguration

Enclosing class:

HttpClientConfiguration

public static class HttpClientConfiguration.ConnectionPoolConfiguration
extends java.lang.Object
implements Toggleable

Configuration for the HTTP client connnection pool.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static int	DEFAULT_MAXCONNECTIONS The default max connections value.
static java.lang.String	PREFIX The prefix to use for configuration.

Constructor Summary

Constructors

Constructor and Description
ConnectionPoolConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.time.Duration>	getAcquireTimeout() The time to wait to acquire a connection.
int	getMaxConnections() The maximum number of connections.
int	getMaxPendingAcquires() Maximum number of futures awaiting connection acquisition.
boolean	isEnabled() Whether connection pooling is enabled.
void	setAcquireTimeout(java.time.Duration acquireTimeout) Sets the timeout to wait for a connection.
void	setEnabled(boolean enabled) Sets whether connection pooling is enabled.
void	setMaxConnections(int maxConnections) Sets the maximum number of connections.
void	setMaxPendingAcquires(int maxPendingAcquires) Sets the max pending acquires.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

The prefix to use for configuration.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_MAXCONNECTIONS

public static final int DEFAULT_MAXCONNECTIONS

The default max connections value.

See Also:

Constant Field Values

Constructor Detail

ConnectionPoolConfiguration

public ConnectionPoolConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

Whether connection pooling is enabled.

Specified by:

isEnabled in interface Toggleable

Returns:

True if connection pooling is enabled

setEnabled

public void setEnabled(boolean enabled)

Sets whether connection pooling is enabled. Default value (false).

Parameters:

enabled - True if it is enabled

getMaxConnections

public int getMaxConnections()

The maximum number of connections. Defaults to (-1); no maximum.

Returns:

The max connections

setMaxConnections

public void setMaxConnections(int maxConnections)

Sets the maximum number of connections. Defaults to no maximum.

Parameters:

maxConnections - The count

getMaxPendingAcquires

public int getMaxPendingAcquires()

Maximum number of futures awaiting connection acquisition. Defaults to no maximum.

Returns:

The max pending requires

setMaxPendingAcquires

public void setMaxPendingAcquires(int maxPendingAcquires)

Sets the max pending acquires.

Parameters:

maxPendingAcquires - The max pending acquires

getAcquireTimeout

public java.util.Optional<java.time.Duration> getAcquireTimeout()

The time to wait to acquire a connection.

Returns:

The timeout as a duration.

setAcquireTimeout

public void setAcquireTimeout(@Nullable
                              java.time.Duration acquireTimeout)

Sets the timeout to wait for a connection.

Parameters:

acquireTimeout - The acquire timeout