Skip to content

LeanEngineSystemHandlers

QuantConnect.Lean.Engine.LeanEngineSystemHandlers

LeanEngineSystemHandlers(
    job_queue: IJobQueueHandler,
    api: IApi,
    notify: IMessagingHandler,
    lean_manager: ILeanManager,
)

Bases: Object, IDisposable

Provides a container for the system level handlers

Initializes a new instance of the LeanEngineSystemHandlers class with the specified handles

Parameters:

Name Type Description Default
job_queue IJobQueueHandler

The job queue used to acquire algorithm jobs

required
api IApi

The api instance used for communicating limits and status

required
notify IMessagingHandler

The messaging handler user for passing messages from the algorithm to listeners

required
lean_manager ILeanManager
required

api

api: IApi

Gets the api instance used for communicating algorithm limits, status, and storing of log data

notify

Gets the messaging handler instance used for communicating various packets to listeners, including debug/log messages, email/sms/web messages, as well as results and run time errors

job_queue

job_queue: IJobQueueHandler

Gets the job queue responsible for acquiring and acknowledging an algorithm job

lean_manager

lean_manager: ILeanManager

Gets the ILeanManager implementation using to enhance the hosting environment

dispose

dispose() -> None

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

from_configuration

from_configuration(
    composer: Composer,
) -> LeanEngineSystemHandlers

Creates a new instance of the LeanEngineSystemHandlers class from the specified composer using type names from configuration

Parameters:

Name Type Description Default
composer Composer

The composer instance to obtain implementations from

required

Returns:

Type Description
LeanEngineSystemHandlers

A fully hydrates LeanEngineSystemHandlers instance.

initialize

initialize() -> None

Initializes the Api, Messaging, and JobQueue components