QuantConnect.Interfaces.IMessagingHandler Interface Reference

Messaging System Plugin Interface. Provides a common messaging pattern between desktop and cloud implementations of QuantConnect. More...

Inheritance diagram for QuantConnect.Interfaces.IMessagingHandler:

Public Member Functions
void	Initialize (MessagingHandlerInitializeParameters initializeParameters)
	Initialize the Messaging System Plugin. More...
void	SetAuthentication (AlgorithmNodePacket job)
	Set the user communication channel More...
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...

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...

Detailed Description

Messaging System Plugin Interface. Provides a common messaging pattern between desktop and cloud implementations of QuantConnect.

Definition at line 29 of file IMessagingHandler.cs.

Member Function Documentation

Initialize()

void QuantConnect.Interfaces.IMessagingHandler.Initialize

(

MessagingHandlerInitializeParameters

initializeParameters

)

Initialize the Messaging System Plugin.

Parameters

initializeParameters

The parameters required for initialization

Implemented in QuantConnect.Messaging.StreamingMessageHandler, QuantConnect.Messaging.EventMessagingHandler, and QuantConnect.Messaging.Messaging.

Here is the caller graph for this function:

SetAuthentication()

void QuantConnect.Interfaces.IMessagingHandler.SetAuthentication

(

AlgorithmNodePacket

job

)

Set the user communication channel

Parameters

job	The job packet

Implemented in QuantConnect.Messaging.EventMessagingHandler, QuantConnect.Messaging.StreamingMessageHandler, and QuantConnect.Messaging.Messaging.

Here is the caller graph for this function:

Send()

void QuantConnect.Interfaces.IMessagingHandler.Send

(

Packet

packet

)

Send any message with a base type of Packet.

Parameters

packet

Packet of data to send via the messaging system plugin

Implemented in QuantConnect.Messaging.EventMessagingHandler, QuantConnect.Messaging.StreamingMessageHandler, and QuantConnect.Messaging.Messaging.

Here is the caller graph for this function:

SendNotification()

void QuantConnect.Interfaces.IMessagingHandler.SendNotification

(

Notification

notification

)

Send any notification with a base type of Notification.

Parameters

notification

The notification to be sent.

Implemented in QuantConnect.Messaging.EventMessagingHandler, QuantConnect.Messaging.Messaging, and QuantConnect.Messaging.StreamingMessageHandler.

Here is the caller graph for this function:

Property Documentation

HasSubscribers

bool QuantConnect.Interfaces.IMessagingHandler.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 35 of file IMessagingHandler.cs.

---

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

• Common/Interfaces/IMessagingHandler.cs