rate_limiter.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Roc Streaming authors
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
//! @file roc_core/rate_limiter.h
//! @brief Rate limiter.
 
#ifndef ROC_CORE_RATE_LIMITER_H_
#define ROC_CORE_RATE_LIMITER_H_
 
#include "roc_core/noncopyable.h"
#include "roc_core/ticker.h"
 
namespace roc {
namespace core {
 
//! Rate limiter.
class RateLimiter : public NonCopyable<> {
public:
    //! Initialize rate limiter.
    //! @remarks
    //!  @p period is tick duration in nanoseconds.
    explicit RateLimiter(nanoseconds_t period);
 
    //! Check whether allow() would succeed.
    bool would_allow();
 
    //! Check whether an event is allowed to occur now, and if yes, mark it as occurred.
    bool allow();
 
private:
    const Ticker::ticks_t period_;
    Ticker::ticks_t pos_;
    Ticker ticker_;
};
 
} // namespace core
} // namespace roc
 
#endif // ROC_CORE_RATE_LIMITER_H_