UDP Class

Properties   Methods   Events   Config Settings   Errors  

The User Datagram Protocol (UDP) class is used to facilitate UDP (datagram) communications. It can act both as a client and a server and communicate with any number of hosts simultaneously, as well as generate and receive broadcast packets.

Syntax

ipworks.udp()

Remarks

The interface of the class is similar to the interface of TCPClient, only much simpler. The class is activated or deactivated through the Active property. This property enables or disables sends or receives. The data can be sent in the same way as TCPClient, using the Send method and specifying the text to send. The destination is specified using the RemoteHost and RemotePort properties. Inbound data are received through the DataIn event.

If the UseConnection configuration setting is set to True, then a local association is created with the remote host. Otherwise, the class can receive datagrams (packets) from any host, and send datagrams to any host. Packets can be broadcast on the local net by setting the destination (RemoteHost) to 255.255.255.255.

The operation of the class is almost completely asynchronous. All calls, except the ones that deal with domain name resolution, operate through Windows messages (no blocking calls). The gain in performance is considerable when compared to using blocking calls.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

UDP.AcceptData Property

This property indicates whether data reception is currently enabled.

Syntax

isAcceptData(): boolean;

Default Value

TRUE

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the DataIn event will not fire. Use the PauseData and ProcessData methods to pause and resume data reception.

This property is read-only and not available at design time.

UDP.Active Property

This property indicates whether the class is active.

Syntax

isActive(): boolean;

Default Value

FALSE

Remarks

This property indicates whether the class is currently active and can send or receive data. Use the Activate and Deactivate methods to control whether the class is active.

This property is read-only and not available at design time.

UDP.DontRoute Property

If this property is set to True, it forces the socket to send data directly to the interface (no routing).

Syntax

isDontRoute(): boolean;
setDontRoute(dontRoute: boolean): void;

Default Value

FALSE

Remarks

If this property is set to True, it forces the socket to send data directly to the interface (no routing). Normally, IP sockets send packets of data through routers and gateways until they reach the final destination. If this property is set to True, then data will be delivered on the local subnet only.

This property is not available at design time.

UDP.LocalHost Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

UDP.LocalPort Property

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Syntax

getLocalPort(): number;
setLocalPort(localPort: number): void;

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port on the client side.

UDP.RemoteHost Property

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

getRemoteHost(): string;
setRemoteHost(remoteHost: string): void;

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

If the RemoteHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If UseConnection is set to True, the RemoteHost must be set before the class is activated (Active is set to True).

UDP.RemotePort Property

This property specifies the User Datagram Protocol (UDP) port in the remote host.

Syntax

getRemotePort(): number;
setRemotePort(remotePort: number): void;

Default Value

0

Remarks

The RemotePort is the UDP port on the RemoteHost to send UDP datagrams to.

A valid port number (a value between 1 and 65535) is required.

If UseConnection is set to True, the RemotePort must be set before the class is activated (Active is set to True).

UDP.TimeToLive Property

This property specifies the maximum number of subnets that a datagram can traverse.

Syntax

getTimeToLive(): number;
setTimeToLive(timeToLive: number): void;

Default Value

0

Remarks

The default value for this property is 0, which tells the class to use the default time-to-live (TTL) value of the underlying Transmission Control Protocol (TCP)/IP subsystem. Depending on the application, you can specify a value between 1 and 255.

UDP.activate Method

This method enables sending and receiving of data.

Syntax

async udp.activate(): Promise<void>

Remarks

This method enables sending and receiving of data. When called, the class will create a communication endpoint (socket) that can be used for sending and receiving User Datagram Protocol (UDP) messages. This method must be called before using the class to send and receive data.

If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host is also created.

UDP.config Method

Sets or retrieves a configuration setting.

Syntax

async udp.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

UDP.deactivate Method

This method disables sending and receive of data.

Syntax

async udp.deactivate(): Promise<void>

Remarks

This method disables sending and receiving of data. When called, the class will destroy the existing socket and disable data communications.

UDP.doEvents Method

This method processes events from the internal message queue.

Syntax

async udp.doEvents(): Promise<void>

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

UDP.pauseData Method

This method pauses data reception.

Syntax

async udp.pauseData(): Promise<void>

Remarks

This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. Call ProcessData to reenable data reception.

UDP.processData Method

This method reenables data reception after a call to PauseData .

Syntax

async udp.processData(): Promise<void>

Remarks

This method reenables data reception after a previous call to PauseData. When PauseData is called, the DataIn event will not fire. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

UDP.reset Method

This method will reset the class.

Syntax

async udp.reset(): Promise<void>

Remarks

This method will reset the class's properties to their default values.

UDP.resolveRemoteHost Method

This method resolves the hostname in RemoteHost to an IP address.

Syntax

async udp.resolveRemoteHost(): Promise<void>

Remarks

This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.

In most cases, calling this method is not necessary; the class will resolve the hostname automatically when needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.

UDP.send Method

This method sends binary data to the remote host.

Syntax

async udp.send(text : Uint8Array): Promise<void>

Remarks

This method sends the specified binary data to the remote host. To send text, use the SendText method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

UDP.sendBytes Method

This method sends binary data to the remote host.

Syntax

async udp.sendBytes(data : Uint8Array): Promise<void>

Remarks

This method sends the specified binary data to the remote host. To send text, use the SendText method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

UDP.sendText Method

This method sends text to the remote host.

Syntax

async udp.sendText(text : string): Promise<void>

Remarks

This method sends the specified text to the remote host. To send binary data, use the SendBytes method instead.

Example. Send Data:

UDPControl.LocalPort = 8765 UDPControl.RemotePort = 8765 UDPControl.RemoteHost = "HostNameOrIPAddress" UDPControl.Active = True UDPControl.SendText("Hello!")

UDP.DataIn Event

This event is fired when data are received.

Syntax

udp.on('DataIn', listener: (e: {readonly datagram: string, readonly datagramB: Uint8Array, readonly sourceAddress: string, readonly sourcePort: number}) => void )

Remarks

The DataIn event is fired every time a new datagram is received.

Datagram contains the packet as sent by the remote host.

SourceAddress contains the IP number (Internet address) of the remote host, and SourcePort contains the port from which the packet originated.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

UDP.Error Event

Fired when information is available about errors during data delivery.

Syntax

udp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

UDP.ReadyToSend Event

This event is fired when the class is ready to send data.

Syntax

udp.on('ReadyToSend', listener: (e: {}) => void )

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed Send.

Config Settings (class ipworks.udp)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworks.udp)

UDP Errors

SSL Errors

TCP/IP Errors