All Classes Namespaces Files Functions Pages
Rx.Trigger.SizeDistribution.ResultSnapshot Class Reference

Contains the results for the size distribution. More...

Methods

 ByteCount.Get
 Gets the number of received bytes. 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...
 
 PacketCount.AboveMaximum.Get
 Gets number of received packets in this snapshot that are too big. More...
 
 PacketCount.BelowMinimum.Get
 Gets number of received packets that are too small. More...
 
 PacketCount.Get
 Gets the number received packets. Or if provided with a size, the number of packets received of that size. More...
 
 Parent.Get
 Returns the parent object.
 
 Refresh.Timestamp.Get
 
 Refresh
 Updates the counters with the latest data available from the ByteBlower server. More...
 
 Timestamp.First.Get
 Gets the timestamp [NS] of the first received packet. More...
 
 Timestamp.Get
 Gets the snapshot timestamp [NS]. More...
 
 Timestamp.Last.Get
 Gets the current timestamp [NS] of the last received packet. More...
 

Class overview

Contains the results for the size distribution.

Definition at line 21639 of file api.tcl.

Method documentation

Rx.Trigger.SizeDistribution.ResultSnapshot::ByteCount.Get

Gets the number of received bytes.

Example
1 $result ByteCount.Get

Returns:

100 

Definition at line 21649 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Framesize.Max.Get

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

Returns
Largest received frame size in bytes of this snapshot
Deprecated:
since 2.5.0, please use Framesize.Maximum.Get instead
Example

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

1 $result Framesize.Max.Get

Returns:

1024 

Definition at line 21668 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Framesize.Maximum.Get

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

Returns
Largest received frame size in bytes of this snapshot
Since
2.5.0
Example

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

1 $result Framesize.Maximum.Get

Returns:

1024 

Definition at line 21682 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Framesize.Min.Get

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

Returns
Smallest received frame size in bytes of this snapshot
Deprecated:
since 2.5.0, please use Framesize.Minimum.Get instead
Example

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

1 $result Framesize.Min.Get

Returns:

60 

Definition at line 21696 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Framesize.Minimum.Get

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

Returns
Smallest received frame size in bytes of this snapshot
Since
2.5.0
Example

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

1 $result Framesize.Minimum.Get

Returns:

60 

Definition at line 21710 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::PacketCount.AboveMaximum.Get

Gets number of received packets in this snapshot that are too big.

Example
1 $result PacketCount.AboveMaximum.Get

Returns:

100 

Definition at line 21720 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::PacketCount.BelowMinimum.Get

Gets number of received packets that are too small.

Example
1 $result PacketCount.BelowMinimum.Get

Returns:

100 

Definition at line 21730 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::PacketCount.Get

Gets the number received packets. Or if provided with a size, the number of packets received of that size.

Example
1 $result PacketCount.Get

Returns:

100 
Example
1 $result PacketCount.Get 60

We received 10 frames of size 60 Returns:

10 

Definition at line 21744 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Refresh

Updates the counters with the latest data available from the ByteBlower server.

Example
1 $result Refresh

Definition at line 21764 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Timestamp.First.Get

Gets the timestamp [NS] of the first received packet.

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Example

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

1 $result Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 21776 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example
1 $result Timestamp.Get

Returns:

1432050751000000000 

Definition at line 21786 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Timestamp.Last.Get

Gets the current timestamp [NS] of the last received packet.

Exceptions
CounterUnavailableWhen no frames are received, this counter is unavailable
Example
1 $result Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 21798 of file api.tcl.