org.apache.hc.core5.pool

Class PoolStats

java.lang.Object

org.apache.hc.core5.pool.PoolStats

All Implemented Interfaces:

Serializable

@Contract(threading=IMMUTABLE)
public class PoolStats
extends Object
implements Serializable

Pool statistics.

The total number of connections in the pool is equal to available plus leased.

Since:

4.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PoolStats(int leased, int pending, int free, int max)

Method Summary

Modifier and Type	Method and Description
int	getAvailable() Gets the number idle persistent connections.
int	getLeased() Gets the number of persistent connections tracked by the connection manager currently being used to execute requests.
int	getMax() Gets the maximum number of allowed persistent connections.
int	getPending() Gets the number of connection requests being blocked awaiting a free connection.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolStats

public PoolStats(int leased,
                 int pending,
                 int free,
                 int max)

Method Detail

getAvailable

public int getAvailable()

Gets the number idle persistent connections.

The total number of connections in the pool is equal to available plus leased.

Returns:

number idle persistent connections.

getLeased

public int getLeased()

Gets the number of persistent connections tracked by the connection manager currently being used to execute requests.

The total number of connections in the pool is equal to available plus leased.

Returns:

the number of persistent connections.

getMax

public int getMax()

Gets the maximum number of allowed persistent connections.

Returns:

the maximum number of allowed persistent connections.

getPending

public int getPending()

Gets the number of connection requests being blocked awaiting a free connection. This can happen only if there are more worker threads contending for fewer connections.

Returns:

the number of connection requests being blocked awaiting a free connection.

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.