Lean  $LEAN_TAG$
QuantConnect.Packets.RuntimeErrorPacket Class Reference

Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution. More...

Inheritance diagram for QuantConnect.Packets.RuntimeErrorPacket:
[legend]

Public Member Functions

 RuntimeErrorPacket ()
 Default constructor for JSON More...
 
 RuntimeErrorPacket (int userId, string algorithmId, string message, string stacktrace="")
 Create a new runtime error packet More...
 
- Public Member Functions inherited from QuantConnect.Packets.Packet
 Packet (PacketType type)
 Initialize the base class and setup the packet type. More...
 

Properties

string Message [get, set]
 Runtime error message from the exception More...
 
string AlgorithmId [get, set]
 Algorithm id which generated this runtime error More...
 
string StackTrace [get, set]
 Error stack trace information string passed through from the Lean exception More...
 
int UserId [get, set]
 User Id associated with the backtest that threw the error More...
 
- Properties inherited from QuantConnect.Packets.Packet
PacketType Type = PacketType.None [get, set]
 Packet type defined by a string enum More...
 
virtual string Channel = "" [get, set]
 User unique specific channel endpoint to send the packets More...
 

Detailed Description

Algorithm runtime error packet from the lean engine. This is a managed error which stops the algorithm execution.

Definition at line 25 of file RuntimeErrorPacket.cs.

Constructor & Destructor Documentation

◆ RuntimeErrorPacket() [1/2]

QuantConnect.Packets.RuntimeErrorPacket.RuntimeErrorPacket ( )

Default constructor for JSON

Definition at line 50 of file RuntimeErrorPacket.cs.

◆ RuntimeErrorPacket() [2/2]

QuantConnect.Packets.RuntimeErrorPacket.RuntimeErrorPacket ( int  userId,
string  algorithmId,
string  message,
string  stacktrace = "" 
)

Create a new runtime error packet

Definition at line 57 of file RuntimeErrorPacket.cs.

Property Documentation

◆ Message

string QuantConnect.Packets.RuntimeErrorPacket.Message
getset

Runtime error message from the exception

Definition at line 30 of file RuntimeErrorPacket.cs.

◆ AlgorithmId

string QuantConnect.Packets.RuntimeErrorPacket.AlgorithmId
getset

Algorithm id which generated this runtime error

Definition at line 35 of file RuntimeErrorPacket.cs.

◆ StackTrace

string QuantConnect.Packets.RuntimeErrorPacket.StackTrace
getset

Error stack trace information string passed through from the Lean exception

Definition at line 40 of file RuntimeErrorPacket.cs.

◆ UserId

int QuantConnect.Packets.RuntimeErrorPacket.UserId
getset

User Id associated with the backtest that threw the error

Definition at line 45 of file RuntimeErrorPacket.cs.


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