All Classes Namespaces Files Functions Pages
Rx.Trigger.Basic.ResultHistory Class Reference

Receive-side trigger 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 trigger result history.

The history contains the trigger 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 trigger history result object can be created via a Rx.Trigger.Basic, using Rx.Trigger.Basic::Result.History.Get

Since
2.1.0
Example

Receive all frames on "trunk-1-2" of some server, matching UDP source or destination port 67.

1 set port [ $server Port.Create "trunk-1-2" ]
2  set trigger [ $port Rx.Trigger.Basic.Add ]
3  $trigger Filter.Set "udp port 67"
4  set history [ $trigger Result.History.Get ]
5  $history Result.Interval.Get
6  $history Refresh
7  $history Result.Interval.Get

Definition at line 21063 of file api.tcl.

Method documentation

Rx.Trigger.Basic.ResultHistory::Clear

Clear the history.

With each Refresh interval and cumulative counters are transferred 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 21075 of file api.tcl.

Rx.Trigger.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.Trigger.Basic.ResultData containing the Cumulative counters
Example

This example gets the available cumulative results

1 $historyObject Cumulative.Get

Returns:

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

Definition at line 21089 of file api.tcl.

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

Returns a single item of the cumulative list.

Parameters
index
Returns
Rx.Trigger.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.Trigger.Basic.ResultData object> 

Definition at line 21103 of file api.tcl.

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

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

Parameters
timestampin nanoseconds
Returns
Rx.Trigger.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.Trigger.Basic.ResultData object> 
Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Trigger.Basic.ResultData object> 

Definition at line 21123 of file api.tcl.

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

Returns latest closed item of the cumulative list.

Returns
Rx.Trigger.Basic.ResultData
Since
API 2.2.0
Example

This example gets the latest closed Cumulative counter object

1 $historyObject Cumulative.Latest.Get

Returns:

<Rx.Trigger.Basic.ResultData object> 

Definition at line 21137 of file api.tcl.

Rx.Trigger.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:

32 

Definition at line 21149 of file api.tcl.

Rx.Trigger.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.Trigger.Basic.ResultData containing the Interval counters
Example

This example gets the available interval results

1 $historyObject Interval.Get

Returns:

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

Definition at line 21168 of file api.tcl.

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

Returns a single item of the interval list.

Parameters
index
Returns
Rx.Trigger.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.Trigger.Basic.ResultData object> 

Definition at line 21182 of file api.tcl.

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

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

Parameters
timestampin nanoseconds
Returns
Rx.Trigger.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.Trigger.Basic.ResultData object> 
Example

This example gets the cumulative counter at timestamp 1432805398 seconds

1 $historyObject Cumulative.GetByTime 1432805398s

Returns:

<Rx.Trigger.Basic.ResultData object> 

Definition at line 21202 of file api.tcl.

Rx.Trigger.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.Trigger.Basic.ResultData object> 

Definition at line 21216 of file api.tcl.

Rx.Trigger.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:

32 

Definition at line 21228 of file api.tcl.

Rx.Trigger.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 21259 of file api.tcl.

Rx.Trigger.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:

1432805398684381498 

Definition at line 21247 of file api.tcl.

Rx.Trigger.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:

6 

Definition at line 21273 of file api.tcl.

Rx.Trigger.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 21287 of file api.tcl.

Rx.Trigger.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 21299 of file api.tcl.

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

Sets the duration of one sampling interval.

Since
2.3.0
Example
1 $historyObject Sampling.Interval.Duration.Set 1000000000
Example
1 $historyObject Sampling.Interval.Duration.Set 1s

Definition at line 21313 of file api.tcl.