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
160
161
162
|
/*
* Copyright 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 android.hardware.location;
import android.annotation.NonNull;
import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.app.PendingIntent;
import android.os.RemoteException;
import com.android.internal.util.Preconditions;
import dalvik.system.CloseGuard;
import java.io.Closeable;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* A class describing a client of the Context Hub Service.
*
* Clients can send messages to nanoapps at a Context Hub through this object. The APIs supported
* by this object are thread-safe and can be used without external synchronization.
*
* @hide
*/
@SystemApi
public class ContextHubClient implements Closeable {
/*
* The proxy to the client interface at the service.
*/
private IContextHubClient mClientProxy = null;
/*
* The Context Hub that this client is attached to.
*/
private final ContextHubInfo mAttachedHub;
private final CloseGuard mCloseGuard;
private final AtomicBoolean mIsClosed = new AtomicBoolean(false);
/*
* True if this is a persistent client (i.e. does not have to close the connection when the
* resource is freed from the system).
*/
private final boolean mPersistent;
/* package */ ContextHubClient(ContextHubInfo hubInfo, boolean persistent) {
mAttachedHub = hubInfo;
mPersistent = persistent;
if (mPersistent) {
mCloseGuard = null;
} else {
mCloseGuard = CloseGuard.get();
mCloseGuard.open("close");
}
}
/**
* Sets the proxy interface of the client at the service. This method should always be called
* by the ContextHubManager after the client is registered at the service, and should only be
* called once.
*
* @param clientProxy the proxy of the client at the service
*/
/* package */ void setClientProxy(IContextHubClient clientProxy) {
Preconditions.checkNotNull(clientProxy, "IContextHubClient cannot be null");
if (mClientProxy != null) {
throw new IllegalStateException("Cannot change client proxy multiple times");
}
mClientProxy = clientProxy;
}
/**
* Returns the hub that this client is attached to.
*
* @return the ContextHubInfo of the attached hub
*/
@NonNull
public ContextHubInfo getAttachedHub() {
return mAttachedHub;
}
/**
* Closes the connection for this client and the Context Hub Service.
*
* When this function is invoked, the messaging associated with this client is invalidated.
* All futures messages targeted for this client are dropped at the service, and the
* ContextHubClient is unregistered from the service.
*
* If this object has a PendingIntent, i.e. the object was generated via
* {@link ContextHubManager.createClient(PendingIntent, ContextHubInfo, long)}, then the
* Intent events corresponding to the PendingIntent will no longer be triggered.
*/
public void close() {
if (!mIsClosed.getAndSet(true)) {
if (mCloseGuard != null) {
mCloseGuard.close();
}
try {
mClientProxy.close();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Sends a message to a nanoapp through the Context Hub Service.
*
* This function returns RESULT_SUCCESS if the message has reached the HAL, but
* does not guarantee delivery of the message to the target nanoapp.
*
* @param message the message object to send
*
* @return the result of sending the message defined as in ContextHubTransaction.Result
*
* @throws NullPointerException if NanoAppMessage is null
*
* @see NanoAppMessage
* @see ContextHubTransaction.Result
*/
@RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE)
@ContextHubTransaction.Result
public int sendMessageToNanoApp(@NonNull NanoAppMessage message) {
Preconditions.checkNotNull(message, "NanoAppMessage cannot be null");
try {
return mClientProxy.sendMessageToNanoApp(message);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
@Override
protected void finalize() throws Throwable {
try {
if (mCloseGuard != null) {
mCloseGuard.warnIfOpen();
}
if (!mPersistent) {
close();
}
} finally {
super.finalize();
}
}
}
|
