byteblowerll.byteblower.StreamResultHistory

class byteblowerll.byteblower.StreamResultHistory(*args, **kwargs)

Sender-side transmit result history.

The history contains the sender information in time since the object is created or refreshed.

..note :: The information is not updated until Refresh() is called

A Stream history result object can be created via a Stream, using Stream.ResultHistoryGet()

Note

See History result for more information

New in version 2.1.0.

Example

Get the counters per sampling interval for the stream result history.

from byteblowerll.byteblower import ByteBlower
server = ByteBlower.ServerAdd('byteblower-1.lab.byteblower.com')
# TODO
__init__(*args, **kwargs)

Methods

Clear() Clear the history.
CumulativeGet() Returns a list of available cumulative counters.
CumulativeGetByIndex(index) Returns a single item of the cumulative list.
CumulativeGetByTime(timestamp) Returns a single item of the cumulative list using a timestamp.
CumulativeLatestGet() Returns latest closed item of the cumulative list.
CumulativeLengthGet() Returns the size of the cumulative list.
DescriptionGet(*args) Gets a textual description for the current object
IntervalGet() Returns a list of available interval results.
IntervalGetByIndex(index) Returns a single item of the interval list.
IntervalGetByTime(timestamp) Returns a single item of the interval list using a timestamp in nanoseconds.
IntervalLatestGet() Returns the latest closed item of the interval list.
IntervalLengthGet() Returns the size of the interval list.
ParentGet() Returns the parent object.
Refresh() Retrieves the latest data from the server for this object.
RefreshTimestampGet() Returns the timestamp on the server when the current history was refreshed.
SamplingBufferLengthGet() Number of samples to keep in the buffer.
SamplingBufferLengthSet(inLength) Sets the number of samples to keep in the buffer.
SamplingIntervalDurationGet() Duration of one sampling interval in nanoseconds.
SamplingIntervalDurationSet(inDuration) Sets the duration of one sampling interval.
__init__(*args, **kwargs)