QuantConnect.Packets Namespace Reference

Classes
class	AlgorithmNameUpdatePacket
	Packet to communicate updates to the algorithm's name More...
class	AlgorithmNodePacket
	Algorithm Node Packet is a work task for the Lean Engine More...
class	AlgorithmStatusPacket
	Algorithm status update information packet More...
class	AlgorithmTagsUpdatePacket
	Packet to communicate updates to the algorithm tags More...
class	AlphaNodePacket
	Alpha job packet More...
class	AlphaResultPacket
	Provides a packet type for transmitting alpha insights data More...
class	BacktestNodePacket
	Algorithm backtest task information packet. More...
class	BacktestResult
	Backtest results object class - result specific items from the packet. More...
class	BacktestResultPacket
	Backtest result packet: send backtest information to GUI for user consumption. More...
class	BacktestResultParameters
	Defines the parameters for BacktestResult More...
class	BaseResultParameters
	Base parameters used by LiveResultParameters and BacktestResultParameters More...
class	CompletedHistoryResult
	Specifies the completed message from a history result More...
class	Controls
	Specifies values used to control algorithm limits More...
class	DebugPacket
	Send a simple debug message from the users algorithm to the console. More...
class	ErrorHistoryResult
	Specfies an error message in a history result More...
class	FileHistoryResult
	Defines requested file data for a history request More...
class	HandledErrorPacket
	Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution. More...
class	HistoryPacket
	Packet for history jobs More...
class	HistoryRequest
	Specifies request parameters for a single historical request. A HistoryPacket is made of multiple requests for data. These are used to request data during live mode from a data server More...
class	HistoryResult
	Provides a container for results from history requests. This contains the file path relative to the /Data folder where the data can be written More...
class	LeakyBucketControlParameters
	Provides parameters that control the behavior of a leaky bucket rate limiting algorithm. The parameter names below are phrased in the positive, such that the bucket is filled up over time vs leaking out over time. More...
class	LiveNodePacket
	Live job task packet: container for any live specific job variables More...
class	LiveResult
	Live results object class for packaging live result data. More...
class	LiveResultPacket
	Live result packet from a lean engine algorithm. More...
class	LiveResultParameters
	Defines the parameters for LiveResult More...
class	LogPacket
	Simple log message instruction from the lean engine. More...
class	MarketHours
	Market open hours model for pre, normal and post market hour definitions. More...
class	MarketToday
	Market today information class More...
class	OrderEventPacket
	Order event packet for passing updates on the state of an order to the portfolio. More...
class	Packet
	Base class for packet messaging system More...
class	PythonEnvironmentPacket
	Python Environment Packet is an abstract packet that contains a PythonVirtualEnvironment definition. Intended to be used by inheriting classes that may use a PythonVirtualEnvironment More...
class	RuntimeErrorPacket
	Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution. More...
class	SecurityTypesPacket
	Security types packet contains information on the markets the user data has requested. More...
class	StatusHistoryResult
	Specifies the progress of a request More...
class	SystemDebugPacket
	Debug packets generated by Lean More...

Enumerations
enum	HistoryResultType { HistoryResultType.File, HistoryResultType.Status, HistoryResultType.Completed, HistoryResultType.Error }
	Specifies various types of history results More...
enum	PacketType {   PacketType.None, PacketType.AlgorithmNode, PacketType.AutocompleteWork, PacketType.AutocompleteResult,   PacketType.BacktestNode, PacketType.BacktestResult, PacketType.BacktestWork, PacketType.LiveNode,   PacketType.LiveResult, PacketType.LiveWork, PacketType.SecurityTypes, PacketType.BacktestError,   PacketType.AlgorithmStatus, PacketType.BuildWork, PacketType.BuildSuccess, PacketType.BuildError,   PacketType.RuntimeError, PacketType.HandledError, PacketType.Log, PacketType.Debug,   PacketType.OrderEvent, PacketType.Success, PacketType.History, PacketType.CommandResult,   PacketType.GitHubHook, PacketType.DocumentationResult, PacketType.Documentation, PacketType.SystemDebug,   PacketType.AlphaResult, PacketType.AlphaWork, PacketType.AlphaNode, PacketType.RegressionAlgorithm,   PacketType.AlphaHeartbeat, PacketType.DebuggingStatus, PacketType.OptimizationNode, PacketType.OptimizationEstimate,   PacketType.OptimizationStatus, PacketType.OptimizationResult, PacketType.Aggregated, PacketType.LanguageModelQuery,   PacketType.LanguageModelFeedback, PacketType.LanguageModelResponse, PacketType.LanguageModelCodeAnalysis, PacketType.LanguageModelChatWork,   PacketType.LanguageModelChatResponse, PacketType.AlgorithmNameUpdate, PacketType.AlgorithmTagsUpdate }
	Classifications of internal packet system More...

Enumeration Type Documentation

HistoryResultType

enum QuantConnect.Packets.HistoryResultType

strong

Specifies various types of history results

Enumerator
File	The requested file data
Status	The request's status
Completed	The request is completed
Error	The request had an error

Definition at line 82 of file HistoryPacket.cs.

PacketType

enum QuantConnect.Packets.PacketType

strong

Classifications of internal packet system

Enumerator
None	Default, unset:
AlgorithmNode	Base type for backtest and live work.
AutocompleteWork	Autocomplete Work Packet.
AutocompleteResult	Result of the Autocomplete Job:
BacktestNode	Controller->Backtest Node Packet:
BacktestResult	Packet out of backtest node:
BacktestWork	API-> Controller Work Packet:
LiveNode	Controller -> Live Node Packet:
LiveResult	Live Node -> User Packet:
LiveWork	API -> Controller Packet:
SecurityTypes	Node -> User Algo Security Types.
BacktestError	Controller -> User Error in Backtest Settings:
AlgorithmStatus	Nodes -> User Algorithm Status Packet:
BuildWork	API -> Compiler Work Packet:
BuildSuccess	Compiler -> User Build Success.
BuildError	Compiler -> User, Compile Error.
RuntimeError	Node -> User Algorithm Runtime Error.
HandledError	Error is an internal handled error packet inside users algorithm.
Log	Nodes -> User Log Message.
Debug	Nodes -> User Debug Message.
OrderEvent	Nodes -> User, Order Update Event.
Success	Boolean true/false success.
History	History live job packets.
CommandResult	Result from a command.
GitHubHook	Hook from git hub.
DocumentationResult	Documentation result from docs server.
Documentation	Documentation request to the docs server.
SystemDebug	Debug packet generated by Lean.
AlphaResult	Packet containing insights generated by the algorithm.
AlphaWork	Alpha API -> Controller packet.
AlphaNode	Alpha Controller -> Alpha Node packet.
RegressionAlgorithm	Packet containing list of algorithms to run as a regression test.
AlphaHeartbeat	Packet containing a heartbeat.
DebuggingStatus	Used when debugging to send status updates.
OptimizationNode	Optimization Node Packet:
OptimizationEstimate	Optimization Estimate Packet:
OptimizationStatus	Optimization work status update.
OptimizationResult	Optimization work result.
Aggregated	Aggregated packets.
LanguageModelQuery	Query the language model.
LanguageModelFeedback	Send feedback to a language model response.
LanguageModelResponse	The language models response.
LanguageModelCodeAnalysis	Language model code analysis.
LanguageModelChatWork	Language model chat work.
LanguageModelChatResponse	Language model chat response.
AlgorithmNameUpdate	Algorithm name update.
AlgorithmTagsUpdate	Algorithm tags update.

Definition at line 54 of file Packet.cs.