# Struct ipworks::IPMonitor

The IPMonitor struct is used to listen to network traffic.

## Syntax

```text
ipworks::IPMonitor
```

## Remarks

The IPMonitor struct will bind to a specific local host address and listen for network traffic received by the interface. The interface must support promiscuous mode (which may not work in many wireless cards because of security considerations) and must be installed on Windows 2000 or greater.

NOTE: If your computer connects to a switch, the switch will forward only those packets addressed to your computer. If your computer is on a hub, then you will receive everything.

The use of this component requires administrative permissions.

The first step in using the IPMonitor struct is to set [local_host](#local_host-property-ipmonitor-struct) to the IP address whose traffic you wish to monitor, and then set [active](#active-property-ipmonitor-struct) to True. For each packet that crosses the interface, the struct will parse the header and fire an [on_ip_packet](#on_ip_packet-event-ipmonitor-struct) event.

### 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 IPMonitor struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of IPMonitor 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-ipmonitor-struct) | This property indicates whether data reception is currently enabled. |
| [active](#active-property-ipmonitor-struct) | This property indicates whether the struct is active. |
| [ip_packet](#ip_packet-property-ipmonitor-struct) | This property includes the contents of the current packet. |
| [local_host](#local_host-property-ipmonitor-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |

## 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-ipmonitor-struct) | This method enables network monitoring. |
| [config](#config-method-ipmonitor-struct) | Sets or retrieves a configuration setting. |
| [deactivate](#deactivate-method-ipmonitor-struct) | This method disables network monitoring. |
| [do_events](#do_events-method-ipmonitor-struct) | This method processes events from the internal message queue. |
| [list_ip_addresses](#list_ip_addresses-method-ipmonitor-struct) | This method lists the valid IP addresses for this host. |
| [parse_pcap_file](#parse_pcap_file-method-ipmonitor-struct) | This method parses the specified pcap file. |
| [pause_data](#pause_data-method-ipmonitor-struct) | This method pauses data reception. |
| [process_data](#process_data-method-ipmonitor-struct) | This method reenables data reception after a call to PauseData . |
| [reset](#reset-method-ipmonitor-struct) | This method will reset the struct. |

## 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_error](#on_error-event-ipmonitor-struct) | Fired when information is available about errors during data delivery. |
| [on_ip_address](#on_ip_address-event-ipmonitor-struct) | This event is fired for each valid IP address on this host. |
| [on_ip_packet](#on_ip_packet-event-ipmonitor-struct) | This event is fired whenever a packet is received. |

## Config Settings

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

|  |  |
| --- | --- |
| [ListInterface](#ListInterface) | Lists the interfaces visible to the WinPCap or NPCap driver. |
| [ReceiveAllMode](#ReceiveAllMode) | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
| [SelectedInterface](#SelectedInterface) | Used to select the interface the WinPCap or NPCap driver will listen on. |
| [UseWinPCap](#UseWinPCap) | Whether to use the WinPCap or NPCap driver. |
| [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 ([IPMonitor](#struct-ipworksipmonitor) 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_ip_packet](#on_ip_packet-event-ipmonitor-struct) event will not fire. Use the [pause_data](#pause_data-method-ipmonitor-struct) and [process_data](#process_data-method-ipmonitor-struct) methods to pause and resume data reception.

This property is read-only.

## Data Type

bool

# active property ([IPMonitor](#struct-ipworksipmonitor) 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 is monitoring network traffic. Use the [activate](#activate-method-ipmonitor-struct) and [deactivate](#deactivate-method-ipmonitor-struct) methods to control whether the struct is active.

This property is read-only.

## Data Type

bool

# ip_packet property ([IPMonitor](#struct-ipworksipmonitor) Struct)

This property includes the contents of the current packet.

## Syntax

*Rust Syntax*

```text
fn ip_packet(&self ) -> Result<Vec<u8>, IPWorksError>
```

## Default Value

""

## Remarks

This property contains the contents of the current packet. This property is available only while the [on_ip_packet](#on_ip_packet-event-ipmonitor-struct) event is being processed. An empty string is returned at all other times.

This property is read-only.

## Data Type

Vec

# local_host property ([IPMonitor](#struct-ipworksipmonitor) 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

# activate method ([IPMonitor](#struct-ipworksipmonitor) Struct)

This method enables network monitoring.

## Syntax

*Rust Syntax*

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

## Remarks

This methods enables network monitoring. When called, the struct will create a communication endpoint (socket) that can be used to monitor network traffic.

To stop monitoring traffic, call [deactivate](#deactivate-method-ipmonitor-struct).

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

# deactivate method ([IPMonitor](#struct-ipworksipmonitor) Struct)

This method disables network monitoring.

## Syntax

*Rust Syntax*

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

## Remarks

This methods disables network monitoring. When called, the struct will stop monitoring network traffic.

# do_events method ([IPMonitor](#struct-ipworksipmonitor) 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.

# list_ip_addresses method ([IPMonitor](#struct-ipworksipmonitor) Struct)

This method lists the valid IP addresses for this host.

## Syntax

*Rust Syntax*

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

## Remarks

Use this method to list all valid addresses that can be monitored. Before monitoring the network, [local_host](#local_host-property-ipmonitor-struct) must be set to a valid address on the host. After a call to this method, an [on_ip_address](#on_ip_address-event-ipmonitor-struct) event will fire for each address.

# parse_pcap_file method ([IPMonitor](#struct-ipworksipmonitor) Struct)

This method parses the specified pcap file.

## Syntax

*Rust Syntax*

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

## Remarks

This method parses the specified pcap (packet capture) file and fires events as if the traffic were received directly.

The struct supports both the standard pcap and the newer pcap-ng file formats used by a variety of popular network capture tools. When calling this method, the file will be parsed and the [on_ip_packet](#on_ip_packet-event-ipmonitor-struct) event will fire for each parsed packet.

# pause_data method ([IPMonitor](#struct-ipworksipmonitor) 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_ip_packet](#on_ip_packet-event-ipmonitor-struct) event will not fire. Call [process_data](#process_data-method-ipmonitor-struct) to reenable data reception.

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

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

# reset method ([IPMonitor](#struct-ipworksipmonitor) 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.

# on_error event ([IPMonitor](#struct-ipworksipmonitor) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

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

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

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

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

# on_ip_address event ([IPMonitor](#struct-ipworksipmonitor) Struct)

This event is fired for each valid IP address on this host.

## Syntax

*Rust Syntax*

```text
// IPMonitorIPAddressEventArgs carries the IPMonitor IPAddress event's parameters.
pub struct IPMonitorIPAddressEventArgs {
  fn ip_address(&self) -> &String
}

// IPMonitorIPAddressEvent defines the signature of the IPMonitor IPAddress event's handler function.
pub trait IPMonitorIPAddressEvent {
  fn on_ip_address(&self, sender : IPMonitor, e : &mut IPMonitorIPAddressEventArgs);
}

impl <'a> IPMonitor<'a> {
  pub fn on_ip_address(&self) -> &'a dyn IPMonitorIPAddressEvent;
  pub fn set_on_ip_address(&mut self, value : &'a dyn IPMonitorIPAddressEvent);
  ...
}
```

## Remarks

Before monitoring the network, [local_host](#local_host-property-ipmonitor-struct) must be set to a valid address on the host. Use the [list_ip_addresses](#list_ip_addresses-method-ipmonitor-struct) method to list all valid addresses that can be monitored. After a call to the method, an on_ip_address event will fire for each address.

# on_ip_packet event ([IPMonitor](#struct-ipworksipmonitor) Struct)

This event is fired whenever a packet is received.

## Syntax

*Rust Syntax*

```text
// IPMonitorIPPacketEventArgs carries the IPMonitor IPPacket event's parameters.
pub struct IPMonitorIPPacketEventArgs {
  fn source_address(&self) -> &String
  fn source_port(&self) -> i32
  fn destination_address(&self) -> &String
  fn destination_port(&self) -> i32
  fn ip_version(&self) -> i32
  fn tos(&self) -> i32
  fn id(&self) -> i32
  fn flags(&self) -> i32
  fn offset(&self) -> i32
  fn ttl(&self) -> i32
  fn checksum(&self) -> i32
  fn ip_protocol(&self) -> i32
  fn payload(&self) -> &[u8]
  fn timestamp(&self) -> i64
}

// IPMonitorIPPacketEvent defines the signature of the IPMonitor IPPacket event's handler function.
pub trait IPMonitorIPPacketEvent {
  fn on_ip_packet(&self, sender : IPMonitor, e : &mut IPMonitorIPPacketEventArgs);
}

impl <'a> IPMonitor<'a> {
  pub fn on_ip_packet(&self) -> &'a dyn IPMonitorIPPacketEvent;
  pub fn set_on_ip_packet(&mut self, value : &'a dyn IPMonitorIPPacketEvent);
  ...
}
```

## Remarks

When [active](#active-property-ipmonitor-struct) is True or [parse_pcap_file](#parse_pcap_file-method-ipmonitor-struct) is called, the struct will listen for network traffic or parse the provided file, respectively. For each packet sent across the interface in [local_host](#local_host-property-ipmonitor-struct), the struct will parse the packet and fire an on_ip_packet event with the header fields and payload. The parameters are defined as follows:

|  |  |
| --- | --- |
| source_address | The IP address of the originating host in IP dotted format. |
| destination_address | The IP address of the destination host in IP dotted format. |
| ip_version | The IP protocol version being used by this packet. |
| tos | The type of service being used by this packet. |
| id | The packet Id used to identify and track packets. |
| flags | Flags relating to the status of the packet and desired responses. |
| offset | The fragment offset of this packet in relation to larger data. |
| ttl | The time to live for this packet. |
| ip_protocol | The IP protocol used in the payload. |
| payload | The data field of the IP packet. This field may contain extra IP headers, depending on the IP protocol used to create it. |
| timestamp | This is the number of microseconds from the UNIX Epoch (1977-01-01). This is available only when parsing files. |

*tos*

|  |  |
| --- | --- |
| Bit 0, 1, 2 | Precedence (see below) |
| Bit 3 | Delay (0 = Normal, 1 = Low) |
| Bit 4 | Throughput (0 = Normal, 1 = High) |
| Bit 5 | Reliability (0 = Normal, 1 = High) |

Precedence

|  |  |
| --- | --- |
| 000 | Routine |
| 001 | Priority |
| 010 | Immediate |
| 011 | Flash |
| 100 | Flash Override |
| 101 | CRITIC/ECP |
| 110 | Internetwork Control |
| 111 | Network Control |

*flags*

|  |  |
| --- | --- |
| Bit 0 | Always zero |
| Bit 1 | Don't Fragment (0 = May Fragment, 1 = Don't Fragment) |
| Bit 2 | More Fragments (0 = Last Fragment, 1 = More Fragments) |

*ip_protocol* (For a full list, visit www.iana.org.)

|  |  |
| --- | --- |
| 1 | ICMP |
| 2 | IGMP |
| 4 | IP |
| 6 | TCP |
| 17 | UDP |

# Config Settings ([IPMonitor](#struct-ipworksipmonitor) 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-ipmonitor-struct) method.

### IPMonitor Config Settings

**ListInterface**: Lists the interfaces visible to the WinPCap or NPCap driver.This configuration setting returns a numbered list of interfaces visible to the WinPCap or NPCap driver on the system.

**ReceiveAllMode**: Enables a socket to receive all IPv4 or IPv6 packets on the network.The following modes are available:

|  |  |
| --- | --- |
| Value | Description |
| 0 | Do not receive all network traffic. |
| 1 (default) | Receive all network traffic. This enables the promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, the NIC that supports 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 promiscuous mode on the NIC. This option affects only packet processing at the IP level. The NIC still receives only packets directed to its configured unicast and multicast addresses. A socket with this option enabled, however, will receive not only packets directed to specific IP addresses, but also all of the IPv4 or IPv6 packets that the NIC receives. |

 ReceiveAllMode captures only IPv4 and IPv6 packets. It will not capture other packets (e.g., ARP, IPX, NetBEUI packets) on the interface.

**SelectedInterface**: Used to select the interface the WinPCap or NPCap driver will listen on.Set this configuration setting to the index of the interface the WinPCap or NPCap driver will listen on. Indices can be returned by querying [ListInterface](#ListInterface).

**UseWinPCap**: Whether to use the WinPCap or NPCap driver.When set to True, the struct will use the WinPCap or NPCap driver available on the system. The default is False.

### 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 ([IPMonitor](#struct-ipworksipmonitor) Struct)

### IPMonitor Errors

|  |  |
| --- | --- |
| 650 | Cannot read packet. |
| 1118 | Invalid local host. |

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