bluesky_queueserver_api.console_monitor.ConsoleMonitor_HTTP_Async¶

class bluesky_queueserver_api.console_monitor.ConsoleMonitor_HTTP_Async(*, parent, poll_period, max_msgs, max_lines)[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 _client that references configured httpx client.
poll_period: float: Period between consecutive requests to HTTP server.
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.
max_lines: int: Maximum number of lines in the text buffer. Setting the value to 0 disables processing of text messages and generation of text output.

__init__(*, parent, poll_period, max_msgs, max_lines)[source]¶

Methods

`__init__`(*, parent, poll_period, max_msgs, ...)
`clear`()	Clear the message buffer.
`disable`()	Disable monitoring of the console output.
`disable_wait`(*[, timeout])	Disable monitoring and wait for completion.
`enable`()	Enable monitoring of the console output.
`next_msg`([timeout])	Returns the next message from the buffer.
`text`([nlines])	Returns text representation of console output.

Attributes

`enabled`	Indicates if monitoring is enabled.
`text_max_lines`	Get/set the maximum size of the text buffer.
`text_uid`	Returns UID of the current text buffer.