Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.LeanEngineSystemHandlers Class Reference

Provides a container for the system level handlers More...

Inheritance diagram for QuantConnect.Lean.Engine.LeanEngineSystemHandlers:
[legend]

Public Member Functions

 LeanEngineSystemHandlers (IJobQueueHandler jobQueue, IApi api, IMessagingHandler notify, ILeanManager leanManager)
 Initializes a new instance of the LeanEngineSystemHandlers class with the specified handles More...
 
void Initialize ()
 Initializes the Api, Messaging, and JobQueue components More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Static Public Member Functions

static LeanEngineSystemHandlers FromConfiguration (Composer composer)
 Creates a new instance of the LeanEngineSystemHandlers class from the specified composer using type names from configuration More...
 

Properties

IApi Api [get]
 Gets the api instance used for communicating algorithm limits, status, and storing of log data More...
 
IMessagingHandler Notify [get]
 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 More...
 
IJobQueueHandler JobQueue [get]
 Gets the job queue responsible for acquiring and acknowledging an algorithm job More...
 
ILeanManager LeanManager [get]
 Gets the ILeanManager implementation using to enhance the hosting environment More...
 

Detailed Description

Provides a container for the system level handlers

Definition at line 30 of file LeanEngineSystemHandlers.cs.

Constructor & Destructor Documentation

◆ LeanEngineSystemHandlers()

QuantConnect.Lean.Engine.LeanEngineSystemHandlers.LeanEngineSystemHandlers ( IJobQueueHandler  jobQueue,
IApi  api,
IMessagingHandler  notify,
ILeanManager  leanManager 
)

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

Parameters
jobQueueThe job queue used to acquire algorithm jobs
apiThe api instance used for communicating limits and status
notifyThe messaging handler user for passing messages from the algorithm to listeners
leanManager

Definition at line 77 of file LeanEngineSystemHandlers.cs.

Here is the caller graph for this function:

Member Function Documentation

◆ FromConfiguration()

static LeanEngineSystemHandlers QuantConnect.Lean.Engine.LeanEngineSystemHandlers.FromConfiguration ( Composer  composer)
static

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

Parameters
composerThe composer instance to obtain implementations from
Returns
A fully hydrates LeanEngineSystemHandlers instance.
Exceptions
CompositionExceptionThrows a CompositionException during failure to load

Definition at line 107 of file LeanEngineSystemHandlers.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Initialize()

void QuantConnect.Lean.Engine.LeanEngineSystemHandlers.Initialize ( )

Initializes the Api, Messaging, and JobQueue components

Definition at line 119 of file LeanEngineSystemHandlers.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Dispose()

void QuantConnect.Lean.Engine.LeanEngineSystemHandlers.Dispose ( )

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

<filterpriority>2</filterpriority>

Definition at line 129 of file LeanEngineSystemHandlers.cs.

Here is the call graph for this function:

Property Documentation

◆ Api

IApi QuantConnect.Lean.Engine.LeanEngineSystemHandlers.Api
get

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

Definition at line 41 of file LeanEngineSystemHandlers.cs.

◆ Notify

IMessagingHandler QuantConnect.Lean.Engine.LeanEngineSystemHandlers.Notify
get

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

Definition at line 50 of file LeanEngineSystemHandlers.cs.

◆ JobQueue

IJobQueueHandler QuantConnect.Lean.Engine.LeanEngineSystemHandlers.JobQueue
get

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

Definition at line 58 of file LeanEngineSystemHandlers.cs.

◆ LeanManager

ILeanManager QuantConnect.Lean.Engine.LeanEngineSystemHandlers.LeanManager
get

Gets the ILeanManager implementation using to enhance the hosting environment

Definition at line 66 of file LeanEngineSystemHandlers.cs.


The documentation for this class was generated from the following file: