IPMonitor Component
Properties Methods Events Config Settings Errors
The IPMonitor component is used to listen to network traffic.
Syntax
TipwIPMonitor
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 to the IP address whose traffic you wish to monitor, and 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.
AcceptData | This property enables or disables data reception (the IPPacket event). |
Active | This property indicates whether the component is active. |
IPPacket | This property includes the contents of the current packet. |
LocalHost | 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 | This method enables network monitoring. |
Config | Sets or retrieves a configuration setting. |
Deactivate | This method disables network monitoring. |
DoEvents | Processes events from the internal message queue. |
ListIPAddresses | This method lists the valid IP addresses for this host. |
ParsePcapFile | This method parses the specified pcap file. |
PauseData | This method pauses data reception. |
ProcessData | This method reenables data reception after a call to PauseData . |
Reset | 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 | Fired when information is available about errors during data delivery. |
IPAddress | This event is fired for each valid IP address on this host. |
IPPacket | 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 | Lists the interfaces visible to the WinPCap or NPCap driver. |
ReceiveAllMode | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
SelectedInterface | Used to select the interface the WinPCap or NPCap driver will listen on. |
UseWinPCap | Whether to use the WinPCap or NPCap driver. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (IPMonitor Component)
This property enables or disables data reception (the IPPacket event).
Syntax
__property bool AcceptData = { read=FAcceptData, write=FSetAcceptData };
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 reenables 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.
Data Type
Boolean
Active Property (IPMonitor Component)
This property indicates whether the component is active.
Syntax
__property bool Active = { read=FActive, write=FSetActive };
Default Value
False
Remarks
This property indicates whether the component is currently active and is monitoring network traffic.
Note: Use the Activate or Deactivate method to control whether the component is active.
This property is not available at design time.
Data Type
Boolean
IPPacket Property (IPMonitor Component)
This property includes the contents of the current packet.
Syntax
__property String IPPacket = { read=FIPPacket }; __property DynamicArray<Byte> IPPacketB = { read=FIPPacketB };
Default Value
""
Remarks
This property contains the contents of the current packet. This property is available only 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.
Data Type
Byte Array
LocalHost Property (IPMonitor Component)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
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.
Data Type
String
Activate Method (IPMonitor Component)
This method enables network monitoring.
Syntax
void __fastcall Activate();
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.
Config Method (IPMonitor Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
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)
This method disables network monitoring.
Syntax
void __fastcall Deactivate();
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
void __fastcall 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)
This method lists the valid IP addresses for this host.
Syntax
void __fastcall ListIPAddresses();
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)
This method parses the specified pcap file.
Syntax
void __fastcall ParsePcapFile(String fileName);
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)
This method pauses data reception.
Syntax
void __fastcall PauseData();
Remarks
This method pauses data reception when called. While data reception is paused, the IPPacket event will not fire. Call ProcessData to reenable data reception.
ProcessData Method (IPMonitor Component)
This method reenables data reception after a call to PauseData .
Syntax
void __fastcall ProcessData();
Remarks
This method reenables data reception after a previous call to PauseData. When PauseData is called, the IPPacket event will not fire. To reenable data reception and allow IPPacket to fire, call this method.
Note: This method is used only after previously calling PauseData. It does not need to be called to process data by default.
Reset Method (IPMonitor Component)
Reset the component.
Syntax
void __fastcall Reset();
Remarks
This method will reset the component's properties to their default values.
Error Event (IPMonitor Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TipwIPMonitorErrorEventParams; typedef void __fastcall (__closure *TipwIPMonitorErrorEvent)(System::TObject* Sender, TipwIPMonitorErrorEventParams *e); __property TipwIPMonitorErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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 section.
IPAddress Event (IPMonitor Component)
This event is fired for each valid IP address on this host.
Syntax
typedef struct { String IpAddress; } TipwIPMonitorIPAddressEventParams; typedef void __fastcall (__closure *TipwIPMonitorIPAddressEvent)(System::TObject* Sender, TipwIPMonitorIPAddressEventParams *e); __property TipwIPMonitorIPAddressEvent OnIPAddress = { read=FOnIPAddress, write=FOnIPAddress };
Remarks
Before monitoring the network, LocalHost must be set to a valid address on the host. Use the 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)
This event is fired whenever a packet is received.
Syntax
typedef struct { String SourceAddress; int SourcePort; String DestinationAddress; int DestinationPort; int IPVersion; int TOS; int Id; int Flags; int Offset; int TTL; int Checksum; int IPProtocol; String Payload; DynamicArray<Byte> PayloadB; __int64 Timestamp; } TipwIPMonitorIPPacketEventParams; typedef void __fastcall (__closure *TipwIPMonitorIPPacketEvent)(System::TObject* Sender, TipwIPMonitorIPPacketEventParams *e); __property TipwIPMonitorIPPacketEvent OnIPPacket = { read=FOnIPPacket, write=FOnIPPacket };
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:
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 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 Config Settings
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. |
Socket Config Settings
Note: This option is not valid for UDP ports.
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.
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
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 |
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 |
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (IPMonitor 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 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). |