All Classes Namespaces Files Functions Pages
Layer5.Http.ResultHistory 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...
 
 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

General interface for getting cumulative or interval results.

Definition at line 15759 of file api.tcl.

Method documentation

Layer5.Http.ResultHistory::Clear

Clears the history.

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

Returns:

6 

Definition at line 15773 of file api.tcl.

Layer5.Http.ResultHistory::Cumulative.Get

Returns a list of available cumulative results.

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

This example gets the available cumulative results

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

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

Definition at line 15786 of file api.tcl.

Layer5.Http.ResultHistory::Cumulative.GetByIndex   index  

Returns a single item of the cumulative list.

Parameters
index
Returns
Layer5.Http.ResultData 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.ResultData object>

Definition at line 15800 of file api.tcl.

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

<Layer5.Http.ResultData object>

Definition at line 15813 of file api.tcl.

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

<Layer5.Http.ResultData object>

Definition at line 15821 of file api.tcl.

Layer5.Http.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 15833 of file api.tcl.

Layer5.Http.ResultHistory::Interval.Get

Returns a list of available interval results.

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

This example gets the available interval results

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

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

Definition at line 15851 of file api.tcl.

Layer5.Http.ResultHistory::Interval.GetByIndex   index  

Returns a single item of the interval list.

Parameters
index
Returns
Layer5.Http.ResultData 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.ResultData object>

Definition at line 15865 of file api.tcl.

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

<Layer5.Http.ResultData object>

Definition at line 15878 of file api.tcl.

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

<Layer5.Http.ResultData object>

Definition at line 15888 of file api.tcl.

Layer5.Http.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 15900 of file api.tcl.

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

Layer5.Http.ResultHistory::Refresh.Timestamp.Get

RefreshTimestampGet.

Returns
Example
1 $historyObject Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 15917 of file api.tcl.

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

Definition at line 15937 of file api.tcl.

Layer5.Http.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 15951 of file api.tcl.

Layer5.Http.ResultHistory::Sampling.Interval.Duration.Get

Duration of one sampling interval in nanoseconds.

Example
1 $httpResultHistory Interval.Duration.Get

Returns:

1000000000 

Definition at line 15961 of file api.tcl.

Layer5.Http.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 15977 of file api.tcl.