Rx.Latency.Basic.Mobile Class Reference

Receive-side packet processor which calculates latency on the incoming frames, matching 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 address field of the packet filter. More...
	Filter.SourceAddress.Set
	Sets the source address field of the packet filter. More...
	Filter.Udp.DestinationPort.Get
	Returns the destination port field of the packet filter. More...
	Filter.Udp.DestinationPort.Set
	Sets the destination port field of the packet filter. More...
	Filter.Udp.SourcePort.Get
	Returns the source port field of the packet filter. More...
	Filter.Udp.SourcePort.Set
	Sets the 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 which calculates latency on the incoming frames, matching a filter.

Since

2.6.0

The basic latency processor extends the basic trigger . It provides additional information like latency and jitter. See Result.Get for more information.

The transmit time stamp of a packet is obtained from a time tag in the frame. This tag is configured on the FrameTag.Tx, which can be obtained via Frame::FrameTag.Time.Get.

A basic latency object can be created via a WirelessEndpoint, using WirelessEndpoint::Rx.Latency.Basic.Add

Example

set latency [ $we Rx.Latency.Basic.Add ] 
 $latency Filter.Udp.SourcePort.Set 1024

Definition at line 18618 of file api.tcl.

Method documentation

Rx.Latency.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

$latency Duration.Set 10m

Definition at line 18641 of file api.tcl.

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

Returns the source address field of the packet filter.

Example

$latency Filter.SourceAddress.Get

Returns:

10.8.1.2 

Definition at line 18651 of file api.tcl.

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

Sets the source address field of the packet filter.

Example

$latency Filter.SourceAddress.Set 10.8.1.2

Definition at line 18661 of file api.tcl.

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

Returns the destination port field of the packet filter.

Example

$latency Filter.Udp.DestinationPort.Get

Returns:

1024 

Definition at line 18671 of file api.tcl.

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

Sets the destination port field of the packet filter.

Example

$latency Filter.Udp.DestinationPort.Set 1024

Definition at line 18681 of file api.tcl.

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

Returns the source port field of the packet filter.

Example

$latency Filter.Udp.SourcePort.Get

Returns:

1024 

Definition at line 18691 of file api.tcl.

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

Sets the source port field of the packet filter.

Example

$latency Filter.Udp.SourcePort.Set 1024

Definition at line 18701 of file api.tcl.

Rx.Latency.Basic.Mobile::Result.Clear

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

Example

$latency Result.Clear

Definition at line 18716 of file api.tcl.

Rx.Latency.Basic.Mobile::Result.Get

Returns the current result counters.

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

Returns

The OID of the Rx.Latency.Basic.ResultSnapshot result object

Example

$latency Result.Get

Returns:

<Rx.Latency.Basic.ResultSnapshot object> 

Definition at line 18730 of file api.tcl.

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

Returns the current History counters.

This method returns a Rx.Latency.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.Latency.Basic.ResultHistory result object.

Example

$latency Results.History.Get

Returns:

<Rx.Latency.Basic.ResultHistory object> 

Definition at line 18744 of file api.tcl.