通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CancellationToken 类

  • 参考
包:
system.fabric
  • java.lang.Object
    • AutoCloseable
      • system.fabric.CancellationToken

public class CancellationToken

CancellationToken 用于传播应取消操作的通知。 通过实例化 CancellationTokenSource 对象来创建取消令牌，该对象管理从其 getToken() 方法检索到的取消令牌。 然后，将取消令牌传递给应接收取消通知的任意数量的操作。 令牌不能用于启动取消。 当拥有对象调用 cancel()时，取消令牌上的已取消属性设置为 true。 接收通知的对象可以采用任何适当的方式进行响应。

方法摘要

修饰符和类型 方法和描述
boolean canBeCancelled()

指定是否可以取消取消取消标记。 system.fabric.CancellationToken如果使用 创建 getToken()，则可以使用 cancel() 方法取消令牌。 system.fabric.CancellationToken如果使用 创建 getDefault()，则无法取消。 它只是充当一个虚拟令牌。

void close()
CancellationToken getDefault()

创建并返回取消标记对象。 当 CancellationToken 不支持取消时，应使用此方法。 只有通过 getToken() 创建的取消令牌支持取消。
boolean isCancelled()

获取是否已请求取消此标记。
void registerCancellationCallback(Runnable callback)

注册将在取消此 system.fabric.CancellationToken 对象时执行的回调。

void registerCancellationCallback(String name, Runnable callback)

注册将在取消此 system.fabric.CancellationToken 对象时执行的回调。

void throwIfCancellationRequested()

如果此令牌已请求取消，则引发 CancellationException。

void unregisterCancellationCallback()

取消注册此 system.fabric.CancellationToken 对象的回调。

void unregisterCancellationCallback(String name)

取消注册此 system.fabric.CancellationToken 对象的回调。

方法详细信息

canBeCancelled

public boolean canBeCancelled()

指定是否可以取消取消取消标记。 system.fabric.CancellationToken如果使用 创建 getToken()，则可以使用 cancel() 方法取消令牌。 system.fabric.CancellationToken如果使用 创建 getDefault()，则无法取消。 它只是充当一个虚拟令牌。

返回:

如果可以取消令牌，则返回 true，否则返回 false。

close

public void close()

getDefault

public static CancellationToken getDefault()

创建并返回取消标记对象。 当 CancellationToken 不支持取消时，应使用此方法。 只有通过 getToken() 创建的取消令牌支持取消。

返回:

isCancelled

public boolean isCancelled()

获取是否已请求取消此标记。

返回:

布尔取消状态

registerCancellationCallback

public void registerCancellationCallback(Runnable callback)

注册将在取消此 system.fabric.CancellationToken 对象时执行的回调。

参数:

callback -

java.lang.Runnable 在令牌取消事件时执行。

registerCancellationCallback

public void registerCancellationCallback(String name, Runnable callback)

注册将在取消此 system.fabric.CancellationToken 对象时执行的回调。

参数:

name - 回调名称。
callback -

java.lang.Runnable 在令牌取消事件时执行。

throwIfCancellationRequested

public void throwIfCancellationRequested()

如果此令牌已请求取消，则引发 CancellationException。

unregisterCancellationCallback

public void unregisterCancellationCallback()

取消注册此 system.fabric.CancellationToken 对象的回调。

unregisterCancellationCallback

public void unregisterCancellationCallback(String name)

取消注册此 system.fabric.CancellationToken 对象的回调。

参数:

name - 为此 system.fabric.CancellationToken 对象注册的回调名称。

适用于