schedule

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package schedule 复刻官方 schedule 的进程内调度核心:after(延迟一次性)、 at(绝对时刻一次性)、every(固定周期,不低于 5 分钟)三类提醒的注册、触发与 取消。提醒投递不离开拥有者会话(session-local)。

Index

Constants

View Source
const MinEveryInterval = 5 * time.Minute

MinEveryInterval 是固定周期规则允许的最小间隔(5 分钟)。

Variables

View Source
var ErrEmptyPrompt = errors.New("schedule: empty prompt")

ErrEmptyPrompt 提醒内容为空。

View Source
var ErrIntervalTooShort = errors.New("schedule: every interval below minimum")

ErrIntervalTooShort 周期小于最小值。

View Source
var ErrNotFuture = errors.New("schedule: target is not in the future")

ErrNotFuture 目标时刻不在未来。

Functions

This section is empty.

Types

type Dispatch

type Dispatch struct {
	ID     string
	Prompt string
}

Dispatch 是一次到点回调。

type Entry

type Entry struct {
	ID       string
	Kind     Kind
	Prompt   string
	NextAt   time.Time
	Interval time.Duration // 仅 every
}

Entry 是一条活动提醒。

type Kind

type Kind string

Kind 是调度规则类型。

const (
	KindAfter Kind = "after" // 相对延迟一次性
	KindAt    Kind = "at"    // 绝对时刻一次性
	KindEvery Kind = "every" // 固定周期
)

type Scheduler

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

Scheduler 是并发安全的进程内调度器。

func New

func New() *Scheduler

New 创建调度器,dispatch 送到返回的通道。

func (*Scheduler) After

func (s *Scheduler) After(id, prompt string, delay time.Duration) error

After 注册相对延迟一次性提醒。

func (*Scheduler) At

func (s *Scheduler) At(id, prompt string, at time.Time) error

At 注册绝对时刻一次性提醒。

func (*Scheduler) Cancel

func (s *Scheduler) Cancel(id string) bool

Cancel 取消一条提醒;不存在返回 false。

func (*Scheduler) Every

func (s *Scheduler) Every(id, prompt string, interval time.Duration) error

Every 注册固定周期提醒。

func (*Scheduler) List

func (s *Scheduler) List() []Entry

List 列出活动提醒快照。

func (*Scheduler) Out

func (s *Scheduler) Out() <-chan Dispatch

Out 返回到点通知通道。

func (*Scheduler) SetNow

func (s *Scheduler) SetNow(f func() time.Time)

SetNow 注入时钟(测试用)。

func (*Scheduler) Shutdown

func (s *Scheduler) Shutdown()

Shutdown 停止全部计时器。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL