Gibt es so etwas wie asynchrone BlockingCollection <T>?

Ich möchte awaitauf das Ergebnis von BlockingCollection<T>.Take()asynchron, damit ich den Thread nicht blockiere. Auf der Suche nach so etwas:

var item = await blockingCollection.TakeAsync();

Ich weiß, dass ich das tun kann:

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

aber das tötet irgendwie die ganze Idee, weil ThreadPoolstattdessen ein anderer Thread (von ) blockiert wird.

Gibt es eine Alternative?

Ich kenne vier Alternativen.

Der erste ist Channels , der eine threadsichere Warteschlange bereitstellt, die Asynchronität Readund WriteOperationen unterstützt. Kanäle sind stark optimiert und unterstützen optional das Löschen einiger Elemente, wenn ein Schwellenwert erreicht wird.

Der nächste stammt BufferBlock<T>aus dem TPL-Datenfluss . Wenn Sie nur einen einzigen Verbraucher haben, können Sie OutputAvailableAsyncoder verwenden ReceiveAsyncoder einfach mit einem verknüpfen ActionBlock<T>. Weitere Informationen finden Sie in meinem Blog .

Die letzten beiden sind von mir erstellte Typen, die in meiner AsyncEx-Bibliothek verfügbar sind .

AsyncCollection<T>ist asyncnahezu gleichwertig mit BlockingCollection<T>, in der Lage, eine gleichzeitige Produzenten- / Verbrauchersammlung wie ConcurrentQueue<T>oder zu verpacken ConcurrentBag<T>. Sie können TakeAsyncdamit Elemente aus der Sammlung asynchron konsumieren. Weitere Informationen finden Sie in meinem Blog .

AsyncProducerConsumerQueue<T>ist eine tragbarere asynckompatible Produzenten- / Konsumentenwarteschlange. Sie können DequeueAsyncdamit Elemente aus der Warteschlange asynchron konsumieren. Weitere Informationen finden Sie in meinem Blog .

Die letzten drei dieser Alternativen ermöglichen synchrone und asynchrone Puts und Takes.

... oder Sie können dies tun:

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;
            }
        }
    }
}

Einfache, voll funktionsfähige asynchrone FIFO-Warteschlange.

Hinweis: SemaphoreSlim.WaitAsyncWurde zuvor in .NET 4.5 hinzugefügt, war dies nicht ganz einfach.

Hier ist eine sehr grundlegende Implementierung von a BlockingCollection, die das Warten unterstützt, mit vielen fehlenden Funktionen. Es verwendet die AsyncEnumerableBibliothek, die eine asynchrone Aufzählung für C # -Versionen ermöglicht, die älter als 8.0 sind.

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);
            }
        });
    }
}

Anwendungsbeispiel:

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);

Ausgabe:

1 2 3 4 5 6 7 8 9 10

Update: Mit der Veröffentlichung von C # 8 ist die asynchrone Aufzählung zu einer integrierten Sprachfunktion geworden. Die erforderlichen Klassen ( IAsyncEnumerable, IAsyncEnumerator) sind in .NET Core 3.0 eingebettet und werden als Paket für .NET Framework 4.6.1+ ( Microsoft.Bcl.AsyncInterfaces ) angeboten.

Hier ist eine alternative GetConsumingEnumerableImplementierung mit der neuen C # 8-Syntax:

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;
    }
}

Beachten Sie die Koexistenz von awaitund yieldin derselben Methode.

Anwendungsbeispiel (C # 8):

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

Beachten Sie die awaitvor dem foreach.

Wenn Ihnen ein kleiner Hack nichts ausmacht, können Sie diese Erweiterungen ausprobieren.

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;
        }
    }
}