Lean  $LEAN_TAG$
IDataFeedSubscriptionManager.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 using System;
18 using QuantConnect.Data;
20 
22 {
23  /// <summary>
24  /// DataFeedSubscriptionManager interface will manage the subscriptions for the Data Feed
25  /// </summary>
27  {
28  /// <summary>
29  /// Event fired when a new subscription is added
30  /// </summary>
31  event EventHandler<Subscription> SubscriptionAdded;
32 
33  /// <summary>
34  /// Event fired when an existing subscription is removed
35  /// </summary>
36  event EventHandler<Subscription> SubscriptionRemoved;
37 
38  /// <summary>
39  /// Gets the data feed subscription collection
40  /// </summary>
42 
43  /// <summary>
44  /// Get the universe selection instance
45  /// </summary>
47 
48  /// <summary>
49  /// Removes the <see cref="Subscription"/>, if it exists
50  /// </summary>
51  /// <param name="configuration">The <see cref="SubscriptionDataConfig"/> of the subscription to remove</param>
52  /// <param name="universe">Universe requesting to remove <see cref="Subscription"/>.
53  /// Default value, null, will remove all universes</param>
54  /// <returns>True if the subscription was successfully removed, false otherwise</returns>
55  bool RemoveSubscription(SubscriptionDataConfig configuration, Universe universe = null);
56 
57  /// <summary>
58  /// Adds a new <see cref="Subscription"/> to provide data for the specified security.
59  /// </summary>
60  /// <param name="request">Defines the <see cref="SubscriptionRequest"/> to be added</param>
61  /// <returns>True if the subscription was created and added successfully, false otherwise</returns>
63  }
64 }