Interface IAsyncCommandHandler

Interface for async command handlers. Provides methods to start, handle, pause, resume, and cancel commands.

interface IAsyncCommandHandler {
    _tick(delta: number): void;
    broadcastCurrentDesignResolution(
        update: undefined | IHosannaCurrentDesignResolution,
    ): void;
    broadcastSystemDeviceInfoEvent(
        event: hosanna_api.ISystemEvent<ISystemDeviceInfoEventData>,
    ): void;
    cancelCommand(command: AsyncCommand): void;
    handleCommand(command: AsyncCommand): void;
    pauseCommand(command: AsyncCommand): void;
    resumeCommand(command: AsyncCommand): void;
    start(taskConfig: AsyncApi.ITaskConfigJson): void;
}

Hierarchy (View Summary)

AsyncApi.ITickable
- IAsyncCommandHandler

Implemented by

AsyncCommandHandler.AsyncCommandHandler

Index

Methods

_tick broadcastCurrentDesignResolution broadcastSystemDeviceInfoEvent cancelCommand handleCommand pauseCommand resumeCommand start

Methods

_tick

_tick(delta: number): void
Called with the time delta to update the object.
Parameters
- delta: number
  The time delta since the last tick.
Returns void
Inherited from ITickable._tick

broadcastCurrentDesignResolution

broadcastCurrentDesignResolution(
update: undefined | IHosannaCurrentDesignResolution,
): void
Broadcasts a scene currentDesignResolution transaction to every async task IoC universe.
Parameters
- update: undefined | IHosannaCurrentDesignResolution
  The current design resolution update to apply in each task.
Returns void

broadcastSystemDeviceInfoEvent

broadcastSystemDeviceInfoEvent(
event: hosanna_api.ISystemEvent<ISystemDeviceInfoEventData>,
): void
Broadcasts a roDeviceInfoEvent update to every async task IoC universe.
Parameters
- event: hosanna_api.ISystemEvent<ISystemDeviceInfoEventData>
  The device info system event to apply in each task.
Returns void

cancelCommand

cancelCommand(command: AsyncCommand): void
Cancels an async command.
Parameters
- command: AsyncCommand
  The command to cancel.
Returns void

handleCommand

handleCommand(command: AsyncCommand): void
Handles an incoming async command.
Parameters
- command: AsyncCommand
  The command to handle.
Returns void

pauseCommand

pauseCommand(command: AsyncCommand): void
Pauses an async command.
Parameters
- command: AsyncCommand
  The command to pause.
Returns void

resumeCommand

resumeCommand(command: AsyncCommand): void
Resumes an async command.
Parameters
- command: AsyncCommand
  The command to resume.
Returns void

start

start(taskConfig: AsyncApi.ITaskConfigJson): void
Starts the handler with task pool configuration.
Parameters
- taskConfig: AsyncApi.ITaskConfigJson
  Task pool configuration mapping pool IDs to task counts.
Returns void