ConnectionPoolSettings (mongo-java-driver 3.0.0-beta3 API)

java.lang.Object
- com.mongodb.connection.ConnectionPoolSettings

```
@Immutable
public class ConnectionPoolSettings
extends Object
```
All settings that relate to the pool of connections to a MongoDB server.

Since:

3.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConnectionPoolSettings.Builder
A builder for creating ConnectionPoolSettings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnectionPoolSettings.Builder` A builder for creating ConnectionPoolSettings.

Method Summary

Methods
Modifier and Type	Method and Description
`static ConnectionPoolSettings.Builder`	`builder()` Gets a Builder for creating a new ConnectionPoolSettings instance.
`boolean`	`equals(Object o)`
`long`	`getMaintenanceFrequency(TimeUnit timeUnit)` Returns the time period between runs of the maintenance job.
`long`	`getMaintenanceInitialDelay(TimeUnit timeUnit)` Returns the period of time to wait before running the first maintenance job on the connection pool.
`long`	`getMaxConnectionIdleTime(TimeUnit timeUnit)` Returns the maximum idle time of a pooled connection.
`long`	`getMaxConnectionLifeTime(TimeUnit timeUnit)` The maximum time a pooled connection can live for.
`int`	`getMaxSize()` The maximum number of connections allowed.
`int`	`getMaxWaitQueueSize()` This is the maximum number of operations that may be waiting for a connection to become available from the pool.
`long`	`getMaxWaitTime(TimeUnit timeUnit)` The maximum time that a thread may wait for a connection to become available.
`int`	`getMinSize()` The minimum number of connections.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static ConnectionPoolSettings.Builder builder()
```
    Gets a Builder for creating a new ConnectionPoolSettings instance.
    
    Returns:
    a new Builder for ConnectionPoolSettings.
  - getMaxSize
```
public int getMaxSize()
```
    The maximum number of connections allowed. Those connections will be kept in the pool when idle. Once the pool is exhausted, any operation requiring a connection will block waiting for an available connection.
    
    Default is 100.
    
    Returns:
    the maximum number of connections in the pool.
  - getMinSize
```
public int getMinSize()
```
    The minimum number of connections. Those connections will be kept in the pool when idle, and the pool will ensure that it contains at least this minimum number.
    
    Default is 0.
    
    Returns:
    the minimum number of connections to have in the pool at all times.
  - getMaxWaitQueueSize
```
public int getMaxWaitQueueSize()
```
    This is the maximum number of operations that may be waiting for a connection to become available from the pool. All further operations will get an exception immediately.
    
    Default is 500.
    
    Returns:
    the number of threads that are allowed to be waiting for a connection.
  - getMaxWaitTime
```
public long getMaxWaitTime(TimeUnit timeUnit)
```
    The maximum time that a thread may wait for a connection to become available.
    
    Default is 2 minutes. A value of 0 means that it will not wait. A negative value means it will wait indefinitely.
    
    Parameters:
    timeUnit - the TimeUnit for this wait period
    
    Returns:
    the maximum amount of time to wait in the given TimeUnits
  - getMaxConnectionLifeTime
```
public long getMaxConnectionLifeTime(TimeUnit timeUnit)
```
    The maximum time a pooled connection can live for. A zero value indicates no limit to the life time. A pooled connection that has exceeded its life time will be closed and replaced when necessary by a new connection.
    
    Parameters:
    timeUnit - the TimeUnit to use for this time period
    
    Returns:
    the maximum length of time a connection can live in the given TimeUnits
  - getMaxConnectionIdleTime
```
public long getMaxConnectionIdleTime(TimeUnit timeUnit)
```
    Returns the maximum idle time of a pooled connection. A zero value indicates no limit to the idle time. A pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection.
    
    Parameters:
    timeUnit - the TimeUnit to use for this time period
    
    Returns:
    the maximum time a connection can be unused, in the given TimeUnits
  - getMaintenanceInitialDelay
```
public long getMaintenanceInitialDelay(TimeUnit timeUnit)
```
    Returns the period of time to wait before running the first maintenance job on the connection pool.
    
    Parameters:
    timeUnit - the TimeUnit to use for this time period
    
    Returns:
    the time period to wait in the given units
  - getMaintenanceFrequency
```
public long getMaintenanceFrequency(TimeUnit timeUnit)
```
    Returns the time period between runs of the maintenance job.
    
    Parameters:
    timeUnit - the TimeUnit to use for this time period
    
    Returns:
    the time period between runs of the maintainance job in the given units
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ConnectionPoolSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getMaxSize

getMinSize

getMaxWaitQueueSize

getMaxWaitTime

getMaxConnectionLifeTime

getMaxConnectionIdleTime

getMaintenanceInitialDelay

getMaintenanceFrequency

equals

hashCode

toString