1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
// Copyright 2014 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 COMPONENTS_KEYED_SERVICE_CORE_REFCOUNTED_KEYED_SERVICE_H_
#define COMPONENTS_KEYED_SERVICE_CORE_REFCOUNTED_KEYED_SERVICE_H_
#include "base/memory/ref_counted.h"
#include "base/sequenced_task_runner_helpers.h"
#include "base/single_thread_task_runner.h"
#include "components/keyed_service/core/keyed_service_export.h"
class RefcountedKeyedService;
namespace impl {
struct KEYED_SERVICE_EXPORT RefcountedKeyedServiceTraits {
static void Destruct(const RefcountedKeyedService* obj);
};
} // namespace impl
// Base class for refcounted objects that hang off the BrowserContext.
//
// The two pass shutdown described in KeyedService works a bit differently
// because there could be outstanding references on other threads.
// ShutdownOnUIThread() will be called on the UI thread, and then the
// destructor will run when the last reference is dropped, which may or may not
// be after the corresponding BrowserContext has been destroyed.
//
// Optionally, if you initialize your service with the constructor that takes a
// single thread task runner, your service will be deleted on that thread. We
// can't use content::DeleteOnThread<> directly because RefcountedKeyedService
// must not depend on //content.
class KEYED_SERVICE_EXPORT RefcountedKeyedService
: public base::RefCountedThreadSafe<RefcountedKeyedService,
impl::RefcountedKeyedServiceTraits> {
public:
// Unlike KeyedService, ShutdownOnUI is not optional. You must do something
// to drop references during the first pass Shutdown() because this is the
// only point where you are guaranteed that something is running on the UI
// thread. The PKSF framework will ensure that this is only called on the UI
// thread; you do not need to check for that yourself.
virtual void ShutdownOnUIThread() = 0;
protected:
// If your service does not need to be deleted on a specific thread, use the
// default constructor.
RefcountedKeyedService();
// If you need your service to be deleted on a specific thread (for example,
// you're converting a service that used content::DeleteOnThread<IO>), then
// use this constructor with a reference to the SingleThreadTaskRunner (you
// can get it from content::BrowserThread::GetMessageLoopProxyForThread).
explicit RefcountedKeyedService(
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
// The second pass destruction can happen anywhere unless you specify which
// thread this service must be destroyed on by using the second constructor.
virtual ~RefcountedKeyedService();
private:
friend struct impl::RefcountedKeyedServiceTraits;
friend class base::DeleteHelper<RefcountedKeyedService>;
friend class base::RefCountedThreadSafe<RefcountedKeyedService,
impl::RefcountedKeyedServiceTraits>;
// Do we have to delete this object on a specific thread?
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
};
#endif // COMPONENTS_KEYED_SERVICE_CORE_REFCOUNTED_KEYED_SERVICE_H_
|
