Lean  $LEAN_TAG$
QuantConnect.Messaging.StreamingMessageHandler Class Reference

Message handler that sends messages over tcp using NetMQ. More...

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

Public Member Functions

void Initialize (MessagingHandlerInitializeParameters initializeParameters)
 Initialize the messaging system More...
 
void SetAuthentication (AlgorithmNodePacket job)
 Set the user communication channel More...
 
void SendNotification (Notification notification)
 Send any notification with a base type of Notification. More...
 
void Send (Packet packet)
 Send all types of packets More...
 
void Transmit (Packet packet)
 Send a message to the _server using ZeroMQ More...
 
void Dispose ()
 Dispose any resources used before destruction More...
 

Properties

bool HasSubscribers [get, set]
 Gets or sets whether this messaging handler has any current subscribers. This is not used in this message handler. Messages are sent via tcp as they arrive 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

Message handler that sends messages over tcp using NetMQ.

Definition at line 34 of file StreamingMessageHandler.cs.

Member Function Documentation

◆ Initialize()

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

Initialize the messaging system

Parameters
initializeParametersThe parameters required for initialization

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 51 of file StreamingMessageHandler.cs.

Here is the call graph for this function:

◆ SetAuthentication()

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

Set the user communication channel

Parameters
job

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 62 of file StreamingMessageHandler.cs.

Here is the call graph for this function:

◆ SendNotification()

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

Send any notification with a base type of Notification.

Parameters
notificationThe notification to be sent.

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 73 of file StreamingMessageHandler.cs.

Here is the call graph for this function:

◆ Send()

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

Send all types of packets

Implements QuantConnect.Interfaces.IMessagingHandler.

Definition at line 86 of file StreamingMessageHandler.cs.

Here is the call graph for this function:

◆ Transmit()

void QuantConnect.Messaging.StreamingMessageHandler.Transmit ( Packet  packet)

Send a message to the _server using ZeroMQ

Parameters
packetPacket to transmit

Definition at line 95 of file StreamingMessageHandler.cs.

Here is the caller graph for this function:

◆ Dispose()

void QuantConnect.Messaging.StreamingMessageHandler.Dispose ( )

Dispose any resources used before destruction

Definition at line 127 of file StreamingMessageHandler.cs.

Property Documentation

◆ HasSubscribers

bool QuantConnect.Messaging.StreamingMessageHandler.HasSubscribers
getset

Gets or sets whether this messaging handler has any current subscribers. This is not used in this message handler. Messages are sent via tcp as they arrive

Definition at line 45 of file StreamingMessageHandler.cs.


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