Represents a command handler that sources it's commands from a file on the local disk More...

Inheritance diagram for QuantConnect.Commands.FileCommandHandler:

Public Member Functions
	FileCommandHandler ()
	Initializes a new instance of the FileCommandHandler class using the 'command-json-file' configuration value for the command json file More...

Public Member Functions inherited from QuantConnect.Commands.BaseCommandHandler
virtual void	Initialize (AlgorithmNodePacket job, IAlgorithm algorithm)
	Initializes this command queue for the specified job More...

IEnumerable< CommandResultPacket >	ProcessCommands ()
	Will consumer and execute any command in the queue More...

virtual void	Dispose ()
	Disposes of this instance More...

Static Public Member Functions
static IEnumerable< FileInfo >	GetCommandFiles ()
	Gets all the available command files More...

Protected Member Functions
override IEnumerable< ICommand >	GetCommands ()
	Gets the next command in the queue More...

override void	Acknowledge (ICommand command, CommandResultPacket commandResultPacket)
	Acknowledge a command that has been executed More...

Protected Member Functions inherited from QuantConnect.Commands.BaseCommandHandler
ICommand	TryGetCallbackCommand (string payload)
	Helper method to create a callback command More...

Additional Inherited Members
Static Protected Attributes inherited from QuantConnect.Commands.BaseCommandHandler
static readonly JsonSerializerSettings	Settings = new() { TypeNameHandling = TypeNameHandling.All }
	Command json settings More...

Properties inherited from QuantConnect.Commands.BaseCommandHandler
IAlgorithm	Algorithm `[get, set]`
	The algorithm instance More...

Detailed Description

Represents a command handler that sources it's commands from a file on the local disk

Definition at line 29 of file FileCommandHandler.cs.

Constructor & Destructor Documentation

◆ FileCommandHandler()

QuantConnect.Commands.FileCommandHandler.FileCommandHandler ( )

Initializes a new instance of the FileCommandHandler class using the 'command-json-file' configuration value for the command json file

Definition at line 39 of file FileCommandHandler.cs.

Member Function Documentation

◆ GetCommandFiles()

static IEnumerable<FileInfo> QuantConnect.Commands.FileCommandHandler.GetCommandFiles ( )

static

Gets all the available command files

Returns: Sorted enumerator of all the available command files

Definition at line 47 of file FileCommandHandler.cs.

Here is the caller graph for this function:

◆ GetCommands()

override IEnumerable<ICommand> QuantConnect.Commands.FileCommandHandler.GetCommands ( )

protectedvirtual

Gets the next command in the queue

Returns: The next command in the queue, if present, null if no commands present

Implements QuantConnect.Commands.BaseCommandHandler.

Definition at line 58 of file FileCommandHandler.cs.

Here is the call graph for this function:

◆ Acknowledge()

override void QuantConnect.Commands.FileCommandHandler.Acknowledge	(	ICommand	command,
		CommandResultPacket	commandResultPacket
	)

protectedvirtual

Acknowledge a command that has been executed

Parameters

command	The command that was executed
commandResultPacket	The result

Reimplemented from QuantConnect.Commands.BaseCommandHandler.

Definition at line 77 of file FileCommandHandler.cs.

Here is the call graph for this function:

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

Common/Commands/FileCommandHandler.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions