bluesky_queueserver_api.zmq.REManagerAPI.queue_stop_cancel

REManagerAPI.queue_stop_cancel(*, lock_key=None)

Cancel the pending request to stop execution of the queue after the currently running plan. Use the status field queue_stop_pending to check 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_cancel()

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