模块 wjybxx.btree.core
程序包 cn.wjybxx.btree

类 CancelToken

java.lang.Object
cn.wjybxx.btree.CancelToken
所有已实现的接口:
ICancelToken, ICancelTokenListener
public class CancelToken extends Object implements ICancelToken
作者:
wjybxx date - 2024/7/14

  • 构造器详细资料

    • CancelToken

      public CancelToken()

    • CancelToken

      public CancelToken(int code)

  • 方法详细资料

    • reset

      public void reset()
      重置状态，以供复用
      指定者:
      reset 在接口中 ICancelToken

    • cancelCode

      public int cancelCode()
      从接口复制的说明: ICancelToken
      取消码 1. 按bit位存储信息，包括是否请求中断，是否超时，紧急程度等 2. 低20位为取消原因；高12位为特殊信息 CancelCodes.MASK_REASON 3. 不为0表示已发起取消请求 4. 取消时至少赋值一个信息，reason通常应该赋值
      指定者:
      cancelCode 在接口中 ICancelToken

    • isCancelling

      public boolean isCancelling()
      从接口复制的说明: ICancelToken
      是否已收到取消信号 任务的执行者将持有该令牌，在调度任务前会检测取消信号；如果任务已经开始，则由用户的任务自身检测取消和中断信号。
      指定者:
      isCancelling 在接口中 ICancelToken

    • reason

      public int reason()
      从接口复制的说明: ICancelToken
      取消的原因 (1~10为底层使用，10以上为用户自定义)T
      指定者:
      reason 在接口中 ICancelToken

    • degree

      public int degree()
      从接口复制的说明: ICancelToken
      取消的紧急程度
      指定者:
      degree 在接口中 ICancelToken

    • cancel

      public int cancel()
      从接口复制的说明: ICancelToken
      使用默认取消码 CancelCodes.REASON_DEFAULT
      指定者:
      cancel 在接口中 ICancelToken

    • cancel

      public int cancel(int cancelCode)
      从接口复制的说明: ICancelToken
      发送取消信号
      指定者:
      cancel 在接口中 ICancelToken
      参数:
      cancelCode - 取消码；reason部分需大于0
      返回:
      Token的当前值；如果Token已被取消，则非0；如果Token尚未被取消，则返回0。

    • addListener

      public void addListener(ICancelTokenListener listener)
      从接口复制的说明: ICancelToken
      添加监听器
      指定者:
      addListener 在接口中 ICancelToken

    • remListener

      public boolean remListener(ICancelTokenListener listener)
      从接口复制的说明: ICancelToken
      删除指定监听器
      指定者:
      remListener 在接口中 ICancelToken

    • remListener

      public boolean remListener(ICancelTokenListener listener, boolean firstOccurrence)
      从接口复制的说明: ICancelToken
      删除监听器
      指定者:
      remListener 在接口中 ICancelToken
      参数:
      listener - 要删除的监听器
      firstOccurrence - 是否强制正向查找删除
      返回:
      存在匹配的监听器则返回true

    • hasListener

      public boolean hasListener(ICancelTokenListener listener)
      从接口复制的说明: ICancelToken
      查询是否存在给定的监听器
      指定者:
      hasListener 在接口中 ICancelToken

    • newInstance

      public ICancelToken newInstance()
      从接口复制的说明: ICancelToken
      创建一个同类型实例(默认只拷贝环境数据)
      指定者:
      newInstance 在接口中 ICancelToken

    • newInstance

      public CancelToken newInstance(boolean copyCode)
      从接口复制的说明: ICancelToken
      创建一个同类型实例(默认只拷贝环境数据)
      指定者:
      newInstance 在接口中 ICancelToken
      参数:
      copyCode - 是否拷贝当前取消码
      返回:
      新实例

    • onCancelRequested

      public void onCancelRequested(ICancelToken cancelToken)
      从接口复制的说明: ICancelTokenListener
      该方法在取消令牌收到取消信号时执行
      指定者:
      onCancelRequested 在接口中 ICancelTokenListener
      参数:
      cancelToken - 收到取消信号的令牌