PollingOptions.cs

Go to the documentation of this file.

using System;
using System.Threading;
 
namespace AnalyzeRe
{
    public class PollingOptions
    {
        public static PollingOptions Default => new PollingOptions();
 
        public int MinPollInterval { get; } = 0;
 
        public int MaxPollInterval { get; } = 10 * 1000;
 
        public int MaxPollTotalTime { get; } = Int32.MaxValue;
 
        public double BackoffRate { get; } = 2.0d;
 
        public CancellationToken? CancellationToken { get; }
 
        public PollingOptions(
            int? minPollInterval = null,
            int? maxPollInterval = null,
            int? maxPollTotalTime = null,
            double? backoffRate = null,
            CancellationToken? cancellationToken = null)
        {
            if (minPollInterval.HasValue)
                MinPollInterval = minPollInterval.Value;
            if (maxPollInterval.HasValue)
                MaxPollInterval = maxPollInterval.Value;
            if (maxPollTotalTime.HasValue)
                MaxPollTotalTime = maxPollTotalTime.Value;
            if (backoffRate.HasValue)
                BackoffRate = backoffRate.Value;
            if (MinPollInterval < 0)
                throw new ArgumentOutOfRangeException(nameof(minPollInterval),
                    "Value must be greater than or equal to zero.");
            if (BackoffRate < 1d)
                throw new ArgumentOutOfRangeException(nameof(backoffRate),
                    "Value must be greater than or equal to 1.");
            if (MinPollInterval > MaxPollInterval)
                throw new ArgumentOutOfRangeException(nameof(minPollInterval),
                    "Value must be less than or equal to " + nameof(maxPollInterval) + ".");
            if (MaxPollTotalTime < 0)
                throw new ArgumentOutOfRangeException(nameof(maxPollTotalTime),
                    "Value must be greater than or equal to zero.");
            CancellationToken = cancellationToken;
        }
 
        public int GetNextPollTime(int lastTimeWaited, int totalTimeWaited)
        {
            int nextTime = lastTimeWaited == 0 ? 1 : lastTimeWaited;
            // Round up so that even small back-off rates result in a minimum 1 ms increase.
            nextTime = (int)Math.Ceiling(nextTime * BackoffRate);
            // If this would be greater than the amount of time left before we
            // time out, make the next request sooner.
            if (nextTime + totalTimeWaited > MaxPollTotalTime)
                nextTime = MaxPollTotalTime - totalTimeWaited;
            // Bound the wait time between the min and max intervals specified.
            return nextTime > MaxPollInterval ? MaxPollInterval :
                nextTime < MinPollInterval ? MinPollInterval : nextTime;
        }
    }
 
    public static partial class API
    {
        [Obsolete("This class has moved to the AnalyzeRe namespace. " +
            "You should remove the `API` prefix.")]
        public class PollingOptions : AnalyzeRe.PollingOptions
        {
            [Obsolete("This class has moved to the AnalyzeRe namespace. " +
                "You should remove the `API` prefix.")]
            public PollingOptions(
                int? minPollInterval = null,
                int? maxPollInterval = null,
                int? maxPollTotalTime = null,
                double? backoffRate = null,
                CancellationToken? cancellationToken = null)
                : base(minPollInterval, maxPollInterval, maxPollTotalTime,
                       backoffRate, cancellationToken)
            {
            }
        }
    }
}