• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include "InputListener.h"
20 
21 namespace android {
22 
23 /**
24  * Base interface for an InputListener stage.
25  * Blocks unintentional input events. Not thread safe. Must be called from the same
26  * thread. All work is performed on the calling threads.
27  */
28 class UnwantedInteractionBlockerInterface : public InputListenerInterface {
29 public:
30     /* Notifies the input reader policy that some input devices have changed
31      * and provides information about all current input devices.
32      * Important! This call should happen on the same thread as the calls to the
33      * InputListenerInterface methods.
34      * That is, same thread should call 'notifyMotion' and 'notifyInputDevicesChanged' and
35      * 'notifyDeviceReset'. If this architecture changes, we will need to make the implementation
36      * of this interface thread-safe.
37      */
38     virtual void notifyInputDevicesChanged(const std::vector<InputDeviceInfo>& inputDevices) = 0;
39 
40     /**
41      * Dump the state of the interaction blocker.
42      * This method may be called on any thread (usually by the input manager on a binder thread).
43      */
44     virtual void dump(std::string& dump) = 0;
45 
46     /* Called by the heatbeat to ensures that the blocker has not deadlocked. */
47     virtual void monitor() = 0;
48 
UnwantedInteractionBlockerInterface()49     UnwantedInteractionBlockerInterface() {}
~UnwantedInteractionBlockerInterface()50     ~UnwantedInteractionBlockerInterface() override {}
51 };
52 
53 } // namespace android
54