QuantConnect.Messaging.EventMessagingHandler Class Reference

Desktop implementation of messaging system for Lean Engine More...

Inheritance diagram for QuantConnect.Messaging.EventMessagingHandler:

Public Member Functions
void	Initialize (MessagingHandlerInitializeParameters initializeParameters)
	Initialize the Messaging System Plugin. More...
void	LoadingComplete ()
	Set Loaded to true More...
void	SetAuthentication (AlgorithmNodePacket job)
	Set the user communication channel More...
delegate void	DebugEventRaised (DebugPacket packet)
delegate void	SystemDebugEventRaised (SystemDebugPacket packet)
delegate void	LogEventRaised (LogPacket packet)
delegate void	RuntimeErrorEventRaised (RuntimeErrorPacket packet)
delegate void	HandledErrorEventRaised (HandledErrorPacket packet)
delegate void	BacktestResultEventRaised (BacktestResultPacket packet)
delegate void	ConsumerReadyEventRaised ()
void	Send (Packet packet)
	Send any message with a base type of Packet. More...
void	SendNotification (Notification notification)
	Send any notification with a base type of Notification. More...
void	SendEnqueuedPackets ()
	Send any message with a base type of Packet that has been enqueued. More...
virtual void	OnConsumerReadyEvent ()
	Handler for consumer ready code. More...
virtual void	Dispose ()
	Dispose of any resources More...

Protected Member Functions
virtual void	OnDebugEvent (DebugPacket packet)
	Raise a debug event safely More...
virtual void	OnSystemDebugEvent (SystemDebugPacket packet)
	Raise a system debug event safely More...
virtual void	OnLogEvent (LogPacket packet)
	Raise a log event safely More...
virtual void	OnHandledErrorEvent (HandledErrorPacket packet)
	Raise a handled error event safely More...
virtual void	OnRuntimeErrorEvent (RuntimeErrorPacket packet)
	Raise runtime error safely More...
virtual void	OnBacktestResultEvent (BacktestResultPacket packet)
	Raise a backtest result event safely. More...

Properties
bool	HasSubscribers [get, set]
	Gets or sets whether this messaging handler has any current subscribers. When set to false, messages won't be sent. More...
Properties inherited from QuantConnect.Interfaces.IMessagingHandler
bool	HasSubscribers [get, set]
	Gets or sets whether this messaging handler has any current subscribers. When set to false, messages won't be sent. More...

Events
DebugEventRaised	DebugEvent
SystemDebugEventRaised	SystemDebugEvent
LogEventRaised	LogEvent
RuntimeErrorEventRaised	RuntimeErrorEvent
HandledErrorEventRaised	HandledErrorEvent
BacktestResultEventRaised	BacktestResultEvent
ConsumerReadyEventRaised	ConsumerReadyEvent

Detailed Description

Desktop implementation of messaging system for Lean Engine

Definition at line 27 of file EventMessagingHandler.cs.

Member Function Documentation

Initialize()

void QuantConnect.Messaging.EventMessagingHandler.Initialize

(

MessagingHandlerInitializeParameters

initializeParameters

)

Initialize the Messaging System Plugin.

Parameters

initializeParameters

The parameters required for initialization

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 47 of file EventMessagingHandler.cs.

LoadingComplete()

void QuantConnect.Messaging.EventMessagingHandler.LoadingComplete

(

)

Set Loaded to true

Definition at line 57 of file EventMessagingHandler.cs.

SetAuthentication()

void QuantConnect.Messaging.EventMessagingHandler.SetAuthentication

(

AlgorithmNodePacket

job

)

Set the user communication channel

Parameters

job

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 66 of file EventMessagingHandler.cs.

Send()

void QuantConnect.Messaging.EventMessagingHandler.Send

(

Packet

packet

)

Send any message with a base type of Packet.

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 99 of file EventMessagingHandler.cs.

SendNotification()

void QuantConnect.Messaging.EventMessagingHandler.SendNotification

(

Notification

notification

)

Send any notification with a base type of Notification.

Parameters

notification

The notification to be sent.

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 122 of file EventMessagingHandler.cs.

Here is the call graph for this function:

SendEnqueuedPackets()

void QuantConnect.Messaging.EventMessagingHandler.SendEnqueuedPackets

(

)

Send any message with a base type of Packet that has been enqueued.

Definition at line 136 of file EventMessagingHandler.cs.

OnDebugEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnDebugEvent ( DebugPacket  packet )

protectedvirtual

Raise a debug event safely

Definition at line 187 of file EventMessagingHandler.cs.

OnSystemDebugEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnSystemDebugEvent ( SystemDebugPacket  packet )

protectedvirtual

Raise a system debug event safely

Definition at line 201 of file EventMessagingHandler.cs.

OnConsumerReadyEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnConsumerReadyEvent ( )

virtual

Handler for consumer ready code.

Definition at line 215 of file EventMessagingHandler.cs.

OnLogEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnLogEvent ( LogPacket  packet )

protectedvirtual

Raise a log event safely

Definition at line 227 of file EventMessagingHandler.cs.

OnHandledErrorEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnHandledErrorEvent ( HandledErrorPacket  packet )

protectedvirtual

Raise a handled error event safely

Definition at line 239 of file EventMessagingHandler.cs.

OnRuntimeErrorEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnRuntimeErrorEvent ( RuntimeErrorPacket  packet )

protectedvirtual

Raise runtime error safely

Definition at line 251 of file EventMessagingHandler.cs.

OnBacktestResultEvent()

virtual void QuantConnect.Messaging.EventMessagingHandler.OnBacktestResultEvent ( BacktestResultPacket  packet )

protectedvirtual

Raise a backtest result event safely.

Definition at line 263 of file EventMessagingHandler.cs.

Dispose()

virtual void QuantConnect.Messaging.EventMessagingHandler.Dispose ( )

virtual

Dispose of any resources

Definition at line 275 of file EventMessagingHandler.cs.

Property Documentation

HasSubscribers

bool QuantConnect.Messaging.EventMessagingHandler.HasSubscribers

getset

Gets or sets whether this messaging handler has any current subscribers. When set to false, messages won't be sent.

Definition at line 38 of file EventMessagingHandler.cs.

---

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

• Messaging/EventMessagingHandler.cs