Socket.BeginReceiveFrom(Byte[], Int32, Int32, SocketFlags, EndPoint, AsyncCallback, Object) Methode

Definition

Beginnt den asynchronen Datenempfang aus dem angegebenen Netzwerkgerät.Begins to asynchronously receive data from a specified network device.

public:
 IAsyncResult ^ BeginReceiveFrom(cli::array <System::Byte> ^ buffer, int offset, int size, System::Net::Sockets::SocketFlags socket_flags, System::Net::EndPoint ^ % remote_end, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginReceiveFrom (byte[] buffer, int offset, int size, System.Net.Sockets.SocketFlags socket_flags, ref System.Net.EndPoint remote_end, AsyncCallback callback, object state);
member this.BeginReceiveFrom : byte[] * int * int * System.Net.Sockets.SocketFlags * EndPoint * AsyncCallback * obj -> IAsyncResult
Public Function BeginReceiveFrom (buffer As Byte(), offset As Integer, size As Integer, socket_flags As SocketFlags, ByRef remote_end As EndPoint, callback As AsyncCallback, state As Object) As IAsyncResult

Parameter

buffer
Byte[]

Ein Array vom Typ Byte, das der Speicherort für die empfangenen Daten ist.An array of type Byte that is the storage location for the received data.

offset
Int32

Die nullbasierte Position im buffer-Parameter, an der die Daten gespeichert werden.The zero-based position in the buffer parameter at which to store the data.

size
Int32

Die Anzahl der zu empfangenden Bytes.The number of bytes to receive.

socketFlags
SocketFlags

Eine bitweise Kombination der SocketFlags-Werte.A bitwise combination of the SocketFlags values.

remoteEP
EndPoint

Ein EndPoint, der die Datenquelle darstellt.An EndPoint that represents the source of the data.

callback
AsyncCallback

Der AsyncCallback-Delegat.The AsyncCallback delegate.

state
Object

Ein Objekt mit Zustandsinformationen für diese Anforderung.An object that contains state information for this request.

Gibt zurück

Ein IAsyncResult, das auf den asynchronen Lesevorgang verweist.An IAsyncResult that references the asynchronous read.

Ausnahmen

buffer ist null.buffer is null.

- oder --or- remoteEP ist null.remoteEP is null.

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

offset ist kleiner als 0.offset is less than 0.

- oder --or- offset ist größer als die Länge von buffer.offset is greater than the length of buffer.

- oder --or- size ist kleiner als 0.size is less than 0.

- oder --or- size ist größer als die Länge von buffer minus dem Wert des offset -Parameters.size is greater than the length of buffer minus the value of the offset parameter.

Der Socket wurde geschlossen.The Socket has been closed.

Ein höher in der Aufrufliste befindlicher Aufrufer verfügt nicht über die Berechtigung für den angeforderten Vorgang.A caller higher in the call stack does not have permission for the requested operation.

Beispiele

Im folgenden Codebeispiel werden verbindungslose Datagramme von einem Remote Host asynchron empfangen.The following code example asynchronously receives connectionless datagrams from a remote host.

IPHostEntry^ lipa = Dns::Resolve( "host.contoso.com" );
IPEndPoint^ lep = gcnew IPEndPoint( lipa->AddressList[ 0 ], 11000);

   Socket^ s = gcnew Socket( lep->Address->AddressFamily,
      SocketType::Dgram,
      ProtocolType::Udp);
   
   IPEndPoint^ sender = gcnew IPEndPoint( IPAddress::Any, 0 );
   EndPoint^ tempRemoteEP = (EndPoint^)( sender );
   s->Connect( sender );
   
   try{
      while(true){
         allDone->Reset();
         StateObject^ so2 = gcnew StateObject();
             so2->workSocket = s;
             Console::WriteLine( "Attempting to Receive data from host.contoso.com" );
         
             s->BeginReceiveFrom( so2->buffer, 0, StateObject::BUFFER_SIZE, SocketFlags::None, tempRemoteEP,
            gcnew AsyncCallback( &Async_Send_Receive::ReceiveFrom_Callback), so2);	
             allDone->WaitOne();
        }
   }
   catch ( Exception^ e )
   {
        Console::WriteLine( e );
   }
IPHostEntry lipa = Dns.Resolve("host.contoso.com");
IPEndPoint lep = new IPEndPoint(lipa.AddressList[0], 11000);

   Socket s = new Socket(lep.Address.AddressFamily,
                               SocketType.Dgram,
                                     ProtocolType.Udp);
   
   IPEndPoint sender = new IPEndPoint(IPAddress.Any, 0);
   EndPoint tempRemoteEP = (EndPoint)sender;
   s.Connect(sender);
   
   try{
        while(true){
             allDone.Reset();
             StateObject so2 = new StateObject();
             so2.workSocket = s;
             Console.WriteLine("Attempting to Receive data from host.contoso.com");
         
             s.BeginReceiveFrom(so2.buffer, 0, StateObject.BUFFER_SIZE,0, ref tempRemoteEP,
                                   new AsyncCallback(Async_Send_Receive.ReceiveFrom_Callback), so2);	
             allDone.WaitOne();
        }
   }
   catch (Exception e){
        Console.WriteLine(e.ToString());
   }
   Dim lipa As IPHostEntry = Dns.Resolve("host.contoso.com")
   Dim lep As New IPEndPoint(lipa.AddressList(0), 11000)
   
   Dim s As New Socket(lep.Address.AddressFamily, SocketType.DGram, ProtocolType.Udp)
   
   Dim sender As New IPEndPoint(IPAddress.Any, 0)
   Dim tempRemoteEP As EndPoint = CType(sender, EndPoint)
   s.Connect(sender)
   Try
      While True
         allDone.Reset()
         Dim so2 As New StateObject()
         so2.workSocket = s
         Console.WriteLine("Attempting to Receive data from host.contoso.com")
         
         s.BeginReceiveFrom(so2.buffer, 0, StateObject.BUFFER_SIZE, 0, tempRemoteEP, New AsyncCallback(AddressOf Async_Send_Receive.ReceiveFrom_Callback), so2)
         allDone.WaitOne()
      End While
   Catch e As Exception
      Console.WriteLine(e.ToString())
   End Try
End Sub

Hinweise

Die BeginReceiveFrom-Methode startet das asynchrone Lesen von Verbindungs losen Datagramme von einem Remote Host.The BeginReceiveFrom method starts asynchronously reading connectionless datagrams from a remote host. Wenn Sie die BeginReceiveFrom-Methode aufrufen, haben Sie die Möglichkeit, Daten in einem separaten Ausführungs Thread zu empfangen.Calling the BeginReceiveFrom method gives you the ability to receive data within a separate execution thread.

Sie können eine Rückruf Methode erstellen, die den AsyncCallback Delegaten implementiert und seinen Namen an die BeginReceiveFrom-Methode übergibt.You can create a callback method that implements the AsyncCallback delegate and pass its name to the BeginReceiveFrom method. Um dies zu erreichen, muss der state Parameter den verbundenen oder den Standard Socket enthalten, der für die Kommunikation verwendet wird.To do this, at the very minimum, your state parameter must contain the connected or default Socket being used for communication. Wenn Ihr Rückruf Weitere Informationen benötigt, können Sie eine kleine Klasse erstellen, um die Socket und die anderen erforderlichen Informationen zu speichern.If your callback needs more information, you can create a small class to hold the Socket and the other required information. Übergeben Sie mithilfe des state-Parameters eine Instanz dieser Klasse an die BeginReceiveFrom-Methode.Pass an instance of this class to the BeginReceiveFrom method through the state parameter.

Die Rückruf Methode sollte die EndReceiveFrom-Methode aufrufen.Your callback method should invoke the EndReceiveFrom method. Wenn die Anwendung BeginReceiveFromaufruft, verwendet das System einen separaten Thread, um die angegebene Rückruf Methode auszuführen, und blockiert EndReceiveFrom, bis der Socket Daten liest oder eine Ausnahme auslöst.When your application calls BeginReceiveFrom, the system will use a separate thread to execute the specified callback method, and it will block on EndReceiveFrom until the Socket reads data or throws an exception. Wenn der ursprüngliche Thread blockiert werden soll, nachdem Sie die BeginReceiveFrom-Methode aufgerufen haben, verwenden Sie WaitHandle.WaitOne.If you want the original thread to block after you call the BeginReceiveFrom method, use WaitHandle.WaitOne. Rufen Sie die Set-Methode für ein T:System.Threading.ManualResetEvent in der Rückruf Methode auf, wenn der ursprüngliche Thread weiter ausgeführt werden soll.Call the Set method on a T:System.Threading.ManualResetEvent in the callback method when you want the original thread to continue executing. Weitere Informationen zum Schreiben von Rückruf Methoden finden Sie unter Mars Hallen eines Delegaten als Rückruf Methode.For additional information on writing callback methods, see Marshaling a Delegate as a Callback Method.

Hinweis

Vor dem Aufrufen von BeginReceiveFrommüssen Sie die Socket mithilfe der Bind-Methode explizit an einen lokalen Endpunkt binden, oder BeginReceiveFrom löst eine SocketExceptionaus.Before calling BeginReceiveFrom, you must explicitly bind the Socket to a local endpoint using the Bind method, or BeginReceiveFrom will throw a SocketException.

Diese Methode liest Daten in den buffer-Parameter und erfasst den Remote Host Endpunkt, von dem die Daten gesendet werden.This method reads data into the buffer parameter, and captures the remote host endpoint from which the data is sent. Informationen zum Abrufen dieses Endpunkts finden Sie unter EndReceiveFrom.For information on how to retrieve this endpoint, refer to EndReceiveFrom. Diese Methode ist besonders nützlich, wenn Sie verbindungslose Datagramme von einem unbekannten Host oder mehreren Hosts asynchron empfangen möchten.This method is most useful if you intend to asynchronously receive connectionless datagrams from an unknown host or multiple hosts. In diesen Fällen liest BeginReceiveFrom das erste in die Warteschlange eingereihte Datagramm, das in den Puffer des lokalen Netzwerks empfangen wird.In these cases, BeginReceiveFrom will read the first enqueued datagram received into the local network buffer. Wenn das Datagramm, das Sie empfangen, größer ist als die Größe der buffer, wird die BeginReceiveFrom Methode buffer mit dem größtmöglichen Wert der Nachricht aufgefüllt und eine SocketExceptionauslösen.If the datagram you receive is larger than the size of buffer, the BeginReceiveFrom method will fill buffer with as much of the message as is possible, and throw a SocketException. Wenn Sie ein unzuverlässiges Protokoll verwenden, gehen die Daten verloren.If you are using an unreliable protocol, the excess data will be lost. Wenn Sie ein zuverlässiges Protokoll verwenden, werden die überzähligen Daten vom Dienstanbieter aufbewahrt, und Sie können Sie abrufen, indem Sie die BeginReceiveFrom-Methode mit einem ausreichend großen Puffer aufrufen.If you are using a reliable protocol, the excess data will be retained by the service provider and you can retrieve it by calling the BeginReceiveFrom method with a large enough buffer.

Um sicherzustellen, dass der Remote Host Endpunkt immer zurückgegeben wird, sollte eine Anwendung die Socket mithilfe der Bind-Methode explizit an einen lokalen Endpunkt binden und dann die SetSocketOption-Methode aufrufen, wobei der optionLevel-Parameter auf IP oder IPv6 als festgelegt ist. entsprechend wird der optionName-Parameter auf PacketInformationfestgelegt, und der optionValue-Parameter, um diese Option zu aktivieren, bevor die BeginReceiveFrom-Methode aufgerufen wird.To guarantee that the remote host endpoint is always returned, an application should explicitly bind the Socket to a local endpoint using the Bind method and then call the SetSocketOption method with the optionLevel parameter set to IP or IPv6 as appropriate, the optionName parameter set to PacketInformation, and the optionValue parameter to enable this option before calling the BeginReceiveFrom method. Andernfalls ist es möglich, dass der Remote Host Endpunkt nicht zurückgegeben wird, wenn der Absender eine Reihe von Datagramme gesendet hat, bevor der Empfänger die BeginReceiveFrom-Methode aufgerufen hat.Otherwise, it is possible for the remote host endpoint to not be returned when the sender has sent a number of datagrams before the receiver has called the BeginReceiveFrom method.

Obwohl BeginReceiveFrom für verbindungslose Protokolle vorgesehen ist, können Sie auch ein Verbindungs orientiertes Protokoll verwenden.Although BeginReceiveFrom is intended for connectionless protocols, you can use a connection-oriented protocol as well. Wenn Sie sich dafür entscheiden, müssen Sie zuerst eine Remote Host Verbindung herstellen, indem Sie die Connect / BeginConnect-Methode aufrufen oder eine eingehende Verbindungsanforderung akzeptieren, indem Sie die Accept-oder BeginAccept-Methode aufrufen.If you choose to do so, you must first either establish a remote host connection by calling the Connect / BeginConnect method or accept an incoming connection request by calling the Accept or BeginAccept method. Wenn Sie die BeginReceiveFrom-Methode vor dem Einrichten oder akzeptieren einer Verbindung aufzurufen, erhalten Sie eine SocketException.If you call the BeginReceiveFrom method before establishing or accepting a connection, you will get a SocketException. Sie können auch einen Standard-Remote Host für ein verbindungsloses Protokoll einrichten, bevor Sie die BeginReceiveFrom-Methode aufrufen.You can also establish a default remote host for a connectionless protocol prior to calling the BeginReceiveFrom method. In beiden Fällen ignoriert die BeginReceiveFrom Methode den remoteEP-Parameter und empfängt nur Daten vom verbundenen oder standardmäßigen Remote Host.In either of these cases, the BeginReceiveFrom method will ignore the remoteEP parameter and only receive data from the connected or default remote host.

Mit Verbindungs orientierten Sockets lesen BeginReceiveFrom so viele Daten, wie Sie bis zur Anzahl der Bytes verfügbar sind, die durch den Parameter size angegeben werden.With connection-oriented sockets, BeginReceiveFrom will read as much data as is available up to the number of bytes specified by the size parameter.

Um einen ausstehenden BeginReceiveFromabzubrechen, rufen Sie die Close-Methode auf.To cancel a pending BeginReceiveFrom, call the Close method.

Hinweis

Wenn Sie erhalten eine SocketException, verwenden die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode zu erhalten.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. Nachdem Sie diesen Code abgerufen haben, finden Sie in der API-Fehlercode Dokumentation der Windows Sockets, Version 2 , eine ausführliche Beschreibung des Fehlers.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Hinweis

Dieser Member gibt Ablaufverfolgungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in der Anwendung aktivieren.This member outputs trace information when you enable network tracing in your application. Weitere Informationen finden Sie unter Netzwerk Ablauf Verfolgung in der .NET Framework.For more information, see Network Tracing in the .NET Framework.

Hinweis

Der Ausführungs Kontext (der Sicherheitskontext, der Benutzer, dessen Identität angenommen wurde, und der aufrufende Kontext) wird für die asynchronen Socket Methoden zwischengespeichert.The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous Socket methods. Nach der ersten Verwendung eines bestimmten Kontexts (einer bestimmten asynchronen Socket Methode, einer bestimmten Socket Instanz und eines bestimmten Rückrufs) wird bei der nachfolgenden Verwendung dieses Kontexts eine Leistungsverbesserung angezeigt.After the first use of a particular context (a specific asynchronous Socket method, a specific Socket instance, and a specific callback), subsequent uses of that context will see a performance improvement.

Gilt für:

Siehe auch