All Classes Namespaces Files Functions Pages
Layer5.Http.MultiResultHistory Class Reference

General interface for getting cumulative or interval results. More...

Methods

 Clear
 Clears the history. More...
 
 Cumulative.Get
 Returns a list of available cumulative results. More...
 
 Cumulative.GetByIndex index
 Returns a single item of the cumulative list. 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 index
 Returns a single item of the interval list. 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
 Updates the results with the results available on the server. More...
 

Class overview

General interface for getting cumulative or interval results.

Definition at line 14673 of file api.tcl.

Method documentation

Layer5.Http.MultiResultHistory::Clear

Clears the history.

Example
1 $resultHistory Clear
Example
1 $historyObject Sampling.BufferLength.Get

Returns:

6 

Definition at line 14687 of file api.tcl.

Layer5.Http.MultiResultHistory::Cumulative.Get

Returns a list of available cumulative results.

Returns
List of Layer5.Http.MultiResultData containing the Cumulative counters
Example

This example gets the available cumulative results

1 $historyObject Refresh
2  $historyObject Result.Cumulative.Get

[ <Layer5.Http.MultiResultData object> ... ]

Definition at line 14700 of file api.tcl.

Layer5.Http.MultiResultHistory::Cumulative.GetByIndex   index  

Returns a single item of the cumulative list.

Parameters
index
Returns
Layer5.Http.MultiResultData cumulative counter object at the specified index
Example

This example gets the available cumulative counters at index 1

1 $historyObject Cumulative.GetByIndex 1

<Layer5.Http.MultiResultData object>

Definition at line 14714 of file api.tcl.

Layer5.Http.MultiResultHistory::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
2  $historyObject Cumulative.GetByTime 123000000us
3  $historyObject Cumulative.GetByTime 123000000000ns
4  $historyObject Cumulative.GetByTime 123000000000

<Layer5.Http.MultiResultData object>

Definition at line 14727 of file api.tcl.

Layer5.Http.MultiResultHistory::Cumulative.Latest.Get

Returns latest closed item of the cumulative list.

Example

This example gets the available cumulative counters

1 $historyObject Cumulative.Latest.Get

<Layer5.Http.MultiResultData object>

Definition at line 14735 of file api.tcl.

Layer5.Http.MultiResultHistory::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 14747 of file api.tcl.

Layer5.Http.MultiResultHistory::Interval.Get

Returns a list of available interval results.

Returns
List of Layer5.Http.MultiResultData containing the Interval counters
Example

This example gets the available interval results

1 $historyObject Refresh
2  $historyObject Result.interval.Get

[ <Layer5.Http.MultiResultData object> ... ]

Definition at line 14765 of file api.tcl.

Layer5.Http.MultiResultHistory::Interval.GetByIndex   index  

Returns a single item of the interval list.

Parameters
index
Returns
Layer5.Http.MultiResultData interval counter object at the specified index
Example

This example gets the available interval counters at index 1

1 $historyObject Interval.GetByIndex 1

<Layer5.Http.MultiResultData object>

Definition at line 14779 of file api.tcl.

Layer5.Http.MultiResultHistory::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
2  $historyObject Interval.GetByTime 123000000us
3  $historyObject Interval.GetByTime 123000000000ns
4  $historyObject Interval.GetByTime 123000000000

<Layer5.Http.MultiResultData object>

Definition at line 14792 of file api.tcl.

Layer5.Http.MultiResultHistory::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

<Layer5.Http.MultiResultData object>

Definition at line 14802 of file api.tcl.

Layer5.Http.MultiResultHistory::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 14814 of file api.tcl.

Layer5.Http.MultiResultHistory::Refresh

Updates the results 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 14841 of file api.tcl.

Layer5.Http.MultiResultHistory::Refresh.Timestamp.Get

RefreshTimestampGet.

Returns
Example
1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 14831 of file api.tcl.