Lean  $LEAN_TAG$
QuantConnect.Messaging.Messaging Class Reference

Local/desktop implementation of messaging system for Lean Engine. More...

Inheritance diagram for QuantConnect.Messaging.Messaging:
[legend]

Public Member Functions

void Initialize (MessagingHandlerInitializeParameters initializeParameters)
 Initialize the messaging system More...
 
virtual void SetAuthentication (AlgorithmNodePacket job)
 Set the messaging channel More...
 
virtual void Send (Packet packet)
 Send a generic base packet without processing More...
 
void SendNotification (Notification notification)
 Send any notification with a base type of Notification. More...
 
void Dispose ()
 Dispose of any resources More...
 

Properties

bool HasSubscribers [get, set]
 This implementation ignores the

See also
HasSubscribers

flag and instead will always write to the log. 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...
 

Detailed Description

Local/desktop implementation of messaging system for Lean Engine.

Definition at line 29 of file Messaging.cs.

Member Function Documentation

◆ Initialize()

void QuantConnect.Messaging.Messaging.Initialize ( MessagingHandlerInitializeParameters  initializeParameters)

Initialize the messaging system

Parameters
initializeParametersThe parameters required for initialization

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 45 of file Messaging.cs.

◆ SetAuthentication()

virtual void QuantConnect.Messaging.Messaging.SetAuthentication ( AlgorithmNodePacket  job)
virtual

Set the messaging channel

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 53 of file Messaging.cs.

◆ Send()

virtual void QuantConnect.Messaging.Messaging.Send ( Packet  packet)
virtual

Send a generic base packet without processing

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 60 of file Messaging.cs.

Here is the call graph for this function:

◆ SendNotification()

void QuantConnect.Messaging.Messaging.SendNotification ( Notification  notification)

Send any notification with a base type of Notification.

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 113 of file Messaging.cs.

Here is the call graph for this function:

◆ Dispose()

void QuantConnect.Messaging.Messaging.Dispose ( )

Dispose of any resources

Definition at line 126 of file Messaging.cs.

Property Documentation

◆ HasSubscribers

bool QuantConnect.Messaging.Messaging.HasSubscribers
getset

This implementation ignores the

See also
HasSubscribers

flag and instead will always write to the log.

Definition at line 36 of file Messaging.cs.


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