Class ConnectionPoolSettings

Namespace

MongoDB.Driver.Core.Configuration

Assembly

MongoDB.Driver.Core.dll

Represents settings for a connection pool.

public class ConnectionPoolSettings

Inheritance

object

ConnectionPoolSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectionPoolSettings(Optional<TimeSpan>, Optional<int>, Optional<int>, Optional<int>, Optional<TimeSpan>, Optional<int>)

Initializes a new instance of the ConnectionPoolSettings class.

public ConnectionPoolSettings(Optional<TimeSpan> maintenanceInterval = default, Optional<int> maxConnections = default, Optional<int> minConnections = default, Optional<int> waitQueueSize = default, Optional<TimeSpan> waitQueueTimeout = default, Optional<int> maxConnecting = default)

Parameters

maintenanceInterval Optional<TimeSpan>

The maintenance interval.

maxConnections Optional<int>

The maximum number of connections.

minConnections Optional<int>

The minimum number of connections.

waitQueueSize Optional<int>

Size of the wait queue.

waitQueueTimeout Optional<TimeSpan>

The wait queue timeout.

maxConnecting Optional<int>

The maximum concurrently connecting connections.

Properties

MaintenanceInterval

Gets the maintenance interval. Infinite values indicates that maintenance thread is disabled.

public TimeSpan MaintenanceInterval { get; }

Property Value

TimeSpan

The maintenance interval.

MaxConnecting

Gets the maximum number of connections a pool may be establishing concurrently. Defaults to 2.

public int MaxConnecting { get; }

Property Value

int

The maximum concurrently connecting connections.

MaxConnections

Gets the maximum number of connections.

public int MaxConnections { get; }

Property Value

int

The maximum number of connections.

MinConnections

Gets the minimum number of connections.

public int MinConnections { get; }

Property Value

int

The minimum number of connections.

WaitQueueSize

Gets the size of the wait queue.

[Obsolete("This property will be removed in a later release.")]
public int WaitQueueSize { get; }

Property Value

int

The size of the wait queue.

WaitQueueTimeout

Gets the wait queue timeout.

public TimeSpan WaitQueueTimeout { get; }

Property Value

TimeSpan

The wait queue timeout.

Methods

With(Optional<TimeSpan>, Optional<int>, Optional<int>, Optional<int>, Optional<TimeSpan>, Optional<int>)

Returns a new ConnectionPoolSettings instance with some settings changed.

public ConnectionPoolSettings With(Optional<TimeSpan> maintenanceInterval = default, Optional<int> maxConnections = default, Optional<int> minConnections = default, Optional<int> waitQueueSize = default, Optional<TimeSpan> waitQueueTimeout = default, Optional<int> maxConnecting = default)

Parameters

maintenanceInterval Optional<TimeSpan>

The maintenance interval.

maxConnections Optional<int>

The maximum connections.

minConnections Optional<int>

The minimum connections.

waitQueueSize Optional<int>

Size of the wait queue.

waitQueueTimeout Optional<TimeSpan>

The wait queue timeout.

maxConnecting Optional<int>

The maximum concurrently connecting connections.

Returns

ConnectionPoolSettings

A new ConnectionPoolSettings instance.