Program Listing for File RateLimiter.hpp
↰ Return to documentation for file (include/rmf_utils/RateLimiter.hpp
)
/*
* Copyright (C) 2021 Open Source Robotics Foundation
*
* 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.
*
*/
#ifndef RMF_UTILS__RATELIMITER_HPP
#define RMF_UTILS__RATELIMITER_HPP
#include <chrono>
#include <rmf_utils/impl_ptr.hpp>
namespace rmf_utils {
//==============================================================================
class RateLimiter
{
public:
RateLimiter(
std::chrono::steady_clock::duration period_limit_,
std::size_t count_limit_);
bool reached_limit() const;
std::chrono::steady_clock::duration period_limit() const;
RateLimiter& period_limit(std::chrono::steady_clock::duration new_limit);
std::size_t count_limit() const;
RateLimiter& count_limit(std::size_t new_limit);
class Implementation;
private:
rmf_utils::impl_ptr<Implementation> _pimpl;
};
} // namespace rmf_utils
#endif // RMF_UTILS__RATELIMITER_HPP