bluesky_queueserver_api.zmq.REManagerAPI.enable_locked_api

property REManagerAPI.enable_locked_api

Enable/disable access to locked API. When access to locked API is enabled, the current lock key (RM.lock_key) is automatically sent with API requests. The locked API may be called without enabling automatic access by explicitly sending the lock key with each request. A valid current lock key must be set before access could be enabled. The access is disabled when the lock key is cleared.

Raises:

TypeError

Attempt to set to a value of non-boolean type.

RuntimeError

Current lock key is not set.