Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C#

Channel — transferência assíncrona de dados entre produtor e consumidor

System.Threading.Channels.Channel cria canais que ligam produtores e consumidores. Um canal limitado pode esperar de forma assíncrona que haja espaço, enquanto um canal ilimitado não impõe um limite ao número de elementos. As opções também descrevem garantias relativas a operações simultâneas de leitura e escrita.

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

Sintaxe

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 é uma classe de fábrica estática, enquanto Channel<T> expõe Writer e Reader. Channel.CreateBounded<T> e Channel.CreateUnbounded<T> criam filas FIFO para a transferência assíncrona de dados. Vários consumidores repartem os elementos entre si: um canal não envia cada elemento para todos. As APIs aqui abordadas estão disponíveis no .NET 10; o exemplo não requer funcionalidades de linguagem em pré-visualização.

BoundedChannelOptions especifica a capacidade do canal e o seu comportamento quando não pode aceitar mais um elemento. No .NET 10, a capacidade pode ser positiva ou igual a 0. Com capacidade igual a 0, o canal não tem buffer: uma escrita e uma leitura têm de ser emparelhadas para que o elemento seja transferido diretamente. No modo predefinido BoundedChannelFullMode.Wait, se uma escrita não puder avançar de imediato, WriteAsync espera de forma assíncrona que haja espaço no buffer ou, num canal sem buffer, que haja uma leitura correspondente. Não bloqueia uma thread; na mesma situação, TryWrite devolve false. Isto proporciona contrapressão, abrandando o produtor. Os outros modos de canal cheio podem descartar elementos.

UnboundedChannelOptions configura um canal sem um limite fixo de capacidade, criado através de Channel.CreateUnbounded<T>. As escritas não esperam por espaço, mas se o produtor estiver continuamente à frente do consumidor, o buffer pode consumir cada vez mais memória. Ambos os tipos de opções herdam ChannelOptions.SingleReader e ChannelOptions.SingleWriter. Definir qualquer um como true garante, no máximo, uma operação de leitura ou escrita de cada vez e permite otimizações; não é um bloqueio que imponha essa regra. Sem essa garantia, mantém o valor false.

Quando as escritas terminarem, chama Writer.Complete(): ReadAllAsync() esvazia o buffer e termina a iteração. Se houver vários produtores, termina o canal apenas depois de todos os escritores concluírem. Um erro pode ser transmitido através de TryComplete(error), e um token de cancelamento permite interromper a espera. Executa o produtor e o consumidor em simultâneo; esperar pela conclusão do produtor antes de iniciar as leituras pode causar um deadlock se o canal estiver cheio no modo Wait.

Exemplos

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

Resultado

1
2
3

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes