Socket.ReceiveMessageFromAsync Méthode

Source:

Socket.cs

Source:

Socket.cs

Source:

Socket.cs

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

Paramètres

Retours

true si l’opération d’E/S est en attente. L'événement Completed sur le paramètre e sera déclenché une fois l'opération terminée.

false si l’opération d’E/S a été terminée de manière synchrone. Dans ce cas, l'événement Completed sur le paramètre e ne sera pas déclenché et l'objet e transmis en tant que paramètre peut être examiné immédiatement après que l'appel de méthode a été retourné pour extraire le résultat de l'opération.

Exceptions

Remarques

La ReceiveMessageFromAsync méthode est principalement utilisée pour recevoir des données de message sur un socket sans connexion. L’adresse locale du socket doit être connue. Cette méthode ne peut être utilisée qu’avec des datagrammes et des sockets bruts. Le socket doit être initialisé avec le type de socket défini sur Dgram ou Raw avant d’appeler cette méthode. Cela peut être effectué lorsque le socket est construit à l’aide de Socket.

L’appelant doit définir la SocketAsyncEventArgs.RemoteEndPoint propriété sur un EndPoint du même type que le point de terminaison de l’hôte distant. La propriété sera mise à jour lors de la réception réussie vers le point de terminaison distant réel.

Les propriétés et événements suivants sur l’objet System.Net.Sockets.SocketAsyncEventArgs sont nécessaires pour appeler cette méthode :

• SocketAsyncEventArgs.Buffer

• SocketAsyncEventArgs.Count

• SocketAsyncEventArgs.Offset

• SocketAsyncEventArgs.RemoteEndPoint

• SocketAsyncEventArgs.Completed

L’appelant peut définir la SocketAsyncEventArgs.UserToken propriété sur n’importe quel objet d’état utilisateur souhaité avant d’appeler la ReceiveMessageFromAsync méthode, afin que les informations soient récupérables dans la méthode de rappel. Si le rappel a besoin de plus d’informations qu’un seul objet, une petite classe peut être créée pour contenir les autres informations d’état requises en tant que membres.

Pour les sockets orientés message, un message entrant est placé dans la mémoire tampon jusqu’à la taille totale de la mémoire tampon. Les SocketAsyncEventArgs.Count propriétés et SocketAsyncEventArgs.Offset déterminent où dans la mémoire tampon les données sont placées et la quantité de données.

La ReceiveMessageFromAsync méthode définit automatiquement l’option PacketInformation socket sur true la première fois qu’elle est appelée pour un donné Socket. Toutefois, l’objet IPPacketInformation n’est valide que pour les paquets qui arrivent sur l’ordinateur local une fois l’option de socket définie. Si un socket est envoyé des paquets entre le moment où le socket est lié à un point de terminaison local (explicitement par la Bind méthode ou implicitement par l’une Connectdes méthodes , ConnectAsync, SendToouSendToAsync) et le premier appel à la méthode, les appels à ReceiveMessageFromAsync la ReceiveMessageFromAsync méthode entraînent des objets non valides IPPacketInformation pour ces paquets.

Pour s’assurer que tous les IPPacketInformation objets sont valides, une application doit définir l’option PacketInformation socket surtrue avant d’être liée à un point de terminaison local à l’aide de la SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean) méthode .

Une application peut examiner les objets résultants IPPacketInformation si elle doit savoir si le datagramme a été envoyé à l’aide d’une unidiffusion, d’une multidiffusion ou d’une adresse de diffusion.

Voir aussi

• SocketAsyncEventArgs
• Buffer
• Completed
• Count
• Offset
• RemoteEndPoint
• UserToken

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<System::Net::Sockets::SocketReceiveMessageFromResult> ^ ReceiveMessageFromAsync(ArraySegment<System::Byte> buffer, System::Net::EndPoint ^ remoteEndPoint);

public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync (ArraySegment<byte> buffer, System.Net.EndPoint remoteEndPoint);

member this.ReceiveMessageFromAsync : ArraySegment<byte> * System.Net.EndPoint -> System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult>

Public Function ReceiveMessageFromAsync (buffer As ArraySegment(Of Byte), remoteEndPoint As EndPoint) As Task(Of SocketReceiveMessageFromResult)

Paramètres

Retours

Tâche asynchrone qui se termine par un SocketReceiveMessageFromResult contenant le nombre d’octets reçus et des informations supplémentaires sur l’hôte d’envoi.

Exceptions

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<System::Net::Sockets::SocketReceiveMessageFromResult> ^ ReceiveMessageFromAsync(ArraySegment<System::Byte> buffer, System::Net::Sockets::SocketFlags socketFlags, System::Net::EndPoint ^ remoteEndPoint);

public System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync (ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint);

member this.ReceiveMessageFromAsync : ArraySegment<byte> * System.Net.Sockets.SocketFlags * System.Net.EndPoint -> System.Threading.Tasks.Task<System.Net.Sockets.SocketReceiveMessageFromResult>

Public Function ReceiveMessageFromAsync (buffer As ArraySegment(Of Byte), socketFlags As SocketFlags, remoteEndPoint As EndPoint) As Task(Of SocketReceiveMessageFromResult)

Paramètres

Retours

Tâche asynchrone qui se termine par un SocketReceiveMessageFromResult contenant le nombre d’octets reçus et des informations supplémentaires sur l’hôte d’envoi.

Exceptions

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync (Memory<byte> buffer, System.Net.EndPoint remoteEndPoint, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveMessageFromAsync : Memory<byte> * System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveMessageFromResult>

Public Function ReceiveMessageFromAsync (buffer As Memory(Of Byte), remoteEndPoint As EndPoint, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of SocketReceiveMessageFromResult)

Paramètres

Retours

Tâche asynchrone qui se termine par un SocketReceiveMessageFromResult contenant le nombre d’octets reçus et des informations supplémentaires sur l’hôte d’envoi.

Exceptions

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

Source:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveMessageFromResult> ReceiveMessageFromAsync (Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Net.EndPoint remoteEndPoint, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveMessageFromAsync : Memory<byte> * System.Net.Sockets.SocketFlags * System.Net.EndPoint * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Net.Sockets.SocketReceiveMessageFromResult>

Public Function ReceiveMessageFromAsync (buffer As Memory(Of Byte), socketFlags As SocketFlags, remoteEndPoint As EndPoint, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of SocketReceiveMessageFromResult)

Paramètres

Retours

Tâche asynchrone qui se termine par un SocketReceiveMessageFromResult contenant le nombre d’octets reçus et des informations supplémentaires sur l’hôte d’envoi.

Exceptions