Class RetryableReadContext

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents a context for retryable reads.

public sealed class RetryableReadContext : IDisposable

Inheritance

object

RetryableReadContext

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RetryableReadContext(IReadBinding, bool)

Initializes a new instance of the RetryableReadContext class.

public RetryableReadContext(IReadBinding binding, bool retryRequested)

Parameters

binding IReadBinding

The binding.

retryRequested bool

if set to true the operation can be retried.

See Also

IDisposable

Properties

Binding

Gets the binding.

public IReadBinding Binding { get; }

Property Value

IReadBinding

The binding.

See Also

IDisposable

Channel

Gets the channel.

public IChannelHandle Channel { get; }

Property Value

IChannelHandle

The channel.

See Also

IDisposable

ChannelSource

Gets the channel source.

public IChannelSourceHandle ChannelSource { get; }

Property Value

IChannelSourceHandle

The channel source.

See Also

IDisposable

RetryRequested

Gets a value indicating whether the operation can be retried.

public bool RetryRequested { get; }

Property Value

bool

true if the operation can be retried; otherwise, false.

See Also

IDisposable

Methods

Create(IReadBinding, bool, CancellationToken)

Creates and initializes a retryable read operation context.

public static RetryableReadContext Create(IReadBinding binding, bool retryRequested, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

retryRequested bool

if set to true [retry requested].

cancellationToken CancellationToken

The cancellation token.

Returns

RetryableReadContext

A retryable read context.

See Also

IDisposable

CreateAsync(IReadBinding, bool, CancellationToken)

Creates and initializes a retryable read operation context.

public static Task<RetryableReadContext> CreateAsync(IReadBinding binding, bool retryRequested, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

retryRequested bool

if set to true [retry requested].

cancellationToken CancellationToken

The cancellation token.

Returns

Task<RetryableReadContext>

A retryable read context.

See Also

IDisposable

Dispose()

public void Dispose()

See Also

IDisposable

ReplaceChannel(IChannelHandle)

Replaces the channel.

public void ReplaceChannel(IChannelHandle channel)

Parameters

channel IChannelHandle

The channel.

See Also

IDisposable

ReplaceChannelSource(IChannelSourceHandle)

Replaces the channel source.

public void ReplaceChannelSource(IChannelSourceHandle channelSource)

Parameters

channelSource IChannelSourceHandle

The channel source.

See Also

IDisposable

See Also

IDisposable