blob: 401f6b450d2a0860f35e8305618cee9fbb91ebf8 [file] [log] [blame]
Davide Pesavento8de8a8b2022-05-12 01:26:43 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2014-2022, Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of NLSR (Named-data Link State Routing).
12 * See AUTHORS.md for complete list of NLSR authors and contributors.
13 *
14 * NLSR is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
26#ifndef NLSR_TESTS_CLOCK_FIXTURE_HPP
27#define NLSR_TESTS_CLOCK_FIXTURE_HPP
28
29#include <ndn-cxx/util/time-unit-test-clock.hpp>
30
31namespace nlsr {
32namespace test {
33
34namespace time = ndn::time;
35
36/** \brief A test fixture that overrides steady clock and system clock.
37 */
38class ClockFixture
39{
40public:
41 virtual
42 ~ClockFixture();
43
44 /** \brief Advance steady and system clocks.
45 *
46 * Clocks are advanced in increments of \p tick for \p nTicks ticks.
47 * afterTick() is called after each tick.
48 *
49 * Exceptions thrown during I/O events are propagated to the caller.
50 * Clock advancement will stop in the event of an exception.
51 */
52 void
53 advanceClocks(time::nanoseconds tick, size_t nTicks = 1)
54 {
55 advanceClocks(tick, tick * nTicks);
56 }
57
58 /** \brief Advance steady and system clocks.
59 *
60 * Clocks are advanced in increments of \p tick for \p total time.
61 * The last increment might be shorter than \p tick.
62 * afterTick() is called after each tick.
63 *
64 * Exceptions thrown during I/O events are propagated to the caller.
65 * Clock advancement will stop in the event of an exception.
66 */
67 void
68 advanceClocks(time::nanoseconds tick, time::nanoseconds total);
69
70protected:
71 ClockFixture();
72
73private:
74 /** \brief Called by advanceClocks() after each clock advancement (tick).
75 *
76 * The base class implementation is a no-op.
77 */
78 virtual void
79 afterTick()
80 {
81 }
82
83protected:
84 std::shared_ptr<time::UnitTestSteadyClock> m_steadyClock;
85 std::shared_ptr<time::UnitTestSystemClock> m_systemClock;
86};
87
88} // namespace test
89} // namespace nlsr
90
91#endif // NLSR_TESTS_CLOCK_FIXTURE_HPP