Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Método

Definição

Inicia o recebimento de forma assíncrona do número especificado de bytes de dados no local especificado do buffer de dados, usando o SocketFlags especificado e armazena as informações de ponto de extremidade e de pacote.Begins to asynchronously receive the specified number of bytes of data into the specified location in the data buffer, using the specified SocketFlags, and stores the endpoint and packet information.

public:
 bool ReceiveMessageFromAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool ReceiveMessageFromAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.ReceiveMessageFromAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function ReceiveMessageFromAsync (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

O RemoteEndPoint não pode ser nulo.The RemoteEndPoint cannot be null.

É 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 ReceiveMessageFromAsync método é usado principalmente para receber dados de mensagem em um soquete sem conexão.The ReceiveMessageFromAsync method is used primarily to receive message data on a connectionless socket. O endereço local do soquete deve ser conhecido.The socket's local address must be known. Esse método só pode ser usado com datagrama e soquetes brutos.This method can only be used with datagram and raw sockets. O soquete deve ser inicializado com o tipo de soquete definido como Dgram ou Raw antes de chamar esse método.The socket must be initialized with the socket type set to Dgram or Raw before calling this method. Isso pode ser feito quando o soquete é construído usando Socket .This can be done when the socket is constructed using Socket.

O chamador deve definir a SocketAsyncEventArgs.RemoteEndPoint propriedade para o IPEndPoint do host remoto do qual os dados serão recebidos.The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host from which the data is to be received.

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 ReceiveMessageFromAsync 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 ReceiveMessageFromAsync 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 orientados a mensagens, uma mensagem de entrada é colocada no buffer até o tamanho total do buffer.For message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer. As SocketAsyncEventArgs.Count SocketAsyncEventArgs.Offset Propriedades e determinam onde os dados são colocados no buffer e a quantidade de dados.The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

O ReceiveMessageFromAsync método define automaticamente a PacketInformation opção socket para true a primeira vez que ela é chamada para um determinado Socket .The ReceiveMessageFromAsync method automatically sets the PacketInformation socket option to true the first time it is called for a given Socket. No entanto, o IPPacketInformation objeto só será válido para pacotes que chegam ao computador local após a opção de soquete ter sido definida.However, the IPPacketInformation object will only be valid for packets which arrive at the local computer after the socket option has been set. Se um soquete enviar pacotes entre quando o soquete estiver associado a um ponto de extremidade local (explicitamente pelo Bind método ou implicitamente por um dos Connect métodos, ConnectAsync , SendTo ou SendToAsync ) e a primeira chamada para o ReceiveMessageFromAsync método, as chamadas para o ReceiveMessageFromAsync método resultarão em objetos inválidos IPPacketInformation para esses pacotes.If a socket is sent packets between when the socket is bound to a local endpoint (explicitly by the Bind method or implicitly by one of the Connect, ConnectAsync, SendTo, or SendToAsync methods) and the first call to the ReceiveMessageFromAsync method, calls to ReceiveMessageFromAsync method will result in invalid IPPacketInformation objects for these packets.

Para garantir que todos os IPPacketInformation objetos sejam válidos, um aplicativo deve definir a PacketInformation opção socket para true antes de ser associado a um ponto de extremidade local usando o SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean) método.To ensure that all IPPacketInformation objects are valid, an application should set the PacketInformation socket option totrue before it is bound to a local endpoint using the SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean) method.

Um aplicativo pode examinar os objetos resultantes IPPacketInformation se precisar saber se o datagrama foi enviado usando um endereço unicast, multicast ou de difusão.An application can examine the resulting IPPacketInformation objects if it needs to know if the datagram was sent using a unicast, multicast, or broadcast address.

Aplica-se a

Confira também