IMessagingHandler
Bases: IDisposable
Messaging System Plugin Interface. Provides a common messaging pattern between desktop and cloud implementations of QuantConnect.
has_subscribers: bool
Gets or sets whether this messaging handler has any current subscribers. When set to false, messages won't be sent.
initialize(
initialize_parameters: MessagingHandlerInitializeParameters,
) -> None
Initialize the Messaging System Plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
initialize_parameters
|
MessagingHandlerInitializeParameters
|
The parameters required for initialization |
required |
send(packet: Packet) -> None
Send any message with a base type of Packet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
packet
|
Packet
|
Packet of data to send via the messaging system plugin |
required |
send_notification(notification: Notification) -> None
Send any notification with a base type of Notification.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
notification
|
Notification
|
The notification to be sent. |
required |
set_authentication(job: AlgorithmNodePacket) -> None
Set the user communication channel
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job
|
AlgorithmNodePacket
|
The job packet |
required |