summaryrefslogtreecommitdiff
path: root/service/java/com/android/safetycenter/SafetyCenterTimeouts.java
blob: f8bfd691e0a8b06b7c5a293be0834e7717dbc340 (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
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.safetycenter;

import static android.os.Build.VERSION_CODES.TIRAMISU;

import android.os.Handler;

import androidx.annotation.RequiresApi;

import com.android.permission.util.ForegroundThread;

import java.io.PrintWriter;
import java.time.Duration;
import java.util.ArrayDeque;
import java.util.Iterator;

import javax.annotation.concurrent.NotThreadSafe;

/**
 * A class to track timeouts related to Safety Center.
 *
 * <p>This class isn't thread safe. Thread safety must be handled by the caller.
 */
@RequiresApi(TIRAMISU)
@NotThreadSafe
final class SafetyCenterTimeouts {

    /**
     * The maximum number of timeouts we are tracking at a given time. This is to avoid having the
     * {@code mTimeouts} queue grow unbounded. In practice, we should never have more than 1 or 2
     * timeouts in flight.
     */
    private static final int MAX_TRACKED = 10;

    private final ArrayDeque<Runnable> mTimeouts = new ArrayDeque<>(MAX_TRACKED);

    private final Handler mForegroundHandler = ForegroundThread.getHandler();

    SafetyCenterTimeouts() {}

    /** Adds the given {@link Runnable} to run as a timeout after the given {@link Duration}. */
    void add(Runnable timeoutAction, Duration timeoutDuration) {
        if (mTimeouts.size() + 1 >= MAX_TRACKED) {
            remove(mTimeouts.pollFirst());
        }
        mTimeouts.addLast(timeoutAction);
        mForegroundHandler.postDelayed(timeoutAction, timeoutDuration.toMillis());
    }

    /** Removes the given {@link Runnable} to run as a timeout. */
    void remove(Runnable timeoutAction) {
        mTimeouts.remove(timeoutAction);
        mForegroundHandler.removeCallbacks(timeoutAction);
    }

    /** Clears all timeouts. */
    void clear() {
        while (!mTimeouts.isEmpty()) {
            mForegroundHandler.removeCallbacks(mTimeouts.pollFirst());
        }
    }

    /** Dumps state for debugging purposes. */
    void dump(PrintWriter fout) {
        int count = mTimeouts.size();
        fout.println("TIMEOUTS (" + count + ")");
        Iterator<Runnable> it = mTimeouts.iterator();
        int i = 0;
        while (it.hasNext()) {
            fout.println("\t[" + i++ + "] " + it.next());
        }
        fout.println();
    }
}