Layer4.Tcp.ResultHistory Class Reference

Interface that allows you to obtain the cumulative and interval result data objects regarding TCP stats. More...

Methods
	Clear
	Clears the history. More...
	Cumulative.Get
	Returns a list of recent TCP result objects containing cumulative counters. More...
	Cumulative.GetByIndex index
	Returns a list of recent TCP result objects containing 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 a list of recent TCP result objects containing cumulative counters. More...
	Description.Get
	Returns a textual description of the object.
	Interval.Get
	Returns a list of recent TCP result objects containing interval counters. More...
	Interval.GetByIndex index
	Returns a list of recent TCP result objects containing 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 a list of recent TCP result objects containing interval counters. More...
	Parent.Get
	Returns the parent object.
	Refresh.Timestamp.Get
	Returns the timestamp on the server when the current history is requested. 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 at server-side. 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

Interface that allows you to obtain the cumulative and interval result data objects regarding TCP stats.

At fixed time intervals, ByteBlower takes Interval and Cumulative stats of the TCP session. Only a fixed number of stats ( use Sampling.BufferLength.Get to know how many ) are kept in memory at the ByteBlower server. Using the Refresh method those stats are transfered to the client pc where they are stored until you clear them ( Clear ).

The interval duration of such a historyObject can be obtained using Sampling.Interval.Duration.Get

Definition at line 9628 of file api.tcl.

Method documentation

Layer4.Tcp.ResultHistory::Clear

Clears 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

$resultHistory Clear

Definition at line 9640 of file api.tcl.

Layer4.Tcp.ResultHistory::Cumulative.Get

Returns a list of recent TCP result objects containing 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 Layer4.Tcp.ResultData containing the Cumulative counters

Example

$tcpResultHistory Refresh

$tcpResultHistory Cumulative.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9654 of file api.tcl.

Layer4.Tcp.ResultHistory::Cumulative.GetByIndex			index

Returns a list of recent TCP result objects containing 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.

Parameters

index

Returns

Layer4.Tcp.ResultData

Example

$tcpResultHistory Refresh

$tcpResultHistory Cumulative.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9670 of file api.tcl.

Layer4.Tcp.ResultHistory::Cumulative.GetByTime

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

Returns

Layer4.Tcp.ResultData

Since

API 2.2.0

Example

This example gets the available cumulative counters

$historyObject Cumulative.GetByTime 123000000000

<Layer4.Tcp.ResultData object>

Example

This example gets the available cumulative counters

$historyObject Cumulative.GetByTime 123s

<Layer4.Tcp.ResultData object>

Definition at line 9688 of file api.tcl.

Layer4.Tcp.ResultHistory::Cumulative.Latest.Get

Returns latest closed item of the cumulative list.

Returns

Layer4.Tcp.ResultData

Since

API 2.2.0

Example

This example gets the available cumulative counters

$historyObject Cumulative.Latest.Get

<Layer4.Tcp.ResultData object>

Definition at line 9702 of file api.tcl.

Layer4.Tcp.ResultHistory::Cumulative.Length.Get

Returns a list of recent TCP result objects containing 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

The length of the cumulative list

Example

$tcpResultHistory Refresh

$tcpResultHistory Cumulative.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9716 of file api.tcl.

Layer4.Tcp.ResultHistory::Interval.Get

Returns a list of recent TCP result objects containing interval counters.

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

Returns

List of Layer4.Tcp.ResultData containing the Interval counters

Example

$tcpResultHistory Refresh

$tcpResultHistory Interval.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9735 of file api.tcl.

Layer4.Tcp.ResultHistory::Interval.GetByIndex			index

Returns a list of recent TCP result objects containing interval counters.

Each result object contains the counters only for a specific time interval. The duration of the interval can be obtained using Sampling.Interval.Duration.Get.

Returns

Layer4.Tcp.ResultData

Parameters

index

Example

$tcpResultHistory Refresh

$tcpResultHistory Interval.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9751 of file api.tcl.

Layer4.Tcp.ResultHistory::Interval.GetByTime

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

Returns

Layer4.Tcp.ResultData

Since

API 2.2.0

Example

This example gets the available interval counters

$historyObject Interval.GetByTime 123000000000

<Layer4.Tcp.ResultData object>

Example

This example gets the available interval counters

$historyObject Interval.GetByTime 123000000us

<Layer4.Tcp.ResultData object>

Definition at line 9769 of file api.tcl.

Layer4.Tcp.ResultHistory::Interval.Latest.Get

Returns the latest closed item of the interval list.

Returns

Layer4.Tcp.ResultData

Since

API 2.2.0

Example

This example gets the available interval counters

$historyObject Interval.Latest.Get

<Layer4.Tcp.ResultData object>

Definition at line 9783 of file api.tcl.

Layer4.Tcp.ResultHistory::Interval.Length.Get

Returns a list of recent TCP result objects containing interval counters.

Each result object contains the counters only for a specific time interval. The duration of the interval can be obtained using Sampling.Interval.Duration.Get.

Returns

The length of the Interval list

Example

$tcpResultHistory Refresh

$tcpResultHistory Interval.Get

Returns:

<Layer4.Tcp.ResultData object> 

Definition at line 9797 of file api.tcl.

Layer4.Tcp.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

$historyObject Refresh

Definition at line 9828 of file api.tcl.

Layer4.Tcp.ResultHistory::Refresh.Timestamp.Get

Returns the timestamp on the server when the current history is requested.

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

Returns

Timestamp in nanoseconds since epoch

Example

$historyObject Refresh.Timestamp.Get

Returns:

1432805398376482498 

Definition at line 9816 of file api.tcl.

Layer4.Tcp.ResultHistory::Sampling.BufferLength.Get

Number of samples to keep in the buffer at server-side.

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

$historyObject Sampling.BufferLength.Get

Returns:

6 

Definition at line 9842 of file api.tcl.

Layer4.Tcp.ResultHistory::Sampling.BufferLength.Set

Sets the number of samples to keep in the buffer.

Since

2.3.0

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.

Example

$historyObject Sampling.BufferLength.Set 6

Definition at line 9856 of file api.tcl.

Layer4.Tcp.ResultHistory::Sampling.Interval.Duration.Get

Duration of one sampling interval in nanoseconds..

Returns

Duration in nanoseconds

Example

$tcpResultHistory Sampling.Interval.Duration.Get

Returns:

1000000000 

Definition at line 9868 of file api.tcl.

Layer4.Tcp.ResultHistory::Sampling.Interval.Duration.Set

Sets the duration of one sampling interval.

Since

2.3.0

Warning

The previously collected history will be invalidated.

Example

$historyObject Sampling.Interval.Duration.Set 1000000000

Example

$historyObject Sampling.Interval.Duration.Set 1s

Definition at line 9884 of file api.tcl.