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

Unified Diff: base/observer_list_threadsafe.h

Issue 1647803004: Move base to DEPS (Closed) Base URL: git@github.com:domokit/mojo.git@master
Patch Set: Created 4 years, 11 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 | « base/observer_list.h ('k') | base/observer_list_unittest.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: base/observer_list_threadsafe.h
diff --git a/base/observer_list_threadsafe.h b/base/observer_list_threadsafe.h
deleted file mode 100644
index b9b4a624ca815da9efdf4d72423516b03f4637b6..0000000000000000000000000000000000000000
--- a/base/observer_list_threadsafe.h
+++ /dev/null
@@ -1,273 +0,0 @@
-// 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.
-
-#ifndef BASE_OBSERVER_LIST_THREADSAFE_H_
-#define BASE_OBSERVER_LIST_THREADSAFE_H_
-
-#include <algorithm>
-#include <map>
-
-#include "base/basictypes.h"
-#include "base/bind.h"
-#include "base/location.h"
-#include "base/logging.h"
-#include "base/memory/ref_counted.h"
-#include "base/message_loop/message_loop.h"
-#include "base/observer_list.h"
-#include "base/single_thread_task_runner.h"
-#include "base/stl_util.h"
-#include "base/thread_task_runner_handle.h"
-#include "base/threading/platform_thread.h"
-
-///////////////////////////////////////////////////////////////////////////////
-//
-// OVERVIEW:
-//
-// A thread-safe container for a list of observers.
-// This is similar to the observer_list (see observer_list.h), but it
-// is more robust for multi-threaded situations.
-//
-// The following use cases are supported:
-// * Observers can register for notifications from any thread.
-// Callbacks to the observer will occur on the same thread where
-// the observer initially called AddObserver() from.
-// * Any thread may trigger a notification via Notify().
-// * Observers can remove themselves from the observer list inside
-// of a callback.
-// * If one thread is notifying observers concurrently with an observer
-// removing itself from the observer list, the notifications will
-// be silently dropped.
-//
-// The drawback of the threadsafe observer list is that notifications
-// are not as real-time as the non-threadsafe version of this class.
-// Notifications will always be done via PostTask() to another thread,
-// whereas with the non-thread-safe observer_list, notifications happen
-// synchronously and immediately.
-//
-// IMPLEMENTATION NOTES
-// The ObserverListThreadSafe maintains an ObserverList for each thread
-// which uses the ThreadSafeObserver. When Notifying the observers,
-// we simply call PostTask to each registered thread, and then each thread
-// will notify its regular ObserverList.
-//
-///////////////////////////////////////////////////////////////////////////////
-
-namespace base {
-
-// Forward declaration for ObserverListThreadSafeTraits.
-template <class ObserverType>
-class ObserverListThreadSafe;
-
-namespace internal {
-
-// An UnboundMethod is a wrapper for a method where the actual object is
-// provided at Run dispatch time.
-template <class T, class Method, class Params>
-class UnboundMethod {
- public:
- UnboundMethod(Method m, const Params& p) : m_(m), p_(p) {
- COMPILE_ASSERT(
- (internal::ParamsUseScopedRefptrCorrectly<Params>::value),
- badunboundmethodparams);
- }
- void Run(T* obj) const {
- DispatchToMethod(obj, m_, p_);
- }
- private:
- Method m_;
- Params p_;
-};
-
-} // namespace internal
-
-// This class is used to work around VS2005 not accepting:
-//
-// friend class
-// base::RefCountedThreadSafe<ObserverListThreadSafe<ObserverType>>;
-//
-// Instead of friending the class, we could friend the actual function
-// which calls delete. However, this ends up being
-// RefCountedThreadSafe::DeleteInternal(), which is private. So we
-// define our own templated traits class so we can friend it.
-template <class T>
-struct ObserverListThreadSafeTraits {
- static void Destruct(const ObserverListThreadSafe<T>* x) {
- delete x;
- }
-};
-
-template <class ObserverType>
-class ObserverListThreadSafe
- : public RefCountedThreadSafe<
- ObserverListThreadSafe<ObserverType>,
- ObserverListThreadSafeTraits<ObserverType>> {
- public:
- typedef typename ObserverList<ObserverType>::NotificationType
- NotificationType;
-
- ObserverListThreadSafe()
- : type_(ObserverListBase<ObserverType>::NOTIFY_ALL) {}
- explicit ObserverListThreadSafe(NotificationType type) : type_(type) {}
-
- // Add an observer to the list. An observer should not be added to
- // the same list more than once.
- void AddObserver(ObserverType* obs) {
- // If there is not a current MessageLoop, it is impossible to notify on it,
- // so do not add the observer.
- if (!MessageLoop::current())
- return;
-
- ObserverList<ObserverType>* list = nullptr;
- PlatformThreadId thread_id = PlatformThread::CurrentId();
- {
- AutoLock lock(list_lock_);
- if (observer_lists_.find(thread_id) == observer_lists_.end())
- observer_lists_[thread_id] = new ObserverListContext(type_);
- list = &(observer_lists_[thread_id]->list);
- }
- list->AddObserver(obs);
- }
-
- // Remove an observer from the list if it is in the list.
- // If there are pending notifications in-transit to the observer, they will
- // be aborted.
- // If the observer to be removed is in the list, RemoveObserver MUST
- // be called from the same thread which called AddObserver.
- void RemoveObserver(ObserverType* obs) {
- ObserverListContext* context = nullptr;
- ObserverList<ObserverType>* list = nullptr;
- PlatformThreadId thread_id = PlatformThread::CurrentId();
- {
- AutoLock lock(list_lock_);
- typename ObserversListMap::iterator it = observer_lists_.find(thread_id);
- if (it == observer_lists_.end()) {
- // This will happen if we try to remove an observer on a thread
- // we never added an observer for.
- return;
- }
- context = it->second;
- list = &context->list;
-
- // If we're about to remove the last observer from the list,
- // then we can remove this observer_list entirely.
- if (list->HasObserver(obs) && list->size() == 1)
- observer_lists_.erase(it);
- }
- list->RemoveObserver(obs);
-
- // If RemoveObserver is called from a notification, the size will be
- // nonzero. Instead of deleting here, the NotifyWrapper will delete
- // when it finishes iterating.
- if (list->size() == 0)
- delete context;
- }
-
- // Verifies that the list is currently empty (i.e. there are no observers).
- void AssertEmpty() const {
- AutoLock lock(list_lock_);
- DCHECK(observer_lists_.empty());
- }
-
- // Notify methods.
- // Make a thread-safe callback to each Observer in the list.
- // Note, these calls are effectively asynchronous. You cannot assume
- // that at the completion of the Notify call that all Observers have
- // been Notified. The notification may still be pending delivery.
- template <class Method, class... Params>
- void Notify(const tracked_objects::Location& from_here,
- Method m,
- const Params&... params) {
- internal::UnboundMethod<ObserverType, Method, Tuple<Params...>> method(
- m, MakeTuple(params...));
-
- AutoLock lock(list_lock_);
- for (const auto& entry : observer_lists_) {
- ObserverListContext* context = entry.second;
- context->task_runner->PostTask(
- from_here,
- Bind(&ObserverListThreadSafe<ObserverType>::template NotifyWrapper<
- Method, Tuple<Params...>>,
- this, context, method));
- }
- }
-
- private:
- // See comment above ObserverListThreadSafeTraits' definition.
- friend struct ObserverListThreadSafeTraits<ObserverType>;
-
- struct ObserverListContext {
- explicit ObserverListContext(NotificationType type)
- : task_runner(ThreadTaskRunnerHandle::Get()), list(type) {}
-
- scoped_refptr<SingleThreadTaskRunner> task_runner;
- ObserverList<ObserverType> list;
-
- private:
- DISALLOW_COPY_AND_ASSIGN(ObserverListContext);
- };
-
- ~ObserverListThreadSafe() {
- STLDeleteValues(&observer_lists_);
- }
-
- // Wrapper which is called to fire the notifications for each thread's
- // ObserverList. This function MUST be called on the thread which owns
- // the unsafe ObserverList.
- template <class Method, class Params>
- void NotifyWrapper(
- ObserverListContext* context,
- const internal::UnboundMethod<ObserverType, Method, Params>& method) {
- // Check that this list still needs notifications.
- {
- AutoLock lock(list_lock_);
- typename ObserversListMap::iterator it =
- observer_lists_.find(PlatformThread::CurrentId());
-
- // The ObserverList could have been removed already. In fact, it could
- // have been removed and then re-added! If the master list's loop
- // does not match this one, then we do not need to finish this
- // notification.
- if (it == observer_lists_.end() || it->second != context)
- return;
- }
-
- {
- typename ObserverList<ObserverType>::Iterator it(&context->list);
- ObserverType* obs;
- while ((obs = it.GetNext()) != nullptr)
- method.Run(obs);
- }
-
- // If there are no more observers on the list, we can now delete it.
- if (context->list.size() == 0) {
- {
- AutoLock lock(list_lock_);
- // Remove |list| if it's not already removed.
- // This can happen if multiple observers got removed in a notification.
- // See http://crbug.com/55725.
- typename ObserversListMap::iterator it =
- observer_lists_.find(PlatformThread::CurrentId());
- if (it != observer_lists_.end() && it->second == context)
- observer_lists_.erase(it);
- }
- delete context;
- }
- }
-
- // Key by PlatformThreadId because in tests, clients can attempt to remove
- // observers without a MessageLoop. If this were keyed by MessageLoop, that
- // operation would be silently ignored, leaving garbage in the ObserverList.
- typedef std::map<PlatformThreadId, ObserverListContext*>
- ObserversListMap;
-
- mutable Lock list_lock_; // Protects the observer_lists_.
- ObserversListMap observer_lists_;
- const NotificationType type_;
-
- DISALLOW_COPY_AND_ASSIGN(ObserverListThreadSafe);
-};
-
-} // namespace base
-
-#endif // BASE_OBSERVER_LIST_THREADSAFE_H_
« no previous file with comments | « base/observer_list.h ('k') | base/observer_list_unittest.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698