# Struct ipworks::ICMP

The ICMP struct is used to facilitate ICMP communications. It can act both as a client and a server and can communicate with any number of hosts simultaneously. It also can generate and receive broadcast packets.

## Syntax

```text
ipworks::ICMP
```

## Remarks

The interface of the struct is similar to the interface of TCPClient, only it is much simpler. The struct is activated/deactivated by using the [active](#active-property-icmp-struct) property. This property enables or disables the sending or receiving of data. Data can be sent in the same way as TCPClient, using the [send](#send-method-icmp-struct) method and *Text* parameter. The destination is specified using the [remote_host](#remote_host-property-icmp-struct) property. The struct automatically creates an ICMP header containing [message_type](#message_type-property-icmp-struct), [message_sub_type](#message_sub_type-property-icmp-struct), and a checksum for the message.

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 can send datagrams to any host. Packets can be broadcast on the local net by setting the destination to 255.255.255.255.

Inbound data is received through the [on_data_in](#on_data_in-event-icmp-struct) event.

The operation of the struct is almost completely asynchronous. All the 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 with 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 ICMP struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of ICMP 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-icmp-struct) | This property indicates whether data reception is currently enabled. |
| [active](#active-property-icmp-struct) | This property indicates whether the struct is active. |
| [dont_route](#dont_route-property-icmp-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-icmp-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [message_sub_type](#message_sub_type-property-icmp-struct) | This property is the subtype of the ICMP message (part of the ICMP header). |
| [message_type](#message_type-property-icmp-struct) | This property includes the type of the ICMP message (part of the ICMP header). |
| [remote_host](#remote_host-property-icmp-struct) | This property includes the address of the RemoteHost. Domain names are resolved to IP addresses. |
| [timeout](#timeout-property-icmp-struct) | This property specifies the timeout for the struct. |
| [time_to_live](#time_to_live-property-icmp-struct) | This property includes the time-to-live (TTL) value for the ICMP packets sent by the struct. |

## 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-icmp-struct) | This method enables sending and receiving of data. |
| [config](#config-method-icmp-struct) | Sets or retrieves a configuration setting. |
| [deactivate](#deactivate-method-icmp-struct) | This method disables sending and receiving of data. |
| [do_events](#do_events-method-icmp-struct) | This method processes events from the internal message queue. |
| [pause_data](#pause_data-method-icmp-struct) | This method pauses data reception. |
| [process_data](#process_data-method-icmp-struct) | This method reenables data reception after a call to PauseData . |
| [reset](#reset-method-icmp-struct) | This method will reset the struct. |
| [resolve_remote_host](#resolve_remote_host-method-icmp-struct) | This method resolves the hostname in RemoteHost to an IP address. |
| [send](#send-method-icmp-struct) | This method sends data to the remote host. |
| [send_bytes](#send_bytes-method-icmp-struct) | This method sends data to the remote host. |
| [send_text](#send_text-method-icmp-struct) | This method sends data 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-icmp-struct) | This event is fired when a new ICMP messages come in. |
| [on_error](#on_error-event-icmp-struct) | Fired when information is available about errors during data delivery. |
| [on_ready_to_send](#on_ready_to_send-event-icmp-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.*

|  |  |
| --- | --- |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DontFragment](#DontFragment) | Whether the DontFragment control flag is set. |
| [IcmpDllTimeout](#IcmpDllTimeout) | The timeout for the struct when using the icmp.dll. |
| [MaxMessageSize](#MaxMessageSize) | The maximum length of the messages that can be received. |
| [MulticastTTL](#MulticastTTL) | The time to live (TTL) value for multicast ICMP packets sent by the struct. |
| [ReceiveAllMode](#ReceiveAllMode) | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
| [TimeoutInMilliseconds](#TimeoutInMilliseconds) | The timeout is treated as milliseconds. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseICMPDLL](#UseICMPDLL) | Use the icmp.dll included on Windows Systems. |
| [UseIPHLPDLL](#UseIPHLPDLL) | Use the iphlpapi.dll included on Windows Systems. |
| [UseIPv6](#UseIPv6) | Whether 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 ([ICMP](#struct-ipworksicmp) 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-icmp-struct) event will not fire. Use the [pause_data](#pause_data-method-icmp-struct) and [process_data](#process_data-method-icmp-struct) methods to pause and resume data reception.

This property is read-only.

## Data Type

bool

# active property ([ICMP](#struct-ipworksicmp) 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.

If the [UseConnection](#UseConnection) configuration setting is set to *true*, then a local association (connection) to the remote host also is created. Use the [activate](#activate-method-icmp-struct) and [deactivate](#deactivate-method-icmp-struct) methods to control whether the struct is active.

This property is read-only.

## Data Type

bool

# dont_route property ([ICMP](#struct-ipworksicmp) 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 ([ICMP](#struct-ipworksicmp) 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

# message_sub_type property ([ICMP](#struct-ipworksicmp) Struct)

This property is the subtype of the ICMP message (part of the ICMP header).

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property contains the subtype of the ICMP message (part of the ICMP header). The ICMP message subtype (also referred to as "code") is a byte value representing the message subclass. Its meaning is associated with the [message_type](#message_type-property-icmp-struct).

Types and subtypes of ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP)/IP.

## Data Type

i32

# message_type property ([ICMP](#struct-ipworksicmp) Struct)

This property includes the type of the ICMP message (part of the ICMP header).

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

This property contains the type of the ICMP message (part of the ICMP header). The ICMP message type is a byte value representing the message class. The message type defines the structure and meaning of the message data assigned to *Text* parameter of the [send](#send-method-icmp-struct) method.

Types for ICMP messages are defined in the various internet RFCs and other documentation associated with Transmission Control Protocol (TCP/IP). The following are a few examples of ICMP message types:

|  |  |
| --- | --- |
| 0 | Echo reply ("ping" reply). |
| 3 | Destination unreachable. |
| 4 | Source quench. |
| 5 | Redirect (change a route). |
| 8 | Echo request ("ping" request). |
| 11 | Time exceeded for datagram. |
| 12 | Parameter problem on datagram. |
| 13 | Timestamp request. |
| 14 | Timestamp reply. |
| 17 | Address mask request. |
| 18 | Address mask reply. |

## Data Type

i32

# remote_host property ([ICMP](#struct-ipworksicmp) Struct)

This property includes the address of the RemoteHost. 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

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

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

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, the struct fails with an error.

If [UseConnection](#UseConnection) is True, this property must be set before the struct is activated ([active](#active-property-icmp-struct) is set to True).

## Data Type

String

# timeout property ([ICMP](#struct-ipworksicmp) Struct)

This property specifies the timeout for the struct.

## Syntax

*Rust Syntax*

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

## Default Value

0

## Remarks

If the timeout property is set to 0, all operations return immediately, potentially failing with an *WOULDBLOCK* error if data cannot be sent or received immediately.

If timeout is set to a positive value, the struct will automatically retry each operation that otherwise would result in a *WOULDBLOCK* error for a maximum of timeout seconds.

The struct will use [do_events](#do_events-method-icmp-struct) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 0 (asynchronous operation).

## Data Type

i32

# time_to_live property ([ICMP](#struct-ipworksicmp) Struct)

This property includes the time-to-live (TTL) value for the ICMP packets sent by the struct.

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

This method contains the time-to-live (TTL) value for the ICMP packets sent by the struct. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL value is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL value is reduced to zero (or less), the packet is discarded.

If the value of the property is set to zero, then the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.

## Data Type

i32

# activate method ([ICMP](#struct-ipworksicmp) 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 ICMP 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 also is created.

# config method ([ICMP](#struct-ipworksicmp) 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-icmp-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-icmp-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# deactivate method ([ICMP](#struct-ipworksicmp) Struct)

This method disables sending and receiving 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 ([ICMP](#struct-ipworksicmp) 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 ([ICMP](#struct-ipworksicmp) 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-icmp-struct) event will not fire. Call [process_data](#process_data-method-icmp-struct) to reenable data reception.

# process_data method ([ICMP](#struct-ipworksicmp) 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-icmp-struct). When [pause_data](#pause_data-method-icmp-struct) is called, the [on_data_in](#on_data_in-event-icmp-struct) event will not fire. To reenable data reception and allow [on_data_in](#on_data_in-event-icmp-struct) to fire, call this method.

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

# reset method ([ICMP](#struct-ipworksicmp) 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 ([ICMP](#struct-ipworksicmp) 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-icmp-struct) to an IP address. The resolved value is available in the [remote_host](#remote_host-property-icmp-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-icmp-struct), if desired.

# send method ([ICMP](#struct-ipworksicmp) Struct)

This method sends data to the remote host.

## Syntax

*Rust Syntax*

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

## Remarks

This method sends data to the remote host.

# send_bytes method ([ICMP](#struct-ipworksicmp) Struct)

This method sends data to the remote host.

## Syntax

*Rust Syntax*

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

## Remarks

This method sends data to the remote host. Calling this method is equivalent to calling the send_bytes/[send_text](#send_text-method-icmp-struct) method.

# send_text method ([ICMP](#struct-ipworksicmp) Struct)

This method sends data to the remote host.

## Syntax

*Rust Syntax*

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

## Remarks

This method sends data to the remote host. Calling this method is equivalent to calling the [send_bytes](#send_bytes-method-icmp-struct)/send_text method.

# on_data_in event ([ICMP](#struct-ipworksicmp) Struct)

This event is fired when a new ICMP messages come in.

## Syntax

*Rust Syntax*

```text
// ICMPDataInEventArgs carries the ICMP DataIn event's parameters.
pub struct ICMPDataInEventArgs {
  fn message_type(&self) -> i32
  fn message_sub_type(&self) -> i32
  fn message_data(&self) -> &[u8]
  fn checksum(&self) -> i32
  fn source_address(&self) -> &String
}

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

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

## Remarks

The *message_type* parameter shows the type of the ICMP messages and the *message_sub_type* parameter shows its subtype.

The *message_data* parameter contains the message data.

The *checksum* parameter is True or False depending on the ICMP checksum validation on the message.

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 ([ICMP](#struct-ipworksicmp) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

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

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

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

## 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-icmp-struct) section.

# on_ready_to_send event ([ICMP](#struct-ipworksicmp) Struct)

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

## Syntax

*Rust Syntax*

```text
// ICMPReadyToSendEventArgs carries the ICMP ReadyToSend event's parameters.
pub struct ICMPReadyToSendEventArgs {
}

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

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

## 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-icmp-struct).

# Config Settings ([ICMP](#struct-ipworksicmp) 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-icmp-struct) method.

### ICMP Config Settings

**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-icmp-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-icmp-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-icmp-struct) may be called to manually resolve the value in [remote_host](#remote_host-property-icmp-struct) at any time.

The default value is *false*.

**DontFragment**: Whether the DontFragment control flag is set.When set to True, the DontFragment control flag in the IP header will be set.

The default value is False.

**IcmpDllTimeout**: The timeout for the struct when using the icmp.dll.The struct will wait for the operation to complete before returning control. If [IcmpDllTimeout](#IcmpDllTimeout) expires, and the operation is not yet complete, the struct fails with an error. [IcmpDllTimeout](#IcmpDllTimeout) must be set to a positive value.

The default value for [IcmpDllTimeout](#IcmpDllTimeout) is 60 seconds.

NOTE: This configuration setting is valid only when [UseICMPDLL](#UseICMPDLL) is set to True.

**MaxMessageSize**: The maximum length of the messages that can be received.This setting specifies the maximum size of the datagrams that the struct will accept without truncation.

**MulticastTTL**: The time to live (TTL) value for multicast ICMP packets sent by the component.When sending multicast packets, the setting specifies the time-to-live (TTL) field. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL is reduced to zero (or less), the packet is discarded.

By default, the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.

**ReceiveAllMode**: Enables a socket to receive all IPv4 or IPv6 packets on the network.This setting specifies the ReceiveAll mode for the socket. The following modes are available:

|  |  |
| --- | --- |
| Value | Description |
| -1 (default) | The socket option is left unspecified. |
| 0 | Do not receive all network traffic. |
| 1 | Receive all network traffic. This enables the promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, a NIC that supports the promiscuous mode will capture all IPv4 or IPv6 traffic on the LAN, including traffic between other computers on the same LAN segment. |
| 2 | Receive only socket-level network traffic (this feature may not be implemented by your Windows installation). |
| 3 | Receive only IP-level network traffic. This option does not enable the promiscuous mode on the NIC. This option affects packet processing only at the IP level. The NIC still receives only those packets directed to its configured unicast and multicast addresses. A socket with this option enabled, however, not only will receive packets directed to specific IP addresses, but also will receive all the IPv4 or IPv6 packets the NIC receives. |

**TimeoutInMilliseconds**: The timeout is treated as milliseconds.Setting [TimeoutInMilliseconds](#TimeoutInMilliseconds) to True causes the struct to use the value in the [IcmpDllTimeout](#IcmpDllTimeout) configuration setting as milliseconds instead of seconds, which is the default.

NOTE: This setting is valid only when [UseICMPDLL](#UseICMPDLL) is set to True.

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

**UseICMPDLL**: Use the icmp.dll included on Windows Systems.Setting [UseICMPDLL](#UseICMPDLL) to True causes the struct to use the icmp.dll on Windows 9x or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

**UseIPHLPDLL**: Use the iphlpapi.dll included on Windows Systems.Setting [UseIPHLPDLL](#UseIPHLPDLL) to True causes the struct to use the iphlpapi.dll on Windows XP or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

NOTE: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

### 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](#timeout-property-icmp-struct) 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 ([ICMP](#struct-ipworksicmp) Struct)

### ICMP Errors

|  |  |
| --- | --- |
| 104 | The struct is already [active](#active-property-icmp-struct). |
| 107 | Cannot change the LocalHost at this time. A connection is in progress. |
| 109 | The struct must be [active](#active-property-icmp-struct) for this operation. |
| 112 | Cannot change [MaxMessageSize](#MaxMessageSize) while ICMP is [active](#active-property-icmp-struct). |
| 114 | Cannot change [remote_host](#remote_host-property-icmp-struct) when [UseConnection](#UseConnection) is set and the struct is [active](#active-property-icmp-struct). |
| 117 | Cannot change [UseConnection](#UseConnection) while the struct is [active](#active-property-icmp-struct). |
| 118 | The message cannot be longer than [MaxMessageSize](#MaxMessageSize). |
| 119 | The message is too short. |
| 120 | Cannot create ICMP handle. |

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