Documentation
¶
Overview ¶
gtimer 包实现了定时/延迟任务的执行与管理。
本包旨在管理数百万级别的定时任务。gtimer 与 gcron 的区别在于： 1. gcron 包是基于 gtimer 包实现的。 2. gtimer 侧重于高性能，适用于处理百万级的定时任务。 3. gcron 支持类似 Linux crontab 的配置模式语法，更加便于人工阅读。 4. gtimer 的基准操作时间单位为纳秒，而 gcron 的基准操作时间单位为微秒。
另外，特别注意定时器常见的延迟问题：https://github.com/golang/go/issues/14410 md5:c0dc9837a603eb26
Index ¶
- Constants
- func SetInterval别名(ctx context.Context, interval time.Duration, job JobFunc)
- func SetTimeout别名(ctx context.Context, delay time.Duration, job JobFunc)
- func X延时加入单例循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func X延时加入单次任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func X延时加入循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func X延时加入指定次数任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func X延时加入详细循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func X退出()
- type Entry
- func X加入单例循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func X加入单次任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func X加入循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func X加入指定次数任务(上下文 context.Context, 间隔时长 time.Duration, 次数 int, ...) *Entry
- func X加入详细循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc, ...) *Entry
- func (entry *Entry) X关闭任务()
- func (entry *Entry) X取任务上下文() context.Context
- func (entry *Entry) X取任务函数() JobFunc
- func (entry *Entry) X取任务状态() int
- func (entry *Entry) X开始工作()
- func (entry *Entry) X异步运行()
- func (entry *Entry) X是否单例模式() bool
- func (entry *Entry) X暂停工作()
- func (entry *Entry) X设置任务次数(次数 int)
- func (entry *Entry) X设置任务状态(状态 int) int
- func (entry *Entry) X设置单例模式(单例模式 bool)
- func (entry *Entry) X重置任务()
- type JobFunc
- type Timer
- func (t *Timer) X关闭任务()
- func (t *Timer) X加入单例循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func (t *Timer) X加入单次任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func (t *Timer) X加入循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc) *Entry
- func (t *Timer) X加入指定次数任务(上下文 context.Context, 间隔时长 time.Duration, 次数 int, ...) *Entry
- func (t *Timer) X加入详细循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc, ...) *Entry
- func (t *Timer) X延时加入单例循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func (t *Timer) X延时加入单次任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func (t *Timer) X延时加入循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func (t *Timer) X延时加入指定次数任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func (t *Timer) X延时加入详细循环任务(上下文 context.Context, 延时加入 time.Duration, ...)
- func (t *Timer) X开始工作()
- func (t *Timer) X暂停工作()
- type TimerOptions
Constants ¶
const ( StatusReady = 0 // 作业或定时器已准备好运行。 md5:043261776a379433 StatusRunning = 1 // 已经有任务或定时器在运行。 md5:148ed9b5d89215fe StatusStopped = 2 // 任务或定时器已停止。 md5:3cc8479a2061f7db StatusClosed = -1 // 作业或计时器已关闭，正在等待被删除。 md5:9b775a18fd7fe5b9 )
Variables ¶
This section is empty.
Functions ¶
func SetInterval别名 ¶
SetInterval别名 每隔 `delay` 的时间运行一次任务。 类似于 JavaScript 中的 SetInterval别名。 md5:1a47e33b3567d415
func SetTimeout别名 ¶
SetTimeout别名 在`delay`时间间隔后执行一次该任务。 它的作用类似于JavaScript中的同名函数。 md5:e0477460fecac4d8
func X延时加入单例循环任务 ¶
X延时加入单例循环任务 在延迟`interval`时长后添加一个定时任务。 参阅 AddSingleton。 md5:80f70090fa17a370
func X延时加入指定次数任务 ¶
X延时加入指定次数任务 在延迟`interval`持续时间后，添加一个定时任务。 参见AddTimes。 md5:62463bf6c56709b2
Types ¶
type Entry ¶
type Entry struct {
// contains filtered or unexported fields
}
Entry是定时任务。 md5:50a66c0cedad73c2
func X加入详细循环任务 ¶
func X加入详细循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc, 是否单例模式 bool, 次数 int, 任务状态 int) *Entry
X加入详细循环任务 向默认计时器添加一个带有详细参数的定时任务。
参数 `interval` 指定任务的运行间隔。
参数 `singleton` 指定任务是否以单例模式运行。 当任务为单例模式时，同一任务只允许有一个实例在运行。
参数 `times` 限制了任务的运行次数，意味着如果任务运行次数超过 `times` 就会退出。
参数 `status` 指定任务首次添加到计时器时的状态。 md5:0f65b7fd26b5f483
type Timer ¶
type Timer struct {
// contains filtered or unexported fields
}
Timer 是计时器管理器，它使用ticks来计算时间间隔。 md5:eab16bf4737f12a8
func (*Timer) X加入详细循环任务 ¶
func (t *Timer) X加入详细循环任务(上下文 context.Context, 间隔时长 time.Duration, 任务函数 JobFunc, 是否单例模式 bool, 次数 int, 任务状态 int) *Entry
X加入详细循环任务 向计时器添加一个具有详细参数的定时任务。
参数 `interval` 指定任务的运行间隔。
参数 `singleton` 指定任务是否以单例模式运行。当任务为单例模式时，只允许运行一个相同的任务。
参数 `times` 指定任务的最大运行次数，即如果任务的运行次数超过 `times`，则退出。
参数 `status` 指定任务初次添加到计时器时的状态。 md5:22c21ed21d95479c
func (*Timer) X延时加入单例循环任务 ¶
func (t *Timer) X延时加入单例循环任务(上下文 context.Context, 延时加入 time.Duration, 间隔时长 time.Duration, 任务函数 JobFunc)
X延时加入单例循环任务 在延迟`delay`时间后添加一个定时任务。 另请参阅AddSingleton。 md5:4df66d0755ab0371
func (*Timer) X延时加入单次任务 ¶
func (t *Timer) X延时加入单次任务(上下文 context.Context, 延时加入 time.Duration, 间隔时长 time.Duration, 任务函数 JobFunc)
X延时加入单次任务 在延迟 `delay` 持续时间后添加一个定时任务。 参见 AddOnce。 md5:613532ca791628bf
func (*Timer) X延时加入循环任务 ¶
func (t *Timer) X延时加入循环任务(上下文 context.Context, 延时加入 time.Duration, 间隔时长 time.Duration, 任务函数 JobFunc)
X延时加入循环任务 在延迟`delay`持续时间后添加一个定时任务。 参阅 Add。 md5:5db03c917e923b89
func (*Timer) X延时加入指定次数任务 ¶
func (t *Timer) X延时加入指定次数任务(上下文 context.Context, 延时加入 time.Duration, 间隔时长 time.Duration, 次数 int, 任务函数 JobFunc)
X延时加入指定次数任务 在`delay`持续时间后添加一个定时任务。 参阅 AddTimes。 md5:8a53452ea0989047
type TimerOptions ¶
type TimerOptions struct {
Interval time.Duration // (可选) Interval是计时器的基础滚动间隔刻度。 md5:4c933d7fc9ae2121
Quick bool // Quick 用于快速计时器，这意味着计时器不会等待第一个间隔结束便立即触发。 md5:7b719aee1cbeb308
}
TimerOptions是Timer的配置对象。 md5:9d2942910cd72ea4
Source Files