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

Method documentation

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

Gets the number of received bytes.

Example

$result ByteCount.Get

Returns:

100 

Definition at line 22329 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.

$result Framesize.Max.Get

Returns:

1024 

Definition at line 22348 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.

$result Framesize.Maximum.Get

Returns:

1024 

Definition at line 22362 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.

$result Framesize.Min.Get

Returns:

60 

Definition at line 22376 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.

$result Framesize.Minimum.Get

Returns:

60 

Definition at line 22390 of file api.tcl.

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

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

Example

$result PacketCount.AboveMaximum.Get

Returns:

100 

Definition at line 22400 of file api.tcl.

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

Gets number of received packets that are too small.

Example

$result PacketCount.BelowMinimum.Get

Returns:

100 

Definition at line 22410 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

$result PacketCount.Get

Returns:

100 

Example

$result PacketCount.Get 60

We received 10 frames of size 60 Returns:

10 

Definition at line 22424 of file api.tcl.

Rx.Trigger.SizeDistribution.ResultSnapshot::Refresh

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

Example

$result Refresh

Definition at line 22444 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

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

$result Timestamp.First.Get

Returns:

1413475037767331530 

Definition at line 22456 of file api.tcl.

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

Gets the snapshot timestamp [NS].

Example

$result Timestamp.Get

Returns:

1432050751000000000 

Definition at line 22466 of file api.tcl.

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

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

Exceptions

CounterUnavailable

When no frames are received, this counter is unavailable

Example

$result Timestamp.Last.Get

Returns:

1413475071947640170 

Definition at line 22478 of file api.tcl.