Lean  $LEAN_TAG$
BaseWorkScheduler.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 
19 namespace QuantConnect.Lean.Engine.DataFeeds.WorkScheduling
20 {
21  /// <summary>
22  /// Base work scheduler abstraction
23  /// </summary>
24  public abstract class WorkScheduler
25  {
26  /// <summary>
27  /// The quantity of workers to be used
28  /// </summary>
29  public static int WorkersCount = Configuration.Config.GetInt("data-feed-workers-count", Environment.ProcessorCount);
30 
31  /// <summary>
32  /// Add a new work item to the queue
33  /// </summary>
34  /// <param name="symbol">The symbol associated with this work</param>
35  /// <param name="workFunc">The work function to run</param>
36  /// <param name="weightFunc">The weight function.
37  /// Work will be sorted in ascending order based on this weight</param>
38  public abstract void QueueWork(Symbol symbol, Func<int, bool> workFunc, Func<int> weightFunc);
39  }
40 }