blob: cc3722bd6b48d278fb9ede40f856a2080735a43b [file] [log] [blame]
niklase@google.com470e71d2011-07-07 08:21:251/*
2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
kjellanderd56d68c2015-11-02 10:12:4111#ifndef WEBRTC_SYSTEM_WRAPPERS_INCLUDE_EVENT_WRAPPER_H_
12#define WEBRTC_SYSTEM_WRAPPERS_INCLUDE_EVENT_WRAPPER_H_
niklase@google.com470e71d2011-07-07 08:21:2513
14namespace webrtc {
phoglund@webrtc.org5bbe0692012-12-10 10:44:3715enum EventTypeWrapper {
16 kEventSignaled = 1,
17 kEventError = 2,
18 kEventTimeout = 3
niklase@google.com470e71d2011-07-07 08:21:2519};
20
niklase@google.com470e71d2011-07-07 08:21:2521#define WEBRTC_EVENT_INFINITE 0xffffffff
22
Peter Boström64c03662015-04-08 09:24:1923class EventTimerWrapper;
24
phoglund@webrtc.org5bbe0692012-12-10 10:44:3725class EventWrapper {
26 public:
27 // Factory method. Constructor disabled.
28 static EventWrapper* Create();
Peter Boström64c03662015-04-08 09:24:1929
phoglund@webrtc.org5bbe0692012-12-10 10:44:3730 virtual ~EventWrapper() {}
niklase@google.com470e71d2011-07-07 08:21:2531
phoglund@webrtc.org5bbe0692012-12-10 10:44:3732 // Releases threads who are calling Wait() and has started waiting. Please
33 // note that a thread calling Wait() will not start waiting immediately.
34 // assumptions to the contrary is a very common source of issues in
35 // multithreaded programming.
36 // Set is sticky in the sense that it will release at least one thread
37 // either immediately or some time in the future.
38 virtual bool Set() = 0;
niklase@google.com470e71d2011-07-07 08:21:2539
phoglund@webrtc.org5bbe0692012-12-10 10:44:3740 // Puts the calling thread into a wait state. The thread may be released
41 // by a Set() call depending on if other threads are waiting and if so on
Wan-Teh Chang5a8bad62015-05-29 16:41:3842 // timing. The thread that was released will reset the event before leaving
phoglund@webrtc.org5bbe0692012-12-10 10:44:3743 // preventing more threads from being released. If multiple threads
44 // are waiting for the same Set(), only one (random) thread is guaranteed to
45 // be released. It is possible that multiple (random) threads are released
46 // Depending on timing.
Wan-Teh Chang76cda012015-06-02 00:33:4047 //
48 // |max_time| is the maximum time to wait in milliseconds or
49 // WEBRTC_EVENT_INFINITE to wait infinitely.
phoglund@webrtc.org5bbe0692012-12-10 10:44:3750 virtual EventTypeWrapper Wait(unsigned long max_time) = 0;
Peter Boström64c03662015-04-08 09:24:1951};
52
53class EventTimerWrapper : public EventWrapper {
54 public:
55 static EventTimerWrapper* Create();
niklase@google.com470e71d2011-07-07 08:21:2556
phoglund@webrtc.org5bbe0692012-12-10 10:44:3757 // Starts a timer that will call a non-sticky version of Set() either once
58 // or periodically. If the timer is periodic it ensures that there is no
59 // drift over time relative to the system clock.
Wan-Teh Chang76cda012015-06-02 00:33:4060 //
61 // |time| is in milliseconds.
phoglund@webrtc.org5bbe0692012-12-10 10:44:3762 virtual bool StartTimer(bool periodic, unsigned long time) = 0;
niklase@google.com470e71d2011-07-07 08:21:2563
phoglund@webrtc.org5bbe0692012-12-10 10:44:3764 virtual bool StopTimer() = 0;
niklase@google.com470e71d2011-07-07 08:21:2565
niklase@google.com470e71d2011-07-07 08:21:2566};
Peter Boström64c03662015-04-08 09:24:1967
pbos@webrtc.orgd900e8b2013-07-03 15:12:2668} // namespace webrtc
niklase@google.com470e71d2011-07-07 08:21:2569
kjellanderd56d68c2015-11-02 10:12:4170#endif // WEBRTC_SYSTEM_WRAPPERS_INCLUDE_EVENT_WRAPPER_H_