QueueConfiguration.cs

namespace osu.Server.QueueProcessor
{
    public class QueueConfiguration
    {
        /// <summary>
        /// The queue to read from.
        /// </summary>
        public string InputQueueName { get; set; } = "default";

        /// <summary>
        /// The time between polls (in the case a poll returns no items).
        /// </summary>
        public int TimeBetweenPolls { get; set; } = 100;

        /// <summary>
        /// The number of items allowed to be dequeued but not processed at one time.
        /// </summary>
        public int MaxInFlightItems { get; set; } = 100;

        /// <summary>
        /// The number of times to re-queue a failed item for another attempt.
        /// </summary>
        public int MaxRetries { get; set; } = 3;

        /// <summary>
        /// The maximum number of recent errors before exiting with an error.
        /// </summary>
        /// <remarks>
        /// Every error will increment an internal count, while every success will decrement it.
        /// </remarks>
        public int ErrorThreshold { get; set; } = 10;

        /// <summary>
        /// Setting above 1 will allow processing in batches (see <see cref="QueueProcessor{T}.ProcessResults"/>).
        /// </summary>
        public int BatchSize { get; set; } = 1;

        /// <summary>
        /// When enabled, uses <c>BRPOP</c> to wait for items instead of polling with <c>RPOP</c>.
        /// </summary>
        /// <remarks>
        /// <see cref="BatchSize"/> is ignored when this is enabled.
        /// <see cref="TimeBetweenPolls"/> is still used as a delay for when processor is overloaded.
        /// </remarks>
        public bool UseBlockingPop { get; set; } = false;
    }
}