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
|
/*
* Copyright (C) 2020 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 android.companion;
import android.annotation.MainThread;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.app.Service;
import android.content.Intent;
import android.os.Handler;
import android.os.IBinder;
import android.util.Log;
import com.android.internal.util.function.pooled.PooledLambda;
import java.util.Objects;
/**
* Service to be implemented by apps that manage a companion device.
*
* System will keep this service bound whenever an associated device is nearby,
* ensuring app stays alive.
*
* An app must be {@link CompanionDeviceManager#associate associated} with at leas one device,
* before it can take advantage of this service.
*
* You must declare this service in your manifest with an
* intent-filter action of {@link #SERVICE_INTERFACE} and
* permission of {@link android.Manifest.permission#BIND_COMPANION_DEVICE_SERVICE}
*/
public abstract class CompanionDeviceService extends Service {
private static final String LOG_TAG = "CompanionDeviceService";
/**
* An intent action for a service to be bound whenever this app's companion device(s)
* are nearby.
*
* <p>The app will be kept alive for as long as the device is nearby.
* If the app is not running at the time device gets connected, the app will be woken up.</p>
*
* <p>Shortly after the device goes out of range, the service will be unbound, and the
* app will be eligible for cleanup, unless any other user-visible components are running.</p>
*
* <p>An app shouldn't declare more than one of these services.
* If running in background is not essential for the devices that this app can manage,
* app should avoid declaring this service.</p>
*
* <p>The service must also require permission
* {@link android.Manifest.permission#BIND_COMPANION_DEVICE_SERVICE}</p>
*/
public static final String SERVICE_INTERFACE = "android.companion.CompanionDeviceService";
private final Stub mRemote = new Stub();
/**
* Called by system whenever a device associated with this app is available.
*
* @param address the MAC address of the device
*/
@MainThread
public abstract void onDeviceAppeared(@NonNull String address);
/**
* Called by system whenever a device associated with this app stops being available.
*
* Usually this means the device goes out of range or is turned off.
*
* @param address the MAC address of the device
*/
@MainThread
public abstract void onDeviceDisappeared(@NonNull String address);
@Nullable
@Override
public final IBinder onBind(@NonNull Intent intent) {
if (Objects.equals(intent.getAction(), SERVICE_INTERFACE)) {
return mRemote;
}
Log.w(LOG_TAG,
"Tried to bind to wrong intent (should be " + SERVICE_INTERFACE + "): " + intent);
return null;
}
class Stub extends ICompanionDeviceService.Stub {
@Override
public void onDeviceAppeared(String address) {
Handler.getMain().sendMessage(PooledLambda.obtainMessage(
CompanionDeviceService::onDeviceAppeared,
CompanionDeviceService.this, address));
}
@Override
public void onDeviceDisappeared(String address) {
Handler.getMain().sendMessage(PooledLambda.obtainMessage(
CompanionDeviceService::onDeviceDisappeared,
CompanionDeviceService.this, address));
}
}
}
|
