The latency distribution result. More...

Methods
	Bucket.Count.Get
	Returns the number of buckets in which the range is divided. More...

	Bucket.Width.Get
	Returns the width in nanoseconds of a bucket. More...

	ByteCount.Get
	Gets the current received bytes counter. More...

	Description.Get
	Returns a textual description of the object.

	Framesize.Maximum.Get
	Gets the largest frame size received in this snapshot. More...

	Framesize.Minimum.Get
	Gets the smallest frame size received in this snapshot. 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.AboveMaximum.Get
	Returns the number of packets arrived with a latency above the given range. More...

	PacketCount.BelowMinimum.Get
	Returns the number of packets arrived with a latency below the given range. 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.

	Range.Maximum.Get
	Returns the exclusive maximum of the range configured. More...

	Range.Minimum.Get
	Returns the inclusive minimum of the range configured. More...

	Refresh.Timestamp.Get
	Returns the timestamp when the counters of this object where last refreshed. More...

	Refresh
	Updates the counters with the latest data available from the ByteBlower server. 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

The latency distribution result.

Note: The information is not updated until Refresh is called; See What's new in API v2 for more information.

Example

 set port [ $server Port.Create "trunk-1-2"] 
  set latencyDist [ $port Rx.Latency.Distribution.Add ]  
  $latencyDist filter.set "ip src 10.1.1.1"

start the traffic

1 set distribution [ $latencyDist Result.Get ]

Returns:

<Rx.Latency.Distribution.ResultSnapshot object>

1 $distribution PacketCount.Get

Returns:

Definition at line 20049 of file api.tcl.

Method documentation

Rx.Latency.Distribution.ResultSnapshot::Bucket.Count.Get

Returns the number of buckets in which the range is divided.

Example

 $latency Range.Set 0 1 s 
  set result [ $latency Result.Get ] 
  $result Bucket.Count.Get

Returns:

Definition at line 20061 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::Bucket.Width.Get

Returns the width in nanoseconds of a bucket.

Example

 set latency [ $port Rx.Latency.Add "distribution" ] 
  $latency Range.Set 0 1s 
  set result [ $latency Result.Get ] 
  $result Bucket.Width.Get

Returns:

Definition at line 20074 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::ByteCount.Get

Gets the current received bytes counter.

Example

This example gets the received bytes counter

1 $triggerResult ByteCount.Get

Returns:

Definition at line 20084 of file api.tcl.

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

Gets the largest frame size received in this snapshot.

Exceptions

CounterUnavailable When no frames are received, this counter is unavailable

Example

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

1 $triggerResult Framesize.Maximum.Get

Returns:

Definition at line 20101 of file api.tcl.

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

Gets the smallest frame size received in this snapshot.

Exceptions

CounterUnavailable When no frames are received, this counter is unavailable

Example

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

1 $triggerResult Framesize.Minimum.Get

Returns:

Definition at line 20113 of file api.tcl.

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

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

Definition at line 20133 of file api.tcl.

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

Definition at line 20143 of file api.tcl.

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

Definition at line 20153 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::PacketCount.AboveMaximum.Get

Returns the number of packets arrived with a latency above the given range.

Example

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

Returns:

Definition at line 20165 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::PacketCount.BelowMinimum.Get

Returns the number of packets arrived with a latency below the given range.

Example

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

Returns:

Definition at line 20177 of file api.tcl.

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

Rx.Latency.Distribution.ResultSnapshot::PacketCount.Get

Gets the received packet count.

Example

This example gets the received packet counter

1 $triggerResult PacketCount.Get

Returns:

Definition at line 20199 of file api.tcl.

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

Gets the received packet count of invalid packets.

Example

This example gets the received invalid packet counter

1 $triggerResult PacketCount.Invalid.Get

Returns:

Definition at line 20209 of file api.tcl.

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

Gets the received packet count of valid packets.

Example

This example gets the received valid packet counter

1 $triggerResult PacketCount.Valid.Get

Returns:

Definition at line 20219 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::Range.Maximum.Get

Returns the exclusive maximum of the range configured.

Returns: The lower bound of the configured range on the Rx.Latency.Distribution object.

Example

1 $latencyResult Range.Maximum.Get

Returns:

1000000000

Definition at line 20232 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::Range.Minimum.Get

Returns the inclusive minimum of the range configured.

Returns: The lower bound of the configured range on the Rx.Latency.Distribution object.

Example

1 $latencyResult Range.Minimum.Get

Returns:

Definition at line 20242 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::Refresh

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

Example

1 $result Refresh

Definition at line 20264 of file api.tcl.

Rx.Latency.Distribution.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

1 $result Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 20254 of file api.tcl.

Rx.Latency.Distribution.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

1 $triggerResult Timestamp.First.Get

Returns:

1413475037767331530

Definition at line 20276 of file api.tcl.

Rx.Latency.Distribution.ResultSnapshot::Timestamp.Get

Gets the snapshot timestamp [NS].

Example

This example gets the snapshot timestamp [NS].

1 $triggerResult Timestamp.Get

Returns:

1413475070000000000

Definition at line 20286 of file api.tcl.

Rx.Latency.Distribution.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

1 $triggerResult Timestamp.Last.Get

Returns:

1413475071947640170

Definition at line 20298 of file api.tcl.

Methods

Class overview

Method documentation