From 76cda01ae214c904edde470bbc560e7f224e27a4 Mon Sep 17 00:00:00 2001 From: Wan-Teh Chang Date: Mon, 1 Jun 2015 17:33:40 -0700 Subject: [PATCH] Document the time unit in EventWrapper. R=henrika@webrtc.org, phoglund@webrtc.org, tommi@webrtc.org BUG=none TEST=none Review URL: https://webrtc-codereview.appspot.com/51139004 Cr-Commit-Position: refs/heads/master@{#9349} --- webrtc/system_wrappers/interface/event_wrapper.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/webrtc/system_wrappers/interface/event_wrapper.h b/webrtc/system_wrappers/interface/event_wrapper.h index 7d9e47c16..bd12eef90 100644 --- a/webrtc/system_wrappers/interface/event_wrapper.h +++ b/webrtc/system_wrappers/interface/event_wrapper.h @@ -44,6 +44,9 @@ class EventWrapper { // are waiting for the same Set(), only one (random) thread is guaranteed to // be released. It is possible that multiple (random) threads are released // Depending on timing. + // + // |max_time| is the maximum time to wait in milliseconds or + // WEBRTC_EVENT_INFINITE to wait infinitely. virtual EventTypeWrapper Wait(unsigned long max_time) = 0; }; @@ -54,6 +57,8 @@ class EventTimerWrapper : public EventWrapper { // Starts a timer that will call a non-sticky version of Set() either once // or periodically. If the timer is periodic it ensures that there is no // drift over time relative to the system clock. + // + // |time| is in milliseconds. virtual bool StartTimer(bool periodic, unsigned long time) = 0; virtual bool StopTimer() = 0;