NetworkStream.EndRead(IAsyncResult) Méthode

Définition

Gère la fin d'une lecture asynchrone.Handles the end of an asynchronous read.

public:
 override int EndRead(IAsyncResult ^ asyncResult);
public override int EndRead (IAsyncResult asyncResult);
override this.EndRead : IAsyncResult -> int
Public Overrides Function EndRead (asyncResult As IAsyncResult) As Integer

Paramètres

asyncResult
IAsyncResult

IAsyncResult qui représente un appel asynchrone.An IAsyncResult that represents an asynchronous call.

Retours

Int32

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

Exceptions

Le paramètre asyncResult a la valeur null.The asyncResult parameter is null.

Le Socket sous-jacent est fermé.The underlying Socket is closed.

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

Le NetworkStream est fermé.The NetworkStream is closed.

Exemples

Dans l’exemple de code suivant, myReadCallback est fourni à BeginRead comme méthode de rappel.In the following code example, myReadCallback is provided to BeginRead as the callback method. EndRead est implémenté dans myReadCallback pour terminer l’appel de lecture asynchrone démarré par BeginRead .EndRead is implemented in myReadCallback to complete the asynchronous read call started by BeginRead.

// Example of EndRead, DataAvailable and BeginRead.
static void myReadCallBack( IAsyncResult^ ar )
{
   NetworkStream^ myNetworkStream = safe_cast<NetworkStream^>(ar->AsyncState);
   array<Byte>^myReadBuffer = gcnew array<Byte>(1024);
   String^ myCompleteMessage = "";
   int numberOfBytesRead;
   numberOfBytesRead = myNetworkStream->EndRead( ar );
   myCompleteMessage = String::Concat( myCompleteMessage, Encoding::ASCII->GetString( myReadBuffer, 0, numberOfBytesRead ) );
   
   // message received may be larger than buffer size so loop through until you have it all.
   while ( myNetworkStream->DataAvailable )
   {
      AsyncCallback^ pasync = gcnew AsyncCallback( &myReadCallBack );
      myNetworkStream->BeginRead( myReadBuffer, 0, myReadBuffer->Length, pasync, myNetworkStream );
   }

   // Print out the received message to the console.
   Console::WriteLine( "You received the following message : {0}", myCompleteMessage );
}
// Example of EndRead, DataAvailable and BeginRead.

public static void myReadCallBack(IAsyncResult ar ){

    NetworkStream myNetworkStream = (NetworkStream)ar.AsyncState;
    byte[] myReadBuffer = new byte[1024];
    String myCompleteMessage = "";
    int numberOfBytesRead;

    numberOfBytesRead = myNetworkStream.EndRead(ar);
    myCompleteMessage =
        String.Concat(myCompleteMessage, Encoding.ASCII.GetString(myReadBuffer, 0, numberOfBytesRead));

    // message received may be larger than buffer size so loop through until you have it all.
    while(myNetworkStream.DataAvailable){
        
        myNetworkStream.BeginRead(myReadBuffer, 0, myReadBuffer.Length,
                                                   new AsyncCallback(NetworkStream_ASync_Send_Receive.myReadCallBack),
                                                   myNetworkStream);
    }

    // Print out the received message to the console.
    Console.WriteLine("You received the following message : " +
                                myCompleteMessage);
}

' Example of EndRead, DataAvailable and BeginRead.
Public Shared Sub myReadCallBack(ar As IAsyncResult)
   
   Dim myNetworkStream As NetworkStream = CType(ar.AsyncState, NetworkStream)
   Dim myReadBuffer(1024) As Byte
   Dim myCompleteMessage As [String] = ""
   Dim numberOfBytesRead As Integer
   
   numberOfBytesRead = myNetworkStream.EndRead(ar)
   myCompleteMessage = [String].Concat(myCompleteMessage, Encoding.ASCII.GetString(myReadBuffer, 0, numberOfBytesRead))
   
   ' message received may be larger than buffer size so loop through until you have it all.
   While myNetworkStream.DataAvailable
      
      myNetworkStream.BeginRead(myReadBuffer, 0, myReadBuffer.Length, New AsyncCallback(AddressOf NetworkStream_ASync_Send_Receive.myReadCallBack), myNetworkStream)
   End While
   
   
   ' Print out the received message to the console.
   Console.WriteLine(("You received the following message : " + myCompleteMessage))
End Sub

Remarques

La EndRead méthode termine l’opération de lecture asynchrone démarrée dans la BeginRead méthode.The EndRead method completes the asynchronous read operation started in the BeginRead method.

Avant BeginRead d’appeler, vous devez créer une méthode de rappel qui implémente le AsyncCallback délégué.Before calling BeginRead, you need to create a callback method that implements the AsyncCallback delegate. Cette méthode de rappel s’exécute dans un thread distinct et est appelée par le système après que BeginRead retourne.This callback method executes in a separate thread and is called by the system after BeginRead returns. La méthode de rappel doit accepter le IAsyncResult retourné à partir de la BeginRead méthode en tant que paramètre.The callback method must accept the IAsyncResult returned from the BeginRead method as a parameter.

Dans la méthode de rappel, appelez la AsyncState propriété du IAsyncResult pour obtenir l’objet d’état passé à la BeginRead méthode.Within the callback method, call the AsyncState property of the IAsyncResult to obtain the state object passed to the BeginRead method. Extrayez la réception NetworkStream de cet objet d’État.Extract the receiving NetworkStream from this state object. Après avoir obtenu le NetworkStream , appelez la EndRead méthode pour terminer correctement l’opération de lecture et retourner le nombre d’octets lus.After obtaining the NetworkStream, call the EndRead method to successfully complete the read operation and return the number of bytes read.

La EndRead méthode se bloque jusqu’à ce que les données soient disponibles.The EndRead method blocks until data is available. La EndRead méthode lit autant de données que possible jusqu’au nombre d’octets spécifié dans le size paramètre de la BeginRead méthode.The EndRead method reads as much data as is available up to the number of bytes specified in the size parameter of the BeginRead method. Si l’hôte distant arrête la Socket connexion et que toutes les données disponibles ont été reçues, la EndRead méthode se termine immédiatement et retourne zéro octet.If the remote host shuts down the Socket connection and all available data has been received, the EndRead method completes immediately and returns zero bytes.

Pour obtenir les données reçues, appelez la AsyncState propriété du IAsyncResult et extrayez la mémoire tampon contenue dans l’objet d’état résultant.To obtain the received data, call the AsyncState property of the IAsyncResult, and extract the buffer contained in the resulting state object.

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 à

Voir aussi