IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

IPMonitor Class

Properties   Methods   Events   Configuration Settings   Errors  

The IPMonitor component is used to listen to network traffic.

Class Name

IPWorks_IPMonitor

Procedural Interface

 ipworks_ipmonitor_open();
 ipworks_ipmonitor_close($res);
 ipworks_ipmonitor_register_callback($res, $id, $function);
 ipworks_ipmonitor_get_last_error($res);
 ipworks_ipmonitor_get_last_error_code($res);
 ipworks_ipmonitor_set($res, $id, $index, $value);
 ipworks_ipmonitor_get($res, $id, $index);
 ipworks_ipmonitor_do_config($res, $configurationstring);
 ipworks_ipmonitor_do_doevents($res);
 ipworks_ipmonitor_do_listipaddresses($res);

Remarks

The IPMonitor class 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 class 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 class will parse the header and fire an IPPacket event.

Property List


The following is the full list of the properties of the class 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 class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
ListIPAddressesLists the valid IP addresses for this host.

Event List


The following is the full list of the events fired by the class 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 class with short descriptions. Click on the links for further details.

ReceiveAllModeEnables a socket to receive all IPv4 or IPv6 packets on the network.
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0