Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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 | package android.hardware.location; |
| 17 | |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 18 | import android.annotation.Nullable; |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 19 | import android.annotation.RequiresPermission; |
| 20 | import android.annotation.SuppressLint; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 21 | import android.annotation.SystemApi; |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 22 | import android.annotation.SystemService; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 23 | import android.content.Context; |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 24 | import android.os.Handler; |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 25 | import android.os.Looper; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 26 | import android.os.RemoteException; |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 27 | import android.os.ServiceManager; |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 28 | import android.os.ServiceManager.ServiceNotFoundException; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 29 | import android.util.Log; |
| 30 | |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 31 | import java.util.List; |
| 32 | |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 33 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 34 | * A class that exposes the Context hubs on a device to applications. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 35 | * |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 36 | * Please note that this class is not expected to be used by unbundled applications. Also, calling |
| 37 | * applications are expected to have LOCATION_HARDWARE permissions to use this class. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 38 | * |
| 39 | * @hide |
| 40 | */ |
| 41 | @SystemApi |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 42 | @SystemService(Context.CONTEXTHUB_SERVICE) |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 43 | public final class ContextHubManager { |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 44 | private static final String TAG = "ContextHubManager"; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 45 | |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 46 | private final Looper mMainLooper; |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 47 | private final IContextHubService mService; |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 48 | private Callback mCallback; |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 49 | private Handler mCallbackHandler; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 50 | |
| 51 | /** |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 52 | * @deprecated Use {@code mCallback} instead. |
| 53 | */ |
| 54 | @Deprecated |
| 55 | private ICallback mLocalCallback; |
| 56 | |
| 57 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 58 | * An interface to receive asynchronous communication from the context hub. |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 59 | */ |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 60 | public abstract static class Callback { |
| 61 | protected Callback() {} |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 62 | |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 63 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 64 | * Callback function called on message receipt from context hub. |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 65 | * |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 66 | * @param hubHandle Handle (system-wide unique identifier) of the hub of the message. |
Ashutosh Joshi | b741e3b | 2016-03-29 09:19:56 -0700 | [diff] [blame] | 67 | * @param nanoAppHandle Handle (unique identifier) for app instance that sent the message. |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 68 | * @param message The context hub message. |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 69 | * |
| 70 | * @see ContextHubMessage |
| 71 | */ |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 72 | public abstract void onMessageReceipt( |
| 73 | int hubHandle, |
| 74 | int nanoAppHandle, |
| 75 | ContextHubMessage message); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 76 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 77 | |
| 78 | /** |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 79 | * @deprecated Use {@link Callback} instead. |
| 80 | * @hide |
| 81 | */ |
| 82 | @Deprecated |
| 83 | public interface ICallback { |
| 84 | /** |
| 85 | * Callback function called on message receipt from context hub. |
| 86 | * |
| 87 | * @param hubHandle Handle (system-wide unique identifier) of the hub of the message. |
| 88 | * @param nanoAppHandle Handle (unique identifier) for app instance that sent the message. |
| 89 | * @param message The context hub message. |
| 90 | * |
| 91 | * @see ContextHubMessage |
| 92 | */ |
| 93 | void onMessageReceipt(int hubHandle, int nanoAppHandle, ContextHubMessage message); |
| 94 | } |
| 95 | |
| 96 | /** |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 97 | * Get a handle to all the context hubs in the system |
| 98 | * @return array of context hub handles |
| 99 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 100 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 101 | public int[] getContextHubHandles() { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 102 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 103 | return mService.getContextHubHandles(); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 104 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 105 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 106 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | /** |
| 110 | * Get more information about a specific hub. |
| 111 | * |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 112 | * @param hubHandle Handle (system-wide unique identifier) of a context hub. |
| 113 | * @return ContextHubInfo Information about the requested context hub. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 114 | * |
| 115 | * @see ContextHubInfo |
| 116 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 117 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 118 | public ContextHubInfo getContextHubInfo(int hubHandle) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 119 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 120 | return mService.getContextHubInfo(hubHandle); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 121 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 122 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 123 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 127 | * Load a nano app on a specified context hub. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 128 | * |
Greg Kaiser | fac5be2 | 2016-08-17 15:33:10 -0700 | [diff] [blame] | 129 | * Note that loading is asynchronous. When we return from this method, |
| 130 | * the nano app (probably) hasn't loaded yet. Assuming a return of 0 |
| 131 | * from this method, then the final success/failure for the load, along |
| 132 | * with the "handle" for the nanoapp, is all delivered in a byte |
| 133 | * string via a call to Callback.onMessageReceipt. |
| 134 | * |
| 135 | * TODO(b/30784270): Provide a better success/failure and "handle" delivery. |
| 136 | * |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 137 | * @param hubHandle handle of context hub to load the app on. |
| 138 | * @param app the nanoApp to load on the hub |
| 139 | * |
Greg Kaiser | fac5be2 | 2016-08-17 15:33:10 -0700 | [diff] [blame] | 140 | * @return 0 if the command for loading was sent to the context hub; |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 141 | * -1 otherwise |
| 142 | * |
| 143 | * @see NanoApp |
| 144 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 145 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 146 | public int loadNanoApp(int hubHandle, NanoApp app) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 147 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 148 | return mService.loadNanoApp(hubHandle, app); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 149 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 150 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 151 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Unload a specified nanoApp |
| 156 | * |
Greg Kaiser | fac5be2 | 2016-08-17 15:33:10 -0700 | [diff] [blame] | 157 | * Note that unloading is asynchronous. When we return from this method, |
| 158 | * the nano app (probably) hasn't unloaded yet. Assuming a return of 0 |
| 159 | * from this method, then the final success/failure for the unload is |
| 160 | * delivered in a byte string via a call to Callback.onMessageReceipt. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 161 | * |
Greg Kaiser | fac5be2 | 2016-08-17 15:33:10 -0700 | [diff] [blame] | 162 | * TODO(b/30784270): Provide a better success/failure delivery. |
| 163 | * |
| 164 | * @param nanoAppHandle handle of the nanoApp to unload |
| 165 | * |
| 166 | * @return 0 if the command for unloading was sent to the context hub; |
| 167 | * -1 otherwise |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 168 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 169 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 170 | public int unloadNanoApp(int nanoAppHandle) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 171 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 172 | return mService.unloadNanoApp(nanoAppHandle); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 173 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 174 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 175 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | /** |
| 179 | * get information about the nano app instance |
| 180 | * |
Greg Kaiser | 3be73d3 | 2016-08-18 10:13:52 -0700 | [diff] [blame] | 181 | * NOTE: The returned NanoAppInstanceInfo does _not_ contain correct |
| 182 | * information for several fields, specifically: |
| 183 | * - getName() |
| 184 | * - getPublisher() |
| 185 | * - getNeededExecMemBytes() |
| 186 | * - getNeededReadMemBytes() |
| 187 | * - getNeededWriteMemBytes() |
| 188 | * |
| 189 | * For example, say you call loadNanoApp() with a NanoApp that has |
| 190 | * getName() returning "My Name". Later, if you call getNanoAppInstanceInfo |
| 191 | * for that nanoapp, the returned NanoAppInstanceInfo's getName() |
| 192 | * method will claim "Preloaded app, unknown", even though you would |
| 193 | * have expected "My Name". For now, as the user, you'll need to |
| 194 | * separately track the above fields if they are of interest to you. |
| 195 | * |
| 196 | * TODO(b/30943489): Have the returned NanoAppInstanceInfo contain the |
| 197 | * correct information. |
| 198 | * |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 199 | * @param nanoAppHandle handle of the nanoAppInstance |
| 200 | * @return NanoAppInstanceInfo Information about the nano app instance. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 201 | * |
| 202 | * @see NanoAppInstanceInfo |
| 203 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 204 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 205 | public NanoAppInstanceInfo getNanoAppInstanceInfo(int nanoAppHandle) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 206 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 207 | return mService.getNanoAppInstanceInfo(nanoAppHandle); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 208 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 209 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 210 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Find a specified nano app on the system |
| 215 | * |
| 216 | * @param hubHandle handle of hub to search for nano app |
| 217 | * @param filter filter specifying the search criteria for app |
| 218 | * |
| 219 | * @see NanoAppFilter |
| 220 | * |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 221 | * @return int[] Array of handles to any found nano apps |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 222 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 223 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 224 | public int[] findNanoAppOnHub(int hubHandle, NanoAppFilter filter) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 225 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 226 | return mService.findNanoAppOnHub(hubHandle, filter); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 227 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 228 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 229 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 233 | * Send a message to a specific nano app instance on a context hub. |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 234 | * |
Greg Kaiser | fac5be2 | 2016-08-17 15:33:10 -0700 | [diff] [blame] | 235 | * Note that the return value of this method only speaks of success |
| 236 | * up to the point of sending this to the Context Hub. It is not |
| 237 | * an assurance that the Context Hub successfully sent this message |
| 238 | * on to the nanoapp. If assurance is desired, a protocol should be |
| 239 | * established between your code and the nanoapp, with the nanoapp |
| 240 | * sending a confirmation message (which will be reported via |
| 241 | * Callback.onMessageReceipt). |
| 242 | * |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 243 | * @param hubHandle handle of the hub to send the message to |
| 244 | * @param nanoAppHandle handle of the nano app to send to |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 245 | * @param message Message to be sent |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 246 | * |
| 247 | * @see ContextHubMessage |
| 248 | * |
| 249 | * @return int 0 on success, -1 otherwise |
| 250 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 251 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 252 | public int sendMessage(int hubHandle, int nanoAppHandle, ContextHubMessage message) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 253 | try { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 254 | return mService.sendMessage(hubHandle, nanoAppHandle, message); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 255 | } catch (RemoteException e) { |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 256 | throw e.rethrowFromSystemServer(); |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 257 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 258 | } |
| 259 | |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 260 | /** |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 261 | * Returns the list of context hubs in the system. |
| 262 | * |
| 263 | * @return the list of context hub informations |
| 264 | * |
| 265 | * @see ContextHubInfo |
| 266 | * |
| 267 | * @hide |
| 268 | */ |
| 269 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 270 | public List<ContextHubInfo> getContextHubs() { |
| 271 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 272 | } |
| 273 | |
Arthur Ishiguro | 6c37fd0 | 2017-10-26 15:36:22 -0700 | [diff] [blame] | 274 | /* |
| 275 | * Helper function to generate a stub for a non-query transaction callback. |
| 276 | * |
| 277 | * @param transaction the transaction to unblock when complete |
| 278 | * |
| 279 | * @return the callback |
| 280 | * |
| 281 | * @hide |
| 282 | */ |
| 283 | private IContextHubTransactionCallback createTransactionCallback( |
| 284 | ContextHubTransaction<Void> transaction) { |
| 285 | return new IContextHubTransactionCallback.Stub() { |
| 286 | @Override |
| 287 | public void onQueryResponse(int result, List<NanoAppState> nanoappList) { |
| 288 | Log.e(TAG, "Received a query callback on a non-query request"); |
| 289 | transaction.setResponse(new ContextHubTransaction.Response<Void>( |
| 290 | ContextHubTransaction.TRANSACTION_FAILED_SERVICE_INTERNAL_FAILURE, null)); |
| 291 | } |
| 292 | |
| 293 | @Override |
| 294 | public void onTransactionComplete(int result) { |
| 295 | transaction.setResponse(new ContextHubTransaction.Response<Void>(result, null)); |
| 296 | } |
| 297 | }; |
| 298 | } |
| 299 | |
| 300 | /* |
| 301 | * Helper function to generate a stub for a query transaction callback. |
| 302 | * |
| 303 | * @param transaction the transaction to unblock when complete |
| 304 | * |
| 305 | * @return the callback |
| 306 | * |
| 307 | * @hide |
| 308 | */ |
| 309 | private IContextHubTransactionCallback createQueryCallback( |
| 310 | ContextHubTransaction<List<NanoAppState>> transaction) { |
| 311 | return new IContextHubTransactionCallback.Stub() { |
| 312 | @Override |
| 313 | public void onQueryResponse(int result, List<NanoAppState> nanoappList) { |
| 314 | transaction.setResponse(new ContextHubTransaction.Response<List<NanoAppState>>( |
| 315 | result, nanoappList)); |
| 316 | } |
| 317 | |
| 318 | @Override |
| 319 | public void onTransactionComplete(int result) { |
| 320 | Log.e(TAG, "Received a non-query callback on a query request"); |
| 321 | transaction.setResponse(new ContextHubTransaction.Response<List<NanoAppState>>( |
| 322 | ContextHubTransaction.TRANSACTION_FAILED_SERVICE_INTERNAL_FAILURE, null)); |
| 323 | } |
| 324 | }; |
| 325 | } |
| 326 | |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 327 | /** |
| 328 | * Loads a nanoapp at the specified Context Hub. |
| 329 | * |
| 330 | * After the nanoapp binary is successfully loaded at the specified hub, the nanoapp will be in |
| 331 | * the enabled state. |
| 332 | * |
| 333 | * @param hubInfo the hub to load the nanoapp on |
| 334 | * @param appBinary The app binary to load |
| 335 | * |
| 336 | * @return the ContextHubTransaction of the request |
| 337 | * |
| 338 | * @see NanoAppBinary |
| 339 | * |
| 340 | * @hide |
| 341 | */ |
| 342 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 343 | public ContextHubTransaction<Void> loadNanoApp( |
| 344 | ContextHubInfo hubInfo, NanoAppBinary appBinary) { |
| 345 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 346 | } |
| 347 | |
| 348 | /** |
| 349 | * Unloads a nanoapp at the specified Context Hub. |
| 350 | * |
| 351 | * @param hubInfo the hub to unload the nanoapp from |
| 352 | * @param nanoAppId the app to unload |
| 353 | * |
| 354 | * @return the ContextHubTransaction of the request |
| 355 | * |
| 356 | * @hide |
| 357 | */ |
| 358 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 359 | public ContextHubTransaction<Void> unloadNanoApp(ContextHubInfo hubInfo, long nanoAppId) { |
| 360 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 361 | } |
| 362 | |
| 363 | /** |
| 364 | * Enables a nanoapp at the specified Context Hub. |
| 365 | * |
| 366 | * @param hubInfo the hub to enable the nanoapp on |
| 367 | * @param nanoAppId the app to enable |
| 368 | * |
| 369 | * @return the ContextHubTransaction of the request |
| 370 | * |
| 371 | * @hide |
| 372 | */ |
| 373 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 374 | public ContextHubTransaction<Void> enableNanoApp(ContextHubInfo hubInfo, long nanoAppId) { |
| 375 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 376 | } |
| 377 | |
| 378 | /** |
| 379 | * Disables a nanoapp at the specified Context Hub. |
| 380 | * |
| 381 | * @param hubInfo the hub to disable the nanoapp on |
| 382 | * @param nanoAppId the app to disable |
| 383 | * |
| 384 | * @return the ContextHubTransaction of the request |
| 385 | * |
| 386 | * @hide |
| 387 | */ |
| 388 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 389 | public ContextHubTransaction<Void> disableNanoApp(ContextHubInfo hubInfo, long nanoAppId) { |
| 390 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 391 | } |
| 392 | |
| 393 | /** |
| 394 | * Requests a query for nanoapps loaded at the specified Context Hub. |
| 395 | * |
| 396 | * @param hubInfo the hub to query a list of nanoapps from |
| 397 | * |
| 398 | * @return the ContextHubTransaction of the request |
| 399 | * |
| 400 | * @hide |
| 401 | */ |
| 402 | @RequiresPermission(android.Manifest.permission.LOCATION_HARDWARE) |
| 403 | public ContextHubTransaction<List<NanoAppState>> queryNanoApps(ContextHubInfo hubInfo) { |
| 404 | throw new UnsupportedOperationException("TODO: Implement this"); |
| 405 | } |
| 406 | |
| 407 | /** |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 408 | * Set a callback to receive messages from the context hub |
| 409 | * |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 410 | * @param callback Callback object |
| 411 | * |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 412 | * @see Callback |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 413 | * |
| 414 | * @return int 0 on success, -1 otherwise |
| 415 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 416 | @SuppressLint("Doclava125") |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 417 | public int registerCallback(Callback callback) { |
| 418 | return registerCallback(callback, null); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 419 | } |
| 420 | |
| 421 | /** |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 422 | * @deprecated Use {@link #registerCallback(Callback)} instead. |
| 423 | * @hide |
| 424 | */ |
| 425 | @Deprecated |
| 426 | public int registerCallback(ICallback callback) { |
| 427 | if (mLocalCallback != null) { |
| 428 | Log.w(TAG, "Max number of local callbacks reached!"); |
| 429 | return -1; |
| 430 | } |
| 431 | mLocalCallback = callback; |
| 432 | return 0; |
| 433 | } |
| 434 | |
| 435 | /** |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 436 | * Set a callback to receive messages from the context hub |
| 437 | * |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 438 | * @param callback Callback object |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 439 | * @param handler Handler object |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 440 | * |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 441 | * @see Callback |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 442 | * |
| 443 | * @return int 0 on success, -1 otherwise |
| 444 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 445 | @SuppressLint("Doclava125") |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 446 | public int registerCallback(Callback callback, Handler handler) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 447 | synchronized(this) { |
| 448 | if (mCallback != null) { |
Ashutosh Joshi | b741e3b | 2016-03-29 09:19:56 -0700 | [diff] [blame] | 449 | Log.w(TAG, "Max number of callbacks reached!"); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 450 | return -1; |
| 451 | } |
| 452 | mCallback = callback; |
| 453 | mCallbackHandler = handler; |
| 454 | } |
| 455 | return 0; |
| 456 | } |
| 457 | |
| 458 | /** |
Arthur Ishiguro | 4e39aa1 | 2017-11-14 14:59:08 -0800 | [diff] [blame] | 459 | * Creates an interface to the ContextHubClient to send down to the service. |
| 460 | * |
| 461 | * @param callback the callback to invoke at the client process |
| 462 | * @param handler the handler to post callbacks for this client |
| 463 | * |
| 464 | * @return the callback interface |
| 465 | */ |
| 466 | private IContextHubClientCallback createClientCallback( |
| 467 | ContextHubClientCallback callback, Handler handler) { |
| 468 | return new IContextHubClientCallback.Stub() { |
| 469 | @Override |
| 470 | public void onMessageFromNanoApp(NanoAppMessage message) { |
| 471 | handler.post(() -> callback.onMessageFromNanoApp(message)); |
| 472 | } |
| 473 | |
| 474 | @Override |
| 475 | public void onHubReset() { |
| 476 | handler.post(() -> callback.onHubReset()); |
| 477 | } |
| 478 | |
| 479 | @Override |
| 480 | public void onNanoAppAborted(long nanoAppId, int abortCode) { |
| 481 | handler.post(() -> callback.onNanoAppAborted(nanoAppId, abortCode)); |
| 482 | } |
| 483 | |
| 484 | @Override |
| 485 | public void onNanoAppLoaded(long nanoAppId) { |
| 486 | handler.post(() -> callback.onNanoAppLoaded(nanoAppId)); |
| 487 | } |
| 488 | |
| 489 | @Override |
| 490 | public void onNanoAppUnloaded(long nanoAppId) { |
| 491 | handler.post(() -> callback.onNanoAppUnloaded(nanoAppId)); |
| 492 | } |
| 493 | |
| 494 | @Override |
| 495 | public void onNanoAppEnabled(long nanoAppId) { |
| 496 | handler.post(() -> callback.onNanoAppEnabled(nanoAppId)); |
| 497 | } |
| 498 | |
| 499 | @Override |
| 500 | public void onNanoAppDisabled(long nanoAppId) { |
| 501 | handler.post(() -> callback.onNanoAppDisabled(nanoAppId)); |
| 502 | } |
| 503 | }; |
| 504 | } |
| 505 | |
| 506 | /** |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 507 | * Creates and registers a client and its callback with the Context Hub Service. |
| 508 | * |
| 509 | * A client is registered with the Context Hub Service for a specified Context Hub. When the |
| 510 | * registration succeeds, the client can send messages to nanoapps through the returned |
| 511 | * {@link ContextHubClient} object, and receive notifications through the provided callback. |
| 512 | * |
| 513 | * @param callback the notification callback to register |
Arthur Ishiguro | 4e39aa1 | 2017-11-14 14:59:08 -0800 | [diff] [blame] | 514 | * @param hubInfo the hub to attach this client to |
| 515 | * @param handler the handler to invoke the callback, if null uses the main thread's Looper |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 516 | * @return the registered client object |
| 517 | * |
Arthur Ishiguro | 4e39aa1 | 2017-11-14 14:59:08 -0800 | [diff] [blame] | 518 | * @throws IllegalArgumentException if hubInfo does not represent a valid hub |
| 519 | * @throws IllegalStateException if there were too many registered clients at the service |
| 520 | * @throws NullPointerException if callback or hubInfo is null |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 521 | * |
| 522 | * @hide |
Arthur Ishiguro | 4e39aa1 | 2017-11-14 14:59:08 -0800 | [diff] [blame] | 523 | * @see ContextHubClientCallback |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 524 | */ |
| 525 | public ContextHubClient createClient( |
| 526 | ContextHubClientCallback callback, ContextHubInfo hubInfo, @Nullable Handler handler) { |
Arthur Ishiguro | 4e39aa1 | 2017-11-14 14:59:08 -0800 | [diff] [blame] | 527 | if (callback == null) { |
| 528 | throw new NullPointerException("Callback cannot be null"); |
| 529 | } |
| 530 | if (hubInfo == null) { |
| 531 | throw new NullPointerException("Hub info cannot be null"); |
| 532 | } |
| 533 | |
| 534 | Handler realHandler = (handler == null) ? new Handler(mMainLooper) : handler; |
| 535 | IContextHubClientCallback clientInterface = createClientCallback(callback, realHandler); |
| 536 | |
| 537 | IContextHubClient client; |
| 538 | try { |
| 539 | client = mService.createClient(clientInterface, hubInfo.getId()); |
| 540 | } catch (RemoteException e) { |
| 541 | throw e.rethrowFromSystemServer(); |
| 542 | } |
| 543 | |
| 544 | return new ContextHubClient(client, clientInterface, hubInfo); |
Arthur Ishiguro | b9ae7bd | 2017-10-09 12:47:52 -0700 | [diff] [blame] | 545 | } |
| 546 | |
| 547 | /** |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 548 | * Unregister a callback for receive messages from the context hub. |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 549 | * |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 550 | * @see Callback |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 551 | * |
| 552 | * @param callback method to deregister |
| 553 | * |
| 554 | * @return int 0 on success, -1 otherwise |
| 555 | */ |
Jeff Sharkey | d86b8fe | 2017-06-02 17:36:26 -0600 | [diff] [blame] | 556 | @SuppressLint("Doclava125") |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 557 | public int unregisterCallback(Callback callback) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 558 | synchronized(this) { |
| 559 | if (callback != mCallback) { |
Ashutosh Joshi | b741e3b | 2016-03-29 09:19:56 -0700 | [diff] [blame] | 560 | Log.w(TAG, "Cannot recognize callback!"); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 561 | return -1; |
| 562 | } |
| 563 | |
| 564 | mCallback = null; |
| 565 | mCallbackHandler = null; |
| 566 | } |
| 567 | return 0; |
| 568 | } |
| 569 | |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 570 | /** |
| 571 | * @deprecated Use {@link #unregisterCallback(Callback)} instead. |
| 572 | * @hide |
| 573 | */ |
Aurimas Liutikas | 514c5ef | 2016-05-24 15:22:55 -0700 | [diff] [blame] | 574 | @Deprecated |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 575 | public synchronized int unregisterCallback(ICallback callback) { |
| 576 | if (callback != mLocalCallback) { |
| 577 | Log.w(TAG, "Cannot recognize local callback!"); |
| 578 | return -1; |
| 579 | } |
| 580 | mLocalCallback = null; |
| 581 | return 0; |
| 582 | } |
| 583 | |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 584 | private final IContextHubCallback.Stub mClientCallback = new IContextHubCallback.Stub() { |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 585 | @Override |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 586 | public void onMessageReceipt(final int hubId, final int nanoAppId, |
destradaa | 8bad3fe | 2016-03-15 12:33:40 -0700 | [diff] [blame] | 587 | final ContextHubMessage message) { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 588 | if (mCallback != null) { |
| 589 | synchronized(this) { |
Greg Kaiser | 6ba60e6 | 2016-03-18 10:08:39 -0700 | [diff] [blame] | 590 | final Callback callback = mCallback; |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 591 | Handler handler = mCallbackHandler == null ? |
| 592 | new Handler(mMainLooper) : mCallbackHandler; |
| 593 | handler.post(new Runnable() { |
| 594 | @Override |
| 595 | public void run() { |
| 596 | callback.onMessageReceipt(hubId, nanoAppId, message); |
| 597 | } |
| 598 | }); |
| 599 | } |
destradaa | 78cebca | 2016-04-14 18:40:14 -0700 | [diff] [blame] | 600 | } else if (mLocalCallback != null) { |
| 601 | // we always ensure that mCallback takes precedence, because mLocalCallback is only |
| 602 | // for internal compatibility |
| 603 | synchronized (this) { |
| 604 | mLocalCallback.onMessageReceipt(hubId, nanoAppId, message); |
| 605 | } |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 606 | } else { |
| 607 | Log.d(TAG, "Context hub manager client callback is NULL"); |
| 608 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 609 | } |
| 610 | }; |
| 611 | |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 612 | /** @throws ServiceNotFoundException |
| 613 | * @hide */ |
| 614 | public ContextHubManager(Context context, Looper mainLooper) throws ServiceNotFoundException { |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 615 | mMainLooper = mainLooper; |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 616 | mService = IContextHubService.Stub.asInterface( |
Ashutosh Joshi | 420e45e | 2016-12-20 16:34:41 -0800 | [diff] [blame] | 617 | ServiceManager.getServiceOrThrow(Context.CONTEXTHUB_SERVICE)); |
Jeff Sharkey | 49ca529 | 2016-05-10 12:54:45 -0600 | [diff] [blame] | 618 | try { |
| 619 | mService.registerCallback(mClientCallback); |
| 620 | } catch (RemoteException e) { |
| 621 | Log.w(TAG, "Could not register callback:" + e); |
Peng Xu | 9ff7d22 | 2016-02-11 13:02:05 -0800 | [diff] [blame] | 622 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 623 | } |
Ashutosh Joshi | 1d1ac54 | 2016-01-18 17:19:27 -0800 | [diff] [blame] | 624 | } |