Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager Interface Reference

DataFeedSubscriptionManager interface will manage the subscriptions for the Data Feed More...

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

Public Member Functions

bool RemoveSubscription (SubscriptionDataConfig configuration, Universe universe=null)
 Removes the Subscription, if it exists More...
 
bool AddSubscription (SubscriptionRequest request)
 Adds a new Subscription to provide data for the specified security. More...
 

Properties

SubscriptionCollection DataFeedSubscriptions [get]
 Gets the data feed subscription collection More...
 
UniverseSelection UniverseSelection [get]
 Get the universe selection instance More...
 

Events

EventHandler< SubscriptionSubscriptionAdded
 Event fired when a new subscription is added More...
 
EventHandler< SubscriptionSubscriptionRemoved
 Event fired when an existing subscription is removed More...
 

Detailed Description

DataFeedSubscriptionManager interface will manage the subscriptions for the Data Feed

Definition at line 26 of file IDataFeedSubscriptionManager.cs.

Member Function Documentation

◆ RemoveSubscription()

bool QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.RemoveSubscription ( SubscriptionDataConfig  configuration,
Universe  universe = null 
)

Removes the Subscription, if it exists

Parameters
configurationThe SubscriptionDataConfig of the subscription to remove
universeUniverse requesting to remove Subscription. Default value, null, will remove all universes
Returns
True if the subscription was successfully removed, false otherwise

Implemented in QuantConnect.Lean.Engine.DataFeeds.DataManager.

Here is the caller graph for this function:

◆ AddSubscription()

bool QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.AddSubscription ( SubscriptionRequest  request)

Adds a new Subscription to provide data for the specified security.

Parameters
requestDefines the SubscriptionRequest to be added
Returns
True if the subscription was created and added successfully, false otherwise

Implemented in QuantConnect.Lean.Engine.DataFeeds.DataManager.

Here is the caller graph for this function:

Property Documentation

◆ DataFeedSubscriptions

SubscriptionCollection QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.DataFeedSubscriptions
get

Gets the data feed subscription collection

Definition at line 41 of file IDataFeedSubscriptionManager.cs.

◆ UniverseSelection

UniverseSelection QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.UniverseSelection
get

Get the universe selection instance

Definition at line 46 of file IDataFeedSubscriptionManager.cs.

Event Documentation

◆ SubscriptionAdded

EventHandler<Subscription> QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.SubscriptionAdded

Event fired when a new subscription is added

Definition at line 31 of file IDataFeedSubscriptionManager.cs.

◆ SubscriptionRemoved

EventHandler<Subscription> QuantConnect.Lean.Engine.DataFeeds.IDataFeedSubscriptionManager.SubscriptionRemoved

Event fired when an existing subscription is removed

Definition at line 36 of file IDataFeedSubscriptionManager.cs.


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