Socket.ReceiveMessageFromAsync(SocketAsyncEventArgs) Methode

Definition

Beginnt unter Verwendung der angegebenen SocketFlags den asynchronen Empfang der angegebenen Anzahl von Datenbytes an der angegebenen Position im Datenpuffer und speichert die Endpunkt- und Paketinformationen.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

Parameter

e
SocketAsyncEventArgs

Das SocketAsyncEventArgs-Objekt, das für diesen asynchronen Socketvorgang verwendet werden soll.The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Gibt zurück

true, wenn der E/A-Vorgang aussteht.true if the I/O operation is pending. Das Completed-Ereignis für den e-Parameter wird nach dem Abschluss des Vorgangs ausgelöst.The Completed event on the e parameter will be raised upon completion of the operation.

false, wenn der E/A-Vorgang synchron abgeschlossen wurde.false if the I/O operation completed synchronously. In diesem Fall wird das Completed-Ereignis für den e-Parameter nicht ausgelöst, und das als Parameter übergebene e-Objekt kann direkt nach der Rückgabe des Methodenaufrufs untersucht werden, um die Ergebnisse des Vorgangs abzurufen.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.

Ausnahmen

RemoteEndPoint darf nicht NULL sein.The RemoteEndPoint cannot be null.

Für diese Methode ist Windows XP oder höher erforderlich.Windows XP or later is required for this method.

Der Socket wurde geschlossen.The Socket has been closed.

Fehler beim Versuch, auf den Socket zuzugreifen.An error occurred when attempting to access the socket.

Hinweise

Die ReceiveMessageFromAsync-Methode wird hauptsächlich verwendet, um Nachrichten Daten in einem Verbindungs losen Socket zu empfangen.The ReceiveMessageFromAsync method is used primarily to receive message data on a connectionless socket. Die lokale Adresse des Sockets muss bekannt sein.The socket's local address must be known. Diese Methode kann nur mit Datagramm-und RAW-Sockets verwendet werden.This method can only be used with datagram and raw sockets. Der Socket muss initialisiert werden, wenn der socketyp auf Dgram oder Raw festgelegt ist, bevor diese Methode aufgerufen wird.The socket must be initialized with the socket type set to Dgram or Raw before calling this method. Dies kann geschehen, wenn der Socket mithilfe Socketerstellt wird.This can be done when the socket is constructed using Socket.

Der Aufrufer muss die SocketAsyncEventArgs.RemoteEndPoint-Eigenschaft auf die IPEndPoint des Remote Hosts festlegen, von dem die Daten empfangen werden sollen.The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host from which the data is to be received.

Die folgenden Eigenschaften und Ereignisse für das System.Net.Sockets.SocketAsyncEventArgs Objekt sind erforderlich, um diese Methode erfolgreich aufzurufen:The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:

Der Aufrufer kann die SocketAsyncEventArgs.UserToken-Eigenschaft auf ein beliebiges Benutzer Zustands Objekt festlegen, bevor die ReceiveMessageFromAsync-Methode aufgerufen wird, damit die Informationen in der Rückruf Methode abgerufen werden können.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. Wenn der Rückruf mehr Informationen benötigt als ein einzelnes Objekt, kann eine kleine Klasse erstellt werden, die die anderen erforderlichen Zustandsinformationen als Member enthält.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.

Bei Nachrichten orientierten Sockets wird eine eingehende Nachricht bis zur Gesamtgröße des Puffers in den Puffer eingefügt.For message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer. Die Eigenschaften "SocketAsyncEventArgs.Count" und "SocketAsyncEventArgs.Offset" bestimmen, wo die Daten im Puffer abgelegt werden, und die Datenmenge.The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

Die ReceiveMessageFromAsync-Methode legt die PacketInformation Socket-Option automatisch auf true fest, wenn Sie zum ersten Mal für eine bestimmte Socketaufgerufen wird.The ReceiveMessageFromAsync method automatically sets the PacketInformation socket option to true the first time it is called for a given Socket. Das IPPacketInformation-Objekt ist jedoch nur für Pakete gültig, die auf dem lokalen Computer eintreffen, nachdem die Socketoption festgelegt wurde.However, the IPPacketInformation object will only be valid for packets which arrive at the local computer after the socket option has been set. Wenn an einen Socket Pakete gesendet werden, zwischen denen der Socket an einen lokalen Endpunkt gebunden ist (explizit durch die Bind-Methode oder implizit durch eine der Methoden Connect, ConnectAsync, SendTooder SendToAsync) und der erste aufrufsvorgang der ReceiveMessageFromAsync-Methode. führt der Aufruf von ReceiveMessageFromAsync-Methode zu ungültigen IPPacketInformation Objekten für diese Pakete.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.

Um sicherzustellen, dass alle IPPacketInformation-Objekte gültig sind, sollte eine Anwendung die PacketInformation Socket-Option auftrue festlegen, bevor Sie mithilfe der SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)-Methode an einen lokalen Endpunkt gebunden wird.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.

Eine Anwendung kann die resultierenden IPPacketInformation Objekte untersuchen, wenn Sie wissen muss, ob das Datagramm mithilfe einer Unicast-, Multicast-oder Broadcast Adresse gesendet wurde.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.

Gilt für:

Siehe auch