bluesky_queueserver_api.zmq.REManagerAPI.queue_clear

REManagerAPI.queue_clear(*, lock_key=None)

Remove all items from the plan queue. The currently running plan does not belong to the queue and is not affected by this operation. Failed or stopped plans are pushed to the front of the queue.

Parameters:

lock_key: str or None (optional)

The lock key enables access to the API when RE Manager queue is locked. If the parameter is not None, the key overrides the current lock key set by REManagerAPI.lock_key. See documentation on REMangerAPI.lock() for more information. Default: None.

Returns:

response: dict

Dictionary keys:

• success: boolean - success of the request.

• msg: str - error message in case the request is rejected by RE Manager or operation failed.

Raises:

RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.

Examples

# Synchronous code (0MQ, HTTP)
RM.queue_clear()

# Asynchronous code (0MQ, HTTP)
await RM.queue_clear()