Receive-side latency result history. More...

Methods
	Clear
	Clear the history. More...

	Cumulative.Get
	Returns a list of available cumulative counters. More...

	Cumulative.GetByIndex index
	Returns a single item of the cumulative list. More...

	Cumulative.GetByTime timestamp
	Returns a single item of the cumulative list using a timestamp. More...

	Cumulative.Latest.Get
	Returns latest closed item of the cumulative list. More...

	Cumulative.Length.Get
	Returns the size of the cumulative list. More...

	Description.Get
	Returns a textual description of the object.

	Interval.Get
	Returns a list of available interval results. More...

	Interval.GetByIndex index
	Returns a single item of the interval list. More...

	Interval.GetByTime timestamp
	Returns a single item of the interval list using a timestamp. More...

	Interval.Latest.Get
	Returns the latest closed item of the interval list. More...

	Interval.Length.Get
	Returns the size of the interval list. More...

	Parent.Get
	Returns the parent object.

	Refresh.Timestamp.Get
	Returns the timestamp on the server when the current history was refreshed. More...

	Refresh
	Updates the Interval and Cumulative results with the results available on the server. More...

	Sampling.BufferLength.Get
	Number of samples to keep in the buffer. More...

	Sampling.BufferLength.Set
	Sets the number of samples to keep in the buffer. More...

	Sampling.Interval.Duration.Get
	Duration of one sampling interval in nanoseconds. More...

	Sampling.Interval.Duration.Set
	Sets the duration of one sampling interval. More...

Class overview

Receive-side latency result history.

The history contains the latency information in time since the object is created or refreshed.

Note: The information is not updated until Refresh is called; See History result for more information

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

Since: 2.1.0

Example

Receive all frames on "trunk-1-2" of some server

 set port [ $server Port.Create "trunk-1-2" ] 
  $latency Filter.Set "udp port 67" 
  set history [ $latency Result.History.Get ]  
  $history Result.Interval.Get  
  $history Refresh  
  $history Result.Interval.Get

Definition at line 18924 of file api.tcl.

Method documentation

Rx.Latency.Basic.ResultHistory::Clear

Clear the history.

With each Refresh interval and cumulative counters are transfert from Server to the Client. To remove all counter-objects in this history, you can execute this method. Both Interval and Cumulative counter lists will be cleared.

Example

Clear the History.

1 $historyObject Clear

Definition at line 18936 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Cumulative.Get

Returns a list of available cumulative counters.

Each result object contains cumulative counters at a certain point in time. Snapshots are taken at fixed time intervals. The interval duration can be obtained using Sampling.Interval.Duration.Get.

Returns: List of Rx.Latency.Basic.ResultData containing the Cumulative counters

Example

This example gets the available cumulative results

1 $historyObject Cumulative.Get

Returns:

[ <Rx.Latency.Basic.ResultData object> ... ]

Definition at line 18950 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Cumulative.GetByIndex			index

Returns a single item of the cumulative list.

Parameters

index

Returns: Rx.Latency.Basic.ResultData cumulative counter object at the specified index

Example

This example gets the available cumulative counters at index 1

1 $historyObject Cumulative.GetByIndex 1

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 18964 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Cumulative.GetByTime			timestamp

Returns a single item of the cumulative list using a timestamp.

Parameters

timestamp in nanoseconds

Returns: Rx.Latency.Basic.ResultData

Since: API 2.2.0

Example

This example gets the cumulative counter at timestamp 1432805398000000000 ns

1 $historyObject Cumulative.GetByTime 1432805398000000000

Returns:

<Rx.Latency.Basic.ResultData object>

Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 18984 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Cumulative.Latest.Get

Returns latest closed item of the cumulative list.

Returns: Rx.Latency.Basic.ResultData

Since: API 2.2.0

Example

This example gets the latest closed Cumulative counter object

1 $historyObject Cumulative.Latest.Get

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 18998 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Cumulative.Length.Get

Returns the size of the cumulative list.

Returns: The length of the cumulative list

Example

1 $historyObject Cumulative.Length.Get

Returns:

Definition at line 19010 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Interval.Get

Returns a list of available interval results.

Each result object contains interval counters at a certain point in time. Snapshots are taken at fixed time intervals. The interval duration can be obtained using Sampling.Interval.Duration.Get.

Returns: List of Rx.Latency.Basic.ResultData containing the Interval counters

Example

This example gets the available interval results

1 $historyObject Interval.List.Get

Returns:

[ <Rx.Latency.Basic.ResultData object> ... ]

Definition at line 19029 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Interval.GetByIndex			index

Returns a single item of the interval list.

Parameters

index

Returns: Rx.Latency.Basic.ResultData interval counter object at the specified index

Example

This example gets the available interval counters at index 1

1 $historyObject Interval.GetByIndex 1

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 19043 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Interval.GetByTime			timestamp

Returns a single item of the interval list using a timestamp.

Parameters

timestamp in nanoseconds

Returns: Rx.Latency.Basic.ResultData

Since: API 2.2.0

Example

This example gets the Interval counters at timestamp 1432805398000000000 ns

1 $historyObject Cumulative.GetByTime 1432805398000000000

Returns:

<Rx.Latency.Basic.ResultData object>

Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 19063 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Interval.Latest.Get

Returns the latest closed item of the interval list.

Returns: Rx.Trigger.Basic.ResultData

Since: API 2.2.0

Example

This example gets the latest closed Interval counter object

1 $historyObject Interval.Latest.Get

Returns:

<Rx.Latency.Basic.ResultData object>

Definition at line 19077 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Interval.Length.Get

Returns the size of the interval list.

Returns: The length of the interval list

Example

1 $historyObject Interval.Length.Get

Returns:

Definition at line 19089 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Refresh

Updates the Interval and Cumulative results with the results available on the server.

The ByteBlower server has a buffer to keep some samples. This method transfers those samples to the client. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed. The size of the server-side buffer can be obtained using Sampling.BufferLength.Get.

Example

This example refreshes the history results with the results available on the server

1 $historyObject Refresh

Definition at line 19120 of file api.tcl.

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

Returns the timestamp on the server when the current history was refreshed.

This is the timestamp on the server when the last Refresh was called.

Returns: Timestamp in nanoseconds since epoch

Example

This example gets the Refresh timestamp

1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398000000000

Definition at line 19108 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Sampling.BufferLength.Get

Number of samples to keep in the buffer.

The ByteBlower server has a buffer to keep some samples before they are transferred to the client. This method gets the maximum number of samples the server can hold. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed.

Returns: The length of the server sample buffer

Example

1 $historyObject Sampling.BufferLength.Get

Returns:

Definition at line 19134 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Sampling.BufferLength.Set

Sets the number of samples to keep in the buffer.

The ByteBlower server has a buffer to keep some samples before they are transferred to the client. This method sets the maximum number of samples the server can hold. The last sample will always be the running sample. When a sample is closed, the oldest sample in the buffer will be removed.

Since: 2.3.0

Example

1 $historyObject Sampling.BufferLength.Set 6

Definition at line 19148 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Sampling.Interval.Duration.Get

Duration of one sampling interval in nanoseconds.

Returns: Duration in nanoseconds

Example

1 $historyObject Sampling.Interval.Duration.Get

Returns:

1000000000

Definition at line 19160 of file api.tcl.

Rx.Latency.Basic.ResultHistory::Sampling.Interval.Duration.Set

Sets the duration of one sampling interval.

Note: WARNING: The previously collected history will be invalidated.

Since: 2.3.0

Example

1 $historyObject Sampling.Interval.Duration.Set 1000000000

Example

1 $historyObject Sampling.Interval.Duration.Set 1s

Definition at line 19176 of file api.tcl.

Methods

Class overview

Method documentation