laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_base module

class laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_base.CancelControllerBase(parent_server: Server)[source]

Bases: FeatureImplementationBase, ABC

abstractmethod CancelAll(*, metadata: MetadataDict) CancelAll_Responses[source]

Cancels all currently running Observable and Unobservable Commands running on this SiLA Server.

The SiLA Server MUST throw an Execution Error indicating ‘cancellation’ as the reason for the Command not being able to finish successfully.

param metadata:

The SiLA Client Metadata attached to the call

abstractmethod CancelCommand(CommandExecutionUUID: str, *, metadata: MetadataDict) CancelCommand_Responses[source]

Cancel a specified currently running Observable Command or cancel all currently running Observable Commands .

For any canceled Observable Command the SiLA Server MUST update the Command Execution Status to “Command Finished with Error”. The SiLA Server MUST throw a descriptive error message indicating cancellation as the reason for the Command execution not being able to finish successfully for any canceled Command.

param CommandExecutionUUID:

The Command Execution UUID according to the SiLA Standard.

param metadata:

The SiLA Client Metadata attached to the call

__is_running: bool
__periodic_funcs: List[Callable[[], None]]
__started: bool
_abc_impl = <_abc._abc_data object>
parent_server: Server

SiLA Server serving this feature implementation