UdpDatagram

Description

The UdpDatagram object contains data and meta data of a UDP datagram received through a UdpSocket object.

This object was introduced in InCore 2.3.

› Inherits:ByteArray

Overview

Properties

destinationAddress destinationPort hopLimit senderAddress senderPort ByteArray.arrayBuffer

ByteArray.base64 ByteArray.data ByteArray.hex ByteArray.string Object.objectId Object.parent

Methods

ByteArray.remove() Object.deserializeProperties() Object.fromJson() Object.serializeProperties() Object.toJson()

Signals

Object.completed()

Properties

destinationAddress

This property holds the destination address associated with this datagram. For a datagram received from the network, it is the address the peer node sent the datagram to, which can either be a local address of this machine or a multicast or broadcast address. For an outgoing datagrams, it is the address the datagram should be sent to.

› Type:String › Signal:destinationAddressChanged() › Attributes:Writable

destinationPort

This property holds the port number of the destination associated with this datagram. For a datagram received from the network, it is the local port number that the peer node sent the datagram to. For an outgoing datagram, it is the peer port the datagram should be sent to.

› Type:SignedInteger › Signal:destinationPortChanged() › Attributes:Writable

hopLimit

This property holds the hop count limit associated with this datagram to count. The hop count limit is the number of nodes that are allowed to forward the IP packet before it expires and an error is sent back to the sender of the datagram. In IPv4, this value is usually known as time to live (TTL).

It is usually not necessary to call this function on datagrams received from the network.

If this is an outgoing packet, this is the value to be set in the IP header upon sending. The valid range for the value is 1 to 255. This property also accepts a value of -1 to indicate that the operating system should choose the value.

› Type:SignedInteger › Signal:hopLimitChanged() › Attributes:Writable

senderAddress

This property holds the sender address associated with this datagram. For a datagram received from the network, it is the address of the peer node that sent the datagram. For an outgoing datagrams, it is the local address to be used when sending.

› Type:String › Signal:senderAddressChanged() › Attributes:Writable

senderPort

This property holds the port number of the sender associated with this datagram. For a datagram received from the network, it is the port number that the peer node sent the datagram from. For an outgoing datagram, it is the local port the datagram should be sent from.

› Type:SignedInteger › Signal:senderPortChanged() › Attributes:Writable