QuantConnect.Packets.LiveResultPacket Class Reference

Live result packet from a lean engine algorithm. More...

Inheritance diagram for QuantConnect.Packets.LiveResultPacket:

Public Member Functions
	LiveResultPacket ()
	Default constructor for JSON Serialization More...
	LiveResultPacket (string json)
	Compose the packet from a JSON string: More...
	LiveResultPacket (LiveNodePacket job, LiveResult results)
	Compose Live Result Data Packet - With tradable dates More...
Public Member Functions inherited from QuantConnect.Packets.Packet
	Packet (PacketType type)
	Initialize the base class and setup the packet type. More...

Static Public Member Functions
static LiveResultPacket	CreateEmpty (LiveNodePacket job)
	Creates an empty result packet, useful when the algorithm fails to initialize More...

Properties
int	UserId [get, set]
	User Id sending result packet More...
int	ProjectId [get, set]
	Project Id of the result packet More...
string	SessionId = string.Empty [get, set]
	User session Id who issued the result packet More...
string	DeployId = string.Empty [get, set]
	Live Algorithm Id (DeployId) for this result packet More...
string	CompileId = string.Empty [get, set]
	Compile Id algorithm which generated this result packet More...
LiveResult	Results = new LiveResult() [get, set]
	Result data object for this result packet More...
double	ProcessingTime [get, set]
	Processing time / running time for the live algorithm. 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

Live result packet from a lean engine algorithm.

Definition at line 30 of file LiveResultPacket.cs.

Constructor & Destructor Documentation

LiveResultPacket() [1/3]

QuantConnect.Packets.LiveResultPacket.LiveResultPacket

(

)

Default constructor for JSON Serialization

Definition at line 70 of file LiveResultPacket.cs.

Here is the caller graph for this function:

LiveResultPacket() [2/3]

QuantConnect.Packets.LiveResultPacket.LiveResultPacket

(

string

json

)

Compose the packet from a JSON string:

Definition at line 77 of file LiveResultPacket.cs.

Here is the call graph for this function:

LiveResultPacket() [3/3]

QuantConnect.Packets.LiveResultPacket.LiveResultPacket	(	LiveNodePacket	job,
		LiveResult	results
	)

Compose Live Result Data Packet - With tradable dates

Parameters

job	Job that started this request
results	Results class for the Backtest job

Definition at line 104 of file LiveResultPacket.cs.

Here is the call graph for this function:

Member Function Documentation

CreateEmpty()

static LiveResultPacket QuantConnect.Packets.LiveResultPacket.CreateEmpty ( LiveNodePacket  job )

static

Creates an empty result packet, useful when the algorithm fails to initialize

Parameters

job	The associated job packet

Returns

An empty result packet

Definition at line 128 of file LiveResultPacket.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

UserId

int QuantConnect.Packets.LiveResultPacket.UserId

getset

User Id sending result packet

Definition at line 35 of file LiveResultPacket.cs.

ProjectId

int QuantConnect.Packets.LiveResultPacket.ProjectId

getset

Project Id of the result packet

Definition at line 40 of file LiveResultPacket.cs.

SessionId

string QuantConnect.Packets.LiveResultPacket.SessionId = string.Empty

getset

User session Id who issued the result packet

Definition at line 45 of file LiveResultPacket.cs.

DeployId

string QuantConnect.Packets.LiveResultPacket.DeployId = string.Empty

getset

Live Algorithm Id (DeployId) for this result packet

Definition at line 50 of file LiveResultPacket.cs.

CompileId

string QuantConnect.Packets.LiveResultPacket.CompileId = string.Empty

getset

Compile Id algorithm which generated this result packet

Definition at line 55 of file LiveResultPacket.cs.

Results

LiveResult QuantConnect.Packets.LiveResultPacket.Results = new LiveResult()

getset

Result data object for this result packet

Definition at line 60 of file LiveResultPacket.cs.

ProcessingTime

double QuantConnect.Packets.LiveResultPacket.ProcessingTime

getset

Processing time / running time for the live algorithm.

Definition at line 65 of file LiveResultPacket.cs.

---

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

• Common/Packets/LiveResultPacket.cs