HashedWheelTimer (getty-core 1.4.9 API)

java.lang.Object
- com.gettyio.core.util.timer.HashedWheelTimer

所有已实现的接口:: Timer

public class HashedWheelTimer
extends Object
implements Timer

HashedWheelTimer.java

字段概要

字段
限定符和类型	字段和说明
`static int`	`WORKER_STATE_INIT` 定义worker的3个状态：初始化、启动、关闭
`static int`	`WORKER_STATE_SHUTDOWN`
`static int`	`WORKER_STATE_STARTED`
`int`	`workerState` 当前时间轮的状态

构造器概要

构造器
构造器和说明
`HashedWheelTimer()` 创建时间轮 - 使用默认线程工厂，100ms 转一格， 512格，启用内存溢出检测，不设置最大等待处理次数
`HashedWheelTimer(long tickDuration, TimeUnit unit)` 创建时间轮 - 使用默认线程工厂，512格，启用内存溢出检测，不设置最大等待处理次数
`HashedWheelTimer(long tickDuration, TimeUnit unit, int ticksPerWheel)` 创建时间轮 - 使用默认线程工厂，启用内存溢出检测，不设置最大等待处理次数
`HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel)` 创建时间轮 - 启用内存溢出检测，不设置最大等待处理次数
`HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection)` 创建时间轮 -不设置最大等待处理次数
`HashedWheelTimer(ThreadFactory threadFactory, long tickDuration, TimeUnit unit, int ticksPerWheel, boolean leakDetection, long maxPendingTimeouts)` 时间轮的构造函数

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`closeSwitch()` 动态开关关闭 1、轮子每 tick ，只执行过期的定时任务 2、新的 newTimeout 添加的定时任务，添加到格子
`protected void`	`finalize()`
`Timeout`	`newTimeout(TimerTask task, long delay, TimeUnit unit)` newTimeout()添加定时任务如果没有启动时间轮，则启动
`void`	`openSwitch()` 动态开关开启 1、轮子每 tick ，将格子内所有定时任务执行 2、开关开启后的定时任务直接执行，不进入格子。
`void`	`start()` 启动时间轮。
`Set<Timeout>`	`stop()` 停止时间轮的方法

从类继承的方法 java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - WORKER_STATE_INIT
```
public static final int WORKER_STATE_INIT
```
    定义worker的3个状态：初始化、启动、关闭
    
    另请参阅:
    
    常量字段值
  - WORKER_STATE_STARTED
```
public static final int WORKER_STATE_STARTED
```
    另请参阅:
    
    常量字段值
  - WORKER_STATE_SHUTDOWN
```
public static final int WORKER_STATE_SHUTDOWN
```
    另请参阅:
    
    常量字段值
  - workerState
```
public volatile int workerState
```
    当前时间轮的状态
- 构造器详细资料
  - HashedWheelTimer
```
public HashedWheelTimer(ThreadFactory threadFactory,
                        long tickDuration,
                        TimeUnit unit,
                        int ticksPerWheel,
                        boolean leakDetection,
                        long maxPendingTimeouts)
```
    时间轮的构造函数
    
    参数:
    
    threadFactory - ThreadFactory用来创建执行TimerTask的 worker 线程 Thread
    
    tickDuration - tick的时长，即指针多久转一格
    
    unit - tickDuration的时间单位
    
    ticksPerWheel - 每圈几格
    
    leakDetection - 是否开启内存泄露检测；默认设置true 如果工作线程不是守护线程，需设置 false
    
    maxPendingTimeouts - 最大等待处理次数；调用newTimeout的次数超过最大等待处理次数，将抛出异常RejectedExecutionException 如果该值为0或负值，则不考虑最大超时时间限制。
  - HashedWheelTimer
```
public HashedWheelTimer()
```
    创建时间轮 - 使用默认线程工厂，100ms 转一格， 512格，启用内存溢出检测，不设置最大等待处理次数
  - HashedWheelTimer
```
public HashedWheelTimer(long tickDuration,
                        TimeUnit unit)
```
    创建时间轮 - 使用默认线程工厂，512格，启用内存溢出检测，不设置最大等待处理次数
    
    参数:
    
    tickDuration - tick的时长，即指针多久转一格
    
    unit - tickDuration的时间单位
  - HashedWheelTimer
```
public HashedWheelTimer(long tickDuration,
                        TimeUnit unit,
                        int ticksPerWheel)
```
    创建时间轮 - 使用默认线程工厂，启用内存溢出检测，不设置最大等待处理次数
    
    参数:
    
    tickDuration - tick的时长，即指针多久转一格
    
    unit - tickDuration的时间单位
    
    ticksPerWheel - 每圈几格
  - HashedWheelTimer
```
public HashedWheelTimer(ThreadFactory threadFactory,
                        long tickDuration,
                        TimeUnit unit,
                        int ticksPerWheel)
```
    创建时间轮 - 启用内存溢出检测，不设置最大等待处理次数
    
    参数:
    
    threadFactory - ThreadFactory用来创建执行TimerTask的 worker 线程 Thread
    
    tickDuration - tick的时长，即指针多久转一格
    
    unit - tickDuration的时间单位
    
    ticksPerWheel - 每圈几格默认设置true 如果工作线程不是守护线程，需设置 false
  - HashedWheelTimer
```
public HashedWheelTimer(ThreadFactory threadFactory,
                        long tickDuration,
                        TimeUnit unit,
                        int ticksPerWheel,
                        boolean leakDetection)
```
    创建时间轮 -不设置最大等待处理次数
    
    参数:
    
    threadFactory - ThreadFactory用来创建执行TimerTask的 worker 线程 Thread
    
    tickDuration - tick的时长，即指针多久转一格
    
    unit - tickDuration的时间单位
    
    ticksPerWheel - 每圈几格
    
    leakDetection - 是否开启内存泄露检测；默认设置true 如果工作线程不是守护线程，需设置 false
- 方法详细资料
  - newTimeout
```
public Timeout newTimeout(TimerTask task,
                          long delay,
                          TimeUnit unit)
```
    从接口复制的说明: Timer
    
    newTimeout()添加定时任务如果没有启动时间轮，则启动
    
    指定者:
    
    newTimeout 在接口中 Timer
    
    参数:
    
    task - 定时任务
    
    delay - 延迟时间
    
    unit - 延迟时间单位
    
    返回:
    
    the timeout
  - start
```
public void start()
```
    启动时间轮。这个方法其实不需要显示的主动调用，因为在添加定时任务（newTimeout()方法）的时候会自动调用此方法。这个是合理的设计，因为如果时间轮里根本没有定时任务，启动时间轮也是空耗资源
  - stop
```
public Set<Timeout> stop()
```
    停止时间轮的方法
    
    指定者:
    
    stop 在接口中 Timer
    
    返回:
  - openSwitch
```
public void openSwitch()
```
    从接口复制的说明: Timer
    
    动态开关开启 1、轮子每 tick ，将格子内所有定时任务执行 2、开关开启后的定时任务直接执行，不进入格子。
    
    指定者:
    
    openSwitch 在接口中 Timer
  - closeSwitch
```
public void closeSwitch()
```
    从接口复制的说明: Timer
    
    动态开关关闭 1、轮子每 tick ，只执行过期的定时任务 2、新的 newTimeout 添加的定时任务，添加到格子
    
    指定者:
    
    closeSwitch 在接口中 Timer
  - finalize
```
protected void finalize()
                 throws Throwable
```
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable

类 HashedWheelTimer

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

WORKER_STATE_INIT

WORKER_STATE_STARTED

WORKER_STATE_SHUTDOWN

workerState

构造器详细资料

HashedWheelTimer

HashedWheelTimer

HashedWheelTimer

HashedWheelTimer

HashedWheelTimer

HashedWheelTimer

方法详细资料

newTimeout

start

stop

openSwitch

closeSwitch

finalize