Lean  $LEAN_TAG$
QuantConnect.Commands.ICommandHandler Interface Reference

Represents a command queue for the algorithm. This is an entry point for external messages to act upon the running algorithm instance. More...

Inheritance diagram for QuantConnect.Commands.ICommandHandler:
[legend]

Public Member Functions

void Initialize (AlgorithmNodePacket job, IAlgorithm algorithm)
 Initializes this command queue for the specified job More...
 
IEnumerable< CommandResultPacketProcessCommands ()
 Process any commands in the queue More...
 

Detailed Description

Represents a command queue for the algorithm. This is an entry point for external messages to act upon the running algorithm instance.

Definition at line 27 of file ICommandHandler.cs.

Member Function Documentation

◆ Initialize()

void QuantConnect.Commands.ICommandHandler.Initialize ( AlgorithmNodePacket  job,
IAlgorithm  algorithm 
)

Initializes this command queue for the specified job

Parameters
jobThe job that defines what queue to bind to
algorithmThe algorithm instance

Implemented in QuantConnect.Commands.BaseCommandHandler.

Here is the caller graph for this function:

◆ ProcessCommands()

IEnumerable<CommandResultPacket> QuantConnect.Commands.ICommandHandler.ProcessCommands ( )

Process any commands in the queue

Returns
The command result packet of each command executed if any

Implemented in QuantConnect.Commands.BaseCommandHandler.

Here is the caller graph for this function:

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