DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs Class

Provides data for a MessageReceived event on a DatagramSocket.

Syntax

Declaration

public sealed class DatagramSocketMessageReceivedEventArgspublic sealed class DatagramSocketMessageReceivedEventArgsPublic NotInheritable Class DatagramSocketMessageReceivedEventArgspublic sealed class DatagramSocketMessageReceivedEventArgs

Remarks

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

The BindServiceNameAsync(String, NetworkAdapter) or BindEndpointAsync(HostName, String) 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 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 MessageReceived event occurs.

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

  • The GetDataStream() method returns a 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 DataReader object to read incoming data. The 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 summary

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

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

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

Methods summary

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

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.

Properties

  • LocalAddress
    LocalAddress
    LocalAddress
    LocalAddress

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

    public HostName LocalAddress { get; }public HostName LocalAddress { get; }Public ReadOnly Property LocalAddress As HostNamepublic HostName LocalAddress { get; }

    Property Value

    Remarks

    The LocalAddress property gets the local IP address where a message was received on a DatagramSocket. A message received event can only occur after a successful connect or bind operation on the DatagramSocket.

  • RemoteAddress
    RemoteAddress
    RemoteAddress
    RemoteAddress

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

    public HostName RemoteAddress { get; }public HostName RemoteAddress { get; }Public ReadOnly Property RemoteAddress As HostNamepublic HostName RemoteAddress { get; }

    Property Value

    Remarks

    The RemoteAddress property gets the IP address of the remote sender when a datagram was received on a DatagramSocket. A message received event can only occur after a successful connect or bind operation on the DatagramSocket.

  • RemotePort
    RemotePort
    RemotePort
    RemotePort

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

    public string RemotePort { get; }public string RemotePort { get; }Public ReadOnly Property RemotePort As stringpublic string RemotePort { get; }

    Property Value

    • string
      string
      string
      string

      The UDP port number of the remote network destination when a message is received on a DatagramSocket.

    Remarks

    The RemotePort property gets the UDP port number of the remote sender when a datagram was received on a DatagramSocket. A message received event can only occur after a successful connect or bind operation on the DatagramSocket.

Methods

  • GetDataReader()
    GetDataReader()
    GetDataReader()
    GetDataReader()

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

    public DataReader GetDataReader()public DataReader GetDataReader()Public Function GetDataReader() As DataReaderpublic DataReader GetDataReader()

    Returns

  • GetDataStream()
    GetDataStream()
    GetDataStream()
    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.

    public IInputStream GetDataStream()public IInputStream GetDataStream()Public Function GetDataStream() As IInputStreampublic IInputStream GetDataStream()

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Capabilities

ID_CAP_NETWORKING [Windows Phone]

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.GCPressureAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Networking.Sockets.dll