RemoteObject

java.lang.Object
- ohos.rpc.RemoteObject

所有已实现的接口:

IRemoteObject

直接已知子类:

InstallerCallback, LocalRemoteObject, NfcController.ReaderModeCallbackStub, OnPermissionChangedCallback
```
public class RemoteObject
extends Object
implements IRemoteObject
```
Implements remote objects.
Service providers must inherit this class.
If RemoteObject is defined as an anonymous, local, or member class but not a static singleton class, potential leaks may occur.

从以下版本开始:

1

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.rpc.IRemoteObject
  IRemoteObject.DeathRecipient

字段概要
- 从接口继承的字段 ohos.rpc.IRemoteObject
  DUMP_TRANSACTION, INTERFACE_TRANSACTION, MAX_TRANSACTION_ID, MIN_TRANSACTION_ID, PING_TRANSACTION

构造器概要

构造器
构造器说明

RemoteObject(String descriptor)
A constructor used to create a RemoteObject instance using the default interface descriptor.

构造器
构造器	说明
`RemoteObject(String descriptor)`	A constructor used to create a `RemoteObject` instance using the default interface descriptor.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`addDeathRecipient(IRemoteObject.DeathRecipient recipient, int flags)`	Registers a callback used to receive death notifications of a remote proxy.
`void`	`attachLocalInterface(IRemoteBroker localInterface, String descriptor)`	Modifies the description of the current `RemoteObject`.
`protected void`	`dump(FileDescriptor fd, PrintWriter pw, String[] args)`	Dumps the status of the current interface to a file with a specific descriptor.
`void`	`dump(FileDescriptor fd, String[] args)`	Dumps the status of the current interface to a file with a specific descriptor.
`protected void`	`finalize()`	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`int`	`getCallingPid()`	Obtains the PID of the `RemoteProxy` object.
`int`	`getCallingUid()`	Obtains the UID of the `RemoteProxy` object.
`String`	`getInterfaceDescriptor()`	Queries an interface descriptor.
`boolean`	`isObjectDead()`	Checks whether a `RemoteObject` is dead.
`boolean`	`onRemoteRequest(int code, MessageParcel data, MessageParcel reply, MessageOption option)`	Sets an entry for receiving requests.
`IRemoteBroker`	`queryLocalInterface(String descriptor)`	Queries a remote object using an interface descriptor.
`boolean`	`removeDeathRecipient(IRemoteObject.DeathRecipient recipient, int flags)`	Deregisters a callback used to receive death notifications of a remote proxy.
`boolean`	`sendRequest(int code, MessageParcel data, MessageParcel reply, MessageOption option)`	Sends a request to the peer object.
`protected void`	`slowPathDump(FileDescriptor fd, PrintWriter pw, String[] args)`	Asynchronously dumps data to a specified file using the given `PrintWriter` object.
`void`	`slowPathDump(FileDescriptor fd, String[] args)`	Asynchronously dumps data to a specified file.

从类继承的方法 java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RemoteObject
```
public RemoteObject(String descriptor)
```
    A constructor used to create a RemoteObject instance using the default interface descriptor.
    
    参数:
    
    descriptor - Indicates the interface descriptor used to create the RemoteObject instance.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - queryLocalInterface
```
public IRemoteBroker queryLocalInterface(String descriptor)
```
    Queries a remote object using an interface descriptor.
    
    指定者:
    
    queryLocalInterface 在接口中 IRemoteObject
    
    参数:
    
    descriptor - Indicates the interface descriptor used to query the remote object.
    
    返回:
    
    Returns the remote object matching the interface descriptor; returns null if no such remote object is found.
    
    从以下版本开始:
    
    1
  - addDeathRecipient
```
public boolean addDeathRecipient(IRemoteObject.DeathRecipient recipient,
                                 int flags)
```
    Registers a callback used to receive death notifications of a remote proxy.
    
    指定者:
    
    addDeathRecipient 在接口中 IRemoteObject
    
    参数:
    
    recipient - Indicates the callback to be registered.
    
    flags - Indicates the flag of the death notification.
    
    返回:
    
    Returns false because this callback is not required.
    
    从以下版本开始:
    
    1
  - removeDeathRecipient
```
public boolean removeDeathRecipient(IRemoteObject.DeathRecipient recipient,
                                    int flags)
```
    Deregisters a callback used to receive death notifications of a remote proxy.
    
    指定者:
    
    removeDeathRecipient 在接口中 IRemoteObject
    
    参数:
    
    recipient - Indicates the callback to be deregistered.
    
    flags - Indicates the flag of the death notification.
    
    返回:
    
    Returns false because this callback is not required.
    
    从以下版本开始:
    
    1
  - getInterfaceDescriptor
```
public String getInterfaceDescriptor()
```
    Queries an interface descriptor.
    
    指定者:
    
    getInterfaceDescriptor 在接口中 IRemoteObject
    
    返回:
    
    Returns the interface descriptor.
    
    从以下版本开始:
    
    1
  - onRemoteRequest
```
public boolean onRemoteRequest(int code,
                               MessageParcel data,
                               MessageParcel reply,
                               MessageOption option)
                        throws RemoteException
```
    Sets an entry for receiving requests.
    This method is implemented by the remote service provider. You need to override this method with your own service logic when you are using IPC.
    
    参数:
    
    code - Indicates the service request code sent from the peer end.
    
    data - Indicates the MessageParcel object sent from the peer end.
    
    reply - Indicates the response message object sent from the remote service. The local service writes the response data to the MessageParcel object.
    
    option - Indicates whether the operation is synchronous or asynchronous.
    
    返回:
    
    Returns true if the operation succeeds; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if a remote service error occurs.
    
    从以下版本开始:
    
    1
  - sendRequest
```
public boolean sendRequest(int code,
                           MessageParcel data,
                           MessageParcel reply,
                           MessageOption option)
                    throws RemoteException
```
    Sends a request to the peer object.
    If the peer object and RemoteObject are on the same device, the request is sent by the IPC driver. If they are on different devices, the request is sent by the socket driver.
    
    指定者:
    
    sendRequest 在接口中 IRemoteObject
    
    参数:
    
    code - Indicates the message code of the request.
    
    data - Indicates the MessageParcel object storing the data to be sent.
    
    reply - Indicates the MessageParcel object receiving the response data.
    
    option - Indicates a synchronous (default) or asynchronous request.
    
    返回:
    
    Returns true if the operation succeeds; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if a remote service error occurs.
    
    从以下版本开始:
    
    1
  - getCallingPid
```
public int getCallingPid()
```
    Obtains the PID of the RemoteProxy object.
    
    返回:
    
    Returns the PID of the RemoteProxy object.
    
    从以下版本开始:
    
    1
  - getCallingUid
```
public int getCallingUid()
```
    Obtains the UID of the RemoteProxy object.
    
    返回:
    
    Returns the UID of the RemoteProxy object.
    
    从以下版本开始:
    
    1
  - dump
```
protected void dump(FileDescriptor fd,
                    PrintWriter pw,
                    String[] args)
```
    Dumps the status of the current interface to a file with a specific descriptor.
    
    参数:
    
    fd - Indicates the descriptor of the target file.
    
    pw - Prints a formatted representation of the object to the output stream.
    
    args - Indicates parameters of this method in character string format.
    
    抛出:
    
    RemoteException - Throws this exception if an error occurs when FileOutputStream is opened or data is written to FileOutputStream.
    
    从以下版本开始:
    
    1
  - slowPathDump
```
protected void slowPathDump(FileDescriptor fd,
                            PrintWriter pw,
                            String[] args)
```
    Asynchronously dumps data to a specified file using the given PrintWriter object.
    This method applies only to data dump on the same device.
    You need to override this method to define the data to dump to the file. After the dump is complete, you need to close the file descriptor.
    
    参数:
    
    fd - Indicates the file descriptor of the target file.
    
    pw - Indicates the PrintWriter object used to dump data to the target file, with automatic flushing disabled.
    
    args - Indicates the arguments (an array of strings) to dump.
    
    从以下版本开始:
    
    5
  - dump
```
public void dump(FileDescriptor fd,
                 String[] args)
          throws RemoteException
```
    Dumps the status of the current interface to a file with a specific descriptor.
    
    指定者:
    
    dump 在接口中 IRemoteObject
    
    参数:
    
    fd - Indicates the descriptor of the target file.
    
    args - Indicates parameters of this method in character string format.
    
    抛出:
    
    RemoteException - Throws this exception if an error occurs when FileOutputStream is opened or data is written to FileOutputStream.
    
    从以下版本开始:
    
    1
  - slowPathDump
```
public void slowPathDump(FileDescriptor fd,
                         String[] args)
                  throws RemoteException
```
    Asynchronously dumps data to a specified file.
    This method applies only to data dump on the same device.
    Alternatively, you can override the slowPathDump(java.io.FileDescriptor,java.io.PrintWriter,java.lang.String[]) method to define the data to dump to the file. After the dump is complete, you need to close the file descriptor.
    
    指定者:
    
    slowPathDump 在接口中 IRemoteObject
    
    参数:
    
    fd - Indicates the file descriptor of the target file.
    
    args - Indicates the arguments (an array of strings) to dump.
    
    抛出:
    
    RemoteException - Throws this exception if the dump command fails to be sent or an error occurs during the dump.
    
    从以下版本开始:
    
    5
  - finalize
```
protected void finalize()
                 throws Throwable
```
    从类复制的说明: Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable - the Exception raised by this method
    
    另请参阅:
    
    WeakReference, PhantomReference
  - isObjectDead
```
public boolean isObjectDead()
```
    Checks whether a RemoteObject is dead.
    
    指定者:
    
    isObjectDead 在接口中 IRemoteObject
    
    返回:
    
    Returns false by default.
    
    从以下版本开始:
    
    1
  - attachLocalInterface
```
public void attachLocalInterface(IRemoteBroker localInterface,
                                 String descriptor)
```
    Modifies the description of the current RemoteObject.
    This method is used to change the default descriptor specified during the creation of RemoteObject.
    
    参数:
    
    localInterface - Indicates the RemoteObject whose descriptor is to be changed.
    
    descriptor - Indicates the new descriptor of the RemoteObject.
    
    从以下版本开始:
    
    1

类 RemoteObject

嵌套类概要

从接口继承的嵌套类/接口 ohos.rpc.IRemoteObject

字段概要

从接口继承的字段 ohos.rpc.IRemoteObject

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

RemoteObject

方法详细资料

queryLocalInterface

addDeathRecipient

removeDeathRecipient

getInterfaceDescriptor

onRemoteRequest

sendRequest

getCallingPid

getCallingUid

dump

slowPathDump

dump

slowPathDump

finalize

isObjectDead

attachLocalInterface