1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*
* Copyright 2019 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef API_TEST_TIME_CONTROLLER_H_
#define API_TEST_TIME_CONTROLLER_H_
#include <functional>
#include <memory>
#include <string>
#include "api/task_queue/task_queue_factory.h"
#include "api/units/time_delta.h"
#include "rtc_base/socket_server.h"
#include "rtc_base/thread.h"
#include "system_wrappers/include/clock.h"
namespace webrtc {
// Interface for controlling time progress. This allows us to execute test code
// in either real time or simulated time by using different implementation of
// this interface.
class TimeController {
public:
virtual ~TimeController() = default;
// Provides a clock instance that follows implementation defined time
// progress.
virtual Clock* GetClock() = 0;
// The returned factory will created task queues that runs in implementation
// defined time domain.
virtual TaskQueueFactory* GetTaskQueueFactory() = 0;
// Simple helper to create an owned factory that can be used as a parameter
// for PeerConnectionFactory. Note that this might depend on the underlying
// time controller and therfore must be destroyed before the time controller
// is destroyed.
std::unique_ptr<TaskQueueFactory> CreateTaskQueueFactory();
// Creates an webrtc::Thread instance. If `socket_server` is nullptr, a
// default noop socket server is created. Returned thread is not null and
// started.
virtual std::unique_ptr<Thread> CreateThread(
const std::string& name,
std::unique_ptr<SocketServer> socket_server = nullptr) = 0;
// Creates an webrtc::Thread instance that ensure that it's set as the current
// thread.
virtual Thread* GetMainThread() = 0;
// Allow task queues and process threads created by this instance to execute
// for the given `duration`.
virtual void AdvanceTime(TimeDelta duration) = 0;
// Waits until condition() == true, polling condition() in small time
// intervals.
// Returns true if condition() was evaluated to true before `max_duration`
// elapsed and false otherwise.
bool Wait(const std::function<bool()>& condition,
TimeDelta max_duration = TimeDelta::Seconds(5));
};
} // namespace webrtc
#endif // API_TEST_TIME_CONTROLLER_H_
|
