Socket.EndReceive Método

Definição

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Encerra uma leitura assíncrona pendente.

Sobrecargas

EndReceive(IAsyncResult)	Encerra uma leitura assíncrona pendente.
EndReceive(IAsyncResult, SocketError)	Encerra uma leitura assíncrona pendente.

EndReceive(IAsyncResult)

Origem:

Socket.cs

Encerra uma leitura assíncrona pendente.

public:
 int EndReceive(IAsyncResult ^ asyncResult);

public int EndReceive (IAsyncResult asyncResult);

member this.EndReceive : IAsyncResult -> int

Public Function EndReceive (asyncResult As IAsyncResult) 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.

Retornos

Int32

O número de bytes recebidos.

Exceções

ArgumentNullException

asyncResult é null.

ArgumentException

asyncResult não foi retornado por uma chamada ao método BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).

InvalidOperationException

O EndReceive(IAsyncResult) foi chamado anteriormente para a leitura assíncrona.

SocketException

Ocorreu um erro ao tentar acessar o soquete.

- ou -

Somente .NET 7+: o Socket foi fechado.

ObjectDisposedException

somente .NET Framework, .NET Core e .NET 5-6: o Socket foi fechado.

Comentários

Importante

Essa é uma API de compatibilidade. Não recomendamos usar os métodos APM (Begin* e End*) para novo desenvolvimento. Em vez disso, use os Taskequivalentes baseados em .

EndReceive conclui a operação iniciada por BeginReceive. Você precisa passar o IAsyncResult criado pela chamada correspondente BeginReceive .

O EndReceive método será bloqueado até que os dados sejam disponibilizados. Se você estiver usando um protocolo sem conexão, EndReceive lerá o primeiro datagrama enfileirado disponível no buffer de rede de entrada. Se você estiver usando um protocolo orientado a conexão, o EndReceive método lerá o máximo de dados que estiver disponível até o número de bytes especificado no size parâmetro do BeginReceive método . 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.

Observação

Se você receber um SocketException, use a SocketException.ErrorCode propriedade para obter o código de erro específico.

Observação

Todas as E/S iniciadas por um determinado thread são canceladas quando esse thread é encerrado. Uma operação assíncrona pendente poderá falhar se o thread for encerrado antes da conclusão da operação.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo. Para obter mais informações, consulte Rastreamento de rede em .NET Framework.

Confira também

• BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object)
• AsyncCallback
• IAsyncResult
• AsyncState
• Shutdown(SocketShutdown)

EndReceive(IAsyncResult, SocketError)

Origem:

Socket.cs

Encerra uma leitura assíncrona pendente.

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.

errorCode

SocketError

Um objeto SocketError que armazena o erro de soquete.

Retornos

Int32

O número de bytes recebidos.

Exceções

ArgumentNullException

asyncResult é null.

ArgumentException

asyncResult não foi retornado por uma chamada ao método BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).

InvalidOperationException

O EndReceive(IAsyncResult) foi chamado anteriormente para a leitura assíncrona.

SocketException

Ocorreu um erro ao tentar acessar o soquete.

- ou -

Somente .NET 7+: o Socket foi fechado.

ObjectDisposedException

somente .NET Framework, .NET Core e .NET 5-6: o Socket foi fechado.

Comentários

Importante

Essa é uma API de compatibilidade. Não recomendamos usar os métodos APM (Begin* e End*) para novo desenvolvimento. Em vez disso, use os Taskequivalentes baseados em .

EndReceive conclui a operação iniciada por BeginReceive. Você precisa passar o IAsyncResult criado pela chamada correspondente BeginReceive .

O EndReceive método será bloqueado até que os dados sejam disponibilizados. Se você estiver usando um protocolo sem conexão, EndReceive lerá o primeiro datagrama enfileirado disponível no buffer de rede de entrada. Se você estiver usando um protocolo orientado a conexão, o EndReceive método lerá o máximo de dados que estiver disponível até o número de bytes especificado no size parâmetro do BeginReceive método . 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.

Observação

Se você receber um SocketException, use a SocketException.ErrorCode propriedade para obter o código de erro específico.

Observação

Todas as E/S iniciadas por um determinado thread são canceladas quando esse thread é encerrado. Uma operação assíncrona pendente poderá falhar se o thread for encerrado antes da conclusão da operação.

Observação

Esse membro emite o rastreamento de informações quando você ativa o rastreamento de rede em seu aplicativo. Para obter mais informações, consulte Rastreamento de rede em .NET Framework.

Confira também

• BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object)
• AsyncCallback
• IAsyncResult
• AsyncState
• Shutdown(SocketShutdown)