Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 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 | package android.net.util; |
| 18 | |
| 19 | import android.content.BroadcastReceiver; |
| 20 | import android.content.Context; |
| 21 | import android.content.Intent; |
| 22 | import android.content.IntentFilter; |
| 23 | import android.os.Handler; |
| 24 | import android.util.Log; |
| 25 | |
| 26 | import java.util.concurrent.atomic.AtomicInteger; |
| 27 | import java.util.function.Consumer; |
| 28 | |
| 29 | |
| 30 | /** |
| 31 | * A utility class that runs the provided callback on the provided handler when |
| 32 | * intents matching the provided filter arrive. Intents received by a stale |
| 33 | * receiver are safely ignored. |
| 34 | * |
| 35 | * Calls to startListening() and stopListening() must happen on the same thread. |
| 36 | * |
| 37 | * @hide |
| 38 | */ |
| 39 | public class VersionedBroadcastListener { |
| 40 | private static final boolean DBG = false; |
| 41 | |
Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 42 | private final String mTag; |
| 43 | private final Context mContext; |
| 44 | private final Handler mHandler; |
| 45 | private final IntentFilter mFilter; |
| 46 | private final Consumer<Intent> mCallback; |
| 47 | private final AtomicInteger mGenerationNumber; |
| 48 | private BroadcastReceiver mReceiver; |
| 49 | |
| 50 | public VersionedBroadcastListener(String tag, Context ctx, Handler handler, |
| 51 | IntentFilter filter, Consumer<Intent> callback) { |
| 52 | mTag = tag; |
| 53 | mContext = ctx; |
| 54 | mHandler = handler; |
| 55 | mFilter = filter; |
| 56 | mCallback = callback; |
| 57 | mGenerationNumber = new AtomicInteger(0); |
| 58 | } |
| 59 | |
markchien | 0df2ebc4 | 2019-09-30 14:40:57 +0800 | [diff] [blame] | 60 | /** Start listening to intent broadcast. */ |
Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 61 | public void startListening() { |
| 62 | if (DBG) Log.d(mTag, "startListening"); |
| 63 | if (mReceiver != null) return; |
| 64 | |
| 65 | mReceiver = new Receiver(mTag, mGenerationNumber, mCallback); |
| 66 | mContext.registerReceiver(mReceiver, mFilter, null, mHandler); |
| 67 | } |
| 68 | |
markchien | 0df2ebc4 | 2019-09-30 14:40:57 +0800 | [diff] [blame] | 69 | /** Stop listening to intent broadcast. */ |
Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 70 | public void stopListening() { |
| 71 | if (DBG) Log.d(mTag, "stopListening"); |
| 72 | if (mReceiver == null) return; |
| 73 | |
| 74 | mGenerationNumber.incrementAndGet(); |
| 75 | mContext.unregisterReceiver(mReceiver); |
| 76 | mReceiver = null; |
| 77 | } |
| 78 | |
| 79 | private static class Receiver extends BroadcastReceiver { |
| 80 | public final String tag; |
| 81 | public final AtomicInteger atomicGenerationNumber; |
| 82 | public final Consumer<Intent> callback; |
| 83 | // Used to verify this receiver is still current. |
| 84 | public final int generationNumber; |
| 85 | |
markchien | 0df2ebc4 | 2019-09-30 14:40:57 +0800 | [diff] [blame] | 86 | Receiver(String tag, AtomicInteger atomicGenerationNumber, Consumer<Intent> callback) { |
Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 87 | this.tag = tag; |
| 88 | this.atomicGenerationNumber = atomicGenerationNumber; |
| 89 | this.callback = callback; |
| 90 | generationNumber = atomicGenerationNumber.incrementAndGet(); |
| 91 | } |
| 92 | |
| 93 | @Override |
| 94 | public void onReceive(Context context, Intent intent) { |
| 95 | final int currentGenerationNumber = atomicGenerationNumber.get(); |
| 96 | |
| 97 | if (DBG) { |
markchien | 0df2ebc4 | 2019-09-30 14:40:57 +0800 | [diff] [blame] | 98 | Log.d(tag, "receiver generationNumber=" + generationNumber |
| 99 | + ", current generationNumber=" + currentGenerationNumber); |
Erik Kline | de63772 | 2017-10-12 22:16:01 +0900 | [diff] [blame] | 100 | } |
| 101 | if (generationNumber != currentGenerationNumber) return; |
| 102 | |
| 103 | callback.accept(intent); |
| 104 | } |
| 105 | } |
| 106 | } |