Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

BoundedChannelOptions i BoundedChannelFullMode.Wait

Ustaw limit bufora i zobacz, dlaczego przy pełnym kanale `TryWrite` od razu zwraca `false`, a `WriteAsync` asynchronicznie czeka na miejsce.

Wersja: C# 12 and .NET 8; later runtimes may add compatible features

Składnia

using System.Threading.Channels;

var options = new BoundedChannelOptions(capacity: 2)
{
    FullMode = BoundedChannelFullMode.Wait
};
Channel<int> channel = Channel.CreateBounded<int>(options);
bool written = channel.Writer.TryWrite(1);
await channel.Writer.WriteAsync(2);

W C# 12 i .NET 8 użyj BoundedChannelOptions z przestrzeni nazw System.Threading.Channels w przeciążeniu Channel.CreateBounded<T>(options). Dodatnia Capacity wyznacza maksymalną liczbę elementów w buforze, a nie limit elementów już przetwarzanych przez konsumentów ani oczekujących zapisów. Prostsze przeciążenie Channel.CreateBounded<T>(capacity) również używa trybu Wait.

FullMode określa reakcję na próbę zapisu do pełnego bufora. Domyślny BoundedChannelFullMode.Wait nie odrzuca elementów z powodu przepełnienia. TryWrite(item) zwraca true, jeśli zapis się powiódł, albo natychmiast false, jeśli kanał jest pełny lub zakończono zapis. Po false nie pozostaje żaden oczekujący zapis.

WriteAsync(item, cancellationToken) zwraca ValueTask: może zakończyć się od razu, a przy pełnym buforze czeka na miejsce bez blokowania wątku. Użyj await, zanim wyprodukujesz kolejny element, aby wolniejszy konsument mógł spowolnić producenta (backpressure). Anulowanie może przerwać oczekujący zapis z OperationCanceledException, a zwykłe zakończenie zapisu może przerwać go z ChannelClosedException. Sukces oznacza przyjęcie elementu, a nie jego przetworzenie.

WaitToWriteAsync sygnalizuje możliwość zapisu, ale nie rezerwuje miejsca. Przy wielu producentach inny może je zająć, więc po nieudanym TryWrite ponów oczekiwanie, jeśli zapis jest nadal możliwy. Po normalnym zakończeniu zapisu przez Complete() konsument nadal może odczytać elementy z bufora.

Przykłady

using System;
using System.Threading.Channels;

var channel = Channel.CreateBounded<int>(new BoundedChannelOptions(capacity: 1)
{
    FullMode = BoundedChannelFullMode.Wait
});

await channel.Writer.WriteAsync(1);
Console.WriteLine($"TryWrite(99): {channel.Writer.TryWrite(99)}");

var pending = channel.Writer.WriteAsync(2);
Console.WriteLine($"WriteAsync(2) completed: {pending.IsCompleted}");

Console.WriteLine($"Read: {await channel.Reader.ReadAsync()}");
await pending;
channel.Writer.Complete();

await foreach (var item in channel.Reader.ReadAllAsync())
{
    Console.WriteLine($"Read: {item}");
}

Wynik

TryWrite(99): False
WriteAsync(2) completed: False
Read: 1
Read: 2

`1` wypełnia bufor. Próba zapisu `99` kończy się niepowodzeniem, a zapis `2` pozostaje w toku. Odczyt `1` zwalnia miejsce, zapis `2` się kończy, a `ReadAllAsync()` odczytuje `2` po `Complete()`.

Powiązane lekcje

  • C# · Lekcja 46 · Zaawansowany · Wersja: 3

Źródła