mirror of
https://github.com/XRPLF/clio.git
synced 2025-12-06 17:27:58 +00:00
36
tests/common/util/WithTimeout.hpp
Normal file
36
tests/common/util/WithTimeout.hpp
Normal file
@@ -0,0 +1,36 @@
|
||||
//------------------------------------------------------------------------------
|
||||
/*
|
||||
This file is part of clio: https://github.com/XRPLF/clio
|
||||
Copyright (c) 2024, the clio developers.
|
||||
|
||||
Permission to use, copy, modify, and distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
//==============================================================================
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <chrono>
|
||||
#include <functional>
|
||||
|
||||
namespace tests::common::util {
|
||||
|
||||
/**
|
||||
* @brief Run a function with a timeout. If the function does not complete within the timeout, the test will fail.
|
||||
*
|
||||
* @param timeout The timeout duration
|
||||
* @param function The function to run
|
||||
*/
|
||||
void
|
||||
withTimeout(std::chrono::steady_clock::duration timeout, std::function<void()> function);
|
||||
|
||||
} // namespace tests::common::util
|
||||
Reference in New Issue
Block a user