/* * Copyright (c) Meta Platforms, Inc. and affiliates. * * 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. */ #pragma once #include <chrono> #include <iosfwd> #include <folly/portability/SysTypes.h> namespace folly { /** * A class for tracking time durations in test code. * * This is primarily useful for testing timeout functionality. When comparing * the differences between two TimePoints, it can exclude time spent waiting on * the OS scheduler. This helps avoid spurious test failures when timeouts are * exceeded by longer than expected simply because the underlying system was * busy and could not schedule this thread in time. */ class TimePoint { … }; std::ostream& operator<<(std::ostream& os, const TimePoint& timePoint); bool checkTimeout( const TimePoint& start, const TimePoint& end, std::chrono::nanoseconds expected, bool allowSmaller, std::chrono::nanoseconds tolerance = std::chrono::milliseconds(5)); } // namespace folly