# UDP Class

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.

## Class Name

**IPWorks_UDP**

## Procedural Interface

```text
 ipworks_udp_open();
 ipworks_udp_close($res);
 ipworks_udp_register_callback($res, $id, $function);
 ipworks_udp_get_last_error($res);
 ipworks_udp_get_last_error_code($res);
 ipworks_udp_set($res, $id, $index, $value);
 ipworks_udp_get($res, $id, $index);
 ipworks_udp_do_activate($res);
 ipworks_udp_do_config($res, $configurationstring);
 ipworks_udp_do_deactivate($res);
 ipworks_udp_do_doevents($res);
 ipworks_udp_do_pausedata($res);
 ipworks_udp_do_processdata($res);
 ipworks_udp_do_reset($res);
 ipworks_udp_do_resolveremotehost($res);
 ipworks_udp_do_send($res, $text);
 ipworks_udp_do_sendbytes($res, $data);
 ipworks_udp_do_sendtext($res, $text);
```

## 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](#active-property-ipworks_udp-class) property. This property enables or disables sends or receives. The data can be sent in the same way as TCPClient, using the [Send](#send-method-ipworks_udp-class) method and specifying the text to send. The destination is specified using the [RemoteHost](#remotehost-property-ipworks_udp-class) and [RemotePort](#remoteport-property-ipworks_udp-class) properties. Inbound data are received through the [DataIn](#datain-event-ipworks_udp-class) event.

If the [UseConnection](#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](#remotehost-property-ipworks_udp-class)) 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.*

|  |  |
| --- | --- |
| [AcceptData](#acceptdata-property-ipworks_udp-class) | This property indicates whether data reception is currently enabled. |
| [Active](#active-property-ipworks_udp-class) | This property indicates whether the class is active. |
| [DontRoute](#dontroute-property-ipworks_udp-class) | If this property is set to True, it forces the socket to send data directly to the interface (no routing). |
| [LocalHost](#localhost-property-ipworks_udp-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LocalPort](#localport-property-ipworks_udp-class) | This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. |
| [RemoteHost](#remotehost-property-ipworks_udp-class) | This property includes the address of the remote host. Domain names are resolved to IP addresses. |
| [RemotePort](#remoteport-property-ipworks_udp-class) | This property specifies the User Datagram Protocol (UDP) port in the remote host. |
| [TimeToLive](#timetolive-property-ipworks_udp-class) | This property specifies the maximum number of subnets that a datagram can traverse. |

## Method List

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

|  |  |
| --- | --- |
| [Activate](#activate-method-ipworks_udp-class) | This method enables sending and receiving of data. |
| [Config](#config-method-ipworks_udp-class) | Sets or retrieves a configuration setting. |
| [Deactivate](#deactivate-method-ipworks_udp-class) | This method disables sending and receive of data. |
| [DoEvents](#doevents-method-ipworks_udp-class) | This method processes events from the internal message queue. |
| [PauseData](#pausedata-method-ipworks_udp-class) | This method pauses data reception. |
| [ProcessData](#processdata-method-ipworks_udp-class) | This method reenables data reception after a call to PauseData . |
| [Reset](#reset-method-ipworks_udp-class) | This method will reset the class. |
| [ResolveRemoteHost](#resolveremotehost-method-ipworks_udp-class) | This method resolves the hostname in RemoteHost to an IP address. |
| [Send](#send-method-ipworks_udp-class) | This method sends binary data to the remote host. |
| [SendBytes](#sendbytes-method-ipworks_udp-class) | This method sends binary data to the remote host. |
| [SendText](#sendtext-method-ipworks_udp-class) | This method sends text to the remote host. |

## 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.*

|  |  |
| --- | --- |
| [DataIn](#datain-event-ipworks_udp-class) | This event is fired when data are received. |
| [Error](#error-event-ipworks_udp-class) | Fired when information is available about errors during data delivery. |
| [ReadyToSend](#readytosend-event-ipworks_udp-class) | This event is fired when the class is ready to send data. |

## Config Settings

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

|  |  |
| --- | --- |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the class to be active on the same local port. |
| [SourceIPAddress](#SourceIPAddress) | Used to set the source IP address used when sending a packet. |
| [SourceMacAddress](#SourceMacAddress) | Used to set the source MAC address used when sending a packet. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AcceptData Property ([IPWorks_UDP](#udp-class) Class)

This property indicates whether data reception is currently enabled.

## Object Oriented Interface

```text
public function getAcceptData();
```

## Procedural Interface

```text
ipworks_udp_get($res, 1 );
```

## Default Value

true

## Remarks

This property indicates whether data reception is currently enabled. When *false*, data reception is disabled and the [DataIn](#datain-event-ipworks_udp-class) event will not fire. Use the [PauseData](#pausedata-method-ipworks_udp-class) and [ProcessData](#processdata-method-ipworks_udp-class) methods to pause and resume data reception.

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

## Data Type

Boolean

# Active Property ([IPWorks_UDP](#udp-class) Class)

This property indicates whether the class is active.

## Object Oriented Interface

```text
public function getActive();
```

## Procedural Interface

```text
ipworks_udp_get($res, 2 );
```

## Default Value

false

## Remarks

This property indicates whether the class is currently active and can send or receive data. Use the [Activate](#activate-method-ipworks_udp-class) and [Deactivate](#deactivate-method-ipworks_udp-class) methods to control whether the class is active.

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

## Data Type

Boolean

# DontRoute Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getDontRoute();
public function setDontRoute($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 3 );
ipworks_udp_set($res, 3, $value );
```

## 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.

## Data Type

Boolean

# LocalHost Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getLocalHost();
public function setLocalHost($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 4 );
ipworks_udp_set($res, 4, $value );
```

## 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 classes) 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.

## Data Type

String

# LocalPort Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getLocalPort();
public function setLocalPort($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 5 );
ipworks_udp_set($res, 5, $value );
```

## Default Value

0

## Remarks

The LocalPort property must be set before UDP is activated ([Active](#active-property-ipworks_udp-class) 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](#active-property-ipworks_udp-class). Any attempt to set the LocalPort property when the class is [Active](#active-property-ipworks_udp-class) will generate an error.

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

## Data Type

Integer

# RemoteHost Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getRemoteHost();
public function setRemoteHost($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 6 );
ipworks_udp_set($res, 6, $value );
```

## 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](#UseConnection) is set to True, the RemoteHost must be set before the class is activated ([Active](#active-property-ipworks_udp-class) is set to True).

## Data Type

String

# RemotePort Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getRemotePort();
public function setRemotePort($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 7 );
ipworks_udp_set($res, 7, $value );
```

## Default Value

0

## Remarks

The RemotePort is the UDP port on the [RemoteHost](#remotehost-property-ipworks_udp-class) to send UDP datagrams to.

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

If [UseConnection](#UseConnection) is set to True, the RemotePort must be set before the class is activated ([Active](#active-property-ipworks_udp-class) is set to True).

## Data Type

Integer

# TimeToLive Property ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function getTimeToLive();
public function setTimeToLive($value);
```

## Procedural Interface

```text
ipworks_udp_get($res, 8 );
ipworks_udp_set($res, 8, $value );
```

## 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.

## Data Type

Integer

# Activate Method ([IPWorks_UDP](#udp-class) Class)

This method enables sending and receiving of data.

## Object Oriented Interface

```text
public function doActivate();
```

## Procedural Interface

```text
ipworks_udp_do_activate($res);
```

## 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](#UseConnection) configuration setting is set to *true*, then a local association (connection) to the remote host is also created.

# Config Method ([IPWorks_UDP](#udp-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworks_udp_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-udp-class) 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](#config-settings-udp-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Deactivate Method ([IPWorks_UDP](#udp-class) Class)

This method disables sending and receive of data.

## Object Oriented Interface

```text
public function doDeactivate();
```

## Procedural Interface

```text
ipworks_udp_do_deactivate($res);
```

## Remarks

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

# DoEvents Method ([IPWorks_UDP](#udp-class) Class)

This method processes events from the internal message queue.

## Object Oriented Interface

```text
public function doEvents();
```

## Procedural Interface

```text
ipworks_udp_do_doevents($res);
```

## 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.

# PauseData Method ([IPWorks_UDP](#udp-class) Class)

This method pauses data reception.

## Object Oriented Interface

```text
public function doPauseData();
```

## Procedural Interface

```text
ipworks_udp_do_pausedata($res);
```

## Remarks

This method pauses data reception when called. While data reception is paused, the [DataIn](#datain-event-ipworks_udp-class) event will not fire. Call [ProcessData](#processdata-method-ipworks_udp-class) to reenable data reception.

# ProcessData Method ([IPWorks_UDP](#udp-class) Class)

This method reenables data reception after a call to PauseData .

## Object Oriented Interface

```text
public function doProcessData();
```

## Procedural Interface

```text
ipworks_udp_do_processdata($res);
```

## Remarks

This method reenables data reception after a previous call to [PauseData](#pausedata-method-ipworks_udp-class). When [PauseData](#pausedata-method-ipworks_udp-class) is called, the [DataIn](#datain-event-ipworks_udp-class) event will not fire. To reenable data reception and allow [DataIn](#datain-event-ipworks_udp-class) to fire, call this method.

NOTE: This method is used only after previously calling [PauseData](#pausedata-method-ipworks_udp-class). It does not need to be called to process incoming data by default.

# Reset Method ([IPWorks_UDP](#udp-class) Class)

This method will reset the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworks_udp_do_reset($res);
```

## Remarks

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

# ResolveRemoteHost Method ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function doResolveRemoteHost();
```

## Procedural Interface

```text
ipworks_udp_do_resolveremotehost($res);
```

## Remarks

This method resolves the hostname specified by [RemoteHost](#remotehost-property-ipworks_udp-class) to an IP address. The resolved value is available in the [RemoteHost](#remotehost-property-ipworks_udp-class) 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](#DelayHostResolution) is *true*, this method may be called to manually resolve [RemoteHost](#remotehost-property-ipworks_udp-class), if desired.

# Send Method ([IPWorks_UDP](#udp-class) Class)

This method sends binary data to the remote host.

## Object Oriented Interface

```text
public function doSend($text);
```

## Procedural Interface

```text
ipworks_udp_do_send($res, $text);
```

## Remarks

This method sends the specified binary data to the remote host. To send text, use the [SendText](#sendtext-method-ipworks_udp-class) method instead.

**Example. Send Data:**

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

# SendBytes Method ([IPWorks_UDP](#udp-class) Class)

This method sends binary data to the remote host.

## Object Oriented Interface

```text
public function doSendBytes($data);
```

## Procedural Interface

```text
ipworks_udp_do_sendbytes($res, $data);
```

## Remarks

This method sends the specified binary data to the remote host. To send text, use the [SendText](#sendtext-method-ipworks_udp-class) method instead.

**Example. Send Data:**

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

# SendText Method ([IPWorks_UDP](#udp-class) Class)

This method sends text to the remote host.

## Object Oriented Interface

```text
public function doSendText($text);
```

## Procedural Interface

```text
ipworks_udp_do_sendtext($res, $text);
```

## Remarks

This method sends the specified text to the remote host. To send binary data, use the [SendBytes](#sendbytes-method-ipworks_udp-class) method instead.

**Example. Send Data:**

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

# DataIn Event ([IPWorks_UDP](#udp-class) Class)

This event is fired when data are received.

## Object Oriented Interface

```text
public function fireDataIn($param);
```

## Procedural Interface

```text
ipworks_udp_register_callback($res, 1, array($this, 'fireDataIn'));
```

## Parameter List

```text
 'datagram' 'sourceaddress' 'sourceport'
```

## 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.

# Error Event ([IPWorks_UDP](#udp-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworks_udp_register_callback($res, 2, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

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

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](#trappable-errors-udp-class) section.

# ReadyToSend Event ([IPWorks_UDP](#udp-class) Class)

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

## Object Oriented Interface

```text
public function fireReadyToSend($param);
```

## Procedural Interface

```text
ipworks_udp_register_callback($res, 3, array($this, 'fireReadyToSend'));
```

## Parameter List

```text

```

## Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed [Send](#send-method-ipworks_udp-class).

# Config Settings ([UDP](#udp-class) Class)

 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](#config-method-ipworks_udp-class) method.

### UDP Config Settings

**CaptureIPPacketInfo**: Used to capture the packet information.If this configuration setting is set to True, the component will capture the IP packet information.

The default value for this setting is False.

NOTE: This setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when [RemoteHost](#remotehost-property-ipworks_udp-class) is set. If *true* the class will resolve the hostname and the IP address will be present in the [RemoteHost](#remotehost-property-ipworks_udp-class) property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, [ResolveRemoteHost](#resolveremotehost-method-ipworks_udp-class) may be called to manually resolve the value in [RemoteHost](#remotehost-property-ipworks_udp-class) at any time.

The default value is *false*.

**DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

NOTE: This setting is available only in Windows.

**DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When this configuration setting is set to True, packets sent by the class will have the *Don't Fragment* flag set. The default value is False.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-ipworks_udp-class) setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#localhost-property-ipworks_udp-class) setting 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).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-ipworks_udp-class) after the connection is established.

[LocalPort](#localport-property-ipworks_udp-class) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the class will accept without truncation.

**QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).To use this configuration setting, [UseConnection](#UseConnection) must be True. This option allows you to specify an arbitrary DiffServ Code Point (DSCP) value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

NOTE: This setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

**QOSTrafficType**: Used to specify QOS/DSCP settings (optional).To use this configuration setting, [UseConnection](#UseConnection) must be True. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

NOTE: QOSTrafficType must be set before setting [Active](#active-property-ipworks_udp-class) to True.

**ShareLocalPort**: If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through the [Active](#active-property-ipworks_udp-class) property or it will have no effect.

The default value for this setting is False.

**SourceIPAddress**: Used to set the source IP address used when sending a packet.This configuration setting can be used to override the source IP address when sending a packet.

NOTE: This setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

**SourceMacAddress**: Used to set the source MAC address used when sending a packet.This configuration setting can be used to override the source MAC address when sending a packet.

NOTE: This setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the class should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

**UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties and will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-ipworks_udp-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([UDP](#udp-class) Class)

### UDP Errors

|  |  |
| --- | --- |
| 104 | UDP is already [Active](#active-property-ipworks_udp-class). |
| 106 | You cannot change the [LocalPort](#localport-property-ipworks_udp-class) while the class is [Active](#active-property-ipworks_udp-class). |
| 107 | You cannot change the [LocalHost](#localhost-property-ipworks_udp-class) at this time. A connection is in progress. |
| 109 | The class must be [Active](#active-property-ipworks_udp-class) for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the class is [Active](#active-property-ipworks_udp-class). |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the class is [Active](#active-property-ipworks_udp-class). |
| 114 | You cannot change [RemoteHost](#remotehost-property-ipworks_udp-class) when [UseConnection](#UseConnection) is set and the class [Active](#active-property-ipworks_udp-class). |
| 115 | You cannot change [RemotePort](#remoteport-property-ipworks_udp-class) when [UseConnection](#UseConnection) is set and the class is [Active](#active-property-ipworks_udp-class). |
| 116 | [RemotePort](#remoteport-property-ipworks_udp-class) cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the class is [Active](#active-property-ipworks_udp-class). |
| 118 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). |
| 119 | Message is too short. |
| 434 | Unable to convert string to selected CodePage |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |