DatagramSocketMessageReceivedEventArgs Class

  • Reference

Definition

Namespace:
Windows.Networking.Sockets
Edit

Provides data for a MessageReceived event on a DatagramSocket.

public ref class DatagramSocketMessageReceivedEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.GCPressure]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DatagramSocketMessageReceivedEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.GCPressure]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DatagramSocketMessageReceivedEventArgs
Public NotInheritable Class DatagramSocketMessageReceivedEventArgs
Inheritance
Object Platform::Object IInspectable DatagramSocketMessageReceivedEventArgs
Attributes
ContractVersionAttribute GCPressureAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities
ID_CAP_NETWORKING [Windows Phone]

Remarks

The DatagramSocketMessageReceivedEventArgs is used to receive data on a DatagramSocket object.

The DatagramSocket.BindServiceNameAsync or DatagramSocket.BindEndpointAsync method is used to bind a DatagramSocket to a local service name or UDP port if a DatagramSocket instance wants to listen and receive data. These methods are not needed if the DatagramSocket is to be used only for sending data.

A DatagramSocket.MessageReceived event occurs on a DatagramSocket that has been bound to a local service name or UDP port when a message is received. A DatagramSocketMessageReceivedEventArgs instance is created when the DatagramSocket.MessageReceived event occurs.

There are two primary methods to read data when a message has been received:

  • The GetDataStream method returns a Streams.IInputStream object that represents a sequential stream of bytes in the received message. The app must then parse the received stream of bytes.
  • The GetDataReader method returns a Streams.DataReader object to read incoming data. The Streams.DataReader object has separate methods to read the data in a variety of formats including bytes, signed and unsigned integers, boolean values, single and double floating point numbers, strings, date time and time span values, GUIDs, and buffers. These methods can be used directly to parse the received message.

Properties

LocalAddress

Gets the local IP address associated with a DatagramSocket when a message was received.
RemoteAddress

Gets the IP address of the remote sender of the datagram on the DatagramSocket when a message is received.
RemotePort

Gets the UDP port number of the remote sender of the datagram received on the DatagramSocket.

Methods

GetDataReader()

Gets a DataReader object to read incoming data received from the remote network destination on a DatagramSocket object.
GetDataStream()

Gets an IInputStream object that represents a sequential stream of bytes to be read as a message from the remote network destination on a DatagramSocket object.

Applies to

See also