bluesky_queueserver_api.system_info_monitor.SystemInfoMonitor_HTTP_Async
- class bluesky_queueserver_api.system_info_monitor.SystemInfoMonitor_HTTP_Async(*, parent, poll_period, max_msgs)[source]
Console Monitor API (HTTP). The class implements a monitor for console output published by RE Manager over HTTP. The asynchronous version of the class must be instantiated in the loop.
- Parameters:
- parent: class
Reference to the parent class (or any class). The class must expose the attribute
_clientthat references configuredhttpxclient.- poll_period: float
Period between consecutive retries to connect to the websocket at the server. The value is also used as a timeout for websocket receive operation. It may take longer to stop background thread if the value is too large.
- max_msgs: int
Maximum number of messages in the buffer. New messages are ignored if the buffer is full. This could happen only if console monitoring is enabled, but messages are not read from the buffer. Setting the value to 0 disables collection of messages in the buffer.
Methods
__init__(*, parent, poll_period, max_msgs)clear()Clear the message buffer.
disable()Disable monitoring of the system info.
disable_wait(*[, timeout])Disable monitoring and wait for completion.
enable()Enable monitoring of the system info.
next_msg([timeout])Returns the next message from the buffer.
Attributes
enabledIndicates if monitoring is enabled.