timewheel

README

timewheel

Golang实现的时间轮

原理

延迟消息的实现

安装

go get -u github.com/dlwm/timewheel

使用

package main

import (
	"fmt"
	"github.com/dlwm/timewheel"
	"time"
)

func main() {
	// 初始化时间轮
	// 第一个参数为tick刻度，即时间轮多久转动一次，最小为1秒，跨度1秒
	// 第二个参数为时间轮槽slot数量，即每轮有多少个记录点
	// 第三个参数为回调函数
	tw := timewheel.New(1*time.Second, 3600, func(i interface{}) error {
		fmt.Println(i)
		return nil
	})

	// 开启时间轮
	tw.Start()

	// 添加定时器 
	// 第一个参数为周期性开启标记
	// 第二个参数为延迟时间
	// 第三个参数为定时器唯一标识，删除定时器需传递此参数
	// 第四个参数为用户自定义数据，此参数将会传递给回调函数, 类型为interface{}
	tw.AddTimer(true, 3*time.Second, 9028, "LOOP")  // 周期性任务
	tw.AddTimer(false, 5*time.Second, 9376, "NOOP") // 单次任务
	
	// 根据索引删除任务，参数为添加定时器传递的唯一标识
	tw.RemoveTimer(9028)
	
	// 暂停时间轮
	tw.Stop()

	// 继续时间轮
	tw.Start()

	select {}
}

Documentation

Index

• type Job
• type Task
• type TimeWheel
  • func New(interval time.Duration, slotNum int, job Job) *TimeWheel
  • func (tw *TimeWheel) AddTimer(loop bool, delay time.Duration, key interface{}, data interface{})
  • func (tw *TimeWheel) RemoveTimer(key interface{})
  • func (tw *TimeWheel) Start()
  • func (tw *TimeWheel) Stop()

Types

type Job

type Job func(interface{}) error

Job 延时任务回调函数 返回参数非空时，自动删除循环任务

type Task

type Task struct {
	// contains filtered or unexported fields
}

Task 延时任务

type TimeWheel

type TimeWheel struct {
	// contains filtered or unexported fields
}

TimeWheel 时间轮

func New

func New(interval time.Duration, slotNum int, job Job) *TimeWheel

New 创建时间轮

func (*TimeWheel) AddTimer

func (tw *TimeWheel) AddTimer(loop bool, delay time.Duration, key interface{}, data interface{})

AddTimer 添加定时器 key为定时器唯一标识

func (*TimeWheel) RemoveTimer

func (tw *TimeWheel) RemoveTimer(key interface{})

RemoveTimer 删除定时器 key为添加定时器时传递的定时器唯一标识

func (*TimeWheel) Start

func (tw *TimeWheel) Start()

Start 启动时间轮

func (*TimeWheel) Stop

func (tw *TimeWheel) Stop()

Stop 停止时间轮