Socket.EndReceive Método

Definição

Encerra uma leitura assíncrona pendente.Ends a pending asynchronous read.

Sobrecargas

EndReceive(IAsyncResult)

Encerra uma leitura assíncrona pendente.Ends a pending asynchronous read.

EndReceive(IAsyncResult, SocketError)

Encerra uma leitura assíncrona pendente.Ends a pending asynchronous read.

EndReceive(IAsyncResult)

Encerra uma leitura assíncrona pendente.Ends a pending asynchronous read.

public:
 int EndReceive(IAsyncResult ^ asyncResult);
public:
 int EndReceive(IAsyncResult ^ result);
public int EndReceive (IAsyncResult asyncResult);
public int EndReceive (IAsyncResult result);
member this.EndReceive : IAsyncResult -> int
member this.EndReceive : IAsyncResult -> int
Public Function EndReceive (asyncResult As IAsyncResult) As Integer
Public Function EndReceive (result As IAsyncResult) As Integer

Parâmetros

asyncResultresult
IAsyncResult

Um IAsyncResult que armazena informações de estado e dados definidos pelo usuário para essa operação assíncrona.An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

Retornos

Int32

O número de bytes recebidos.The number of bytes received.

Exceções

asyncResult é null.asyncResult is null.

asyncResult não foi retornado por uma chamada ao método BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).asyncResult was not returned by a call to the BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) method.

O EndReceive(IAsyncResult) foi chamado anteriormente para a leitura assíncrona.EndReceive(IAsyncResult) was previously called for the asynchronous read.

Ocorreu um erro ao tentar acessar o soquete.An error occurred when attempting to access the socket.

O Socket foi fechado.The Socket has been closed.

Exemplos

O exemplo de código a seguir Finaliza uma leitura assíncrona pendente.The following code example ends a pending asynchronous read. Para obter um exemplo completo que demonstra comunicações assíncronas com soquetes, consulte exemplos de código de soquete.For a complete example that demonstrates asynchronous communications with sockets, see Socket Code Examples.

static void Read_Callback( IAsyncResult^ ar )
{
   StateObject^ so = safe_cast<StateObject^>(ar->AsyncState);
   Socket^ s = so->workSocket;

   int read = s->EndReceive( ar );

   if ( read > 0 )
   {
      so->sb->Append( Encoding::ASCII->GetString( so->buffer, 0, read ) );
      s->BeginReceive( so->buffer, 0, StateObject::BUFFER_SIZE, SocketFlags::None,
         gcnew AsyncCallback( &Async_Send_Receive::Read_Callback ), so );
   }
   else
   {
      if ( so->sb->Length > 1 )
      {
         //All of the data has been read, so displays it to the console
         String^ strContent = so->sb->ToString();
         Console::WriteLine( String::Format( "Read {0} byte from socket" +
            " data = {1} ", strContent->Length, strContent ) );
      }
      s->Close();
   }
}
public static void Read_Callback(IAsyncResult ar){
    StateObject so = (StateObject) ar.AsyncState;
    Socket s = so.workSocket;

    int read = s.EndReceive(ar);

    if (read > 0) {
            so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read));
            s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0,
                                     new AsyncCallback(Async_Send_Receive.Read_Callback), so);
    }
    else{
         if (so.sb.Length > 1) {
              //All of the data has been read, so displays it to the console
              string strContent;
              strContent = so.sb.ToString();
              Console.WriteLine(String.Format("Read {0} byte from socket" +
                               "data = {1} ", strContent.Length, strContent));
         }
         s.Close();
    }
}
Public Shared Sub Read_Callback(ar As IAsyncResult)
   Dim so As StateObject = CType(ar.AsyncState, StateObject)
   Dim s As Socket = so.workSocket
   
   Dim read As Integer = s.EndReceive(ar)
   
   If read > 0 Then
      so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read))
      s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0, New AsyncCallback(AddressOf Async_Send_Receive.Read_Callback), so)
   Else
      If so.sb.Length > 1 Then
         'All the data has been read, so displays it to the console
         Dim strContent As String
         strContent = so.sb.ToString()
         Console.WriteLine([String].Format("Read {0} byte from socket" + "data = {1} ", strContent.Length, strContent))
      End If
      s.Close()
   End If
End Sub

Comentários

O EndReceive método conclui a operação de leitura assíncrona iniciada no BeginReceive método.The EndReceive method completes the asynchronous read operation started in the BeginReceive method.

Antes de chamar BeginReceive , você precisa criar um método de retorno de chamada que implemente o AsyncCallback delegado.Before calling BeginReceive, you need to create a callback method that implements the AsyncCallback delegate. Esse método de retorno de chamada é executado em um thread separado e é chamado pelo sistema após o BeginReceive retornos.This callback method executes in a separate thread and is called by the system after BeginReceive returns. O método de retorno de chamada deve aceitar o IAsyncResult retornado pelo BeginReceive método como um parâmetro.The callback method must accept the IAsyncResult returned by the BeginReceive method as a parameter.

No método de retorno de chamada, chame o AsyncState método do IAsyncResult para obter o objeto de estado passado para o BeginReceive método.Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceive method. Extraia o recebimento deste Socket objeto de estado.Extract the receiving Socket from this state object. Depois de obter o Socket , você pode chamar o EndReceive método para concluir a operação de leitura com êxito e retornar o número de bytes lidos.After obtaining the Socket, you can call the EndReceive method to successfully complete the read operation and return the number of bytes read.

O EndReceive método será bloqueado até que os dados estejam disponíveis.The EndReceive method will block until data is available. Se você estiver usando um protocolo sem conexão, EndReceive o lerá o primeiro datagrama enfileirado disponível no buffer de rede de entrada.If you are using a connectionless protocol, EndReceive will read the first enqueued datagram available in the incoming network buffer. Se você estiver usando um protocolo orientado a conexão, o EndReceive método lerá o máximo de dados que está disponível até o número de bytes especificado no size parâmetro do BeginReceive método.If you are using a connection-oriented protocol, the EndReceive method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceive method. Se o host remoto desligar a Socket conexão com o Shutdown método e todos os dados disponíveis tiverem sido recebidos, o EndReceive método será concluído imediatamente e retornará zero bytes.If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the EndReceive method will complete immediately and return zero bytes.

Para obter os dados recebidos, chame o AsyncState método de IAsyncResult e extraia o buffer contido no objeto de estado resultante.To obtain the received data, call the AsyncState method of the IAsyncResult, and extract the buffer contained in the resulting state object.

Para cancelar um pendente BeginReceive , chame o Close método.To cancel a pending BeginReceive, call the Close method.

Observação

Se você receber um SocketException , use a SocketException.ErrorCode propriedade para obter o código de erro específico.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. Depois de obter esse código, consulte a documentação do código de erro da API do Windows Sockets versão 2 para obter uma descrição detalhada do erro.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Observação

Todas as e/s iniciadas por um determinado thread são canceladas quando o thread é encerrado.All I/O initiated by a given thread is canceled when that thread exits. Uma operação assíncrona pendente poderá falhar se o thread sair antes da conclusão da operação.A pending asynchronous operation can fail if the thread exits before the operation completes.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo.This member outputs trace information when you enable network tracing in your application. Para obter mais informações, consulte rastreamento de rede na .NET Framework.For more information, see Network Tracing in the .NET Framework.

Confira também

Aplica-se a

EndReceive(IAsyncResult, SocketError)

Encerra uma leitura assíncrona pendente.Ends a pending asynchronous read.

public:
 int EndReceive(IAsyncResult ^ asyncResult, [Runtime::InteropServices::Out] System::Net::Sockets::SocketError % errorCode);
public int EndReceive (IAsyncResult asyncResult, out System.Net.Sockets.SocketError errorCode);
member this.EndReceive : IAsyncResult * SocketError -> int
Public Function EndReceive (asyncResult As IAsyncResult, ByRef errorCode As SocketError) As Integer

Parâmetros

asyncResult
IAsyncResult

Um IAsyncResult que armazena informações de estado e dados definidos pelo usuário para essa operação assíncrona.An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

errorCode
SocketError

Um objeto SocketError que armazena o erro de soquete.A SocketError object that stores the socket error.

Retornos

Int32

O número de bytes recebidos.The number of bytes received.

Exceções

asyncResult é null.asyncResult is null.

asyncResult não foi retornado por uma chamada ao método BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).asyncResult was not returned by a call to the BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) method.

O EndReceive(IAsyncResult) foi chamado anteriormente para a leitura assíncrona.EndReceive(IAsyncResult) was previously called for the asynchronous read.

Ocorreu um erro ao tentar acessar o soquete.An error occurred when attempting to access the socket.

O Socket foi fechado.The Socket has been closed.

Comentários

O EndReceive método conclui a operação de leitura assíncrona iniciada no BeginReceive método.The EndReceive method completes the asynchronous read operation started in the BeginReceive method.

Antes de chamar BeginReceive , você precisa criar um método de retorno de chamada que implemente o AsyncCallback delegado.Before calling BeginReceive, you need to create a callback method that implements the AsyncCallback delegate. Esse método de retorno de chamada é executado em um thread separado e é chamado pelo sistema após o BeginReceive retornos.This callback method executes in a separate thread and is called by the system after BeginReceive returns. O método de retorno de chamada deve aceitar o IAsyncResult retornado pelo BeginReceive método como um parâmetro.The callback method must accept the IAsyncResult returned by the BeginReceive method as a parameter.

No método de retorno de chamada, chame o AsyncState método do IAsyncResult para obter o objeto de estado passado para o BeginReceive método.Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceive method. Extraia o recebimento deste Socket objeto de estado.Extract the receiving Socket from this state object. Depois de obter o Socket , você pode chamar o EndReceive método para concluir a operação de leitura com êxito e retornar o número de bytes lidos.After obtaining the Socket, you can call the EndReceive method to successfully complete the read operation and return the number of bytes read.

O EndReceive método será bloqueado até que os dados estejam disponíveis.The EndReceive method will block until data is available. Se você estiver usando um protocolo sem conexão, EndReceive o lerá o primeiro datagrama enfileirado disponível no buffer de rede de entrada.If you are using a connectionless protocol, EndReceive will read the first enqueued datagram available in the incoming network buffer. Se você estiver usando um protocolo orientado a conexão, o EndReceive método lerá o máximo de dados que está disponível até o número de bytes especificado no size parâmetro do BeginReceive método.If you are using a connection-oriented protocol, the EndReceive method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceive method. Se o host remoto desligar a Socket conexão com o Shutdown método e todos os dados disponíveis tiverem sido recebidos, o EndReceive método será concluído imediatamente e retornará zero bytes.If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the EndReceive method will complete immediately and return zero bytes.

Para obter os dados recebidos, chame o AsyncState método de IAsyncResult e extraia o buffer contido no objeto de estado resultante.To obtain the received data, call the AsyncState method of the IAsyncResult, and extract the buffer contained in the resulting state object.

Observação

Se você receber um SocketException , use a SocketException.ErrorCode propriedade para obter o código de erro específico.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. Depois de obter esse código, consulte a documentação do código de erro da API do Windows Sockets versão 2 para obter uma descrição detalhada do erro.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Observação

Todas as e/s iniciadas por um determinado thread são canceladas quando o thread é encerrado.All I/O initiated by a given thread is canceled when that thread exits. Uma operação assíncrona pendente poderá falhar se o thread sair antes da conclusão da operação.A pending asynchronous operation can fail if the thread exits before the operation completes.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo.This member outputs trace information when you enable network tracing in your application. Para obter mais informações, consulte rastreamento de rede na .NET Framework.For more information, see Network Tracing in the .NET Framework.

Confira também

Aplica-se a