Class ReadPreferenceBinding

Namespace

MongoDB.Driver.Core.Bindings

Assembly

MongoDB.Driver.Core.dll

Represents a read binding to a cluster using a ReadPreference to select the server.

public sealed class ReadPreferenceBinding : IReadBinding, IBinding, IDisposable

Inheritance

object

ReadPreferenceBinding

Implements

IReadBinding

IBinding

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReadPreferenceBinding(ICluster, ReadPreference, ICoreSessionHandle)

Initializes a new instance of the ReadPreferenceBinding class.

public ReadPreferenceBinding(ICluster cluster, ReadPreference readPreference, ICoreSessionHandle session)

Parameters

cluster ICluster

The cluster.

readPreference ReadPreference

The read preference.

session ICoreSessionHandle

The session.

Properties

ReadPreference

Gets the read preference.

public ReadPreference ReadPreference { get; }

Property Value

ReadPreference

The read preference.

Session

Gets the session.

public ICoreSessionHandle Session { get; }

Property Value

ICoreSessionHandle

The session.

Methods

Dispose()

public void Dispose()

GetReadChannelSource(CancellationToken)

Gets a channel source for read operations.

public IChannelSourceHandle GetReadChannelSource(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

IChannelSourceHandle

A channel source.

GetReadChannelSourceAsync(CancellationToken)

Gets a channel source for read operations.

public Task<IChannelSourceHandle> GetReadChannelSourceAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IChannelSourceHandle>

A channel source.