Struct ipworks::IPMonitor

Properties   Methods   Events   Config Settings   Errors  

The IPMonitor struct is used to listen to network traffic.

Syntax

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 to the IP address whose traffic you wish to monitor, and then set active to True. For each packet that crosses the interface, the struct will parse the header and fire an on_ip_packet 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.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

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.

Config Settings

---

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

accept_data property (IPMonitor Struct)

This property indicates whether data reception is currently enabled.

Syntax

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 event will not fire. Use the pause_data and process_data methods to pause and resume data reception.

This property is read-only.

Data Type

bool

active property (IPMonitor Struct)

This property indicates whether the struct is active.

Syntax

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 and deactivate methods to control whether the struct is active.

This property is read-only.

Data Type

bool

ip_packet property (IPMonitor Struct)

This property includes the contents of the current packet.

Syntax

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

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

Syntax

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)

This method enables network monitoring.

Syntax

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.

config method (IPMonitor Struct)

Sets or retrieves a configuration setting.

Syntax

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 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, you must call Config("PROPERTY"). The value will be returned as a string.

deactivate method (IPMonitor Struct)

This method disables network monitoring.

Syntax

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)

This method processes events from the internal message queue.

Syntax

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)

This method lists the valid IP addresses for this host.

Syntax

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 must be set to a valid address on the host. After a call to this method, an on_ip_address event will fire for each address.

parse_pcap_file method (IPMonitor Struct)

This method parses the specified pcap file.

Syntax

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

pause_data method (IPMonitor Struct)

This method pauses data reception.

Syntax

fn pause_data(&self) -> Result<(), IPWorksError>

Remarks

This method pauses data reception when called. While data reception is paused, the on_ip_packet event will not fire. Call process_data to reenable data reception.

process_data method (IPMonitor Struct)

This method reenables data reception after a call to PauseData .

Syntax

fn process_data(&self) -> Result<(), IPWorksError>

Remarks

This method reenables data reception after a previous call to pause_data. When pause_data is called, the on_ip_packet event will not fire. To reenable data reception and allow on_ip_packet to fire, call this method.

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

reset method (IPMonitor Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

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

on_error event (IPMonitor Struct)

Fired when information is available about errors during data delivery.

Syntax

// 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 section.

on_ip_address event (IPMonitor Struct)

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

Syntax

// 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 must be set to a valid address on the host. Use the list_ip_addresses 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)

This event is fired whenever a packet is received.

Syntax

// 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 is True or parse_pcap_file 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, 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:

tos

Precedence

flags

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

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

IPMonitor Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (IPMonitor Struct)

IPMonitor Errors

SSL Errors

TCP/IP Errors