DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs DatagramSocketMessageReceivedEventArgs Class

Definition

Namespace:
Windows.Networking.Sockets Windows.Networking.Sockets Windows.Networking.Sockets Windows.Networking.Sockets
Edit

Provides data for a MessageReceived event on a DatagramSocket.

public : sealed class DatagramSocketMessageReceivedEventArgs : IDatagramSocketMessageReceivedEventArgspublic sealed class DatagramSocketMessageReceivedEventArgs : IDatagramSocketMessageReceivedEventArgsPublic NotInheritable Class DatagramSocketMessageReceivedEventArgs Implements IDatagramSocketMessageReceivedEventArgs// You can use this class in JavaScript.
Attributes
ContractVersionAttribute DualApiPartitionAttribute GCPressureAttribute MarshalingBehaviorAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
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 LocalAddress LocalAddress LocalAddress

Edit

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 HostName// You can use this property in JavaScript.
Value
HostName HostName HostName HostName

The local IP address where the message was received by the DatagramSocket.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
ID_CAP_NETWORKING [Windows Phone]

Remarks

The DatagramSocketMessageReceivedEventArgs.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.

See Also
RemoteAddressRemoteAddressRemoteAddressRemoteAddress
RemotePortRemotePortRemotePortRemotePort
HostNameHostNameHostNameHostName

RemoteAddress RemoteAddress RemoteAddress RemoteAddress

Edit

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 HostName// You can use this property in JavaScript.
Value
HostName HostName HostName HostName

The IP address of the remote network destination when the message is received on a DatagramSocket.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
ID_CAP_NETWORKING [Windows Phone]

Remarks

The DatagramSocketMessageReceivedEventArgs.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.

See Also
LocalAddressLocalAddressLocalAddressLocalAddress
RemotePortRemotePortRemotePortRemotePort
HostNameHostNameHostNameHostName

RemotePort RemotePort RemotePort RemotePort

Edit

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

public : PlatForm::String RemotePort { get; }public string RemotePort { get; }Public ReadOnly Property RemotePort As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

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

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
ID_CAP_NETWORKING [Windows Phone]

Remarks

The DatagramSocketMessageReceivedEventArgs.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.

See Also
LocalAddressLocalAddressLocalAddressLocalAddress
RemoteAddressRemoteAddressRemoteAddressRemoteAddress

Methods

GetDataReader() GetDataReader() GetDataReader() GetDataReader()

Edit

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 DataReader// You can use this method in JavaScript.
Returns
DataReader DataReader DataReader DataReader

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

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
ID_CAP_NETWORKING [Windows Phone]
See Also
DataReaderDataReaderDataReaderDataReader
GetDataStream()GetDataStream()GetDataStream()GetDataStream()

GetDataStream() GetDataStream() GetDataStream() GetDataStream()

Edit

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 IInputStream// You can use this method in JavaScript.
Returns
IInputStream IInputStream IInputStream IInputStream

An IInputStream object that represents a sequential stream of bytes to be read as a message.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
ID_CAP_NETWORKING [Windows Phone]
See Also
GetDataReader()GetDataReader()GetDataReader()GetDataReader()
IInputStreamIInputStreamIInputStreamIInputStream

See Also