All Classes Namespaces Files Functions Pages
Tx.Frame.ResultHistory Class Reference

Sender-side frame transmission result history. More...

Methods

 Clear
 Removes the locally stored history snapshots. More...
 
 Cumulative.Get
 Returns a list of available accumulated results. More...
 
 Cumulative.GetByIndex
 Returns a list of available cumulative counters. More...
 
 Cumulative.GetByTime
 Returns a single item of the cumulative list using a timestamp nanoseconds. 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
 Returns a list of available interval counters. More...
 
 Interval.GetByTime
 Returns a single item of the interval list using a timestamp in nanoseconds. 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
 RefreshTimestampGet. More...
 
 Refresh
 Synchronizes the results available with the results available on the server. More...
 
 Sampling.BufferLength.Get
 Returns the number of the snapshots to keep in the history. More...
 
 Sampling.BufferLength.Set
 Sets the number of samples to keep in the buffer. More...
 
 Sampling.Interval.Duration.Get
 Returns the duration of the interval used for the history snapshots. More...
 
 Sampling.Interval.Duration.Set
 Sets the duration of one sampling interval. More...
 

Class overview

Sender-side frame transmission result history.

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

Note
The information is not updated until Refresh is called

A Frame history result object can be created via a Frame, using Frame::Result.History.Get

Note
See History result for more information
Since
2.1.0
Example

Get the counters per sampling interval for the frame result history.

1 set stream [ $port Tx.Stream.Get ]
2  set frame [ lindex [ $stream Frame.Get ] 0 ]
3  set history [ $frame Result.History.Get ]
4  $history Result.Interval.Get
5  $history Refresh
6  $history Result.Interval.Get

Definition at line 22520 of file api.tcl.

Method documentation

Tx.Frame.ResultHistory::Clear

Removes the locally stored history snapshots.

This can be used to save memory in long tests where the results are requested at regular intervals.

WARNING: Any interval or cumulative result object returned from this history object before calling Clear will be destoyed and thus become unusable.

Definition at line 22530 of file api.tcl.

Tx.Frame.ResultHistory::Cumulative.Get

Returns a list of available accumulated results.

Returns
List of Tx.Frame.ResultData containing the Cumulative counters
Example

This example gets the available accumulated results

1 $historyObject Cumulative.Get

[ <Tx.Frame.ResultData object> ... ]

Definition at line 22542 of file api.tcl.

Tx.Frame.ResultHistory::Cumulative.GetByIndex

Returns a list of available cumulative counters.

Example

This example gets the available cumulative counters

1 $historyObject Cumulative.GetByIndex 1

<Tx.Frame.ResultData object>

Definition at line 22552 of file api.tcl.

Tx.Frame.ResultHistory::Cumulative.GetByTime

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

Example

This example gets the available cumulative counters

1 $historyObject Cumulative.GetByTime 123s $historyObject Cumulative.GetByTime 123000000us $historyObject Cumulative.GetByTime 123000000000ns $historyObject Cumulative.GetByTime 123000000000

<Tx.Frame.ResultData object>

Definition at line 22562 of file api.tcl.

Tx.Frame.ResultHistory::Cumulative.Latest.Get

Returns latest closed item of the cumulative list.

Example

This example gets the available cumulative counters

1 $historyObject Cumulative.Latest.Get

<Tx.Frame.ResultData object>

Definition at line 22572 of file api.tcl.

Tx.Frame.ResultHistory::Cumulative.Length.Get

Returns the size of the cumulative list.

Returns
The length of the cumulative list
Example
1 $historyObject Cumulative.Length.Get

{32}

Definition at line 22584 of file api.tcl.

Tx.Frame.ResultHistory::Interval.Get

Returns a list of available interval results.

Returns
List of Tx.Frame.ResultData containing the Interval counters
Example

This example gets the available interval results

1 $historyObject Interval.Get

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

Definition at line 22601 of file api.tcl.

Tx.Frame.ResultHistory::Interval.GetByIndex

Returns a list of available interval counters.

Example

This example gets the available interval counters

1 $historyObject Interval.GetByIndex 1

<Tx.Frame.ResultData object>

Definition at line 22611 of file api.tcl.

Tx.Frame.ResultHistory::Interval.GetByTime

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

Example

This example gets the available interval counters

1 $historyObject Interval.GetByTime 123s $historyObject Interval.GetByTime 123000000us $historyObject Interval.GetByTime 123000000000ns $historyObject Interval.GetByTime 123000000000

<Tx.Frame.ResultData object>

Definition at line 22621 of file api.tcl.

Tx.Frame.ResultHistory::Interval.Latest.Get

Returns the latest closed item of the interval list.

Example

This example gets the available interval counters

1 $historyObject Interval.Latest.Get

<Tx.Frame.ResultData object>

Definition at line 22631 of file api.tcl.

Tx.Frame.ResultHistory::Interval.Length.Get

Returns the size of the interval list.

Returns
The length of the interval list
Example
1 $historyObject Interval.Length.Get

{32}

Definition at line 22643 of file api.tcl.

Tx.Frame.ResultHistory::Refresh

Synchronizes the results available with the results available on the server.

Example

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

1 $historyObject Refresh

Definition at line 22670 of file api.tcl.

Tx.Frame.ResultHistory::Refresh.Timestamp.Get

RefreshTimestampGet.

Returns
Example
1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398057591348 

Definition at line 22660 of file api.tcl.

Tx.Frame.ResultHistory::Sampling.BufferLength.Get

Returns the number of the snapshots to keep in the history.

Returns
number of snapshots to keep in the history
Example
1 $historyObject Sampling.BufferLength.Get

6

Definition at line 22682 of file api.tcl.

Tx.Frame.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 22696 of file api.tcl.

Tx.Frame.ResultHistory::Sampling.Interval.Duration.Get

Returns the duration of the interval used for the history snapshots.

The returned duration is in nanoseconds

Returns
interval in nanoseconds used by the server
Example
1 $historyObject Sampling.Interval.Duration.Get

1000000000

Definition at line 22710 of file api.tcl.

Tx.Frame.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 22726 of file api.tcl.