Receive-side latency result set. More...

Methods
	Description.Get
	Returns a textual description of the object.

	Interval.Duration.Get
	Gets the configured duration of this results snapshot [NS]. More...

	Jitter.Get
	Gets the jitter [ns] measured in this snapshot. More...

	Latency.Average.Get
	Gets the average latency [ns] measured in this snapshot. More...

	Latency.Maximum.Get
	Gets the maximum latency [ns] measured in this snapshot. More...

	Latency.Minimum.Get
	Gets the minimum latency [ns] measured in this snapshot. More...

	PacketCount.Buckets.Get
	Returns the number of packets received per bucket. More...

	PacketCount.Get
	Gets the received packet count. More...

	PacketCount.Invalid.Get
	Gets the received packet count of invalid packets. More...

	PacketCount.Valid.Get
	Gets the received packet count of valid packets. More...

	Parent.Get
	Returns the parent object.

	Timestamp.First.Get
	Gets the timestamp [NS] of the first packet in this snapshot. More...

	Timestamp.Get
	Gets the snapshot timestamp [NS]. More...

	Timestamp.Last.Get
	Gets the current timestamp [NS] of the last packet in this snapshot. More...

Class overview

Receive-side latency result set.

The result set contains the latency information of since the object is created or refreshed.

Note: See What's new in API v2 for more information.

A basic trigger result data snapshot object can be created via a Rx.Latency.Distribution.ResultHistory, using Rx.Latency.Distribution::Result.History.Get

Note: The information is not updated until Rx.Latency.Distribution.ResultHistory::Refresh is called.

Example

Receive all frames on "trunk-1-2" of some server, matching UDP source or destination port 67.

 set port [ $server Port.Create "trunk-1-2" ] 
  set latency [ $port Rx.Latency.Distribution.Add ] 
  $latency Filter.Set "udp port 67" 
  set resultHistory [ $latency Result.History.Get ] 
  foreach result [ $resultHistory Result.Cumulative.Get ] { 
  $result PacketCount.Get 
  }

Definition at line 19617 of file api.tcl.

Method documentation

Rx.Latency.Distribution.ResultData::Interval.Duration.Get

Gets the configured duration of this results snapshot [NS].

Since: 2.3.0

Example

This example gets interval duration of this result snapshot [NS]

1 $latencyResult Interval.Duration.Get

Returns:

1000000000

Definition at line 19634 of file api.tcl.

Rx.Latency.Distribution.ResultData::Jitter.Get

Gets the jitter [ns] measured in this snapshot.

Example

This example gets the jitter measured in this snapshot

1 $latencyResult Jitter.Get

Returns:

Definition at line 19644 of file api.tcl.

Rx.Latency.Distribution.ResultData::Latency.Average.Get

Gets the average latency [ns] measured in this snapshot.

Example

This example gets the average latency measured in this snapshot

1 $latencyResult Latency.Average.Get

Returns:

Definition at line 19654 of file api.tcl.

Rx.Latency.Distribution.ResultData::Latency.Maximum.Get

Gets the maximum latency [ns] measured in this snapshot.

Example

This example gets the maximum latency measured in this snapshot

1 $latencyResult Latency.Maximum.Get

Returns:

Definition at line 19664 of file api.tcl.

Rx.Latency.Distribution.ResultData::Latency.Minimum.Get

Gets the minimum latency [ns] measured in this snapshot.

Example

This example gets the minimum latency measured in this snapshot

1 $latencyResult Latency.Minimum.Get

Returns:

Definition at line 19674 of file api.tcl.

Rx.Latency.Distribution.ResultData::PacketCount.Buckets.Get

Returns the number of packets received per bucket.

Example

 $latency Range.Set 0 1 s 
  set result [ $latency Result.Get ] 
  $result PacketCount.Buckets.Get

Returns:

{1 2 3 ... 2 1}

Definition at line 19686 of file api.tcl.

Rx.Latency.Distribution.ResultData::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

1 $latencyResult PacketCount.Get

Returns:

Definition at line 19696 of file api.tcl.

Rx.Latency.Distribution.ResultData::PacketCount.Invalid.Get

Gets the received packet count of invalid packets.

Example

This example gets the received invalid packet counter

1 $latencyResult PacketCount.Invalid.Get

Returns:

Definition at line 19706 of file api.tcl.

Rx.Latency.Distribution.ResultData::PacketCount.Valid.Get

Gets the received packet count of valid packets.

Example

This example gets the received valid packet counter

1 $latencyResult PacketCount.Valid.Get

Returns:

Definition at line 19716 of file api.tcl.

Rx.Latency.Distribution.ResultData::Timestamp.First.Get

Gets the timestamp [NS] of the first packet in this snapshot.

Exceptions

CounterUnavailable When no frames are received, this counter is unavailable

Example

This example gets the timestamp [NS] of the first received packet in this snapshot

1 $latencyResult Timestamp.First.Get

Returns:

1413475037767331530

Definition at line 19733 of file api.tcl.

Rx.Latency.Distribution.ResultData::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $latencyResult Timestamp.Get

Returns:

1413475070000000000

Definition at line 19743 of file api.tcl.

Rx.Latency.Distribution.ResultData::Timestamp.Last.Get

Gets the current timestamp [NS] of the last packet in this snapshot.

Exceptions

CounterUnavailable When no frames are received, this counter is unavailable

Example

This example gets the timestamp [NS] of the last received packet in this snapshot

1 $latencyResult Timestamp.Last.Get

Returns:

1413475071947640170

Definition at line 19755 of file api.tcl.

Methods

Class overview

Method documentation