laborchestrator.sila_server.generated.pausecontroller.pausecontroller_base module

class laborchestrator.sila_server.generated.pausecontroller.pausecontroller_base.PauseControllerBase(parent_server: Server)[source]

Bases: FeatureImplementationBase, ABC

abstractmethod Pause(CommandExecutionUUID: str, *, metadata: MetadataDict) → Pause_Responses[source]

Pause the Command execution. The Command can then be resumed again. The Command Execution Status of the

Observable Command MUST not be affected.

param CommandExecutionUUID:

The Command Execution UUID according to the SiLA Standard.

param metadata:

The SiLA Client Metadata attached to the call

PausedCommands_on_subscription(*, metadata: MetadataDict) → Queue[List[str]] | None[source]

A List of Command Execution UUID that are in a paused state.

This method is called when a client subscribes to the observable property ‘PausedCommands’

Parameters:

metadata – The SiLA Client Metadata attached to the call

Returns:

Optional Queue that should be used for updating this property. If None, the default Queue will be used.

abstractmethod Resume(CommandExecutionUUID: str, *, metadata: MetadataDict) → Resume_Responses[source]

Resume the Command after it has been paused.

Parameters:

  • CommandExecutionUUID – The Command Execution UUID according to the SiLA Standard.

  • metadata – The SiLA Client Metadata attached to the call

_PausedCommands_current_value: List[UUID]
_PausedCommands_producer_queue: Queue[List[UUID] | Exception]
__is_running: bool
__periodic_funcs: List[Callable[[], None]]
__started: bool
_abc_impl = <_abc._abc_data object>
abort_PausedCommands_subscriptions(error: Exception, queue: Queue[List[str]] | None = None) → None[source]

A List of Command Execution UUID that are in a paused state.

This method aborts subscriptions to the observable property ‘PausedCommands’.

Parameters:

  • error – The Exception to be sent to the subscribing client. If it is no DefinedExecutionError or UndefinedExecutionError, it will be wrapped in an UndefinedExecutionError.

  • queue – The queue to abort. If None, the default Queue will be used.

property current_PausedCommands: List[str]
parent_server: Server

SiLA Server serving this feature implementation

update_PausedCommands(PausedCommands: List[str], queue: Queue[List[str]] | None = None) → None[source]

A List of Command Execution UUID that are in a paused state.

This method updates the observable property ‘PausedCommands’.

Parameters:

queue – The queue to send updates to. If None, the default Queue will be used.