orionis.console.base.contracts.listener.IBaseTaskListener

ORIONIS API REFERENCE

Modules Classes Names

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class IBaseTaskListener(ABC): (source)

Known subclasses: orionis.console.base.BaseTaskListener

View In Hierarchy

Undocumented

Async Method	`onTaskAdded`	Handle the event when a task is added.
Async Method	`onTaskError`	Handle the event when a task encounters an error.
Async Method	`onTaskExecuted`	Handle the event when a task is executed.
Async Method	`onTaskMaxInstances`	Handle the event when a task reaches its maximum allowed instances.
Async Method	`onTaskMissed`	Handle the event when a task is missed.
Async Method	`onTaskRemoved`	Handle the event when a task is removed.
Async Method	`onTaskSubmitted`	Handle the event when a task is submitted.

@abstractmethod

async def onTaskAdded(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task is added.

Parameters
event:`TaskEvent`	The event object containing information about the added task.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskError(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task encounters an error.

Parameters
event:`TaskEvent`	The event object containing information about the task error.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskExecuted(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task is executed.

Parameters
event:`TaskEvent`	The event object containing information about the executed task.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskMaxInstances(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task reaches its maximum allowed instances.

Parameters
event:`TaskEvent`	The event object containing information about the max instances event.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskMissed(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task is missed.

Parameters
event:`TaskEvent`	The event object containing information about the missed task.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskRemoved(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task is removed.

Parameters
event:`TaskEvent`	The event object containing information about the removed task.

Returns
`None`	This method does not return a value.

@abstractmethod

async def onTaskSubmitted(self, event: TaskEvent): (source) ¶

overridden in orionis.console.base.BaseTaskListener

Handle the event when a task is submitted.

Parameters
event:`TaskEvent`	The event object containing information about the submitted task.

Returns
`None`	This method does not return a value.