bluesky_queueserver_api.zmq.REManagerAPI.queue_stop

REManagerAPI.queue_stop(*, lock_key=None)

Request RE Manager to stop execution of the queue after completion of the currently running plan. The request succeeds only if the queue is currently running (manager_state status field has value executing_queue). Use the status field queue_stop_pending to verify if the request is pending.

Parameters:
lock_key: str or None (optional)

The lock key enables access to the API when RE Manager environment 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_stop()

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