Rx.Trigger.Basic.Mobile Class Reference

Receive-side packet processor on a WirelessEndpoint that counts all incoming frames that match a filter. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Duration.Get
	Returns the duration for which the trigger will be active.
	Duration.Set
	Sets the duration for which the trigger will be active. More...
	Filter.SourceAddress.Get
	Returns the source (source) address field of the packet filter. More...
	Filter.SourceAddress.Set
	Sets the source (source) address field of the packet filter. More...
	Filter.Udp.DestinationPort.Get
	Returns the destination (destination) port field of the packet filter. More...
	Filter.Udp.DestinationPort.Set
	Sets the destination (destination) port field of the packet filter. More...
	Filter.Udp.SourcePort.Get
	Returns the source (source) port field of the packet filter. More...
	Filter.Udp.SourcePort.Set
	Sets the source (source) port field of the packet filter. More...
	Parent.Get
	Returns the parent object.
	Result.Clear
	Resets the counter values to zero and empties the Result.History. More...
	Result.Get
	Returns the current result counters. More...
	Result.History.Get
	Returns the current History counters. More...

Class overview

Receive-side packet processor on a WirelessEndpoint that counts all incoming frames that match a filter.

All triggers are started after calling WirelessEndpoint::Start on the parent WirelessEndpoint object.

A basic trigger object can be created by calling WirelessEndpoint::Rx.Trigger.Basic.Add.

Since

2.6.0

Example

set trigger [ $device Rx.Trigger.Basic.Add ] 
 $trigger Filter.SourceAddress.Set $src_ip 
 $trigger Filter.Udp.SourcePort.Set $src_port 
 $trigger Filter.Udp.DestinationPort.Set $dst_port

Definition at line 21433 of file api.tcl.

Method documentation

Rx.Trigger.Basic.Mobile::Duration.Set

Sets the duration for which the trigger will be active.

Configures how long the trigger will listen for incoming packets.

Example

Listen for 10 minutes

$trigger Duration.Set 10m

Definition at line 21456 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.SourceAddress.Get

Returns the source (source) address field of the packet filter.

Example

$trigger Filter.SourceAddress.Get

Returns:

10.8.1.2 

Definition at line 21466 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.SourceAddress.Set

Sets the source (source) address field of the packet filter.

Example

$trigger Filter.SourceAddress.Set 10.8.1.2

Definition at line 21476 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.Udp.DestinationPort.Get

Returns the destination (destination) port field of the packet filter.

Example

$trigger Filter.Udp.DestinationPort.Get

Returns:

1024 

Definition at line 21486 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.Udp.DestinationPort.Set

Sets the destination (destination) port field of the packet filter.

Example

$trigger Filter.Udp.DestinationPort.Set 1024

Definition at line 21496 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.Udp.SourcePort.Get

Returns the source (source) port field of the packet filter.

Example

$trigger Filter.Udp.SourcePort.Get

Returns:

1024 

Definition at line 21506 of file api.tcl.

Rx.Trigger.Basic.Mobile::Filter.Udp.SourcePort.Set

Sets the source (source) port field of the packet filter.

Example

$trigger Filter.Udp.SourcePort.Set 1024

Definition at line 21516 of file api.tcl.

Rx.Trigger.Basic.Mobile::Result.Clear

Resets the counter values to zero and empties the Result.History.

Example

$trigger Result.Clear

Definition at line 21531 of file api.tcl.

Rx.Trigger.Basic.Mobile::Result.Get

Returns the current result counters.

This method will return an object of Rx.Trigger.Basic.ResultSnapshot. It will contain all the current Cumulative counters. To update the counters, call Refresh on Rx.Trigger.Basic.ResultSnapshot

Returns

The OID of the Rx.Trigger.Basic.ResultSnapshot object.

Example

$trigger Result.Get

Returns:

<Rx.Trigger.Basic.ResultSnapshot object> 

Definition at line 21545 of file api.tcl.

Rx.Trigger.Basic.Mobile::Result.History.Get

Returns the current History counters.

This method returns a Rx.Trigger.Basic.ResultHistory Object. This will contain the Cumulative and the Interval counters over time. Use this to create results over time.

Returns

The OID of the Rx.Trigger.Basic.ResultHistory object.

Example

$trigger Results.History.Get

Returns:

<Rx.Trigger.Basic.ResultHistory object> 

Definition at line 21559 of file api.tcl.