IRetryableOperation.cs

/* Copyright 2017-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using System.Threading;
using System.Threading.Tasks;

namespace MongoDB.Driver.Core.Operations
{
    /// <summary>
    /// Represents an operation (that may or may not be retryable) that can be executed in a retryable read context.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    public interface IExecutableInRetryableReadContext<TResult>
    {
        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        TResult Execute(RetryableReadContext context, CancellationToken cancellationToken);

        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        Task<TResult> ExecuteAsync(RetryableReadContext context, CancellationToken cancellationToken);
    }

    /// <summary>
    /// Represents an operation (that may or may not be retryable) that can be executed in a retryable write context.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    public interface IExecutableInRetryableWriteContext<TResult>
    {
        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        TResult Execute(RetryableWriteContext context, CancellationToken cancellationToken);

        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        Task<TResult> ExecuteAsync(RetryableWriteContext context, CancellationToken cancellationToken);
    }

    /// <summary>
    /// Represents a retryable read operation.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    public interface IRetryableReadOperation<TResult> : IExecutableInRetryableReadContext<TResult>
    {
        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="attempt">The attempt.</param>
        /// <param name="transactionNumber">The transaction number.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        TResult ExecuteAttempt(RetryableReadContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken);

        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="attempt">The attempt.</param>
        /// <param name="transactionNumber">The transaction number.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        Task<TResult> ExecuteAttemptAsync(RetryableReadContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken);
    }

    /// <summary>
    /// Represents a retryable write operation.
    /// </summary>
    /// <typeparam name="TResult">The type of the result.</typeparam>
    public interface IRetryableWriteOperation<TResult> : IExecutableInRetryableWriteContext<TResult>
    {
        /// <summary>
        /// Gets the write concern for the operation.
        /// </summary>
        WriteConcern WriteConcern { get; }

        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="attempt">The attempt.</param>
        /// <param name="transactionNumber">The transaction number.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        TResult ExecuteAttempt(RetryableWriteContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken);

        /// <summary>
        /// Executes the first attempt.
        /// </summary>
        /// <param name="context">The context.</param>
        /// <param name="attempt">The attempt.</param>
        /// <param name="transactionNumber">The transaction number.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
        /// <returns>The result.</returns>
        Task<TResult> ExecuteAttemptAsync(RetryableWriteContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken);
    }
}