# Struct ipworks::UDP

The User Datagram Protocol (UDP) struct 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

```text
ipworks::UDP
```

## Remarks

The interface of the struct is similar to the interface of TCPClient, only much simpler. The struct is activated or deactivated through the [active](#active-property-udp-struct) 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-udp-struct) method and specifying the text to send. The destination is specified using the [remote_host](#remote_host-property-udp-struct) and [remote_port](#remote_port-property-udp-struct) properties. Inbound data are received through the [on_data_in](#on_data_in-event-udp-struct) event.

If the [UseConnection](#UseConnection) configuration setting is set to True, then a local association is created with the remote host. Otherwise, the struct 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 ([remote_host](#remote_host-property-udp-struct)) to 255.255.255.255.

The operation of the struct 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.

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the UDP struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of UDP when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [accept_data](#accept_data-property-udp-struct) | This property indicates whether data reception is currently enabled. |
| [active](#active-property-udp-struct) | This property indicates whether the struct is active. |
| [dont_route](#dont_route-property-udp-struct) | If this property is set to True, it forces the socket to send data directly to the interface (no routing). |
| [local_host](#local_host-property-udp-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [local_port](#local_port-property-udp-struct) | This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds. |
| [remote_host](#remote_host-property-udp-struct) | This property includes the address of the remote host. Domain names are resolved to IP addresses. |
| [remote_port](#remote_port-property-udp-struct) | This property specifies the User Datagram Protocol (UDP) port in the remote host. |
| [time_to_live](#time_to_live-property-udp-struct) | 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 struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [activate](#activate-method-udp-struct) | This method enables sending and receiving of data. |
| [config](#config-method-udp-struct) | Sets or retrieves a configuration setting. |
| [deactivate](#deactivate-method-udp-struct) | This method disables sending and receive of data. |
| [do_events](#do_events-method-udp-struct) | This method processes events from the internal message queue. |
| [pause_data](#pause_data-method-udp-struct) | This method pauses data reception. |
| [process_data](#process_data-method-udp-struct) | This method reenables data reception after a call to PauseData . |
| [reset](#reset-method-udp-struct) | This method will reset the struct. |
| [resolve_remote_host](#resolve_remote_host-method-udp-struct) | This method resolves the hostname in RemoteHost to an IP address. |
| [send](#send-method-udp-struct) | This method sends binary data to the remote host. |
| [send_bytes](#send_bytes-method-udp-struct) | This method sends binary data to the remote host. |
| [send_text](#send_text-method-udp-struct) | This method sends text to the remote host. |

## Event List

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

|  |  |
| --- | --- |
| [on_data_in](#on_data_in-event-udp-struct) | This event is fired when data are received. |
| [on_error](#on_error-event-udp-struct) | Fired when information is available about errors during data delivery. |
| [on_ready_to_send](#on_ready_to_send-event-udp-struct) | This event is fired when the struct is ready to send data. |

## Config Settings

*The following is a list of config settings for the struct 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 struct 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 struct to be active on the same local port. |
| [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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# accept_data property ([UDP](#struct-ipworksudp) Struct)

This property indicates whether data reception is currently enabled.

## Syntax

*Rust Syntax*

```text
fn accept_data(&self ) -> Result<bool, IPWorksError>
```

## Default Value

true

## Remarks

This property indicates whether data reception is currently enabled. When *false*, data reception is disabled and the [on_data_in](#on_data_in-event-udp-struct) event will not fire. Use the [pause_data](#pause_data-method-udp-struct) and [process_data](#process_data-method-udp-struct) methods to pause and resume data reception.

This property is read-only.

## Data Type

bool

# active property ([UDP](#struct-ipworksudp) Struct)

This property indicates whether the struct is active.

## Syntax

*Rust Syntax*

```text
fn active(&self ) -> Result<bool, IPWorksError>
```

## Default Value

false

## Remarks

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

This property is read-only.

## Data Type

bool

# dont_route property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn dont_route(&self ) -> Result<bool, IPWorksError> fn set_dont_route(&self, value : bool) ->  Option<IPWorksError>
```

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

## Data Type

bool

# local_host property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn local_host(&self ) -> Result<String, IPWorksError> fn set_local_host(&self, value : &str) ->  Option<IPWorksError>
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksError>
```

## 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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

## Data Type

String

# local_port property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn local_port(&self ) -> Result<i32, IPWorksError> fn set_local_port(&self, value : i32) ->  Option<IPWorksError>
```

## Default Value

0

## Remarks

The local_port property must be set before UDP is activated ([active](#active-property-udp-struct) is set to True). This instructs the struct 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 local_port property after the connection is established.

local_port cannot be changed once the struct is [active](#active-property-udp-struct). Any attempt to set the local_port property when the struct is [active](#active-property-udp-struct) will generate an error.

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

## Data Type

i32

# remote_host property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn remote_host(&self ) -> Result<String, IPWorksError> fn set_remote_host(&self, value : &str) ->  Option<IPWorksError>
fn set_remote_host_ref(&self, value : &String) ->  Option<IPWorksError>
```

## Default Value

""

## Remarks

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

If remote_host is set to 255.255.255.255, the struct broadcasts data on the local subnet.

If the remote_host property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the remote_host 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 remote_host must be set before the struct is activated ([active](#active-property-udp-struct) is set to True).

## Data Type

String

# remote_port property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn remote_port(&self ) -> Result<i32, IPWorksError> fn set_remote_port(&self, value : i32) ->  Option<IPWorksError>
```

## Default Value

0

## Remarks

The remote_port is the UDP port on the [remote_host](#remote_host-property-udp-struct) 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 remote_port must be set before the struct is activated ([active](#active-property-udp-struct) is set to True).

## Data Type

i32

# time_to_live property ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn time_to_live(&self ) -> Result<i32, IPWorksError> fn set_time_to_live(&self, value : i32) ->  Option<IPWorksError>
```

## Default Value

0

## Remarks

The default value for this property is *0*, which tells the struct 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

i32

# activate method ([UDP](#struct-ipworksudp) Struct)

This method enables sending and receiving of data.

## Syntax

*Rust Syntax*

```text
fn activate(&self) -> Result<(), IPWorksError>
```

## Remarks

This method enables sending and receiving of data. When called, the struct 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 struct 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 ([UDP](#struct-ipworksudp) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-udp-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# deactivate method ([UDP](#struct-ipworksudp) Struct)

This method disables sending and receive of data.

## Syntax

*Rust Syntax*

```text
fn deactivate(&self) -> Result<(), IPWorksError>
```

## Remarks

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

# do_events method ([UDP](#struct-ipworksudp) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
fn do_events(&self) -> Result<(), IPWorksError>
```

## Remarks

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

# pause_data method ([UDP](#struct-ipworksudp) Struct)

This method pauses data reception.

## Syntax

*Rust Syntax*

```text
fn pause_data(&self) -> Result<(), IPWorksError>
```

## Remarks

This method pauses data reception when called. While data reception is paused, the [on_data_in](#on_data_in-event-udp-struct) event will not fire. Call [process_data](#process_data-method-udp-struct) to reenable data reception.

# process_data method ([UDP](#struct-ipworksudp) Struct)

This method reenables data reception after a call to PauseData .

## Syntax

*Rust Syntax*

```text
fn process_data(&self) -> Result<(), IPWorksError>
```

## Remarks

This method reenables data reception after a previous call to [pause_data](#pause_data-method-udp-struct). When [pause_data](#pause_data-method-udp-struct) is called, the [on_data_in](#on_data_in-event-udp-struct) event will not fire. To reenable data reception and allow [on_data_in](#on_data_in-event-udp-struct) to fire, call this method.

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

# reset method ([UDP](#struct-ipworksudp) Struct)

This method will reset the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksError>
```

## Remarks

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

# resolve_remote_host method ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
fn resolve_remote_host(&self) -> Result<(), IPWorksError>
```

## Remarks

This method resolves the hostname specified by [remote_host](#remote_host-property-udp-struct) to an IP address. The resolved value is available in the [remote_host](#remote_host-property-udp-struct) property after this method returns.

In most cases, calling this method is not necessary; the struct will resolve the hostname automatically when needed. If [DelayHostResolution](#DelayHostResolution) is *true*, this method may be called to manually resolve [remote_host](#remote_host-property-udp-struct), if desired.

# send method ([UDP](#struct-ipworksudp) Struct)

This method sends binary data to the remote host.

## Syntax

*Rust Syntax*

```text
fn send(&self, text : &[u8]) -> Result<(), IPWorksError>
```

## Remarks

This method sends the specified binary data to the remote host. To send text, use the [send_text](#send_text-method-udp-struct) method instead.

**Example. Send Data:**

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

# send_bytes method ([UDP](#struct-ipworksudp) Struct)

This method sends binary data to the remote host.

## Syntax

*Rust Syntax*

```text
fn send_bytes(&self, data : &[u8]) -> Result<(), IPWorksError>
```

## Remarks

This method sends the specified binary data to the remote host. To send text, use the [send_text](#send_text-method-udp-struct) method instead.

**Example. Send Data:**

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

# send_text method ([UDP](#struct-ipworksudp) Struct)

This method sends text to the remote host.

## Syntax

*Rust Syntax*

```text
fn send_text(&self, text : &str) -> Result<(), IPWorksError>
```

## Remarks

This method sends the specified text to the remote host. To send binary data, use the [send_bytes](#send_bytes-method-udp-struct) method instead.

**Example. Send Data:**

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

# on_data_in event ([UDP](#struct-ipworksudp) Struct)

This event is fired when data are received.

## Syntax

*Rust Syntax*

```text
// UDPDataInEventArgs carries the UDP DataIn event's parameters.
pub struct UDPDataInEventArgs {
  fn datagram(&self) -> &[u8]
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
}

// UDPDataInEvent defines the signature of the UDP DataIn event's handler function.
pub trait UDPDataInEvent {
  fn on_data_in(&self, sender : UDP, e : &mut UDPDataInEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_data_in(&self) -> &'a dyn UDPDataInEvent;
  pub fn set_on_data_in(&mut self, value : &'a dyn UDPDataInEvent);
  ...
}
```

## Remarks

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

*datagram* contains the packet as sent by the remote host.

*source_address* contains the IP number (Internet address) of the remote host, and *source_port* 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.

# on_error event ([UDP](#struct-ipworksudp) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// UDPErrorEventArgs carries the UDP Error event's parameters.
pub struct UDPErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// UDPErrorEvent defines the signature of the UDP Error event's handler function.
pub trait UDPErrorEvent {
  fn on_error(&self, sender : UDP, e : &mut UDPErrorEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_error(&self) -> &'a dyn UDPErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn UDPErrorEvent);
  ...
}
```

## Remarks

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

The *error_code* 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-struct) section.

# on_ready_to_send event ([UDP](#struct-ipworksudp) Struct)

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

## Syntax

*Rust Syntax*

```text
// UDPReadyToSendEventArgs carries the UDP ReadyToSend event's parameters.
pub struct UDPReadyToSendEventArgs {
}

// UDPReadyToSendEvent defines the signature of the UDP ReadyToSend event's handler function.
pub trait UDPReadyToSendEvent {
  fn on_ready_to_send(&self, sender : UDP, e : &mut UDPReadyToSendEventArgs);
}

impl <'a> UDP<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn UDPReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn UDPReadyToSendEvent);
  ...
}
```

## Remarks

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

# Config Settings ([UDP](#struct-ipworksudp) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-udp-struct) 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 [remote_host](#remote_host-property-udp-struct) is set. If *true* the struct will resolve the hostname and the IP address will be present in the [remote_host](#remote_host-property-udp-struct) 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, [resolve_remote_host](#resolve_remote_host-method-udp-struct) may be called to manually resolve the value in [remote_host](#remote_host-property-udp-struct) 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 struct 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 [local_host](#local_host-property-udp-struct) 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 struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the [local_host](#local_host-property-udp-struct) 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 struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct 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 [local_port](#local_port-property-udp-struct) after the connection is established.

[local_port](#local_port-property-udp-struct) 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 struct 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-udp-struct) to True.

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

The default value for this setting is False.

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the struct 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 struct 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 struct 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 struct 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 struct 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*.

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

Setting this configuration setting to *true* tells the struct 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](#struct-ipworksudp) Struct)

### UDP Errors

|  |  |
| --- | --- |
| 104 | UDP is already [active](#active-property-udp-struct). |
| 106 | You cannot change the [local_port](#local_port-property-udp-struct) while the struct is [active](#active-property-udp-struct). |
| 107 | You cannot change the [local_host](#local_host-property-udp-struct) at this time. A connection is in progress. |
| 109 | The struct must be [active](#active-property-udp-struct) for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the struct is [active](#active-property-udp-struct). |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the struct is [active](#active-property-udp-struct). |
| 114 | You cannot change [remote_host](#remote_host-property-udp-struct) when [UseConnection](#UseConnection) is set and the struct [active](#active-property-udp-struct). |
| 115 | You cannot change [remote_port](#remote_port-property-udp-struct) when [UseConnection](#UseConnection) is set and the struct is [active](#active-property-udp-struct). |
| 116 | [remote_port](#remote_port-property-udp-struct) cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the struct is [active](#active-property-udp-struct). |
| 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). |