Docs

IPWorks 2022 .NET Edition

Version 22.0 [Build 8171]

IPMonitor Component

Properties   Methods   Events   Configuration Settings   Errors  

The IPMonitor component is used to listen to network traffic.

Syntax

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 (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 only forward 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 to the IP address whose traffic you wish to monitor, then set Active to True. For each packet that crosses the interface, the component will parse the header and fire an IPPacket 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.

AcceptDataEnables or disables data reception (the IPPacket event).
ActiveEnables or disables network monitoring.
IPPacketThe contents of the current packet.
LocalHostThe 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.

ActivateEnables network monitoring.
ConfigSets or retrieves a configuration setting.
DeactivateDisables network monitoring.
DoEventsProcesses events from the internal message queue.
ListIPAddressesLists the valid IP addresses for this host.
ParsePcapFileParses the specified pcap file.
PauseDataPauses data reception.
ProcessDataRe-enables data reception after a call to PauseData
ResetReset 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.

ErrorInformation about errors during data delivery.
IPAddressFired for each valid IP address on this host.
IPPacketFired whenever a packet is received.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

ListInterfaceLists the interfaces visible to the WinPCap or NPCap driver.
ReceiveAllModeEnables a socket to receive all IPv4 or IPv6 packets on the network.
SelectedInterfaceUsed to select the interface the WinPCap or NPCap driver will listen on.
UseWinPCapWhether to use the WinPCap or NPCap driver.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AcceptData Property (IPMonitor Component)

Enables or disables data reception (the IPPacket event).

Syntax

public bool AcceptData { get; set; }
Public Property AcceptData As Boolean

Default Value

True

Remarks

This property enables or disables data reception (the IPPacket event). Setting this property to False, temporarily disables data reception (and the IPPacket event). Setting this property to True, re-enables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Active Property (IPMonitor Component)

Enables or disables network monitoring.

Syntax

public bool Active { get; set; }
Public Property Active As Boolean

Default Value

False

Remarks

This property enables or disables network monitoring. Setting this property to True makes IPMonitor create a communication endpoint (socket) which can be used for monitoring network traffic. Setting it to False destroys the socket and disables network monitoring.

Note: It is recommended to use the Activate or Deactivate method instead of setting this property.

This property is not available at design time.

IPPacket Property (IPMonitor Component)

The contents of the current packet.

Syntax

public string IPPacket { get; }
public byte[] IPPacketB { get; }
Public ReadOnly Property IPPacket As String
Public ReadOnly Property IPPacketB As Byte()

Default Value

""

Remarks

This property contains the contents of the current packet. This property is only available while the IPPacket 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 Component)

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

Syntax

public string LocalHost { get; set; }
Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

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 multi-homed 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 Component)

Enables network monitoring.

Syntax

public void Activate();

Async Version
public async Task Activate();
public async Task Activate(CancellationToken cancellationToken);
Public Sub Activate()

Async Version
Public Sub Activate() As Task
Public Sub Activate(cancellationToken As CancellationToken) As Task

Remarks

This methods enables network monitoring. When called the component will create a communication endpoint (socket) which can be used for monitoring network traffic.

To stop monitoring traffic call Deactivate.

Config Method (IPMonitor Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

Deactivate Method (IPMonitor Component)

Disables network monitoring.

Syntax

public void Deactivate();

Async Version
public async Task Deactivate();
public async Task Deactivate(CancellationToken cancellationToken);
Public Sub Deactivate()

Async Version
Public Sub Deactivate() As Task
Public Sub Deactivate(cancellationToken As CancellationToken) As Task

Remarks

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

DoEvents Method (IPMonitor Component)

Processes events from the internal message queue.

Syntax

public void DoEvents();
Public Sub DoEvents()

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 Component)

Lists the valid IP addresses for this host.

Syntax

public void ListIPAddresses();

Async Version
public async Task ListIPAddresses();
public async Task ListIPAddresses(CancellationToken cancellationToken);
Public Sub ListIPAddresses()

Async Version
Public Sub ListIPAddresses() As Task
Public Sub ListIPAddresses(cancellationToken As CancellationToken) As Task

Remarks

Use this method to list all valid addresses that can be monitored. Before monitoring the network, LocalHost must be set to a valid address on the host. After a call to this method, an IPAddress event will fire for each address.

ParsePcapFile Method (IPMonitor Component)

Parses the specified pcap file.

Syntax

public void ParsePcapFile(string fileName);

Async Version
public async Task ParsePcapFile(string fileName);
public async Task ParsePcapFile(string fileName, CancellationToken cancellationToken);
Public Sub ParsePcapFile(ByVal fileName As String)

Async Version
Public Sub ParsePcapFile(ByVal fileName As String) As Task
Public Sub ParsePcapFile(ByVal fileName As String, cancellationToken As CancellationToken) As Task

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 event will fire for each parsed packet.

PauseData Method (IPMonitor Component)

Pauses data reception.

Syntax

public void PauseData();

Async Version
public async Task PauseData();
public async Task PauseData(CancellationToken cancellationToken);
Public Sub PauseData()

Async Version
Public Sub PauseData() As Task
Public Sub PauseData(cancellationToken As CancellationToken) As Task

Remarks

This method pauses data reception when called. While data reception is paused the IPPacket event will not fire. Call ProcessData to re-enable data reception.

ProcessData Method (IPMonitor Component)

Re-enables data reception after a call to PauseData

Syntax

public void ProcessData();

Async Version
public async Task ProcessData();
public async Task ProcessData(CancellationToken cancellationToken);
Public Sub ProcessData()

Async Version
Public Sub ProcessData() As Task
Public Sub ProcessData(cancellationToken As CancellationToken) As Task

Remarks

This method re-enables data reception after a previous call to PauseData. When PauseData is called the IPPacket event will not fire. To re-enable data reception and allow IPPacket to fire call this method.

Note: This method is only used after previously calling PauseData. It does not need to be called to process data by default.

Reset Method (IPMonitor Component)

Reset the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

Error Event (IPMonitor Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

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

public class IpmonitorErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As IpmonitorErrorEventArgs)

Public Class IpmonitorErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

IPAddress Event (IPMonitor Component)

Fired for each valid IP address on this host.

Syntax

public event OnIPAddressHandler OnIPAddress;

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

public class IpmonitorIPAddressEventArgs : EventArgs {
  public string IpAddress { get; }

}
Public Event OnIPAddress As OnIPAddressHandler

Public Delegate Sub OnIPAddressHandler(sender As Object, e As IpmonitorIPAddressEventArgs)

Public Class IpmonitorIPAddressEventArgs Inherits EventArgs
  Public ReadOnly Property IpAddress As String

End Class

Remarks

Before monitoring the network, LocalHost must be set to a valid address on the host. Use ListIPAddresses 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 Component)

Fired whenever a packet is received.

Syntax

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; } }
Public Event OnIPPacket As OnIPPacketHandler

Public Delegate Sub OnIPPacketHandler(sender As Object, e As IpmonitorIPPacketEventArgs)

Public Class IpmonitorIPPacketEventArgs Inherits EventArgs
  Public ReadOnly Property SourceAddress As String

  Public ReadOnly Property SourcePort As Integer

  Public ReadOnly Property DestinationAddress As String

  Public ReadOnly Property DestinationPort As Integer

  Public ReadOnly Property IPVersion As Integer

  Public ReadOnly Property TOS As Integer

  Public ReadOnly Property Id As Integer

  Public ReadOnly Property Flags As Integer

  Public ReadOnly Property Offset As Integer

  Public ReadOnly Property TTL As Integer

  Public ReadOnly Property Checksum As Integer

  Public ReadOnly Property IPProtocol As Integer

  Public ReadOnly Property Payload As String
Public ReadOnly Property PayloadB As Byte() Public ReadOnly Property Timestamp As Long End Class

Remarks

When Active is True or ParsePcapFile is called, the component will listen for network traffic or parse the provided file, respectively. For each packet sent across the interface in LocalHost, the component will parse the packet and fire an IPPacket event with the header fields and payload. The parameters are defined as follows:

SourceAddressThe IP address of the originating host in IP dotted format.
DestinationAddressThe IP address of the destination host in IP dotted format.
IPVersionThe IP protocol version being used by this packet.
TOSThe type of service being used by this packet.
IdThe packet id used to identify and track packets.
FlagsFlags relating to the status of the packet and desired responses.
OffsetThe fragment offset of this packet in relation to larger data.
TTLThe time to live for this packet.
IPProtocolThe IP protocol used in the payload.
PayloadThe data field of the IP packet. This field may contain extra IP headers, depending upon the IP protocol used to create it.
TimestampThis is the number of microseconds from the UNIX Epoch (1977-01-01). This is only available when parsing files.

TOS

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

Precedence

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

Flags

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

IPProtocol - for a full list, visit www.iana.org.

1ICMP
2IGMP
4IP
6TCP
17UDP

Configuration Settings (IPMonitor 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 method.

IPMonitor Configuration Settings

ListInterface:   Lists the interfaces visible to the WinPCap or NPCap driver.

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.

Available modes:

ValueDescription
0Do not receive all network traffic.
1 (default)Receive all network traffic. This enables promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, a 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.
2Receive only socket-level network traffic (Feature may not be implemented by your Windows installation).
3Receive only IP level network traffic. This option does not enable promiscuous mode on the network interface card. This option only affects packet processing at the IP level. The NIC still receives only packets directed to its configured unicast and multicast addresses. However, a socket with this option enabled will receive not only packets directed to specific IP addresses, but will receive all the IPv4 or IPv6 packets the NIC receives.

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

SelectedInterface:   Used to select the interface the WinPCap or NPCap driver will listen on.

Set this to the index of the interface the WinPCap or NPCap driver will listen on. Indices can be returned by querying 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 Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which 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 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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 Configuration Settings

BuildInfo:   Information about the product's build.

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

GUIAvailable:   Tells the component 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 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).
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False 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 to True tells the component to use the internal implementation instead of using the system's security API.

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 DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (IPMonitor Component)

IPMonitor Errors

650   Can't 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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 .NET Edition - Version 22.0 [Build 8171]