RemoteObjectCallbackList
java.lang.Object
|—ohos.rpc.RemoteObjectCallbackList<E&
public class RemoteObjectCallbackList<E extends IRemoteBroker>
extends Object
存储并维护从服务到其客户端的远程回调列表。
详细来说,这个类:
- 在 Map 容器中存储一组已注册的 IRemoteBroker 回调。 每个回调由一个 IRemoteObject 唯一标识(通过调用 IRemoteBroker#asObject() 获得。
- 将 IRemoteObject.DeathRecipient 对象附加到每个已注册的回调,以便在托管回调的进程死亡时自动从列表中删除回调。
- 锁定并备份回调列表以处理多线程调用,并迭代列表的备份而不保持备份锁定。
构造 RemoteObjectCallbackList 实例时,需要通过 E 来指定回调类型。 E 继承自 IRemoteBroker。
构造函数摘要
构造函数 | 描述 |
---|---|
RemoteObjectCallbackList() |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
Object | getBroadcastCookie(int index) | 获取与广播中给定索引匹配的回调关联的cookie。 |
E | getBroadcastInterface(int index) | 获取与广播中给定索引匹配的回调。 |
Object | getRemoteObjectCallbackCookie(IRemoteObject key) | 获取与指定 IRemoteObject 标识的回调关联的 cookie。 |
int | getRemoteObjectCallbackCount() | 获取存储在此容器中的回调数。 |
E | getRemoteObjectCallbackInterface(IRemoteObject key) | 获取由指定的 IRemoteObject 标识的回调。 |
void | onRemoteCallbackDied(E callback) | 当托管指定回调的进程死亡时调用。 |
void | onRemoteCallbackDied(E callback, Object cookie) | 当托管指定回调的进程终止时调用,cookie 包含附加数据。 |
boolean | register(E callback) | 将指定的回调添加到此 RemoteObjectCallbackList。 |
boolean | register(E callback, Object cookie) | 将具有指定 cookie 的指定回调添加到此 RemoteObjectCallbackList。 |
int | startBroadcast() | 开始广播。 |
void | stopBroadcast() | 停止广播。 |
boolean | unregister(E callback) | 从此 RemoteObjectCallbackList 中删除以前添加的回调。 |
void | unregisterAll() | 从此 RemoteObjectCallbackList 中删除所有以前添加的回调。 |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
构造函数详细信息
RemoteObjectCallbackList
public RemoteObjectCallbackList()
方法详情
onRemoteCallbackDied
public void onRemoteCallbackDied(E callback)
当托管指定回调的进程死亡时调用。 默认情况下,回调没有 cookie。
您可以重写此方法来定义后续操作。
参数:
参数名称 | 参数描述 |
---|---|
callback | 表示进程托管的回调。 由于进程已终止,您不能再调用此回调。 |
onRemoteCallbackDied
public void onRemoteCallbackDied(E callback, Object cookie)
当托管指定回调的进程终止时调用,cookie 包含附加数据。
您可以重写此方法来定义后续操作。
参数:
参数名称 | 参数描述 |
---|---|
callback | 表示进程托管的回调。 由于进程已终止,您不能再调用此回调。 |
cookie | 指示与回调关联的 cookie。 它可以是任何对象。 |
getRemoteObjectCallbackCount
public int getRemoteObjectCallbackCount()
获取存储在此容器中的回调数。
返回:
返回存储在此容器中的回调数。
getRemoteObjectCallbackInterface
public E getRemoteObjectCallbackInterface(IRemoteObject key)
获取由指定的 IRemoteObject 标识的回调。
参数:
参数名称 | 参数描述 |
---|---|
key | 指示指定的 IRemoteObject。 |
返回:
返回由指定的 IRemoteObject 标识的回调。 使用 register(E) 将回调添加到 RemoteObjectCallbackList。
getRemoteObjectCallbackCookie
public Object getRemoteObjectCallbackCookie(IRemoteObject key)
获取与指定 IRemoteObject 标识的回调关联的 cookie。
参数:
参数名称 | 参数描述 |
---|---|
key | 指示指定的 IRemoteObject。 |
返回:
返回与指定 IRemoteObject 标识的回调关联的 cookie。 使用 register(E) 将回调添加到 RemoteObjectCallbackList。
register
public boolean register(E callback)
将指定的回调添加到此 RemoteObjectCallbackList。
此回调将保留在 RemoteObjectCallbackList 中,直到调用 unregister(E) 将其从列表中删除或托管回调的进程终止。
参数:
参数名称 | 参数描述 |
---|---|
callback | 表示要添加的回调。 |
返回:
如果回调被添加到此 RemoteObjectCallbackList,则返回 true; 如果回调未能添加到此 RemoteObjectCallbackList 或已调用 unregisterAll(),则返回 false。
register
public boolean register(E callback, Object cookie)
将具有指定 cookie 的指定回调添加到此 RemoteObjectCallbackList。
与回调关联的 cookie 也会添加到此 RemoteObjectCallbackList。 此回调将保留在 RemoteObjectCallbackList 中,直到调用 unregister(E) 将其从列表中删除或托管回调的进程终止。
参数:
参数名称 | 参数描述 |
---|---|
callback | 表示要添加的回调。 |
cookie | 指示与回调关联的 cookie。 它可以是任何对象。 |
返回:
如果回调被添加到此 RemoteObjectCallbackList,则返回 true; 如果回调未能添加到此 RemoteObjectCallbackList 或已调用 unregisterAll(),则返回 false。
unregister
public boolean unregister(E callback)
从此 RemoteObjectCallbackList 中删除以前添加的回调。
参数:
参数名称 | 参数描述 |
---|---|
callback | 指示要删除的回调。 |
返回:
cookie 如果找到指定的回调并将其从该 RemoteObjectCallbackList 中删除,则返回 true; 如果未找到指定的回调,则返回 false。
unregisterAll
public void unregisterAll()
从此 RemoteObjectCallbackList 中删除所有以前添加的回调。
从此 RemoteObjectCallbackList 中删除所有回调并将列表标记为不可用后,调用 register(E) 将回调添加到此列表将失败。 该方法用于防止客户端在服务停止后注册回调。
startBroadcast
public int startBroadcast()
开始广播。
此方法创建回调列表的副本并开始调用已注册的回调。 您可以使用 getBroadcastInterface(int) 和 getBroadcastCookie(int) 从列表中检索回调。
一次只允许一个广播。 确保始终从同一个线程调用此方法,并确保在调用此方法后调用 stopBroadcast()。
返回:
返回列表中回调的数量,这也是getBroadcastInterface(int)和getBroadcastCookie(int)可以访问的上限; 如果另一个广播正在运行,则返回 -1。
stopBroadcast
public void stopBroadcast()
停止广播。
您必须在广播完成后调用此方法。
getBroadcastInterface
public E getBroadcastInterface(int index)
获取与广播中给定索引匹配的回调。
该方法只能在广播开始后调用,并且在调用 stopBroadcast() 后其数据不再有效。
如果调用时返回的回调消失了,就会抛出 RemoteException。 您需要捕获此异常,但您可以通过简单地忽略它来处理它,因为回调列表会自动删除无效的回调。
参数:
参数名称 | 参数描述 |
---|---|
index | 回调索引。 不能超过 startBroadcast() 的返回值。 |
返回:
返回匹配给定索引的回调。
getBroadcastCookie
public Object getBroadcastCookie(int index)
获取与广播中给定索引匹配的回调关联的cookie。
参数:
参数名称 | 参数描述 |
---|---|
index | 回调索引。 不能超过 startBroadcast() 的返回值。 |
返回:
返回与给定索引匹配的回调关联的 cookie。