CancellationTokenSource

Class CancellationTokenSource

java.lang.Object

com.grapecity.documents.excel.CancellationTokenSource

All Implemented Interfaces:

AutoCloseable

---

public class CancellationTokenSource extends Object implements AutoCloseable

A CancellationTokenSource 允许你向一个或多个方法发出取消请求。要使用令牌源：

• 创建一个令牌源。
• 通过将getToken()的返回值作为参数，将令牌附加到一个或多个操作中。
• 稍后，你可以通过在此令牌源上调用cancel()来取消关联的操作。

这个类是线程安全的。

API Note:

当你不再需要使用它时，必须调用close()方法。

• Constructor Summary

  Constructors

  Constructor

  Description

  CancellationTokenSource()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  void

  cancel()

  启动取消请求。与该令牌关联的所有操作都将被取消。

  void

  cancelAfter(Duration delay)

  安排在指定的时间间隔后对此CancellationTokenSource进行取消操作。

  void

  close()

  关闭资源并执行清理操作。

  CancellationToken

  getToken()

  返回与该CancellationTokenSource关联的令牌。

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • CancellationTokenSource

    public CancellationTokenSource()

• Method Details

  • cancel

    public void cancel()

    启动取消请求。与该令牌关联的所有操作都将被取消。

    假定getToken()的使用者会尽最大努力尝试执行取消操作。此方法立即返回，如果取消成功，被取消的操作将抛出CancellationException。

  • cancelAfter

    public void cancelAfter(Duration delay)

    安排在指定的时间间隔后对此CancellationTokenSource进行取消操作。

    Parameters:

    delay - 在取消此CancellationTokenSource之前等待的时间间隔。此值不能为null。

  • getToken

    public CancellationToken getToken()

    返回与该CancellationTokenSource关联的令牌。

    Returns:

    取消令牌。总是返回同一个实例。

  • close

    public void close() throws Exception

    关闭资源并执行清理操作。

    Specified by:

    close in interface AutoCloseable

    Throws:

    Exception