# IPMonitor Component

The IPMonitor component is used to listen to network traffic.

## Syntax

```text
nsoftware.IPWorks.IPMonitor
```

## Remarks

The IPMonitor component 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 component is to set [LocalHost](#localhost-property-ipmonitor-component) to the IP address whose traffic you wish to monitor, and then set [Active](#active-property-ipmonitor-component) to True. For each packet that crosses the interface, the component will parse the header and fire an [IPPacket](#ippacket-event-ipmonitor-component) event.

## Property List

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

|  |  |
| --- | --- |
| [AcceptData](#acceptdata-property-ipmonitor-component) | This property indicates whether data reception is currently enabled. |
| [Active](#active-property-ipmonitor-component) | This property indicates whether the component is active. |
| [IPPacket](#ippacket-property-ipmonitor-component) | This property includes the contents of the current packet. |
| [LocalHost](#localhost-property-ipmonitor-component) | 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 component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Activate](#activate-method-ipmonitor-component) | This method enables network monitoring. |
| [Config](#config-method-ipmonitor-component) | Sets or retrieves a configuration setting. |
| [Deactivate](#deactivate-method-ipmonitor-component) | This method disables network monitoring. |
| [DoEvents](#doevents-method-ipmonitor-component) | This method processes events from the internal message queue. |
| [ListIPAddresses](#listipaddresses-method-ipmonitor-component) | This method lists the valid IP addresses for this host. |
| [ParsePcapFile](#parsepcapfile-method-ipmonitor-component) | This method parses the specified pcap file. |
| [PauseData](#pausedata-method-ipmonitor-component) | This method pauses data reception. |
| [ProcessData](#processdata-method-ipmonitor-component) | This method reenables data reception after a call to [PauseData](#pausedata-method-ipmonitor-component) . |
| [Reset](#reset-method-ipmonitor-component) | This method will reset the component. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-ipmonitor-component) | Fired when information is available about errors during data delivery. |
| [IPAddress](#ipaddress-event-ipmonitor-component) | This event is fired for each valid IP address on this host. |
| [IPPacket](#ippacket-event-ipmonitor-component) | This event is fired whenever a packet is received. |

## Config Settings

*The following is a list of config settings for the component 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. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [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. |

# AcceptData Property ([IPMonitor](#ipmonitor-component) Component)

This property indicates whether data reception is currently enabled.

## Syntax

```text
public bool AcceptData { get; }
```

## Default Value

True

## Remarks

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

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

# Active Property ([IPMonitor](#ipmonitor-component) Component)

This property indicates whether the component is active.

## Syntax

```text
public bool Active { get; }
```

## Default Value

False

## Remarks

This property indicates whether the component is currently active and is monitoring network traffic. Use the [Activate](#activate-method-ipmonitor-component) and [Deactivate](#deactivate-method-ipmonitor-component) methods to control whether the component is active.

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

# IPPacket Property ([IPMonitor](#ipmonitor-component) Component)

This property includes the contents of the current packet.

## Syntax

```text
public string IPPacket { get; }
public byte[] IPPacketB { get; }
```

## Default Value

""

## Remarks

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

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

# LocalHost Property ([IPMonitor](#ipmonitor-component) Component)

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

## Syntax

```text
public string LocalHost { get; set; }
```

## 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 component initiate connections (or accept in the case of server components) 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 component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

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

# Activate Method ([IPMonitor](#ipmonitor-component) Component)

This method enables network monitoring.

## Syntax

```text
public void Activate();

Async Version
public async Task Activate();
public async Task Activate(CancellationToken cancellationToken);
```

## Remarks

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

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

# Config Method ([IPMonitor](#ipmonitor-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

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

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

# Deactivate Method ([IPMonitor](#ipmonitor-component) Component)

This method disables network monitoring.

## Syntax

```text
public void Deactivate();

Async Version
public async Task Deactivate();
public async Task Deactivate(CancellationToken cancellationToken);
```

## Remarks

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

# DoEvents Method ([IPMonitor](#ipmonitor-component) Component)

This method processes events from the internal message queue.

## Syntax

```text
public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);
```

## Remarks

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

# ListIPAddresses Method ([IPMonitor](#ipmonitor-component) Component)

This method lists the valid IP addresses for this host.

## Syntax

```text
public void ListIPAddresses();

Async Version
public async Task ListIPAddresses();
public async Task ListIPAddresses(CancellationToken cancellationToken);
```

## Remarks

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

# ParsePcapFile Method ([IPMonitor](#ipmonitor-component) Component)

This method parses the specified pcap file.

## Syntax

```text
public void ParsePcapFile(string fileName);

Async Version
public async Task ParsePcapFile(string fileName);
public async Task ParsePcapFile(string fileName, CancellationToken cancellationToken);
```

## Remarks

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

The component 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 [IPPacket](#ippacket-event-ipmonitor-component) event will fire for each parsed packet.

# PauseData Method ([IPMonitor](#ipmonitor-component) Component)

This method pauses data reception.

## Syntax

```text
public void PauseData();

Async Version
public async Task PauseData();
public async Task PauseData(CancellationToken cancellationToken);
```

## Remarks

This method pauses data reception when called. While data reception is paused, the [IPPacket](#ippacket-event-ipmonitor-component) event will not fire. Call [ProcessData](#processdata-method-ipmonitor-component) to reenable data reception.

# ProcessData Method ([IPMonitor](#ipmonitor-component) Component)

This method reenables data reception after a call to [PauseData](#pausedata-method-ipmonitor-component) .

## Syntax

```text
public void ProcessData();

Async Version
public async Task ProcessData();
public async Task ProcessData(CancellationToken cancellationToken);
```

## Remarks

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

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

# Reset Method ([IPMonitor](#ipmonitor-component) Component)

This method will reset the component.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

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

# Error Event ([IPMonitor](#ipmonitor-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, IPMonitorErrorEventArgs e);

public class IPMonitorErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-ipmonitor-component) section.

# IPAddress Event ([IPMonitor](#ipmonitor-component) Component)

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

## Syntax

```text
public event OnIPAddressHandler OnIPAddress;

public delegate void OnIPAddressHandler(object sender, IPMonitorIPAddressEventArgs e);

public class IPMonitorIPAddressEventArgs : EventArgs {
  public string IpAddress { get; }
}
```

## Remarks

Before monitoring the network, [LocalHost](#localhost-property-ipmonitor-component) must be set to a valid address on the host. Use the [ListIPAddresses](#listipaddresses-method-ipmonitor-component) method to list all valid addresses that can be monitored. After a call to the method, an IPAddress event will fire for each address.

# IPPacket Event ([IPMonitor](#ipmonitor-component) Component)

This event is fired whenever a packet is received.

## Syntax

```text
public event OnIPPacketHandler OnIPPacket;

public delegate void OnIPPacketHandler(object sender, IPMonitorIPPacketEventArgs e);

public class IPMonitorIPPacketEventArgs : EventArgs {
  public string SourceAddress { get; }
  public int SourcePort { get; }
  public string DestinationAddress { get; }
  public int DestinationPort { get; }
  public int IPVersion { get; }
  public int TOS { get; }
  public int Id { get; }
  public int Flags { get; }
  public int Offset { get; }
  public int TTL { get; }
  public int Checksum { get; }
  public int IPProtocol { get; }
  public string Payload { get; }  public byte[] PayloadB { get; }
  public long Timestamp { get; }
}
```

## Remarks

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

|  |  |
| --- | --- |
| SourceAddress | The IP address of the originating host in IP dotted format. |
| DestinationAddress | The IP address of the destination host in IP dotted format. |
| IPVersion | 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. |
| IPProtocol | 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) |

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

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

# Config Settings ([IPMonitor](#ipmonitor-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-ipmonitor-component) 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 component 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 component 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 component 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.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component 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 component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component 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.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([IPMonitor](#ipmonitor-component) Component)

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