PipeStream.WriteAsync Método

Definição

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Sobrecargas

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Grava de forma assíncrona um número especificado de bytes de uma matriz de bytes começando em uma posição especificada, avança a posição atual nesse fluxo até o número de bytes gravados e monitora solicitações de cancelamento.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Origem:

PipeStream.Unix.cs

Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.

public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parâmetros

buffer

ReadOnlyMemory<Byte>

A região da memória da qual gravar os dados.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

ValueTask

Uma tarefa que representa a operação de gravação assíncrona.

Exceções

NotSupportedException

O fluxo não dá suporte à gravação.

ObjectDisposedException

Não é possível acessar um pipe fechado.

IOException

O pipe está quebrado.

InvalidOperationException

O pipe ainda não foi conectado.

- ou -

O pipe está em um estado desconectado.

- ou -

O identificador de pipe não foi definido. (A implementação de PipeStream chamou InitializeHandle(SafePipeHandle, Boolean, Boolean)?)

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

O WriteAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração de desempenho é particularmente importante em aplicativos em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Use a CanWrite propriedade para determinar se a instância atual dá suporte à gravação.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o Canceled valor da Status propriedade .

WriteAsync(Byte[], Int32, Int32, CancellationToken)

Origem:

PipeStream.Unix.cs

Grava de forma assíncrona um número especificado de bytes de uma matriz de bytes começando em uma posição especificada, avança a posição atual nesse fluxo até o número de bytes gravados e monitora solicitações de cancelamento.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

Parâmetros

buffer

Byte[]

O buffer do qual os dados serão gravados.

offset

Int32

O deslocamento de bytes baseado em zero em buffer do qual será iniciada a cópia de bytes no fluxo.

count

Int32

O número máximo de bytes a serem gravados.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

Uma tarefa que representa a operação de gravação assíncrona.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

O offset é negativo.

- ou -

O count é negativo.

ArgumentException

buffer.Length – offset é menor que count.

NotSupportedException

O fluxo não dá suporte à gravação.

ObjectDisposedException

Não é possível acessar um pipe fechado.

IOException

O pipe está quebrado.

InvalidOperationException

O pipe ainda não foi conectado.

- ou -

O pipe está em um estado desconectado.

- ou -

O identificador de pipe não foi definido. (A implementação de PipeStream chamou InitializeHandle(SafePipeHandle, Boolean, Boolean)?)

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

O WriteAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração de desempenho é particularmente importante em aplicativos em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Use a CanWrite propriedade para determinar se a instância atual dá suporte à gravação.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade .

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Write(Byte[], Int32, Int32).