laborchestrator.sila_server.generated.cancelcontroller package

Submodules

• laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_base module
  • CancelControllerBase
    • CancelControllerBase.CancelAll()
    • CancelControllerBase.CancelCommand()
    • CancelControllerBase.__is_running
    • CancelControllerBase.__periodic_funcs
    • CancelControllerBase.__started
    • CancelControllerBase._abc_impl
    • CancelControllerBase.parent_server
• laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_client module
  • CancelControllerClient
    • CancelControllerClient.CancelAll()
    • CancelControllerClient.CancelCommand()
• laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_errors module
  • InvalidCommandExecutionUUID
    • InvalidCommandExecutionUUID._abc_impl
    • InvalidCommandExecutionUUID.fully_qualified_identifier
    • InvalidCommandExecutionUUID.identifier
    • InvalidCommandExecutionUUID.message
  • OperationNotSupported
    • OperationNotSupported._abc_impl
    • OperationNotSupported.fully_qualified_identifier
    • OperationNotSupported.identifier
    • OperationNotSupported.message
• laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_feature module
• laborchestrator.sila_server.generated.cancelcontroller.cancelcontroller_types module
  • CancelAll_Responses
    • CancelAll_Responses._asdict()
    • CancelAll_Responses._field_defaults
    • CancelAll_Responses._fields
    • CancelAll_Responses._make()
    • CancelAll_Responses._replace()
  • CancelCommand_Responses
    • CancelCommand_Responses._asdict()
    • CancelCommand_Responses._field_defaults
    • CancelCommand_Responses._fields
    • CancelCommand_Responses._make()
    • CancelCommand_Responses._replace()

Module contents

class laborchestrator.sila_server.generated.cancelcontroller.CancelAll_Responses

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}

_fields = ()

classmethod _make(iterable)

Make a new CancelAll_Responses object from a sequence or iterable

_replace(**kwds)

Return a new CancelAll_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.cancelcontroller.CancelCommand_Responses

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}

_fields = ()

classmethod _make(iterable)

Make a new CancelCommand_Responses object from a sequence or iterable

_replace(**kwds)

Return a new CancelCommand_Responses object replacing specified fields with new values

class laborchestrator.sila_server.generated.cancelcontroller.CancelControllerBase(parent_server: Server)

Bases: FeatureImplementationBase, ABC

abstractmethod CancelAll(*, metadata: MetadataDict) → CancelAll_Responses

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

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

_abc_impl = <_abc._abc_data object>

parent_server: Server

SiLA Server serving this feature implementation

class laborchestrator.sila_server.generated.cancelcontroller.CancelControllerClient

Bases: object

This feature offers commands to cancel/terminate Commands. Cancellation is the act of stopping the running Command execution(s), irrevocably. The SiLA Server SHOULD be able to be in a state where any further commands can be issued after a cancellation.

CancelAll(*, metadata: Iterable[ClientMetadataInstance] | None = None) → CancelAll_Responses

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.

CancelCommand(CommandExecutionUUID: UUID, *, metadata: Iterable[ClientMetadataInstance] | None = None) → CancelCommand_Responses

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.

exception laborchestrator.sila_server.generated.cancelcontroller.InvalidCommandExecutionUUID(message: str | None = None)

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>

exception laborchestrator.sila_server.generated.cancelcontroller.OperationNotSupported(message: str | None = None)

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>

laborchestrator.sila_server.generated.cancelcontroller.UUID

alias of str