IRefillStrategy.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
 
namespace QuantConnect.Util.RateLimit
{
    /// <summary>
    /// Provides a strategy for making tokens available for consumption in the <see cref="ITokenBucket"/>
    /// </summary>
    public interface IRefillStrategy
    {
        /// <summary>
        /// Computes the number of new tokens made available, typically via the passing of time.
        /// </summary>
        long Refill();
    }
}