1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/* 2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License. 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License. 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef ANDROID_IBINDER_H 18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define ANDROID_IBINDER_H 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 20edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/Errors.h> 21edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/RefBase.h> 22edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/String16.h> 23edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/Vector.h> 24edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 25e86316a7495fed93ef381290462b8a790640c35bBart Sears 26b0343a94fc1a573b1ecb1e92f2fcf1987ad7bbfeCasey Dahlin// linux/binder.h already defines this, but we can't just include it from there 27b0343a94fc1a573b1ecb1e92f2fcf1987ad7bbfeCasey Dahlin// because there are host builds that include this file. 28b0343a94fc1a573b1ecb1e92f2fcf1987ad7bbfeCasey Dahlin#ifndef B_PACK_CHARS 29e86316a7495fed93ef381290462b8a790640c35bBart Sears#define B_PACK_CHARS(c1, c2, c3, c4) \ 30e86316a7495fed93ef381290462b8a790640c35bBart Sears ((((c1)<<24)) | (((c2)<<16)) | (((c3)<<8)) | (c4)) 31b0343a94fc1a573b1ecb1e92f2fcf1987ad7bbfeCasey Dahlin#endif // B_PACK_CHARS 32edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass BBinder; 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass BpBinder; 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass IInterface; 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass Parcel; 4023eb1e20cf59e1238b65cc108f31dfbfd85b2337Dianne Hackbornclass IResultReceiver; 411941a404d642b3dfaac365ba494f1e9912876f00Dianne Hackbornclass IShellCallback; 42edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 43edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/** 44edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Base class and low-level protocol for a remotable object. 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You can derive from this class to create an object for which other 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * processes can hold references to it. Communication between processes 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * (method calls, property get and set) is down through a low-level 48edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * protocol implemented on top of the transact() API. 49edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 50edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass IBinder : public virtual RefBase 51edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectpublic: 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project enum { 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project FIRST_CALL_TRANSACTION = 0x00000001, 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project LAST_CALL_TRANSACTION = 0x00ffffff, 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project PING_TRANSACTION = B_PACK_CHARS('_','P','N','G'), 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project DUMP_TRANSACTION = B_PACK_CHARS('_','D','M','P'), 5923eb1e20cf59e1238b65cc108f31dfbfd85b2337Dianne Hackborn SHELL_COMMAND_TRANSACTION = B_PACK_CHARS('_','C','M','D'), 60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project INTERFACE_TRANSACTION = B_PACK_CHARS('_', 'N', 'T', 'F'), 61555f89d8df316cdc5a25dbedb8614c2ac7a5e0a9Dianne Hackborn SYSPROPS_TRANSACTION = B_PACK_CHARS('_', 'S', 'P', 'R'), 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 638c6cedc9bc9a4b69616a79a95449f6f6b08c7bf1Dianne Hackborn // Corresponds to TF_ONE_WAY -- an asynchronous call. 64edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project FLAG_ONEWAY = 0x00000001 65edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project }; 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 6783c0446f27b9542d6c2e724817b2b2d8d1f55085Mathias Agopian IBinder(); 68edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /** 70edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Check if this IBinder implements the interface named by 71edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * @a descriptor. If it does, the base pointer to it is returned, 72edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * which you can safely static_cast<> to the concrete C++ interface. 73edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 74edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual sp<IInterface> queryLocalInterface(const String16& descriptor); 75edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 76edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /** 77edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Return the canonical name of the interface provided by this IBinder 78edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * object. 79edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 8083c0446f27b9542d6c2e724817b2b2d8d1f55085Mathias Agopian virtual const String16& getInterfaceDescriptor() const = 0; 81edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 82edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual bool isBinderAlive() const = 0; 83edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual status_t pingBinder() = 0; 84edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual status_t dump(int fd, const Vector<String16>& args) = 0; 85f2bf93bb080b07159ec1395c1ea8edcf5e00e829Dianne Hackborn static status_t shellCommand(const sp<IBinder>& target, int in, int out, int err, 861941a404d642b3dfaac365ba494f1e9912876f00Dianne Hackborn Vector<String16>& args, const sp<IShellCallback>& callback, 8723eb1e20cf59e1238b65cc108f31dfbfd85b2337Dianne Hackborn const sp<IResultReceiver>& resultReceiver); 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual status_t transact( uint32_t code, 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const Parcel& data, 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Parcel* reply, 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint32_t flags = 0) = 0; 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 9497b64dbe717b7daf29962f44c1b621c633473556Colin Cross // DeathRecipient is pure abstract, there is no virtual method 9597b64dbe717b7daf29962f44c1b621c633473556Colin Cross // implementation to put in a translation unit in order to silence the 9697b64dbe717b7daf29962f44c1b621c633473556Colin Cross // weak vtables warning. 9797b64dbe717b7daf29962f44c1b621c633473556Colin Cross #if defined(__clang__) 9897b64dbe717b7daf29962f44c1b621c633473556Colin Cross #pragma clang diagnostic push 9997b64dbe717b7daf29962f44c1b621c633473556Colin Cross #pragma clang diagnostic ignored "-Wweak-vtables" 10097b64dbe717b7daf29962f44c1b621c633473556Colin Cross #endif 10197b64dbe717b7daf29962f44c1b621c633473556Colin Cross 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project class DeathRecipient : public virtual RefBase 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project { 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project public: 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual void binderDied(const wp<IBinder>& who) = 0; 106edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project }; 107edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 10897b64dbe717b7daf29962f44c1b621c633473556Colin Cross #if defined(__clang__) 10997b64dbe717b7daf29962f44c1b621c633473556Colin Cross #pragma clang diagnostic pop 11097b64dbe717b7daf29962f44c1b621c633473556Colin Cross #endif 11197b64dbe717b7daf29962f44c1b621c633473556Colin Cross 112edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /** 113edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Register the @a recipient for a notification if this binder 114edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * goes away. If this binder object unexpectedly goes away 115edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * (typically because its hosting process has been killed), 11671f64dd876262407ff2636827de64ccde9c2088bChristopher Tate * then DeathRecipient::binderDied() will be called with a reference 117edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * to this. 118edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 119edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * The @a cookie is optional -- if non-NULL, it should be a 120edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * memory address that you own (that is, you know it is unique). 121edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 122edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * @note You will only receive death notifications for remote binders, 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * as local binders by definition can't die without you dying as well. 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Trying to use this function on a local binder will result in an 125edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * INVALID_OPERATION code being returned and nothing happening. 126edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 127edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * @note This link always holds a weak reference to its recipient. 128edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 129edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * @note You will only receive a weak reference to the dead 130edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * binder. You should not try to promote this to a strong reference. 131edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * (Nor should you need to, as there is nothing useful you can 132edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * directly do with it now that it has passed on.) 133edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 134edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual status_t linkToDeath(const sp<DeathRecipient>& recipient, 135edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie = NULL, 136edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint32_t flags = 0) = 0; 137edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 138edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /** 139edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Remove a previously registered death notification. 140edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * The @a recipient will no longer be called if this object 141edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * dies. The @a cookie is optional. If non-NULL, you can 142edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * supply a NULL @a recipient, and the recipient previously 143edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * added with that cookie will be unlinked. 144edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 145edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual status_t unlinkToDeath( const wp<DeathRecipient>& recipient, 146edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cookie = NULL, 147edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project uint32_t flags = 0, 148edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project wp<DeathRecipient>* outRecipient = NULL) = 0; 149edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 150edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual bool checkSubclass(const void* subclassID) const; 151edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 152edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project typedef void (*object_cleanup_func)(const void* id, void* obj, void* cleanupCookie); 153edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 154edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual void attachObject( const void* objectID, 155edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* object, 156edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void* cleanupCookie, 157edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project object_cleanup_func func) = 0; 158edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual void* findObject(const void* objectID) const = 0; 159edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual void detachObject(const void* objectID) = 0; 160edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 161edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual BBinder* localBinder(); 162edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project virtual BpBinder* remoteBinder(); 163edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 164edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectprotected: 16583c0446f27b9542d6c2e724817b2b2d8d1f55085Mathias Agopian virtual ~IBinder(); 166edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 167edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectprivate: 168edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 169edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 170edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 171edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 172edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// --------------------------------------------------------------------------- 173edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 174edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_IBINDER_H 175