非同期BlockingCollection <T>のようなものはありますか？

Question 1

非同期awaitの結果を確認したいBlockingCollection<T>.Take()ので、スレッドをブロックしません。このようなものを探しています：

var item = await blockingCollection.TakeAsync();

私はこれができることを知っています：

var item = await Task.Run(() => blockingCollection.Take());

しかし、ThreadPool代わりに（の）別のスレッドがブロックされるため、それはアイデア全体をやや殺します。

代替手段はありますか？

Question 2

私が知っている4つの選択肢があります。

1つ目はChannelsで、非同期Readとをサポートするスレッドセーフキューを提供します。Write操作。チャネルは高度に最適化されており、オプションで、しきい値に達した場合に一部のアイテムをドロップすることをサポートしています。

次はTPLデータフローBufferBlock<T>からです。コンシューマーが1つしかない場合は、またはを使用するか、単にリンクすることができます。詳細については、私のブログを参照してください OutputAvailableAsyncReceiveAsyncActionBlock<T>。

最後の2つは私が作成したタイプで、AsyncExライブラリで利用できます。

AsyncCollection<T>は、とasyncほぼ同等でありBlockingCollection<T>、ConcurrentQueue<T>またはなどの同時プロデューサー/コンシューマーコレクションをラップできConcurrentBag<T>ます。TakeAsyncコレクションからアイテムを非同期的に消費するために使用できます。詳細については、私のブログを参照してください。

AsyncProducerConsumerQueue<T>よりポータブルなasync互換性のある生産者/消費者キューです。を使用DequeueAsyncして、キューからアイテムを非同期に消費できます。詳細については、私のブログを参照してください。

これらの選択肢の最後の3つは、同期および非同期のプットとテイクを可能にします。

Question 3

...またはこれを行うことができます：

using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class AsyncQueue<T>
{
    private readonly SemaphoreSlim _sem;
    private readonly ConcurrentQueue<T> _que;

    public AsyncQueue()
    {
        _sem = new SemaphoreSlim(0);
        _que = new ConcurrentQueue<T>();
    }

    public void Enqueue(T item)
    {
        _que.Enqueue(item);
        _sem.Release();
    }

    public void EnqueueRange(IEnumerable<T> source)
    {
        var n = 0;
        foreach (var item in source)
        {
            _que.Enqueue(item);
            n++;
        }
        _sem.Release(n);
    }

    public async Task<T> DequeueAsync(CancellationToken cancellationToken = default(CancellationToken))
    {
        for (; ; )
        {
            await _sem.WaitAsync(cancellationToken);

            T item;
            if (_que.TryDequeue(out item))
            {
                return item;
            }
        }
    }
}

シンプルで完全に機能する非同期FIFOキュー。

注：SemaphoreSlim.WaitAsyncそれ以前に.NET 4.5で追加されましたが、これはそれほど単純ではありませんでした。

Question 4

これは、BlockingCollection待機をサポートする非常に基本的な実装ですが、多くの機能が不足しています。これはAsyncEnumerableライブラリを使用します。これにより、8.0より前のC＃バージョンで非同期列挙が可能になります。

public class AsyncBlockingCollection<T>
{ // Missing features: cancellation, boundedCapacity, TakeAsync
    private Queue<T> _queue = new Queue<T>();
    private SemaphoreSlim _semaphore = new SemaphoreSlim(0);
    private int _consumersCount = 0;
    private bool _isAddingCompleted;

    public void Add(T item)
    {
        lock (_queue)
        {
            if (_isAddingCompleted) throw new InvalidOperationException();
            _queue.Enqueue(item);
        }
        _semaphore.Release();
    }

    public void CompleteAdding()
    {
        lock (_queue)
        {
            if (_isAddingCompleted) return;
            _isAddingCompleted = true;
            if (_consumersCount > 0) _semaphore.Release(_consumersCount);
        }
    }

    public IAsyncEnumerable<T> GetConsumingEnumerable()
    {
        lock (_queue) _consumersCount++;
        return new AsyncEnumerable<T>(async yield =>
        {
            while (true)
            {
                lock (_queue)
                {
                    if (_queue.Count == 0 && _isAddingCompleted) break;
                }
                await _semaphore.WaitAsync();
                bool hasItem;
                T item = default;
                lock (_queue)
                {
                    hasItem = _queue.Count > 0;
                    if (hasItem) item = _queue.Dequeue();
                }
                if (hasItem) await yield.ReturnAsync(item);
            }
        });
    }
}

使用例：

var abc = new AsyncBlockingCollection<int>();
var producer = Task.Run(async () =>
{
    for (int i = 1; i <= 10; i++)
    {
        await Task.Delay(100);
        abc.Add(i);
    }
    abc.CompleteAdding();
});
var consumer = Task.Run(async () =>
{
    await abc.GetConsumingEnumerable().ForEachAsync(async item =>
    {
        await Task.Delay(200);
        await Console.Out.WriteAsync(item + " ");
    });
});
await Task.WhenAll(producer, consumer);

出力：

1 2 3 4 5 6 7 8 9 10

更新： C＃8のリリースにより、非同期列挙は組み込み言語機能になりました。必要なクラス（IAsyncEnumerable、IAsyncEnumerator）は.NET Core 3.0に組み込まれており、.NET Framework 4.6.1+（Microsoft.Bcl.AsyncInterfaces）のパッケージとして提供されます。

これは、GetConsumingEnumerable新しいC＃8構文を特徴とする代替実装です。

public async IAsyncEnumerable<T> GetConsumingEnumerable()
{
    lock (_queue) _consumersCount++;
    while (true)
    {
        lock (_queue)
        {
            if (_queue.Count == 0 && _isAddingCompleted) break;
        }
        await _semaphore.WaitAsync();
        bool hasItem;
        T item = default;
        lock (_queue)
        {
            hasItem = _queue.Count > 0;
            if (hasItem) item = _queue.Dequeue();
        }
        if (hasItem) yield return item;
    }
}

同じ方法でawaitとyieldが共存していることに注意してください。

使用例（C＃8）：

var consumer = Task.Run(async () =>
{
    await foreach (var item in abc.GetConsumingEnumerable())
    {
        await Task.Delay(200);
        await Console.Out.WriteAsync(item + " ");
    }
});

のawait前に注意してくださいforeach。

Question 5

少しハックしてもかまわない場合は、これらの拡張機能を試すことができます。

public static async Task AddAsync<TEntity>(
    this BlockingCollection<TEntity> Bc, TEntity item, CancellationToken abortCt)
{
    while (true)
    {
        try
        {
            if (Bc.TryAdd(item, 0, abortCt))
                return;
            else
                await Task.Delay(100, abortCt);
        }
        catch (Exception)
        {
            throw;
        }
    }
}

public static async Task<TEntity> TakeAsync<TEntity>(
    this BlockingCollection<TEntity> Bc, CancellationToken abortCt)
{
    while (true)
    {
        try
        {
            TEntity item;

            if (Bc.TryTake(out item, 0, abortCt))
                return item;
            else
                await Task.Delay(100, abortCt);
        }
        catch (Exception)
        {
            throw;
        }
    }
}