Lean  $LEAN_TAG$
QuantConnect.Interfaces.IDataQueueHandler Interface Reference

Task requestor interface with cloud system More...

Inheritance diagram for QuantConnect.Interfaces.IDataQueueHandler:
[legend]

Public Member Functions

IEnumerator< BaseDataSubscribe (SubscriptionDataConfig dataConfig, EventHandler newDataAvailableHandler)
 Subscribe to the specified configuration More...
 
void Unsubscribe (SubscriptionDataConfig dataConfig)
 Removes the specified configuration More...
 
void SetJob (LiveNodePacket job)
 Sets the job we're subscribing for More...
 

Properties

bool IsConnected [get]
 Returns whether the data provider is connected More...
 

Detailed Description

Task requestor interface with cloud system

Definition at line 29 of file IDataQueueHandler.cs.

Member Function Documentation

◆ Subscribe()

IEnumerator<BaseData> QuantConnect.Interfaces.IDataQueueHandler.Subscribe ( SubscriptionDataConfig  dataConfig,
EventHandler  newDataAvailableHandler 
)

Subscribe to the specified configuration

Parameters
dataConfigdefines the parameters to subscribe to a data feed
newDataAvailableHandlerhandler to be fired on new data available
Returns
The new enumerator for this subscription request

Implemented in QuantConnect.Lean.Engine.DataFeeds.Queues.FakeDataQueue, QuantConnect.Lean.Engine.DataFeeds.DataQueueHandlerManager, and QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.

Here is the caller graph for this function:

◆ Unsubscribe()

void QuantConnect.Interfaces.IDataQueueHandler.Unsubscribe ( SubscriptionDataConfig  dataConfig)

Removes the specified configuration

Parameters
dataConfigSubscription config to be removed

Implemented in QuantConnect.Lean.Engine.DataFeeds.DataQueueHandlerManager, QuantConnect.Lean.Engine.DataFeeds.Queues.FakeDataQueue, and QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.

Here is the caller graph for this function:

◆ SetJob()

void QuantConnect.Interfaces.IDataQueueHandler.SetJob ( LiveNodePacket  job)

Sets the job we're subscribing for

Parameters
jobJob we're subscribing for

Implemented in QuantConnect.Lean.Engine.DataFeeds.DataQueueHandlerManager, QuantConnect.Lean.Engine.DataFeeds.Queues.FakeDataQueue, and QuantConnect.Lean.Engine.DataFeeds.Queues.LiveDataQueue.

Here is the caller graph for this function:

Property Documentation

◆ IsConnected

bool QuantConnect.Interfaces.IDataQueueHandler.IsConnected
get

Returns whether the data provider is connected

Returns
True if the data provider is connected

Definition at line 55 of file IDataQueueHandler.cs.


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