Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue Class Reference

Live Data Queue is the cut out implementation of how to bind a custom live data source More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue:
[legend]

Public Member Functions

IEnumerator< BaseDataSubscribe (SubscriptionDataConfig dataConfig, EventHandler newDataAvailableHandler)
 Desktop/Local doesn't support live data from this handler More...
 
virtual void Unsubscribe (SubscriptionDataConfig dataConfig)
 Desktop/Local doesn't support live data from this handler More...
 
void SetJob (LiveNodePacket job)
 Sets the job we're subscribing for More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Public Attributes

bool IsConnected => false
 Returns whether the data provider is connected More...
 

Additional Inherited Members

- Properties inherited from QuantConnect.Interfaces.IDataQueueHandler
bool IsConnected [get]
 Returns whether the data provider is connected More...
 

Detailed Description

Live Data Queue is the cut out implementation of how to bind a custom live data source

Definition at line 27 of file DataQueue.cs.

Member Function Documentation

◆ Subscribe()

IEnumerator<BaseData> QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.Subscribe ( SubscriptionDataConfig  dataConfig,
EventHandler  newDataAvailableHandler 
)

Desktop/Local doesn't support live data from this handler

Implements QuantConnect.Interfaces.IDataQueueHandler.

Definition at line 32 of file DataQueue.cs.

◆ Unsubscribe()

virtual void QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.Unsubscribe ( SubscriptionDataConfig  dataConfig)
virtual

Desktop/Local doesn't support live data from this handler

Implements QuantConnect.Interfaces.IDataQueueHandler.

Definition at line 40 of file DataQueue.cs.

◆ SetJob()

void QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.SetJob ( LiveNodePacket  job)

Sets the job we're subscribing for

Parameters
jobJob we're subscribing for

Implements QuantConnect.Interfaces.IDataQueueHandler.

Definition at line 49 of file DataQueue.cs.

◆ Dispose()

void QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 62 of file DataQueue.cs.

Member Data Documentation

◆ IsConnected

bool QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.IsConnected => false

Returns whether the data provider is connected

Returns
true if the data provider is connected

Definition at line 57 of file DataQueue.cs.


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