bluesky_queueserver_api.zmq.REManagerAPI.lock_info

REManagerAPI.lock_info(lock_key=None, *, reload=False)

Returns status information of the current lock. Optionally validates the lock key if it is passed with API request.

If the lock_key parameter is not None, then the request is always forwarded to the RE Manager. Do not pass the lock key unless validation to avoid unnecessary overhead.

Parameters:

lock_key: str or None (optional)

A lock key to validate. The API call fails if the lock key is invalid. Default: None.

reload: boolean (optional)

Set the parameter True to force reloading the status from the server before lock_info_uid is checked. Otherwise cached status is used. Default: False.

Returns:

response: dict

Dictionary keys:

• success: boolean - success of the request. The request always succeeds if lock_key is missing or None. If the key is passed, then the request succeeds if the key is valid and fails otherwise.

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

• lock_info: dict - dictionary containing the information on the status of the lock. See the docstring for REManagerAPI.lock() for detailed description.

• lock_info_uid: str UID of lock_info. The UID is also returned in RE Manager status and could be monitored to detect updates of lock_info.

Raises:

RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.

ValueError

The lock key is not a non-empty string.