NetworkStream.ReadAsync Méthode

Définition

Surcharges

ReadAsync(Memory<Byte>, CancellationToken)

Lit des données dans NetworkStream et les stocke dans une plage de mémoire d’octets en tant qu’opération asynchrone.Reads data from the NetworkStream and stores it in a byte memory range as an asynchronous operation.

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

Lit des données dans NetworkStream et les stocke dans une plage spécifiée d’un tableau d’octets en tant qu’opération asynchrone.Reads data from the NetworkStream and stores it to a specified range of a byte array as an asynchronous operation.

ReadAsync(Memory<Byte>, CancellationToken)

Lit des données dans NetworkStream et les stocke dans une plage de mémoire d’octets en tant qu’opération asynchrone.Reads data from the NetworkStream and stores it in a byte memory range as an asynchronous operation.

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)

Paramètres

buffer
Memory<Byte>

Mémoire tampon où écrire les données.The buffer to write the data to.

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests.

Retours

ValueTask<Int32>

Tâche ValueTask<TResult> qui représente l'opération de lecture asynchrone.A ValueTask<TResult> that represents the asynchronous read operation. La valeur de sa propriété Result contient le nombre total d’octets lus dans buffer.The value of its Result property contains the total number of bytes read into buffer.

Exceptions

NetworkStream ne prend pas en charge la lecture.The NetworkStream does not support reading.

Une erreur s’est produite pendant l’accès au socket.An error occurred when accessing the socket.

- ou --or-

Une erreur s'est produite pendant la lecture à partir du réseau.There is a failure reading from the network.

Le NetworkStream est fermé.The NetworkStream is closed.

Remarques

Cette méthode lit autant de données que possible dans buffer et retourne le nombre d’octets lus avec succès.This method reads as much data as is available into buffer and returns the number of bytes successfully read.

Notes

Vérifiez si le NetworkStream est lisible en appelant la CanRead propriété.Check to see if the NetworkStream is readable by calling the CanRead property. Si vous tentez de lire à partir d’un NetworkStream qui ne peut pas être lu, vous obtiendrez un InvalidOperationException .If you attempt to read from a NetworkStream that is not readable, you will get an InvalidOperationException.

Notes

Si vous recevez un IOException , vérifiez la InnerException propriété pour déterminer si elle a été provoquée par un SocketException .If you receive an IOException, check the InnerException property to determine if it was caused by a SocketException. Si c’est le cas, utilisez la ErrorCode propriété pour obtenir le code d’erreur spécifique et reportez-vous à la documentation sur les codes d’erreur de l' API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.If so, use the ErrorCode property to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

S’applique à

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

Lit des données dans NetworkStream et les stocke dans une plage spécifiée d’un tableau d’octets en tant qu’opération asynchrone.Reads data from the NetworkStream and stores it to a specified range of a byte array as an asynchronous operation.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int size, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int size, 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, size As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Paramètres

buffer
Byte[]

Mémoire tampon où écrire les données.The buffer to write the data into.

offset
Int32

Emplacement de buffer auquel commencer le stockage des données.The location in buffer to begin storing the data to.

size
Int32

Nombre d'octets à lire à partir de NetworkStream.The number of bytes to read from the NetworkStream.

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests.

Retours

Task<Int32>

Tâche qui représente l'opération de lecture asynchrone.A task that represents the asynchronous read operation. La valeur de sa propriété Result contient le nombre total d’octets lus dans buffer.The value of its Result property contains the total number of bytes read into buffer.

Exceptions

NetworkStream ne prend pas en charge la lecture.The NetworkStream does not support reading.

Une erreur s’est produite pendant l’accès au socket.An error occurred when accessing the socket.

- ou --or-

Une erreur s'est produite pendant la lecture à partir du réseau.There is a failure reading from the network.

Le NetworkStream est fermé.The NetworkStream is closed.

Remarques

Cette méthode lit les données dans buffer et retourne le nombre d’octets lus avec succès.This method reads data into buffer and returns the number of bytes successfully read. L' ReadAsync opération lit autant de données que possible, jusqu’au nombre d’octets spécifié par le size paramètre.The ReadAsync operation reads as much data as is available, up to the number of bytes specified by the size parameter.

Notes

Vérifiez si le NetworkStream est lisible en appelant la CanRead propriété.Check to see if the NetworkStream is readable by calling the CanRead property. Si vous tentez de lire à partir d’un NetworkStream qui ne peut pas être lu, vous obtiendrez un InvalidOperationException .If you attempt to read from a NetworkStream that is not readable, you will get an InvalidOperationException.

Notes

Si vous recevez un IOException , vérifiez la InnerException propriété pour déterminer si elle a été provoquée par un SocketException .If you receive an IOException, check the InnerException property to determine if it was caused by a SocketException. Si c’est le cas, utilisez la ErrorCode propriété pour obtenir le code d’erreur spécifique et reportez-vous à la documentation sur les codes d’erreur de l' API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.If so, use the ErrorCode property to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

S’applique à