Socket.BeginReceiveFrom Metodo

Definizione

Inizia a ricevere dati in modalità asincrona da un dispositivo di rete specificato.

public:
 IAsyncResult ^ BeginReceiveFrom(cli::array <System::Byte> ^ buffer, int offset, int size, System::Net::Sockets::SocketFlags socketFlags, System::Net::EndPoint ^ % remoteEP, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginReceiveFrom (byte[] buffer, int offset, int size, System.Net.Sockets.SocketFlags socketFlags, ref System.Net.EndPoint remoteEP, AsyncCallback? callback, object? state);
public IAsyncResult BeginReceiveFrom (byte[] buffer, int offset, int size, System.Net.Sockets.SocketFlags socketFlags, ref System.Net.EndPoint remoteEP, 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, socketFlags As SocketFlags, ByRef remoteEP As EndPoint, callback As AsyncCallback, state As Object) As IAsyncResult

Parametri

buffer
Byte[]

Matrice di tipo Byte che costituisce la posizione di archiviazione per i dati ricevuti.

offset
Int32

Posizione in base zero nel parametro bufferin cui memorizzare i dati.

size
Int32

Numero di byte da ricevere.

socketFlags
SocketFlags

Combinazione bit per bit dei valori di SocketFlags.

remoteEP
EndPoint

Riferimento a uno EndPoint dello stesso tipo dell'endpoint dell'host remoto da aggiornare alla ricezione sincrona.

callback
AsyncCallback

Delegato AsyncCallback.

state
Object

Oggetto che contiene informazioni sullo stato per questa richiesta.

Restituisce

Oggetto IAsyncResult che fa riferimento alla lettura asincrona.

Eccezioni

buffer è null.

-oppure-

remoteEP è null.

Solo .NET Framework e .NET 5 e versioni precedenti: si è verificato un errore durante il tentativo di accesso al socket.

offset è minore di 0.

-oppure-

offset è maggiore della lunghezza di buffer.

-oppure-

size è minore di 0.

-oppure-

size è maggiore della lunghezza di buffer meno il valore del parametro offset .

L'oggetto Socket è stato chiuso.

Un chiamante di livello superiore nello stack di chiamate non ha l'autorizzazione per l'operazione richiesta.

Commenti

Importante

Si tratta di un'API di compatibilità. Non è consigliabile usare i metodi APM (Begin* e End*) per nuovi sviluppi. Usare invece gli Taskequivalenti basati su .

È possibile passare un callback che implementa AsyncCallback a BeginReceiveFrom per ricevere una notifica sul completamento dell'operazione. Si noti che se lo stack di rete sottostante completa l'operazione in modo sincrono, il callback verrà eseguito inline, durante la chiamata a BeginReceiveFrom. In questo caso, la CompletedSynchronously proprietà sull'oggetto restituito verrà impostata IAsyncResult su true per indicare che il metodo è stato completato in modo sincrono. Utilizzare la AsyncState proprietà di IAsyncResult per ottenere l'oggetto stato passato al BeginReceiveFrom metodo .

L'operazione asincrona BeginReceiveFrom deve essere completata chiamando il EndReceiveFrom metodo . In genere, il metodo viene richiamato dal AsyncCallback delegato. EndReceiveFrom blocca il thread chiamante fino al completamento dell'operazione.

Questo metodo legge i dati nel buffer parametro e acquisisce l'endpoint host remoto da cui vengono inviati i dati. Per informazioni su come recuperare questo endpoint, vedere EndReceiveFrom. Questo metodo è più utile se si intende ricevere in modo asincrono datagrammi senza connessione da un host sconosciuto o da più host. In questi casi, BeginReceiveFrom leggerà il primo datagramma accodato ricevuto nel buffer di rete locale. Se il datagramma ricevuto è maggiore delle dimensioni di buffer, il BeginReceiveFrom metodo riempirà buffer la maggior parte del messaggio possibile e genererà un'eccezione SocketException. Se si usa un protocollo inaffidabile, i dati in eccesso andranno persi. Se si usa un protocollo affidabile, i dati in eccesso verranno conservati dal provider di servizi e sarà possibile recuperarlo chiamando il BeginReceiveFrom metodo con un buffer sufficientemente grande.

Per garantire che l'endpoint host remoto venga sempre restituito, un'applicazione deve associare in modo esplicito a Socket un endpoint locale usando il Bind metodo e quindi chiamare il metodo con il optionLevelSetSocketOption parametro impostato su IP oIPv6, il optionName parametro impostato su PacketInformatione il optionValue parametro per abilitare questa opzione prima di chiamare il BeginReceiveFrom metodo . In caso contrario, è possibile che l'endpoint host remoto non venga restituito quando il mittente ha inviato un numero di datagrammi prima che il ricevitore abbia chiamato il BeginReceiveFrom metodo .

Anche se BeginReceiveFrom è destinato ai protocolli senza connessione, è possibile usare anche un protocollo orientato alla connessione. Se si sceglie di eseguire questa operazione, è innanzitutto necessario stabilire una connessione host remota chiamando il Connect / BeginConnect metodo o accettando una richiesta di connessione in ingresso chiamando il Accept metodo o .BeginAccept Se si chiama il BeginReceiveFrom metodo prima di stabilire o accettare una connessione, si otterrà un oggetto SocketException. È anche possibile stabilire un host remoto predefinito per un protocollo senza connessione prima di chiamare il BeginReceiveFrom metodo .

Parametro remoteEp

Con i socket orientati alla connessione, BeginReceiveFrom leggerà la quantità di dati disponibile fino al numero di byte specificato dal size parametro .

Per annullare un oggetto in sospeso BeginReceiveFrom, chiamare il Close metodo .

Nota

Se si riceve un SocketExceptionoggetto , utilizzare la SocketException.ErrorCode proprietà per ottenere il codice di errore specifico.

Nota

Questo membro genera informazioni di traccia quando viene abilitata la funzionalità di traccia di rete nell'applicazione in uso. Per altre informazioni, vedere Traccia di rete in .NET Framework.

Nota

Il contesto di esecuzione (il contesto di sicurezza, l'utente rappresentato e il contesto chiamante) viene memorizzato nella cache per i metodi asincroni Socket . Dopo il primo uso di un contesto specifico (un metodo asincrono Socket specifico, un'istanza specifica Socket e un callback specifico), gli usi successivi di tale contesto vedranno un miglioramento delle prestazioni.

Si applica a

Vedi anche