程序包 ohos.rpc

类 RemoteObjectCallbackList<E extends IRemoteBroker>

java.lang.Object

ohos.rpc.RemoteObjectCallbackList<E>

类型参数:

E - Indicates the callback type, which is inherited from IRemoteBroker.

public class RemoteObjectCallbackList<E extends IRemoteBroker>
extends Object

Stores and maintains a list of remote callbacks from a service to its clients.

In details, this class:

• Stores a set of registered IRemoteBroker callbacks in a Map container. Each callback is uniquely identified by an IRemoteObject (obtained by calling IRemoteBroker#asObject().
• Attaches an IRemoteObject.DeathRecipient object to each registered callback so that a callback is automatically removed from the list when the process hosting the callback dies.
• Locks and backs up the callback list to deal with multi-thread calls, and iterates over a backup of the list without keeping the backup locked.

When constructing a RemoteObjectCallbackList instance, you need to pass E to specify the callback type. E is inherited from IRemoteBroker.

从以下版本开始:

3

构造器概要

构造器

构造器	说明
RemoteObjectCallbackList()

方法概要

限定符和类型	方法	说明
Object	getBroadcastCookie(int index)	Obtains the cookie associated with the callback matching the given index in the broadcast.
E	getBroadcastInterface(int index)	Obtains the callback matching the given index in the broadcast.
Object	getRemoteObjectCallbackCookie(IRemoteObject key)	Obtains the cookie associated with the callback identified by the specified IRemoteObject.
int	getRemoteObjectCallbackCount()	Obtains the number of callbacks stored in this container.
E	getRemoteObjectCallbackInterface(IRemoteObject key)	Obtains the callback identified by the specified IRemoteObject.
void	onRemoteCallbackDied(E callback)	Called when the process hosting the specified callback dies.
void	onRemoteCallbackDied(E callback, Object cookie)	Called when the process hosting the specified callback dies, with a cookie containing additional data.
boolean	register(E callback)	Adds the specified callback to this RemoteObjectCallbackList.
boolean	register(E callback, Object cookie)	Adds the specified callback with the specified cookie to this RemoteObjectCallbackList.
int	startBroadcast()	Starts a broadcast.
void	stopBroadcast()	Stops a broadcast.
boolean	unregister(E callback)	Removes a previously added callback from this RemoteObjectCallbackList.
void	unregisterAll()	Removes all previously added callbacks from this RemoteObjectCallbackList.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RemoteObjectCallbackList

public RemoteObjectCallbackList()

方法详细资料

onRemoteCallbackDied

public void onRemoteCallbackDied(E callback)

Called when the process hosting the specified callback dies. By default, the callback has no cookie.

You can override this method to define subsequent operations.

参数:

callback - Indicates the callback hosted by the process. Since the process has died, you can no longer invoke this callback.

从以下版本开始:

3

onRemoteCallbackDied

public void onRemoteCallbackDied(E callback,
                                 Object cookie)

Called when the process hosting the specified callback dies, with a cookie containing additional data.

You can override this method to define subsequent operations.

参数:

callback - Indicates the callback hosted by the process. Since the process has died, you can no longer invoke this callback.

cookie - Indicates the cookie associated with the callback. It can be any object.

从以下版本开始:

3

getRemoteObjectCallbackCount

public int getRemoteObjectCallbackCount()

Obtains the number of callbacks stored in this container.

返回:

Returns the number of callbacks stored in this container.

从以下版本开始:

3

getRemoteObjectCallbackInterface

public E getRemoteObjectCallbackInterface(IRemoteObject key)

Obtains the callback identified by the specified IRemoteObject.

参数:

key - Indicates the specified IRemoteObject.

返回:

Returns the callback identified by the specified IRemoteObject. The callback was added to the RemoteObjectCallbackList using register(E).

从以下版本开始:

3

getRemoteObjectCallbackCookie

public Object getRemoteObjectCallbackCookie(IRemoteObject key)

Obtains the cookie associated with the callback identified by the specified IRemoteObject.

参数:

key - Indicates the specified IRemoteObject.

返回:

Returns the cookie associated with the callback identified by the specified IRemoteObject. The callback was added to the RemoteObjectCallbackList using register(E).

从以下版本开始:

3

register

public boolean register(E callback)

Adds the specified callback to this RemoteObjectCallbackList.

This callback will remain in the RemoteObjectCallbackList until unregister(E) is called to remove it from the list or the process hosting the callback dies.

参数:

callback - Indicates the callback to add.

返回:

Returns true if the callback is added to this RemoteObjectCallbackList; returns false if the callback fails to be added to this RemoteObjectCallbackList or unregisterAll() has been called.

从以下版本开始:

3

register

public boolean register(E callback,
                        Object cookie)

Adds the specified callback with the specified cookie to this RemoteObjectCallbackList.

The cookie associated with the callback is also added to this RemoteObjectCallbackList. This callback will remain in the RemoteObjectCallbackList until unregister(E) is called to remove it from the list or the process hosting the callback dies.

参数:

callback - Indicates the callback to add.

cookie - Indicates the cookie associated with the callback. It can be any object.

返回:

Returns true if the callback is added to this RemoteObjectCallbackList; returns false if the callback fails to be added to this RemoteObjectCallbackList or unregisterAll() has been called.

从以下版本开始:

3

unregister

public boolean unregister(E callback)

Removes a previously added callback from this RemoteObjectCallbackList.

参数:

callback - Indicates the callback to remove.

返回:

cookie Returns true if the specified callback is found and removed from this RemoteObjectCallbackList; returns false if the specified callback is not found.

从以下版本开始:

3

unregisterAll

public void unregisterAll()

Removes all previously added callbacks from this RemoteObjectCallbackList.

After removing all callbacks from this RemoteObjectCallbackList and marking the list as unavailable, calling register(E) to add callbacks to this list will fail. This method is used to prevent clients from registering callbacks after the service has stopped.

从以下版本开始:

3

startBroadcast

public int startBroadcast()

Starts a broadcast.

This method creates a copy of the callback list and starts invoking registered callbacks. You can retrieve callbacks from the list using getBroadcastInterface(int) and getBroadcastCookie(int).

Only one broadcast is allowed at a time. Ensure that you always call this method from the same thread and that you call stopBroadcast() after calling this method.

返回:

Returns the number of callbacks in the list, which is also the upper limit that can be accessed with getBroadcastInterface(int) and getBroadcastCookie(int); otherwise returns -1 if another broadcast is running.

从以下版本开始:

3

stopBroadcast

public void stopBroadcast()

Stops a broadcast.

You must call this method after a broadcast is done.

从以下版本开始:

3

getBroadcastInterface

public E getBroadcastInterface(int index)

Obtains the callback matching the given index in the broadcast.

This method can be called only after a broadcast is started, and its data is no longer valid after stopBroadcast() is called.

If the returned callback has disappeared when you call it, the RemoteException will be thrown. You need to catch this exception, but you can handle it by simply ignoring it because the callback list automatically removes invalid callbacks.

参数:

index - Indicates the callback index. It cannot exceed the return value of startBroadcast().

返回:

Returns the callback matching the given index.

从以下版本开始:

3

getBroadcastCookie

public Object getBroadcastCookie(int index)

Obtains the cookie associated with the callback matching the given index in the broadcast.

参数:

index - Indicates the callback index. It cannot exceed the return value of startBroadcast().

返回:

Returns the cookie associated with the callback matching the given index.

从以下版本开始:

3