bluesky_queueserver_api.zmq.REManagerAPI.lock_key

property REManagerAPI.lock_key

Get/set current lock key. The current lock key is used for locking/unlocking RE Manager unless the key is explicitly passed as lock_key parameter. The current key is also passed with other API if locked API are enabled (enable_locked_api is True). Setting the current lock key to None clears the lock key and disables access to locked API. A valid current lock key must be set before access to locked API is enabled.

Raises:

ValueError

Invalid lock key. The key must be a non-empty string or None.