Socket.ReceiveAsync(SocketAsyncEventArgs) Método

Definição

Inicia uma solicitação assíncrona para receber dados de um objeto Socket conectado.Begins an asynchronous request to receive data from a connected Socket object.

public:
 bool ReceiveAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool ReceiveAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.ReceiveAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function ReceiveAsync (e As SocketAsyncEventArgs) As Boolean

Parâmetros

e
SocketAsyncEventArgs

O objeto SocketAsyncEventArgs a ser usado nessa operação de soquete assíncrono.The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Retornos

Boolean

true se a operação de E/S está pendente.true if the I/O operation is pending. O evento Completed no parâmetro e será acionado após a conclusão da operação.The Completed event on the e parameter will be raised upon completion of the operation.

false se a operação de E/S foi concluída de forma síncrona.false if the I/O operation completed synchronously. Nesse caso, o evento Completed no parâmetro e não será gerado e o objeto e passado como um parâmetro poderá ser examinado imediatamente depois que a chamada do método for retornada para recuperar o resultado da operação.In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exceções

Um argumento era inválido.An argument was invalid. As propriedades Buffer ou BufferList no parâmetro e devem referenciar buffers válidos.The Buffer or BufferList properties on the e parameter must reference valid buffers. Uma ou a outra dessas propriedades poderá ser definida, mas não ambas ao mesmo tempo.One or the other of these properties may be set, but not both at the same time.

Uma operação de soquete já estava em andamento com o objeto SocketAsyncEventArgs especificado no parâmetro e.A socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

É necessário o Windows XP ou posterior para esse método.Windows XP or later is required for this method.

O Socket foi fechado.The Socket has been closed.

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

Comentários

O ReceiveAsync método é usado em soquetes conectados ou em soquetes sem conexão vinculada e é usado para ler dados de entrada.The ReceiveAsync method is used on connected sockets or bound connectionless sockets and is used to read incoming data. O endereço local do soquete deve ser conhecido.The socket's local address must be known.

Para soquetes sem conexão vinculada, essa função restringe os endereços dos quais as mensagens recebidas são aceitas.For bound connectionless sockets, this function restricts the addresses from which received messages are accepted. A função retorna apenas mensagens do endereço remoto especificado na conexão.The function only returns messages from the remote address specified in the connection. As mensagens de outros endereços são silenciosamente descartadas.Messages from other addresses are silently discarded.

A SocketAsyncEventArgs.SocketFlags propriedade no e parâmetro fornece o provedor de serviços do Window Sockets com informações adicionais sobre a solicitação de leitura.The SocketAsyncEventArgs.SocketFlags property on the e parameter provides the Window Sockets service provider with additional information about the read request. Para obter mais informações sobre como usar esse parâmetro, consulte System.Net.Sockets.SocketFlags .For more information about how to use this parameter, see System.Net.Sockets.SocketFlags.

As seguintes propriedades e eventos no System.Net.Sockets.SocketAsyncEventArgs objeto são necessários para chamar esse método com êxito:The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:

O chamador pode definir a SocketAsyncEventArgs.UserToken propriedade para qualquer objeto de estado de usuário desejado antes de chamar o ReceiveAsync método, de modo que as informações serão recuperáveis no método de retorno de chamada.The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ReceiveAsync method, so that the information will be retrievable in the callback method. Se o retorno de chamada precisar de mais informações do que um único objeto, uma classe pequena poderá ser criada para manter as outras informações de estado necessárias como membros.If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.

Para soquetes de estilo de fluxo de bytes, os dados de entrada são colocados no buffer até que o buffer seja preenchido, a conexão é fechada ou os dados armazenados em buffer internamente são esgotados.For byte stream-style sockets, incoming data is placed into the buffer until the buffer is filled, the connection is closed, or the internally buffered data is exhausted.

Para soquetes orientados a mensagens, uma mensagem de entrada é colocada no buffer até o tamanho total do buffer associado ao e parâmetro.For message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer associated with the e parameter. Se a mensagem for maior que o buffer, o buffer será preenchido com a primeira parte da mensagem.If the message is larger than the buffer, the buffer is filled with the first part of the message.

Para soquetes orientados a conexão, o ReceiveAsync método pode indicar o encerramento normal do circuito virtual em uma das duas maneiras que dependem de o soquete ser orientado por fluxo ou mensagem de byte.For connection-oriented sockets, the ReceiveAsync method can indicate the graceful termination of the virtual circuit in one of two ways that depend on whether the socket is byte stream or message oriented. Para fluxos de bytes, zero bytes que tenham sido lidos indicam um fechamento normal e que nenhum número mais de bytes nunca será lido.For byte streams, zero bytes having been read indicates graceful closure and that no more bytes will ever be read. Para soquetes orientados a mensagens, em que uma mensagem de zero byte geralmente é permitida, a SocketException com o SocketAsyncEventArgs.SocketError conjunto de código de erro WSAEDISCON Winsock nativo (10101) é usado para indicar um fechamento normal.For message-oriented sockets, where a zero byte message is often allowable, a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAEDISCON error code (10101) is used to indicate graceful closure. De qualquer forma, um SocketException com o SocketAsyncEventArgs.SocketError conjunto de código de erro WSAECONNRESET nativo do Winsock (10054) indica que ocorreu um fechamento anulado.In any case, a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAECONNRESET error code (10054) indicates an abortive close has occurred.

Aplica-se a

Confira também