byteblowerll.byteblower.StreamRuntimeStatus

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

Status information about a Stream

A stream has some runtime status information:

Is the stream running (StatusGet())?

If not, was there an error (ErrorStatusGet())?

If so, where did the error came from (ErrorSourceGet())?

Example

# stream is configured to transmit for 1 second

status = stream.StatusGet()
print('Stream stopped?', status.StatusGet() == TransmitStatus.INACTIVE)

stream.Start()

status.Refresh()
print('Stream started?', status.StatusGet() == TransmitStatus.ACTIVE)   

time.sleep(1)

status.Refresh()
print('Stream stopped?', status.StatusGet() == TransmitStatus.INACTIVE)   
__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

DescriptionGet(*args) Gets a textual description for the current object
ErrorSourceGet() Returns error source information.
ErrorStatusGet() Returns error information.
ParentGet() Returns the parent object.
Refresh() Retrieves the latest data from the server for this object.
RefreshTimestampGet() Returns the timestamp when the information was last queried on the server.
StatusGet() Returns the stream status.
__init__(*args, **kwargs) Initialize self.

Attributes

thisown The membership flag
transmit_error_source_INTERFACE_HARDWARE
transmit_error_source_NONE
transmit_error_source_SCHEDULING_CONFLICT
transmit_error_source_TXUSER
transmit_error_source_UNKNOWN
transmit_error_status_NONE
transmit_error_status_OUT_OF_RESOURCES
transmit_error_status_UNKNOWN
transmit_status_ACTIVE
transmit_status_INACTIVE
transmit_status_UNKNOWN