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     /**
31      * Dump the state of the interaction blocker.
32      * This method may be called on any thread (usually by the input manager on a binder thread).
33      */
34     virtual void dump(std::string& dump) = 0;
35 
36     /* Called by the heartbeat to ensures that the blocker has not deadlocked. */
37     virtual void monitor() = 0;
38 
UnwantedInteractionBlockerInterface()39     UnwantedInteractionBlockerInterface() {}
~UnwantedInteractionBlockerInterface()40     ~UnwantedInteractionBlockerInterface() override {}
41 };
42 
43 } // namespace android
44