BufferedStream.ReadAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Sobrecargas

ReadAsync(Memory<Byte>, CancellationToken)	Lee de forma asincrónica una secuencia de bytes de la secuencia almacenada en búfer actual y avanza la posición en esta secuencia almacenada en búfer según el número de bytes leídos.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.

ReadAsync(Memory<Byte>, CancellationToken)

Source:

BufferedStream.cs

Lee de forma asincrónica una secuencia de bytes de la secuencia almacenada en búfer actual y avanza la posición en esta secuencia almacenada en búfer según el número de bytes leídos.

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>

Región de memoria en la que se van a escribir los datos.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

ValueTask<Int32>

Tarea que representa la operación de lectura asincrónica. El valor de su propiedad Result contiene el número total de bytes leídos en el búfer. El valor de resultado puede ser menor que el número de bytes asignado en el búfer si esos bytes no están disponibles en ese momento o 0 (cero) si se ha alcanzado el final de la secuencia.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

El ReadAsync método permite realizar operaciones de E/S intensivas en recursos sin bloquear el subproceso principal. Esta consideración de rendimiento es especialmente importante en una aplicación de la Tienda Windows 8.x o una aplicación de escritorio en que una operación de streaming prolongada puede bloquear el subproceso de interfaz de usuario y hacer que parezca que una aplicación ha dejado de responder. Los métodos asincrónicos se usan junto con las async palabras clave y await en Visual Basic y C#.

Use la CanRead propiedad para determinar si la instancia actual admite la lectura.

Si la operación se cancela antes de completarse, la tarea devuelta contiene el TaskStatus.Canceled valor de la Status propiedad .

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

Source:

BufferedStream.cs

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.

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[]

El búfer en el que se escriben los datos.

offset

Int32

Posición de desplazamiento en bytes de buffer donde se comienza a escribir los datos de la secuencia.

count

Int32

Número máximo de bytes que se pueden leer.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación.

Devoluciones

Task<Int32>

Tarea que representa la operación de lectura asincrónica. El valor del parámetro TResult contiene el número total de bytes leídos en el búfer. El valor del resultado puede ser menor que el número de bytes solicitados si el número de bytes disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final de la secuencia.

Excepciones

ArgumentNullException

buffer es null.

ArgumentOutOfRangeException

offset o count es negativo.

ArgumentException

La suma de offset y count es mayor que la longitud del búfer.

NotSupportedException

La secuencia no admite lectura.

ObjectDisposedException

Se ha eliminado la secuencia.

InvalidOperationException

Una operación de lectura anterior está usando actualmente la secuencia.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Puede crear un token de cancelación creando una instancia de la CancellationTokenSource clase y pasando la Token propiedad como el cancellationToken parámetro .

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Read(Byte[], Int32, Int32).