ожидаемая очередь на основе задач

Я не знаю решения без блокировки, но вы можете взглянуть на новый библиотека потоков данных, часть асинхронной CTP. Достаточно простого BufferBlock<T>, например:

BufferBlock<int> buffer = new BufferBlock<int>();

Производство и потребление проще всего выполнять с помощью методов расширения типов блоков потока данных.

Производство так же просто, как:

buffer.Post(13);

и потребление готово к асинхронности:

int item = await buffer.ReceiveAsync();

Я рекомендую вам использовать Dataflow, если это возможно; сделать такой буфер одновременно эффективным и правильным сложнее, чем кажется на первый взгляд.

Простой подход с C# 8.0 IAsyncEnumerable и библиотекой потоков данных

// Instatiate an async queue
var queue = new AsyncQueue<int>();

// Then, loop through the elements of queue.
// This loop won't stop until it is canceled or broken out of
// (for that, use queue.WithCancellation(..) or break;)
await foreach(int i in queue) {
    // Writes a line as soon as some other Task calls queue.Enqueue(..)
    Console.WriteLine(i);
}

С реализацией AsyncQueue следующим образом:

public class AsyncQueue<T> : IAsyncEnumerable<T>
{
    private readonly SemaphoreSlim _enumerationSemaphore = new SemaphoreSlim(1);
    private readonly BufferBlock<T> _bufferBlock = new BufferBlock<T>();

    public void Enqueue(T item) =>
        _bufferBlock.Post(item);

    public async IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken token = default)
    {
        // We lock this so we only ever enumerate once at a time.
        // That way we ensure all items are returned in a continuous
        // fashion with no 'holes' in the data when two foreach compete.
        await _enumerationSemaphore.WaitAsync();
        try {
            // Return new elements until cancellationToken is triggered.
            while (true) {
                // Make sure to throw on cancellation so the Task will transfer into a canceled state
                token.ThrowIfCancellationRequested();
                yield return await _bufferBlock.ReceiveAsync(token);
            }
        } finally {
            _enumerationSemaphore.Release();
        }

    }
}

Один простой и легкий способ реализовать это с помощью SemaphoreSlim:

public class AwaitableQueue<T>
{
    private SemaphoreSlim semaphore = new SemaphoreSlim(0);
    private readonly object queueLock = new object();
    private Queue<T> queue = new Queue<T>();

    public void Enqueue(T item)
    {
        lock (queueLock)
        {
            queue.Enqueue(item);
            semaphore.Release();
        }
    }

    public T WaitAndDequeue(TimeSpan timeSpan, CancellationToken cancellationToken)
    {
        semaphore.Wait(timeSpan, cancellationToken);
        lock (queueLock)
        {
            return queue.Dequeue();
        }
    }

    public async Task<T> WhenDequeue(TimeSpan timeSpan, CancellationToken cancellationToken)
    {
        await semaphore.WaitAsync(timeSpan, cancellationToken);
        lock (queueLock)
        {
            return queue.Dequeue();
        }
    }
}

Прелесть этого в том, что SemaphoreSlim берет на себя всю сложность реализации функций Wait() и WaitAsync(). Недостатком является то, что длина очереди отслеживается как семафором , так и самой очередью, и они оба волшебным образом остаются синхронизированными.

Теперь есть официальный способ сделать это: System.Threading.Channels. Он встроен в основную среду выполнения в .NET Core 3.0 и выше (включая .NET 5.0 и 6.0), но также доступен в виде пакета NuGet в .NET Standard 2.0 и 2.1. Вы можете ознакомиться с документацией здесь.

var channel = System.Threading.Channels.Channel.CreateUnbounded<int>();

// This will succeed and finish synchronously if the channel is unbounded.
channel.Writer.TryWrite(42);

channel.Writer.TryComplete();

var i = await channel.Reader.ReadAsync();

await foreach (int i in channel.Reader.ReadAllAsync())
{
    // whatever processing on i...
}

Моя попытка (событие возникает, когда создается «обещание», и его может использовать внешний производитель, чтобы узнать, когда производить больше предметов):

public class AsyncQueue<T>
{
    private ConcurrentQueue<T> _bufferQueue;
    private ConcurrentQueue<TaskCompletionSource<T>> _promisesQueue;
    private object _syncRoot = new object();

    public AsyncQueue()
    {
        _bufferQueue = new ConcurrentQueue<T>();
        _promisesQueue = new ConcurrentQueue<TaskCompletionSource<T>>();
    }

    /// <summary>
    /// Enqueues the specified item.
    /// </summary>
    /// <param name="item">The item.</param>
    public void Enqueue(T item)
    {
        TaskCompletionSource<T> promise;
        do
        {
            if (_promisesQueue.TryDequeue(out promise) &&
                !promise.Task.IsCanceled &&
                promise.TrySetResult(item))
            {
                return;                                       
            }
        }
        while (promise != null);

        lock (_syncRoot)
        {
            if (_promisesQueue.TryDequeue(out promise) &&
                !promise.Task.IsCanceled &&
                promise.TrySetResult(item))
            {
                return;
            }

            _bufferQueue.Enqueue(item);
        }            
    }

    /// <summary>
    /// Dequeues the asynchronous.
    /// </summary>
    /// <param name="cancellationToken">The cancellation token.</param>
    /// <returns></returns>
    public Task<T> DequeueAsync(CancellationToken cancellationToken)
    {
        T item;

        if (!_bufferQueue.TryDequeue(out item))
        {
            lock (_syncRoot)
            {
                if (!_bufferQueue.TryDequeue(out item))
                {
                    var promise = new TaskCompletionSource<T>();
                    cancellationToken.Register(() => promise.TrySetCanceled());

                    _promisesQueue.Enqueue(promise);
                    this.PromiseAdded.RaiseEvent(this, EventArgs.Empty);

                    return promise.Task;
                }
            }
        }

        return Task.FromResult(item);
    }

    /// <summary>
    /// Gets a value indicating whether this instance has promises.
    /// </summary>
    /// <value>
    /// <c>true</c> if this instance has promises; otherwise, <c>false</c>.
    /// </value>
    public bool HasPromises
    {
        get { return _promisesQueue.Where(p => !p.Task.IsCanceled).Count() > 0; }
    }

    /// <summary>
    /// Occurs when a new promise
    /// is generated by the queue
    /// </summary>
    public event EventHandler PromiseAdded;
}

Это может быть излишним для вашего варианта использования (учитывая кривую обучения), но Реактивные расширения обеспечивает все необходимое для асинхронной композиции.

По сути, вы подписываетесь на изменения, и они передаются вам по мере их появления, и вы можете сделать так, чтобы система отправляла изменения в отдельный поток.

Проверьте https://github.com/somdoron/AsyncCollection, вы можете как асинхронно удалять из очереди, так и использовать C# 8.0 IAsyncEnumerable.

API очень похож на BlockingCollection.

AsyncCollection<int> collection = new AsyncCollection<int>();

var t = Task.Run(async () =>
{
    while (!collection.IsCompleted)
    {
        var item = await collection.TakeAsync();

        // process
    }
});

for (int i = 0; i < 1000; i++)
{
    collection.Add(i);
}

collection.CompleteAdding();

t.Wait();

С IAsyncEnumeable:

AsyncCollection<int> collection = new AsyncCollection<int>();

var t = Task.Run(async () =>
{
    await foreach (var item in collection)
    {
        // process
    }
});

for (int i = 0; i < 1000; i++)
{
    collection.Add(i);
}

collection.CompleteAdding();

t.Wait();

Вот реализация, которую я сейчас использую.

public class MessageQueue<T>
{
    ConcurrentQueue<T> queue = new ConcurrentQueue<T>();
    ConcurrentQueue<TaskCompletionSource<T>> waitingQueue = 
        new ConcurrentQueue<TaskCompletionSource<T>>();
    object queueSyncLock = new object();
    public void Enqueue(T item)
    {
        queue.Enqueue(item);
        ProcessQueues();
    }

    public async Task<T> DequeueAsync(CancellationToken ct)
    {
        TaskCompletionSource<T> tcs = new TaskCompletionSource<T>();
        ct.Register(() =>
        {
            lock (queueSyncLock)
            {
                tcs.TrySetCanceled();
            }
        });
        waitingQueue.Enqueue(tcs);
        ProcessQueues();
        return tcs.Task.IsCompleted ? tcs.Task.Result : await tcs.Task;
    }

    private void ProcessQueues()
    {
        TaskCompletionSource<T> tcs = null;
        T firstItem = default(T);
        lock (queueSyncLock)
        {
            while (true)
            {
                if (waitingQueue.TryPeek(out tcs) && queue.TryPeek(out firstItem))
                {
                    waitingQueue.TryDequeue(out tcs);
                    if (tcs.Task.IsCanceled)
                    {
                        continue;
                    }
                    queue.TryDequeue(out firstItem);
                }
                else
                {
                    break;
                }
                tcs.SetResult(firstItem);
            }
        }
    }
}

Он работает достаточно хорошо, но на queueSyncLock довольно много разногласий, так как я довольно часто использую CancellationToken для отмены некоторых ожидающих задач. Конечно, это приводит к значительно меньшей блокировке, которую я бы увидел с BlockingCollection, но...

Мне интересно, есть ли более гладкие средства без блокировки для достижения той же цели

Ну, 8 лет спустя я столкнулся с этим самым вопросом и собирался реализовать класс MS AsyncQueue<T>, найденный в пакете/пространстве имен nuget: Microsoft.VisualStudio.Threading

Спасибо @Theodor Zoulias за упоминание, что этот API может быть устаревшим, и библиотека DataFlow была бы хорошей альтернативой.

Поэтому я отредактировал свою реализацию AsyncQueue‹>, чтобы использовать BufferBlock‹>. Почти то же самое, но работает лучше.

Я использую это в фоновом потоке AspNet Core, и он работает полностью асинхронно.

protected async Task MyRun()
{
    BufferBlock<MyObj> queue = new BufferBlock<MyObj>();
    Task enqueueTask = StartDataIteration(queue);

    while (await queue.OutputAvailableAsync())
    {
        var myObj = queue.Receive();
        // do something with myObj
    }

}

public async Task StartDataIteration(BufferBlock<MyObj> queue)
{
    var cursor = await RunQuery();
    while(await cursor.Next()) { 
        queue.Post(cursor.Current);
    }
    queue.Complete(); // <<< signals the consumer when queue.Count reaches 0
}

Я обнаружил, что использование queue.OutputAvailableAsync() устранило проблему, которая у меня была с AsyncQueue‹> — попытка определить, когда очередь была завершена, и не нужно проверять задачу удаления из очереди.

Вы можете просто использовать BlockingCollection (используя ConcurrentQueue по умолчанию) и обернуть вызов Take в Task, чтобы вы могли await его:

var bc = new BlockingCollection<T>();

T element = await Task.Run( () => bc.Take() );