bluesky_queueserver_api.zmq.REManagerAPI.environment_open

REManagerAPI.environment_open(*, lock_key=None)

Open RE Worker environment. The API request only initiates the operation of opening an environment. If the request is accepted, the manager_state status parameter is expected to change to creating_environment and then changed back to idle when the operation is complete. Check worker_environment_exists to see if the environment was opened successfully.

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.environment_open()

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