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
|
/*
* Copyright (C) 2017 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.providers.contacts;
import android.os.Handler;
import android.os.HandlerThread;
import android.os.Looper;
import android.os.Message;
import android.util.Log;
import com.android.internal.annotations.VisibleForTesting;
import java.util.concurrent.atomic.AtomicInteger;
import javax.annotation.concurrent.GuardedBy;
/**
* Runs tasks in a worker thread, which is created on-demand and shuts down after a timeout.
*/
public abstract class ContactsTaskScheduler {
private static final String TAG = "ContactsTaskScheduler";
public static final boolean VERBOSE_LOGGING = AbstractContactsProvider.VERBOSE_LOGGING;
private static final int SHUTDOWN_TIMEOUT_SECONDS = 60;
private final AtomicInteger mThreadSequenceNumber = new AtomicInteger();
private final Object mLock = new Object();
/**
* Name of this scheduler for logging.
*/
private final String mName;
@GuardedBy("mLock")
private HandlerThread mThread;
@GuardedBy("mLock")
private MyHandler mHandler;
private final int mShutdownTimeoutSeconds;
public ContactsTaskScheduler(String name) {
this(name, SHUTDOWN_TIMEOUT_SECONDS);
}
/** With explicit timeout seconds, for testing. */
protected ContactsTaskScheduler(String name, int shutdownTimeoutSeconds) {
mName = name;
mShutdownTimeoutSeconds = shutdownTimeoutSeconds;
}
private class MyHandler extends Handler {
public MyHandler(Looper looper) {
super(looper);
}
@Override
public void handleMessage(Message msg) {
if (VERBOSE_LOGGING) {
Log.v(TAG, "[" + mName + "] " + mThread + " dispatching " + msg.what);
}
onPerformTask(msg.what, msg.obj);
}
}
private final Runnable mQuitter = () -> {
synchronized (mLock) {
stopThread(/* joinOnlyForTest=*/ false);
}
};
private boolean isRunning() {
synchronized (mLock) {
return mThread != null;
}
}
/** Schedule a task with no arguments. */
@VisibleForTesting
public void scheduleTask(int taskId) {
scheduleTask(taskId, null);
}
/** Schedule a task with an argument. */
@VisibleForTesting
public void scheduleTask(int taskId, Object arg) {
synchronized (mLock) {
if (!isRunning()) {
mThread = new HandlerThread("Worker-" + mThreadSequenceNumber.incrementAndGet());
mThread.start();
mHandler = new MyHandler(mThread.getLooper());
if (VERBOSE_LOGGING) {
Log.v(TAG, "[" + mName + "] " + mThread + " started.");
}
}
if (arg == null) {
mHandler.sendEmptyMessage(taskId);
} else {
mHandler.sendMessage(mHandler.obtainMessage(taskId, arg));
}
// Schedule thread shutdown.
mHandler.removeCallbacks(mQuitter);
mHandler.postDelayed(mQuitter, mShutdownTimeoutSeconds * 1000);
}
}
public abstract void onPerformTask(int taskId, Object arg);
@VisibleForTesting
public void shutdownForTest() {
stopThread(/* joinOnlyForTest=*/ true);
}
private void stopThread(boolean joinOnlyForTest) {
synchronized (mLock) {
if (VERBOSE_LOGGING) {
Log.v(TAG, "[" + mName + "] " + mThread + " stopping...");
}
if (mThread != null) {
mThread.quit();
if (joinOnlyForTest) {
try {
mThread.join();
} catch (InterruptedException ignore) {
}
}
}
mThread = null;
mHandler = null;
}
}
@VisibleForTesting
public int getThreadSequenceNumber() {
return mThreadSequenceNumber.get();
}
@VisibleForTesting
public boolean isRunningForTest() {
return isRunning();
}
}
|
