blob: 41afbc1cc5f62992f1b15af72f49d6e6cc79fc02 (
plain)
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
// 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 CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_
#define CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_
#include <string>
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "chromeos/chromeos_export.h"
namespace base {
class Thread;
};
namespace dbus {
class Bus;
class ObjectPath;
};
namespace chromeos {
class DBusThreadManagerObserver;
// Style Note: Clients are sorted by names.
class BluetoothAdapterClient;
class BluetoothDeviceClient;
class BluetoothInputClient;
class BluetoothManagerClient;
class BluetoothNodeClient;
class BluetoothOutOfBandClient;
class CrosDisksClient;
class CryptohomeClient;
class DebugDaemonClient;
class GsmSMSClient;
class IBusClient;
class IBusEngineFactoryService;
class IBusEngineService;
class IBusInputContextClient;
class ImageBurnerClient;
class IntrospectableClient;
class ModemMessagingClient;
class PermissionBrokerClient;
class PowerManagerClient;
class RootPowerManagerClient;
class SMSClient;
class SessionManagerClient;
class ShillDeviceClient;
class ShillIPConfigClient;
class ShillManagerClient;
class ShillNetworkClient;
class ShillProfileClient;
class ShillServiceClient;
class SpeechSynthesizerClient;
class UpdateEngineClient;
// TODO(nona): Remove ibus namespace after complete libibus removal.
namespace ibus {
class IBusPanelService;
} // namespace ibus
// DBusThreadManager manages the D-Bus thread, the thread dedicated to
// handling asynchronous D-Bus operations.
//
// This class also manages D-Bus connections and D-Bus clients, which
// depend on the D-Bus thread to ensure the right order of shutdowns for
// the D-Bus thread, the D-Bus connections, and the D-Bus clients.
//
// CALLBACKS IN D-BUS CLIENTS:
//
// D-Bus clients managed by DBusThreadManager are guaranteed to be deleted
// after the D-Bus thread so the clients don't need to worry if new
// incoming messages arrive from the D-Bus thread during shutdown of the
// clients. The UI message loop is not running during the shutdown hence
// the UI message loop won't post tasks to D-BUS clients during the
// shutdown. However, to be extra cautious, clients should use
// WeakPtrFactory when creating callbacks that run on UI thread. See
// session_manager_client.cc for examples.
//
class CHROMEOS_EXPORT DBusThreadManager {
public:
// Sets the global instance. Must be called before any calls to Get().
// We explicitly initialize and shut down the global object, rather than
// making it a Singleton, to ensure clean startup and shutdown.
static void Initialize();
// Similar to Initialize(), but can inject an alternative
// DBusThreadManager such as MockDBusThreadManager for testing.
// The injected object will be owned by the internal pointer and deleted
// by Shutdown().
static void InitializeForTesting(DBusThreadManager* dbus_thread_manager);
// Initialize with stub implementations for tests based on stubs.
static void InitializeWithStub();
// Returns true if DBusThreadManager has been initialized. Call this to
// avoid initializing + shutting down DBusThreadManager more than once.
static bool IsInitialized();
// Destroys the global instance.
static void Shutdown();
// Gets the global instance. Initialize() must be called first.
static DBusThreadManager* Get();
// Adds or removes an observer.
virtual void AddObserver(DBusThreadManagerObserver* observer) = 0;
virtual void RemoveObserver(DBusThreadManagerObserver* observer) = 0;
// Creates new IBusBus instance to communicate with ibus-daemon with specified
// ibus address. Must be called before using ibus related clients.
// TODO(nona): Support shutdown to enable dynamical ibus-daemon shutdown.
virtual void InitIBusBus(const std::string &ibus_address) = 0;
// Returns various D-Bus bus instances, owned by DBusThreadManager.
virtual dbus::Bus* GetSystemBus() = 0;
virtual dbus::Bus* GetIBusBus() = 0;
// All returned objects are owned by DBusThreadManager. Do not cache these
// pointers and use them after DBusThreadManager has been shut down.
virtual BluetoothAdapterClient* GetBluetoothAdapterClient() = 0;
virtual BluetoothDeviceClient* GetBluetoothDeviceClient() = 0;
virtual BluetoothInputClient* GetBluetoothInputClient() = 0;
virtual BluetoothManagerClient* GetBluetoothManagerClient() = 0;
virtual BluetoothNodeClient* GetBluetoothNodeClient() = 0;
virtual BluetoothOutOfBandClient* GetBluetoothOutOfBandClient() = 0;
virtual CrosDisksClient* GetCrosDisksClient() = 0;
virtual CryptohomeClient* GetCryptohomeClient() = 0;
virtual DebugDaemonClient* GetDebugDaemonClient() = 0;
virtual GsmSMSClient* GetGsmSMSClient() = 0;
virtual IBusClient* GetIBusClient() = 0;
virtual IBusEngineFactoryService* GetIBusEngineFactoryService() = 0;
virtual IBusEngineService* GetIBusEngineService(
const dbus::ObjectPath& object_path) = 0;
virtual IBusInputContextClient* GetIBusInputContextClient() = 0;
virtual ibus::IBusPanelService* GetIBusPanelService() = 0;
virtual ImageBurnerClient* GetImageBurnerClient() = 0;
virtual IntrospectableClient* GetIntrospectableClient() = 0;
virtual ModemMessagingClient* GetModemMessagingClient() = 0;
virtual PermissionBrokerClient* GetPermissionBrokerClient() = 0;
virtual PowerManagerClient* GetPowerManagerClient() = 0;
virtual RootPowerManagerClient* GetRootPowerManagerClient() = 0;
virtual SessionManagerClient* GetSessionManagerClient() = 0;
virtual ShillDeviceClient* GetShillDeviceClient() = 0;
virtual ShillIPConfigClient* GetShillIPConfigClient() = 0;
virtual ShillManagerClient* GetShillManagerClient() = 0;
virtual ShillNetworkClient* GetShillNetworkClient() = 0;
virtual ShillProfileClient* GetShillProfileClient() = 0;
virtual ShillServiceClient* GetShillServiceClient() = 0;
virtual SMSClient* GetSMSClient() = 0;
virtual SpeechSynthesizerClient* GetSpeechSynthesizerClient() = 0;
virtual UpdateEngineClient* GetUpdateEngineClient() = 0;
// Removes the ibus engine services for |object_path|.
virtual void RemoveIBusEngineService(const dbus::ObjectPath& object_path) = 0;
virtual ~DBusThreadManager();
protected:
DBusThreadManager();
DISALLOW_COPY_AND_ASSIGN(DBusThreadManager);
};
} // namespace chromeos
#endif // CHROMEOS_DBUS_DBUS_THREAD_MANAGER_H_
|
