19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.os; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.FileDescriptor; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Base interface for a remotable object, the core part of a lightweight 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * remote procedure call mechanism designed for high performance when 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * performing in-process and cross-process calls. This 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * interface describes the abstract protocol for interacting with a 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * remotable object. Do not implement this interface directly, instead 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * extend from {@link Binder}. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The key IBinder API is {@link #transact transact()} matched by 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Binder#onTransact Binder.onTransact()}. These 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * methods allow you to send a call to an IBinder object and receive a 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * call coming in to a Binder object, respectively. This transaction API 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is synchronous, such that a call to {@link #transact transact()} does not 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return until the target has returned from 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Binder#onTransact Binder.onTransact()}; this is the 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * expected behavior when calling an object that exists in the local 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * process, and the underlying inter-process communication (IPC) mechanism 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ensures that these same semantics apply when going across processes. 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The data sent through transact() is a {@link Parcel}, a generic buffer 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of data that also maintains some meta-data about its contents. The meta 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * data is used to manage IBinder object references in the buffer, so that those 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * references can be maintained as the buffer moves across processes. This 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mechanism ensures that when an IBinder is written into a Parcel and sent to 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * another process, if that other process sends a reference to that same IBinder 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * back to the original process, then the original process will receive the 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * same IBinder object back. These semantics allow IBinder/Binder objects to 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be used as a unique identity (to serve as a token or for other purposes) 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that can be managed across processes. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The system maintains a pool of transaction threads in each process that 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it runs in. These threads are used to dispatch all 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * IPCs coming in from other processes. For example, when an IPC is made from 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * process A to process B, the calling thread in A blocks in transact() as 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it sends the transaction to process B. The next available pool thread in 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * B receives the incoming transaction, calls Binder.onTransact() on the target 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * object, and replies with the result Parcel. Upon receiving its result, the 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * thread in process A returns to allow its execution to continue. In effect, 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * other processes appear to use as additional threads that you did not create 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executing in your own process. 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The Binder system also supports recursion across processes. For example 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if process A performs a transaction to process B, and process B while 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * handling that transaction calls transact() on an IBinder that is implemented 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in A, then the thread in A that is currently waiting for the original 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * transaction to finish will take care of calling Binder.onTransact() on the 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * object being called by B. This ensures that the recursion semantics when 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * calling remote binder object are the same as when calling local objects. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>When working with remote objects, you often want to find out when they 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * are no longer valid. There are three ways this can be determined: 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ul> 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> The {@link #transact transact()} method will throw a 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link RemoteException} exception if you try to call it on an IBinder 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * whose process no longer exists. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> The {@link #pingBinder()} method can be called, and will return false 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if the remote process no longer exists. 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li> The {@link #linkToDeath linkToDeath()} method can be used to register 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a {@link DeathRecipient} with the IBinder, which will be called when its 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * containing process goes away. 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ul> 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Binder 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface IBinder { 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The first transaction code available for user commands. 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int FIRST_CALL_TRANSACTION = 0x00000001; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The last transaction code available for user commands. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int LAST_CALL_TRANSACTION = 0x00ffffff; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * IBinder protocol transaction code: pingBinder(). 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int PING_TRANSACTION = ('_'<<24)|('P'<<16)|('N'<<8)|'G'; 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * IBinder protocol transaction code: dump internal state. 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int DUMP_TRANSACTION = ('_'<<24)|('D'<<16)|('M'<<8)|'P'; 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * IBinder protocol transaction code: interrogate the recipient side 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of the transaction for its canonical interface descriptor. 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int INTERFACE_TRANSACTION = ('_'<<24)|('N'<<16)|('T'<<8)|'F'; 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1120d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * IBinder protocol transaction code: send a tweet to the target 1130d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * object. The data in the parcel is intended to be delivered to 1140d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * a shared messaging service associated with the object; it can be 1150d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * anything, as long as it is not more than 130 UTF-8 characters to 1160d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * conservatively fit within common messaging services. As part of 1170d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * {@link Build.VERSION_CODES#HONEYCOMB_MR2}, all Binder objects are 1180d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * expected to support this protocol for fully integrated tweeting 1190d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * across the platform. To support older code, the default implementation 1200d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * logs the tweet to the main log as a simple emulation of broadcasting 1210d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * it publicly over the Internet. 1220d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * 1230d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * <p>Also, upon completing the dispatch, the object must make a cup 1240d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * of tea, return it to the caller, and exclaim "jolly good message 1250d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn * old boy!". 1260d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn */ 1270d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn int TWEET_TRANSACTION = ('_'<<24)|('T'<<16)|('W'<<8)|'T'; 1280d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn 1290d4b9c993d8f1108294f8ccb84eeacd92f051b50Dianne Hackborn /** 130a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * IBinder protocol transaction code: tell an app asynchronously that the 131a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * caller likes it. The app is responsible for incrementing and maintaining 132a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * its own like counter, and may display this value to the user to indicate the 133a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * quality of the app. This is an optional command that applications do not 134a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * need to handle, so the default implementation is to do nothing. 135a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * 136a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * <p>There is no response returned and nothing about the 137a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * system will be functionally affected by it, but it will improve the 138a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn * app's self-esteem. 139a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn */ 140a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn int LIKE_TRANSACTION = ('_'<<24)|('L'<<16)|('I'<<8)|'K'; 141a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn 142a53de0629f3b94472c0f160f5bbe1090b020feabDianne Hackborn /** @hide */ 143a53de0629f3b94472c0f160f5bbe1090b020feabDianne Hackborn int SYSPROPS_TRANSACTION = ('_'<<24)|('S'<<16)|('P'<<8)|'R'; 144a53de0629f3b94472c0f160f5bbe1090b020feabDianne Hackborn 145a3d487cb13983643d5024e493e4d56c96736f1ebDianne Hackborn /** 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag to {@link #transact}: this is a one-way call, meaning that the 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * caller returns immediately, without waiting for a result from the 148d76ef97930d45e37dba4ac58b376c3067c2eb54aDirk Dougherty * callee. Applies only if the caller and callee are in different 149d76ef97930d45e37dba4ac58b376c3067c2eb54aDirk Dougherty * processes. 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int FLAG_ONEWAY = 0x00000001; 15286cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn 15386cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn /** 15486cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn * Limit that should be placed on IPC sizes to keep them safely under the 15586cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn * transaction buffer limit. 15686cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn * @hide 15786cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn */ 15886cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn public static final int MAX_IPC_SIZE = 64 * 1024; 15986cbc2bf30a7623b2ad6564cf50ca20f87067ea7Dianne Hackborn 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the canonical name of the interface supported by this binder. 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String getInterfaceDescriptor() throws RemoteException; 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check to see if the object still exists. 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns false if the 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * hosting process is gone, otherwise the result (always by default 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * true) returned by the pingBinder() implementation on the other 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * side. 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean pingBinder(); 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check to see if the process that the binder is in is still alive. 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return false if the process is not alive. Note that if it returns 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * true, the process may have died while the call is returning. 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isBinderAlive(); 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempt to retrieve a local implementation of an interface 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for this Binder object. If null is returned, you will need 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to instantiate a proxy class to marshall calls through 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the transact() method. 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public IInterface queryLocalInterface(String descriptor); 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Print the object's state into the given stream. 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param fd The raw file descriptor that the dump is being sent to. 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param args additional arguments to the dump request. 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void dump(FileDescriptor fd, String[] args) throws RemoteException; 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2009a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * Like {@link #dump(FileDescriptor, String[])} but always executes 2019a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * asynchronously. If the object is local, a new thread is created 2029a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * to perform the dump. 2039a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * 2049a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * @param fd The raw file descriptor that the dump is being sent to. 2059a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn * @param args additional arguments to the dump request. 2069a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn */ 2079a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn public void dumpAsync(FileDescriptor fd, String[] args) throws RemoteException; 2089a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn 2099a84983a9fd9959671e102045eaf185b83291269Dianne Hackborn /** 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Perform a generic operation with the object. 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param code The action to perform. This should 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be a number between {@link #FIRST_CALL_TRANSACTION} and 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #LAST_CALL_TRANSACTION}. 215334031cd07c3bd09d23fce0ebaf946fc6ecfee26Glenn Kasten * @param data Marshalled data to send to the target. Must not be null. 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you are not sending any data, you must create an empty Parcel 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that is given here. 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param reply Marshalled data to be received from the target. May be 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * null if you are not interested in the return value. 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags Additional operation flags. Either 0 for a normal 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * RPC, or {@link #FLAG_ONEWAY} for a one-way RPC. 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean transact(int code, Parcel data, Parcel reply, int flags) 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws RemoteException; 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface for receiving a callback when the process hosting an IBinder 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * has gone away. 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #linkToDeath 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface DeathRecipient { 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void binderDied(); 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Register the recipient for a notification if this binder 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * goes away. If this binder object unexpectedly goes away 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (typically because its hosting process has been killed), 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * then the given {@link DeathRecipient}'s 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link DeathRecipient#binderDied DeathRecipient.binderDied()} method 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be called. 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>You will only receive death notifications for remote binders, 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as local binders by definition can't die without you dying as well. 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2476098c5d3555860f272d8ddbd353a42f4c8474e1cJohn Spurlock * @throws RemoteException if the target IBinder's 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * process has already died. 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #unlinkToDeath 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void linkToDeath(DeathRecipient recipient, int flags) 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws RemoteException; 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove a previously registered death notification. 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The recipient will no longer be called if this object 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * dies. 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2606098c5d3555860f272d8ddbd353a42f4c8474e1cJohn Spurlock * @return {@code true} if the <var>recipient</var> is successfully 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unlinked, assuring you that its 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link DeathRecipient#binderDied DeathRecipient.binderDied()} method 2636098c5d3555860f272d8ddbd353a42f4c8474e1cJohn Spurlock * will not be called; {@code false} if the target IBinder has already 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * died, meaning the method has been (or soon will be) called. 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2666098c5d3555860f272d8ddbd353a42f4c8474e1cJohn Spurlock * @throws java.util.NoSuchElementException if the given 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>recipient</var> has not been registered with the IBinder, and 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the IBinder is still alive. Note that if the <var>recipient</var> 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * was never registered, but the IBinder has already died, then this 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * exception will <em>not</em> be thrown, and you will receive a false 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * return value instead. 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean unlinkToDeath(DeathRecipient recipient, int flags); 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 275