Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

Channel — asynchroniczne przekazywanie danych między producentem a konsumentem

System.Threading.Channels.Channel tworzy kanały łączące producentów i konsumentów. Kanał ograniczony może asynchronicznie czekać na wolne miejsce, a nieograniczony nie narzuca limitu liczby elementów. Opcje opisują również gwarancje dotyczące współbieżnych odczytów i zapisów.

Wersja: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Składnia

Channel<T> channel = Channel.CreateBounded<T>(new BoundedChannelOptions(capacity) { FullMode = BoundedChannelFullMode.Wait, SingleReader = true, SingleWriter = true });
Channel<T> unbounded = Channel.CreateUnbounded<T>(new UnboundedChannelOptions());

System.Threading.Channels.Channel jest statyczną klasą fabrykującą kanały, a Channel<T> udostępnia Writer i Reader. Channel.CreateBounded<T> i Channel.CreateUnbounded<T> tworzą kolejki FIFO do asynchronicznego przekazywania danych. Wielu konsumentów dzieli elementy między siebie: kanał nie rozsyła każdego elementu do wszystkich. Omawiane API jest dostępne w .NET 10; przykład nie wymaga funkcji języka w wersji preview.

BoundedChannelOptions określa pojemność kanału i jego zachowanie, gdy nie może przyjąć kolejnego elementu. W .NET 10 pojemność może być dodatnia lub równa 0. Przy pojemności 0 kanał nie ma bufora: zapis i odczyt muszą się spotkać, aby element został przekazany bezpośrednio. W domyślnym trybie BoundedChannelFullMode.Wait, jeśli zapis nie może nastąpić od razu, WriteAsync czeka asynchronicznie na wolne miejsce w buforze lub, w kanale bez bufora, na odpowiadający mu odczyt. Nie blokuje przy tym wątku; TryWrite w tej samej sytuacji zwraca false. To mechanizm nacisku zwrotnego (backpressure), który spowalnia producenta. Pozostałe tryby pełnego kanału mogą odrzucać elementy.

UnboundedChannelOptions konfiguruje kanał bez ustalonego limitu pojemności, tworzony przez Channel.CreateUnbounded<T>. Zapis nie czeka w nim na wolne miejsce, ale gdy producent stale wyprzedza konsumenta, bufor może zużywać coraz więcej pamięci. Oba typy opcji dziedziczą ChannelOptions.SingleReader i ChannelOptions.SingleWriter. Wartość true jest obietnicą najwyżej jednej operacji odczytu lub zapisu naraz, umożliwiającą optymalizacje, a nie blokadą wymuszającą tę zasadę. Bez takiej gwarancji pozostaw false.

Po zakończeniu zapisów wywołaj Writer.Complete(): ReadAllAsync() opróżni bufor i zakończy iterację. Przy wielu producentach zakończ kanał dopiero po zakończeniu wszystkich zapisujących. Błąd można przekazać przez TryComplete(error), a token anulowania pozwala przerwać oczekiwanie. Uruchom producenta i konsumenta współbieżnie; oczekiwanie na zakończenie producenta przed rozpoczęciem odczytu może zakleszczyć pełny kanał z trybem Wait.

Przykłady

using System;
using System.Threading.Channels;
using System.Threading.Tasks;

Channel<int> channel = Channel.CreateBounded<int>(
    new BoundedChannelOptions(1)
    {
        FullMode = BoundedChannelFullMode.Wait,
        SingleReader = true,
        SingleWriter = true
    });

Task producer = ProduceAsync(channel.Writer);

await foreach (int value in channel.Reader.ReadAllAsync())
{
    Console.WriteLine(value);
}

await producer;

static async Task ProduceAsync(ChannelWriter<int> writer)
{
    try
    {
        for (int value = 1; value <= 3; value++)
        {
            await writer.WriteAsync(value);
        }
        writer.Complete();
    }
    catch (Exception error)
    {
        writer.TryComplete(error);
        throw;
    }
}

Wynik

1
2
3

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła