Rx.OutOfSequence.Basic.ResultSnapshot Class Reference

Refreshable object containing the out-of-sequence results. More...

Methods
	BiggestSequenceNumberGap.Get
	Gets the largest burst of consecutive missing packets for this snapshot. More...
	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...
	PacketCount.Get
	Gets the received packet count. More...
	PacketCount.Invalid.Get
	Gets the received packet count for the invalid/corrupted packets. More...
	PacketCount.Missing.Get
	Gets the number of missing packets (missing/skipped sequence numbers) in this snapshot. More...
	PacketCount.OutOfSequence.Get
	Gets the received packet count which were out of sequence. More...
	PacketCount.Valid.Get
	Gets the received packet count for packets which were not corrupted. 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

Refreshable object containing the out-of-sequence results.

Definition at line 20991 of file api.tcl.

Method documentation

Rx.OutOfSequence.Basic.ResultSnapshot::BiggestSequenceNumberGap.Get

Gets the largest burst of consecutive missing packets for this snapshot.

Example

This example gets the received out of sequence packet counter

$outOfSequenceResult BiggestSequenceNumberGap.Get

Returns:

10 

Definition at line 21001 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

$outOfSequenceResult ByteCount.Get

Returns:

100 

Definition at line 21011 of file api.tcl.

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

$outOfSequenceResult Framesize.Max.Get

Returns:

100 

Definition at line 21028 of file api.tcl.

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

$outOfSequenceResult Framesize.Maximum.Get

Returns:

100 

Definition at line 21040 of file api.tcl.

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

$outOfSequenceResult Framesize.Min.Get

Returns:

100 

Definition at line 21052 of file api.tcl.

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

$outOfSequenceResult Framesize.Minimum.Get

Returns:

100 

Definition at line 21064 of file api.tcl.

Rx.OutOfSequence.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]

$outOfSequenceResult Interval.Duration.Get

Returns:

1000000000 

Definition at line 21076 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

$outOfSequenceResult PacketCount.Get

Returns:

100 

Definition at line 21086 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Invalid.Get

Gets the received packet count for the invalid/corrupted packets.

Example

This example gets the received invalid packet counter

$outOfSequenceResult PacketCount.Invalid.Get

Returns:

10 

Definition at line 21096 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Missing.Get

Gets the number of missing packets (missing/skipped sequence numbers) in this snapshot.

This can be used as an indicator of packet loss.

Note

This counter does not include packet loss at the tail end of the flow. So if the final packets of a flow are dropped then they won't be counted as missing.

Example

This example gets the missing packet counter

$outOfSequenceResult PacketCount.Missing.Get

Returns:

10 

Definition at line 21110 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.OutOfSequence.Get

Gets the received packet count which were out of sequence.

Example

This example gets the received out of sequence packet counter

$outOfSequenceResult PacketCount.OutOfSequence.Get

Returns:

10 

Definition at line 21120 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::PacketCount.Valid.Get

Gets the received packet count for packets which were not corrupted.

Example

This example gets the valid packet counter

$outOfSequenceResult PacketCount.Valid.Get

Returns:

10 

Definition at line 21130 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Refresh

Refresh the results, get the new counters.

Example

$outOfSequenceResult Refresh

Definition at line 21157 of file api.tcl.

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

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

Note

This is not the same as Timestamp.Get

Example

$outOfSequenceResult Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 21147 of file api.tcl.

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

$outOfSequenceResult Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 21169 of file api.tcl.

Rx.OutOfSequence.Basic.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

$outOfSequenceResult Timestamp.Get

Returns:

1413475070000000000 

Definition at line 21179 of file api.tcl.

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

$outOfSequenceResult Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 21191 of file api.tcl.