Class ConnectionSettings

Namespace

MongoDB.Driver.Core.Configuration

Assembly

MongoDB.Driver.Core.dll

Represents settings for a connection.

public class ConnectionSettings

Inheritance

object

ConnectionSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectionSettings(Optional<IEnumerable<IAuthenticatorFactory>>, Optional<IEnumerable<CompressorConfiguration>>, Optional<bool>, Optional<TimeSpan>, Optional<TimeSpan>, Optional<string>)

Initializes a new instance of the ConnectionSettings class.

public ConnectionSettings(Optional<IEnumerable<IAuthenticatorFactory>> authenticatorFactories = default, Optional<IEnumerable<CompressorConfiguration>> compressors = default, Optional<bool> loadBalanced = default, Optional<TimeSpan> maxIdleTime = default, Optional<TimeSpan> maxLifeTime = default, Optional<string> applicationName = default)

Parameters

authenticatorFactories Optional<IEnumerable<IAuthenticatorFactory>>

The authenticator factories.

compressors Optional<IEnumerable<CompressorConfiguration>>

The compressors.

loadBalanced Optional<bool>

Whether the load balanced mode is enabled.

maxIdleTime Optional<TimeSpan>

The maximum idle time.

maxLifeTime Optional<TimeSpan>

The maximum life time.

applicationName Optional<string>

The application name.

Properties

ApplicationName

Gets the name of the application.

public string ApplicationName { get; }

Property Value

string

The name of the application.

AuthenticatorFactories

Gets the authenticator factories.

public IReadOnlyList<IAuthenticatorFactory> AuthenticatorFactories { get; }

Property Value

IReadOnlyList<IAuthenticatorFactory>

The authenticator factories.

Compressors

Gets the compressors.

public IReadOnlyList<CompressorConfiguration> Compressors { get; }

Property Value

IReadOnlyList<CompressorConfiguration>

The compressors.

LoadBalanced

Whether the load balanced mode is enabled.

public bool LoadBalanced { get; }

Property Value

bool

MaxIdleTime

Gets the maximum idle time.

public TimeSpan MaxIdleTime { get; }

Property Value

TimeSpan

The maximum idle time.

MaxLifeTime

Gets the maximum life time.

public TimeSpan MaxLifeTime { get; }

Property Value

TimeSpan

The maximum life time.

Methods

With(Optional<IEnumerable<IAuthenticatorFactory>>, Optional<IEnumerable<CompressorConfiguration>>, Optional<bool>, Optional<TimeSpan>, Optional<TimeSpan>, Optional<string>)

Returns a new ConnectionSettings instance with some settings changed.

public ConnectionSettings With(Optional<IEnumerable<IAuthenticatorFactory>> authenticatorFactories = default, Optional<IEnumerable<CompressorConfiguration>> compressors = default, Optional<bool> loadBalanced = default, Optional<TimeSpan> maxIdleTime = default, Optional<TimeSpan> maxLifeTime = default, Optional<string> applicationName = default)

Parameters

authenticatorFactories Optional<IEnumerable<IAuthenticatorFactory>>

The authenticator factories.

compressors Optional<IEnumerable<CompressorConfiguration>>

The compressors.

loadBalanced Optional<bool>

Whether the load balanced mode is enabled.

maxIdleTime Optional<TimeSpan>

The maximum idle time.

maxLifeTime Optional<TimeSpan>

The maximum life time.

applicationName Optional<string>

The application name.

Returns

ConnectionSettings

A new ConnectionSettings instance.