blob: 51728e3bca79776289a6dccab41569fed233aadd [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/base_export.h"
#include "base/macros.h"
#include "base/sequenced_task_runner.h"
#include "build/build_config.h"
#if defined(OS_WIN)
#include "base/win/object_watcher.h"
#include "base/win/scoped_handle.h"
#elif defined(OS_MACOSX)
#include <dispatch/dispatch.h>
#include "base/mac/scoped_dispatch_object.h"
#include "base/memory/weak_ptr.h"
#include "base/synchronization/waitable_event.h"
#include "base/sequence_checker.h"
#include "base/synchronization/waitable_event.h"
#if !defined(OS_WIN)
#include "base/callback.h"
namespace base {
class Flag;
class AsyncWaiter;
class WaitableEvent;
// This class provides a way to wait on a WaitableEvent asynchronously.
// Each instance of this object can be waiting on a single WaitableEvent. When
// the waitable event is signaled, a callback is invoked on the sequence that
// called StartWatching(). This callback can be deleted by deleting the waiter.
// Typical usage:
// class MyClass {
// public:
// void DoStuffWhenSignaled(WaitableEvent *waitable_event) {
// watcher_.StartWatching(waitable_event,
// base::BindOnce(&MyClass::OnWaitableEventSignaled, this);
// }
// private:
// void OnWaitableEventSignaled(WaitableEvent* waitable_event) {
// // OK, time to do stuff!
// }
// base::WaitableEventWatcher watcher_;
// };
// In the above example, MyClass wants to "do stuff" when waitable_event
// becomes signaled. WaitableEventWatcher makes this task easy. When MyClass
// goes out of scope, the watcher_ will be destroyed, and there is no need to
// worry about OnWaitableEventSignaled being called on a deleted MyClass
// pointer.
// BEWARE: With automatically reset WaitableEvents, a signal may be lost if it
// occurs just before a WaitableEventWatcher is deleted. There is currently no
// safe way to stop watching an automatic reset WaitableEvent without possibly
// missing a signal.
// NOTE: you /are/ allowed to delete the WaitableEvent while still waiting on
// it with a Watcher. But pay attention: if the event was signaled and deleted
// right after, the callback may be called with deleted WaitableEvent pointer.
class BASE_EXPORT WaitableEventWatcher
#if defined(OS_WIN)
: public win::ObjectWatcher::Delegate
using EventCallback = OnceCallback<void(WaitableEvent*)>;
#if defined(OS_WIN)
~WaitableEventWatcher() override;
// When |event| is signaled, |callback| is called on the sequence that called
// StartWatching().
// |task_runner| is used for asynchronous executions of calling |callback|.
bool StartWatching(WaitableEvent* event,
EventCallback callback,
scoped_refptr<SequencedTaskRunner> task_runner);
// Cancel the current watch. Must be called from the same sequence which
// started the watch.
// Does nothing if no event is being watched, nor if the watch has completed.
// The callback will *not* be called for the current watch after this
// function returns. Since the callback runs on the same sequence as this
// function, it cannot be called during this function either.
void StopWatching();
#if defined(OS_WIN)
void OnObjectSignaled(HANDLE h) override;
// Duplicated handle of the event passed to StartWatching().
win::ScopedHandle duplicated_event_handle_;
// A watcher for |duplicated_event_handle_|. The handle MUST outlive
// |watcher_|.
win::ObjectWatcher watcher_;
EventCallback callback_;
WaitableEvent* event_ = nullptr;
#elif defined(OS_MACOSX)
// Invokes the callback and resets the source. Must be called on the task
// runner on which StartWatching() was called.
void InvokeCallback();
// Closure bound to the event being watched. This will be is_null() if
// nothing is being watched.
OnceClosure callback_;
// A reference to the receive right that is kept alive while a watcher
// is waiting. Null if no event is being watched.
scoped_refptr<WaitableEvent::ReceiveRight> receive_right_;
// A TYPE_MACH_RECV dispatch source on |receive_right_|. When a receive event
// is delivered, the message queue will be peeked and the bound |callback_|
// may be run. This will be null if nothing is currently being watched.
ScopedDispatchObject<dispatch_source_t> source_;
// Used to vend a weak pointer for calling InvokeCallback() from the
// |source_| event handler.
WeakPtrFactory<WaitableEventWatcher> weak_ptr_factory_;
// Instantiated in StartWatching(). Set before the callback runs. Reset in
// StopWatching() or StartWatching().
scoped_refptr<Flag> cancel_flag_;
// Enqueued in the wait list of the watched WaitableEvent.
AsyncWaiter* waiter_ = nullptr;
// Kernel of the watched WaitableEvent.
scoped_refptr<WaitableEvent::WaitableEventKernel> kernel_;
// Ensures that StartWatching() and StopWatching() are called on the same
// sequence.
SequenceChecker sequence_checker_;
} // namespace base