Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(118)

Unified Diff: mojo/public/cpp/system/watcher.h

Issue 1759783003: [mojo-bindings] Use Watch API instead of MessagePumpMojo (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: fix components_unittests EDK deps Created 4 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « mojo/public/cpp/system/tests/watcher_unittest.cc ('k') | mojo/public/cpp/system/watcher.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: mojo/public/cpp/system/watcher.h
diff --git a/mojo/public/cpp/system/watcher.h b/mojo/public/cpp/system/watcher.h
new file mode 100644
index 0000000000000000000000000000000000000000..cd068aad0b4a6adec6331980aab7dbebc14497d0
--- /dev/null
+++ b/mojo/public/cpp/system/watcher.h
@@ -0,0 +1,117 @@
+// Copyright 2016 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.
+
+#ifndef MOJO_PUBLIC_CPP_SYSTEM_WATCHER_H_
+#define MOJO_PUBLIC_CPP_SYSTEM_WATCHER_H_
+
+#include "base/callback.h"
+#include "base/macros.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/single_thread_task_runner.h"
+#include "base/threading/thread_checker.h"
+#include "mojo/public/c/system/types.h"
+#include "mojo/public/cpp/system/handle.h"
+
+namespace mojo {
+
+// A Watcher watches a single Mojo handle for signal state changes.
+//
+// NOTE: Watchers may only be used on threads which have a running MessageLoop.
+class Watcher {
+ public:
+ // A callback to be called any time a watched handle changes state in some
+ // interesting way. The |result| argument indicates one of the following
+ // conditions depending on its value:
+ //
+ // |MOJO_RESULT_OK|: One or more of the signals being watched is satisfied.
+ //
+ // |MOJO_RESULT_FAILED_PRECONDITION|: None of the signals being watched can
+ // ever be satisfied again.
+ //
+ // |MOJO_RESULT_CANCELLED|: The handle has been closed and the watch has
+ // been cancelled implicitly.
+ //
+ // |MOJO_RESULT_ABORTED|: Notifications can no longer be delivered for this
+ // watcher for some unspecified reason, e.g., the watching thread may
+ // be shutting down soon. Note that it is still necessary to explicitly
+ // Cancel() the watch in this case.
+ using ReadyCallback = base::Callback<void(MojoResult result)>;
+
+ // TODO(rockot/yzshen): Support giving Watcher an explicit TaskRunner for
+ // more fine-grained control over dispatch behavior.
+ Watcher();
+
+ // NOTE: This destructor automatically calls |Cancel()| if the Watcher is
+ // still active.
+ ~Watcher();
+
+ // Indicates if the Watcher is currently watching a handle.
+ bool IsWatching() const;
+
+ // Starts watching |handle|. A Watcher may only watch one handle at a time,
+ // but it is safe to call this more than once as long as the previous watch
+ // has been cancelled (i.e. |is_watching()| returns |false|.)
+ //
+ // If no signals in |signals| can ever be satisfied for |handle|, this returns
+ // |MOJO_RESULT_FAILED_PRECONDITION|.
+ //
+ // If |handle| is not a valid watchable (message or data pipe) handle, this
+ // returns |MOJO_RESULT_INVALID_ARGUMENT|.
+ //
+ // Otherwise |MOJO_RESULT_OK| is returned and the handle will be watched until
+ // closure or cancellation.
+ //
+ // Once the watch is started, |callback| may be called at any time on the
+ // current thread until |Cancel()| is called or the handle is closed.
+ //
+ // Destroying the Watcher implicitly calls |Cancel()|.
+ MojoResult Start(Handle handle,
+ MojoHandleSignals signals,
+ const ReadyCallback& callback);
+
+ // Cancels the current watch. Once this returns, the callback previously
+ // passed to |Start()| will never be called again for this Watcher.
+ void Cancel();
+
+ private:
+ class MessageLoopObserver;
+ friend class MessageLoopObserver;
+
+ void OnHandleReady(MojoResult result);
+
+ static void CallOnHandleReady(uintptr_t context,
+ MojoResult result,
+ MojoHandleSignalsState signals_state);
+
+ base::ThreadChecker thread_checker_;
+
+ // The TaskRunner of this Watcher's owning thread. This field is safe to
+ // access from any thread.
+ const scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
+
+ scoped_ptr<MessageLoopObserver> message_loop_observer_;
+
+ // A persistent weak reference to this Watcher which can be passed to the
+ // Dispatcher any time this object should be signalled. Safe to access (but
+ // not to dereference!) from any thread.
+ base::WeakPtr<Watcher> weak_self_;
+
+ // Fields below must only be accessed on the Watcher's owning thread.
+
+ // The handle currently under watch. Not owned.
+ Handle handle_;
+
+ // The callback to call when the handle is signaled.
+ ReadyCallback callback_;
+
+ base::WeakPtrFactory<Watcher> weak_factory_;
+
+ DISALLOW_COPY_AND_ASSIGN(Watcher);
+};
+
+} // namespace mojo
+
+#endif // MOJO_PUBLIC_CPP_SYSTEM_WATCHER_H_
« no previous file with comments | « mojo/public/cpp/system/tests/watcher_unittest.cc ('k') | mojo/public/cpp/system/watcher.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698