Sender-side transmit 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 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 | |
| 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... | |
Sender-side transmit result history.
The history contains the sender information in time since the object is created or refreshed.
A Tx.Stream history result object can be created via a Tx.Stream, using Tx.Stream::Result.History.Get
Get the counters per sampling interval for the stream result history.
| Tx.Stream.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.
Clear the History.
| Tx.Stream.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.
This example gets the available accumulated results
Returns:
[ <Tx.Stream.ResultData object> ... ]
| Tx.Stream.ResultHistory::Cumulative.GetByIndex | index | ||
Returns a single item of the cumulative list.
| index |
This example gets the available cumulative counters at index 1
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Cumulative.GetByTime | timestamp | ||
Returns a single item of the cumulative list using a timestamp.
| timestamp | in nanoseconds |
This example gets the cumulative counter at timestamp 1432805398000000000 ns
Returns:
<Tx.Stream.ResultData object>
This example gets the cumulative counter at timestamp 1432805398 seconds
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Cumulative.Latest.Get |
Returns latest closed item of the cumulative list.
This example gets the latest closed Cumulative counter object
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Cumulative.Length.Get |
| Tx.Stream.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.
This example gets the available interval results
Returns:
[ <Tx.Stream.ResultData object> ... ]
| Tx.Stream.ResultHistory::Interval.GetByIndex | index | ||
Returns a single item of the interval list.
| index |
This example gets the available interval counters at index 1
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Interval.GetByTime | timestamp | ||
Returns a single item of the interval list using a timestamp in nanoseconds.
| timestamp | in nanoseconds |
This example gets the Interval counters at timestamp 1432805398000000000 ns
Returns:
<Tx.Stream.ResultData object>
This example gets the cumulative counter at timestamp 1432805398 seconds
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Interval.Latest.Get |
Returns the latest closed item of the interval list.
This example gets the latest closed Interval counter object
Returns:
<Tx.Stream.ResultData object>
| Tx.Stream.ResultHistory::Interval.Length.Get |
| Tx.Stream.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.
This example refreshes the history results with the results available on the server
| Tx.Stream.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.
This example gets the Refresh timestamp
Returns:
1432805398000000000
| Tx.Stream.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:
6
| Tx.Stream.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.
| Tx.Stream.ResultHistory::Sampling.Interval.Duration.Get |
| Tx.Stream.ResultHistory::Sampling.Interval.Duration.Set |
