Class ClusterBuilder

Namespace

MongoDB.Driver.Core.Configuration

Assembly

MongoDB.Driver.Core.dll

Represents a cluster builder.

public class ClusterBuilder

Inheritance

object

ClusterBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ClusterBuilderExtensions.ConfigureWithConnectionString(ClusterBuilder, ConnectionString)

ClusterBuilderExtensions.ConfigureWithConnectionString(ClusterBuilder, ConnectionString, ServerApi)

ClusterBuilderExtensions.ConfigureWithConnectionString(ClusterBuilder, string)

ClusterBuilderExtensions.ConfigureWithConnectionString(ClusterBuilder, string, ServerApi)

ClusterBuilderExtensions.TraceCommandsWith(ClusterBuilder, TraceSource)

ClusterBuilderExtensions.TraceWith(ClusterBuilder, TraceSource)

Constructors

ClusterBuilder()

Initializes a new instance of the ClusterBuilder class.

public ClusterBuilder()

Methods

BuildCluster()

Builds the cluster.

public ICluster BuildCluster()

Returns

ICluster

A cluster.

ConfigureCluster(Func<ClusterSettings, ClusterSettings>)

Configures the cluster settings.

public ClusterBuilder ConfigureCluster(Func<ClusterSettings, ClusterSettings> configurator)

Parameters

configurator Func<ClusterSettings, ClusterSettings>

The cluster settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureConnection(Func<ConnectionSettings, ConnectionSettings>)

Configures the connection settings.

public ClusterBuilder ConfigureConnection(Func<ConnectionSettings, ConnectionSettings> configurator)

Parameters

configurator Func<ConnectionSettings, ConnectionSettings>

The connection settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureConnectionPool(Func<ConnectionPoolSettings, ConnectionPoolSettings>)

Configures the connection pool settings.

public ClusterBuilder ConfigureConnectionPool(Func<ConnectionPoolSettings, ConnectionPoolSettings> configurator)

Parameters

configurator Func<ConnectionPoolSettings, ConnectionPoolSettings>

The connection pool settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureLoggingSettings(Func<LoggingSettings, LoggingSettings>)

Configures the logging settings.

[CLSCompliant(false)]
public ClusterBuilder ConfigureLoggingSettings(Func<LoggingSettings, LoggingSettings> configurator)

Parameters

configurator Func<LoggingSettings, LoggingSettings>

The logging settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureSdamLogging(Func<SdamLoggingSettings, SdamLoggingSettings>)

Configures the SDAM logging settings.

[Obsolete("Use ConfigureLoggingSettings instead.")]
public ClusterBuilder ConfigureSdamLogging(Func<SdamLoggingSettings, SdamLoggingSettings> configurator)

Parameters

configurator Func<SdamLoggingSettings, SdamLoggingSettings>

The SDAM logging settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureServer(Func<ServerSettings, ServerSettings>)

Configures the server settings.

public ClusterBuilder ConfigureServer(Func<ServerSettings, ServerSettings> configurator)

Parameters

configurator Func<ServerSettings, ServerSettings>

The server settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureSsl(Func<SslStreamSettings, SslStreamSettings>)

Configures the SSL stream settings.

public ClusterBuilder ConfigureSsl(Func<SslStreamSettings, SslStreamSettings> configurator)

Parameters

configurator Func<SslStreamSettings, SslStreamSettings>

The SSL stream settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

ConfigureTcp(Func<TcpStreamSettings, TcpStreamSettings>)

Configures the TCP stream settings.

public ClusterBuilder ConfigureTcp(Func<TcpStreamSettings, TcpStreamSettings> configurator)

Parameters

configurator Func<TcpStreamSettings, TcpStreamSettings>

The TCP stream settings configurator delegate.

Returns

ClusterBuilder

A reconfigured cluster builder.

RegisterStreamFactory(Func<IStreamFactory, IStreamFactory>)

Registers a stream factory wrapper.

public ClusterBuilder RegisterStreamFactory(Func<IStreamFactory, IStreamFactory> wrapper)

Parameters

wrapper Func<IStreamFactory, IStreamFactory>

The stream factory wrapper.

Returns

ClusterBuilder

A reconfigured cluster builder.

Subscribe(IEventSubscriber)

Subscribes the specified subscriber.

public ClusterBuilder Subscribe(IEventSubscriber subscriber)

Parameters

subscriber IEventSubscriber

The subscriber.

Returns

ClusterBuilder

A reconfigured cluster builder.

Subscribe<TEvent>(Action<TEvent>)

Subscribes to events of type TEvent.

public ClusterBuilder Subscribe<TEvent>(Action<TEvent> handler)

Parameters

handler Action<TEvent>

The handler.

Returns

ClusterBuilder

A reconfigured cluster builder.

Type Parameters

TEvent

The type of the event.