PipeStream.ReadAsync Método

Definição

Sobrecargas

ReadAsync(Memory<Byte>, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual, grava-os em um intervalo de memória de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual para uma matriz de bytes começando em uma posição especificada de um número especificado de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual, grava-os em um intervalo de memória de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parâmetros

buffer
Memory<Byte>

A região da memória na qual gravar os dados.The region of memory to write the data into.

cancellationToken
CancellationToken

O token a se monitorar para solicitações de cancelamento.The token to monitor for cancellation requests. O valor padrão é None.The default value is None.

Retornos

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor de sua propriedade Result contém o número total de bytes lidos no buffer.The value of its Result property contains the total number of bytes read into the buffer. O valor do resultado poderá ser menor que o número de bytes alocados no buffer se esses muitos bytes não estiverem disponíveis no momento, ou zero (0), se o final do fluxo tiver sido atingido.The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached.

Exceções

Não há suporte para leitura no fluxo.The stream does not support reading.

Não é possível acessar um pipe fechado.Cannot access a closed pipe.

O pipe ainda não foi conectado.The pipe hasn't been connected yet.

- ou --or-

O pipe está em um estado desconectado.The pipe is in a disconnected state.

- ou --or-

O identificador de pipe não foi definido.The pipe handle has not been set. (A implementação de PipeStream chamou InitializeHandle(SafePipeHandle, Boolean, Boolean)?)(Did your PipeStream implementation call InitializeHandle(SafePipeHandle, Boolean, Boolean)?

Comentários

O ReadAsync método permite que você execute operações de e/s com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Essa consideração de desempenho é particularmente importante em um aplicativo de armazenamento do Windows 8. x ou aplicativo de área de trabalho em que uma operação de fluxo demorado pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se não estiver funcionando.This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Os métodos assíncronos são usados em conjunto com async as await palavras-chave e em Visual Basic e C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a CanRead propriedade para determinar se a instância atual oferece suporte à leitura.Use the CanRead property to determine whether the current instance supports reading.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property.

Aplica-se a

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

Lê de forma assíncrona uma sequência de bytes do fluxo em buffer atual para uma matriz de bytes começando em uma posição especificada de um número especificado de bytes, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parâmetros

buffer
Byte[]

O buffer no qual os dados serão gravados.The buffer to write the data into.

offset
Int32

O deslocamento de bytes no buffer no qual será iniciada a gravação de dados no fluxo.The byte offset in buffer at which to begin writing data from the stream.

count
Int32

O número máximo de bytes a serem lidos.The maximum number of bytes to read.

cancellationToken
CancellationToken

O token a se monitorar para solicitações de cancelamento.The token to monitor for cancellation requests. O valor padrão é None.The default value is None.

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor de sua propriedade Result contém o número total de bytes lidos no buffer.The value of its Result property contains the total number of bytes read into the buffer. O valor do resultado poderá ser menor que o número de bytes solicitados se o número de bytes disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo foi atingido.The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Exceções

Não há suporte para leitura no fluxo.The stream does not support reading.

Não é possível acessar um pipe fechado.Cannot access a closed pipe.

O pipe ainda não foi conectado.The pipe hasn't been connected yet.

- ou --or-

O pipe está em um estado desconectado.The pipe is in a disconnected state.

- ou --or-

O identificador de pipe não foi definido.The pipe handle has not been set. (A implementação de PipeStream chamou InitializeHandle(SafePipeHandle, Boolean, Boolean)?)(Did your PipeStream implementation call InitializeHandle(SafePipeHandle, Boolean, Boolean)?

Comentários

O ReadAsync método permite que você execute operações de e/s com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Essa consideração de desempenho é particularmente importante em um aplicativo de armazenamento do Windows 8. x ou aplicativo de área de trabalho em que uma operação de fluxo demorado pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se não estiver funcionando.This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Os métodos assíncronos são usados em conjunto com async as await palavras-chave e em Visual Basic e C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a CanRead propriedade para determinar se a instância atual oferece suporte à leitura.Use the CanRead property to determine whether the current instance supports reading.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property.

Aplica-se a