XNetworkingUnregisterConnectivityHintChanged

取消注册已使用 XNetworkingRegisterConnectivityHintChanged 注册的回调函数。

语法

bool XNetworkingUnregisterConnectivityHintChanged(
         XTaskQueueRegistrationToken token,
         bool wait
)

参数

token _In_
类型:XTaskQueueRegistrationToken

XNetworkingRegisterConnectivityHintChanged 返回的令牌。

wait _In_
类型:bool

指示是否阻止直到完成所有挂起的回调。

返回值

类型:bool

如果 wait 为 false 且正在挂起取消注册,则返回 false。 否则返回 true。

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息,请参阅时间敏感线程

此函数执行以下操作:

  • 从注册的回调集中删除与令牌关联的回调。
  • 如果对于该回调令牌未执行任何回调,则调用返回 true。
  • 如果回调正在执行且 wait 为 true,将阻止调用直到完成执行的回调。
  • 如果回调正在执行且 wait 为 false,将不阻止调用,但是会返回 false。 完成该令牌的回调后,自动取消注册令牌。

注意

如果 wait 为 true,则不应从 XNetworkingConnectivityHintChangedCallback 内部调用此函数,因为这会死锁。

此机制允许以下编码模式:

  • 您可以在取消注册时阻止,以确保在取消注册调用后从不调用您的回调。
  • 您可以选择不阻止。 如果您需要确保在删除数据前完成您的回调,可以定期调用此函数且将 wait 设置为 false。 当它最终返回 true 时,所有回调都已完成,且您可以删除状态。
  • 如果您的回调不介意在取消注册调用期间自己是否被调用,您可以针对 wait 传递 false 并忽略返回值。

要求

头文件:XNetworking.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XNetworkingRegisterConnectivityHintChanged
XNetworkingGetConnectivityHint
网络初始化和连接
XNetworking