ORIONIS API REFERENCE

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

orionis.console.base.contracts.scheduler.IBaseScheduler

class documentation

class IBaseScheduler(ABC): (source)

Known subclasses: orionis.console.base.BaseScheduler

View In Hierarchy

Undocumented

Async Method onPaused Handle the scheduler pause event.
Async Method onResumed Handle the scheduler resumption event.
Async Method onShutdown Handle the scheduler finalization event.
Async Method onStarted Handle the scheduler start event.
Async Method tasks Register scheduled tasks for the application.
async def onPaused(self, event: SchedulerEvent): (source)
overridden in orionis.console.base.BaseScheduler

Handle the scheduler pause event.

Parameters
event:SchedulerEventThe event object representing the scheduler pause.
Returns
NoneThis method does not return any value.
async def onResumed(self, event: SchedulerEvent): (source)
overridden in orionis.console.base.BaseScheduler

Handle the scheduler resumption event.

Parameters
event:SchedulerEventThe event object representing the scheduler resumption.
Returns
NoneThis method does not return any value.
async def onShutdown(self, event: SchedulerEvent): (source)
overridden in orionis.console.base.BaseScheduler

Handle the scheduler finalization event.

Parameters
event:SchedulerEventThe event object representing the scheduler shutdown.
Returns
NoneThis method does not return any value.
async def onStarted(self, event: SchedulerEvent): (source)
overridden in orionis.console.base.BaseScheduler

Handle the scheduler start event.

Parameters
event:SchedulerEventThe event object representing the scheduler start.
Returns
NoneThis method does not return any value.
async def tasks(self, schedule: ISchedule): (source)
overridden in orionis.console.base.BaseScheduler

Register scheduled tasks for the application.

This method sets up tasks that the scheduler will execute using the provided schedule object. Subclasses should override this method to define specific tasks and their scheduling properties.

Notes

Subclasses must implement this method to specify their task scheduling logic.

Parameters
schedule:IScheduleThe schedule object used to register scheduled commands.
Returns
NoneThis method does not return any value.