All Classes Namespaces Files Functions Pages
Rx.Latency.Basic.ResultSnapshot Class Reference

Receive-side latency result set. More...

Methods

 ByteCount.Get
 Gets the current received bytes counter. More...
 
 Description.Get
 Returns a textual description of the object.
 
 Framesize.Max.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Maximum.Get
 Gets the size (in bytes) of the largest frame received in this snapshot. More...
 
 Framesize.Min.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 Framesize.Minimum.Get
 Gets the size (in bytes) of the smallest frame received in this snapshot. More...
 
 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.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.
 
 Refresh.Timestamp.Get
 Returns the timestamp when the counters of this object where last refreshed. More...
 
 Refresh
 Refresh the results, get the new counters. More...
 
 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
The information is not updated until Refresh is called
See What's new in API v2 for more information.

A basic latency result snapshot object can be created via a Rx.Latency.Basic, using Rx.Latency.Basic::Result.Get

Example

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

1 set port [ $server Port.Create "trunk-1-2" ]
2  set latency [ $port Rx.Latency.Basic.Add ]
3  $latency Filter.Set "udp port 67"
4  set results [ $latency Result.Get ]
5  $results PacketCount.Get

Definition at line 19016 of file api.tcl.

Method documentation

Rx.Latency.Basic.ResultSnapshot::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

1 $latencyResult ByteCount.Get

Returns:

100 

Definition at line 19026 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Framesize.Max.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Deprecated:
since 2.6.4, please use Framesize.Maximum.Get instead
Example

This example gets the largest frame size received in this snapshot.

1 $latencyResult Framesize.Max.Get

Returns:

100 

Definition at line 19043 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Framesize.Maximum.Get

Gets the size (in bytes) of the largest frame received in this snapshot.

Since
2.6.4
Example

This example gets the largest frame size received in this snapshot.

1 $latencyResult Framesize.Maximum.Get

Returns:

100 

Definition at line 19055 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Framesize.Min.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Deprecated:
since 2.6.4, please use Framesize.Minimum.Get instead
Example

This example gets the smallest frame size received in this snapshot.

1 $latencyResult Framesize.Min.Get

Returns:

100 

Definition at line 19067 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Framesize.Minimum.Get

Gets the size (in bytes) of the smallest frame received in this snapshot.

Since
2.6.4
Example

This example gets the smallest frame size received in this snapshot.

1 $latencyResult Framesize.Minimum.Get

Returns:

100 

Definition at line 19079 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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 19091 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Jitter.Get

Gets the jitter [ns] measured in this snapshot.

The jitter is defined as the standard deviation of the measured latency.

Example

This example gets the jitter measured in this snapshot

1 $latencyResult Jitter.Get

Returns:

100 

Definition at line 19103 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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:

100 

Definition at line 19113 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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:

100 

Definition at line 19123 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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:

100 

Definition at line 19133 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

1 $latencyResult PacketCount.Get

Returns:

100 

Definition at line 19143 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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:

10 

Definition at line 19153 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::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:

90 

Definition at line 19163 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Refresh

Refresh the results, get the new counters.

Example
1 $latencyResult Refresh

Definition at line 19188 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Refresh.Timestamp.Get

Returns the timestamp when the counters of this object where last refreshed.

Example
1 $latencyResult Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 19178 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Timestamp.First.Get

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

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 19198 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $latencyResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 19208 of file api.tcl.

Rx.Latency.Basic.ResultSnapshot::Timestamp.Last.Get

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

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 19218 of file api.tcl.