docs: 优化文档展示，适配部分无目录文档，适配非结构体的类型定义，增加测试用例文档
This commit is contained in:
kercylan
@@ -1,19 +1,20 @@
|
||||
# Timer
|
||||
|
||||
|
||||
|
||||
[](https://pkg.go.dev/github.com/kercylan98/minotaur/timer)
|
||||
|
||||
|
||||
## 目录
|
||||
列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
|
||||
|
||||
|
||||
|
||||
## 目录导航
|
||||
列出了该 `package` 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️
|
||||
<details>
|
||||
<summary>展开 / 折叠目录</summary
|
||||
<summary>展开 / 折叠目录导航</summary>
|
||||
|
||||
|
||||
> 包级函数定义
|
||||
|
||||
|函数|描述
|
||||
|函数名称|描述
|
||||
|:--|:--
|
||||
|[RegSystemNewDayEvent](#RegSystemNewDayEvent)|注册系统新的一天事件
|
||||
|[OnSystemNewDayEvent](#OnSystemNewDayEvent)|系统新的一天事件
|
||||
@@ -26,71 +27,82 @@
|
||||
|[GetTicker](#GetTicker)|获取标准池中的一个定时器
|
||||
|
||||
|
||||
> 结构体定义
|
||||
> 类型定义
|
||||
|
||||
|结构体|描述
|
||||
|:--|:--
|
||||
|[SystemNewDayEventHandle](#systemnewdayeventhandle)|暂无描述...
|
||||
|[Option](#option)|暂无描述...
|
||||
|[Pool](#pool)|定时器池
|
||||
|[Scheduler](#scheduler)|调度器
|
||||
|[Ticker](#ticker)|定时器
|
||||
|类型|名称|描述
|
||||
|:--|:--|:--
|
||||
|`STRUCT`|[SystemNewDayEventHandle](#systemnewdayeventhandle)|暂无描述...
|
||||
|`STRUCT`|[Option](#option)|暂无描述...
|
||||
|`STRUCT`|[Pool](#pool)|定时器池
|
||||
|`STRUCT`|[Scheduler](#scheduler)|调度器
|
||||
|`STRUCT`|[Ticker](#ticker)|定时器
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
***
|
||||
## 详情信息
|
||||
#### func RegSystemNewDayEvent(ticker *Ticker, name string, trigger bool, handle SystemNewDayEventHandle)
|
||||
<span id="RegSystemNewDayEvent"></span>
|
||||
> 注册系统新的一天事件
|
||||
> - 建议全局注册一个事件后再另行拓展
|
||||
> - 将特定 name 的定时任务注册到 ticker 中，在系统时间到达每天的 00:00:00 时触发，如果 trigger 为 true，则立即触发一次
|
||||
|
||||
***
|
||||
#### func OnSystemNewDayEvent(name string)
|
||||
<span id="OnSystemNewDayEvent"></span>
|
||||
> 系统新的一天事件
|
||||
|
||||
***
|
||||
#### func RegOffsetTimeNewDayEvent(ticker *Ticker, name string, offset *offset.Time, trigger bool, handle OffsetTimeNewDayEventHandle)
|
||||
<span id="RegOffsetTimeNewDayEvent"></span>
|
||||
> 注册偏移时间新的一天事件
|
||||
> - 建议全局注册一个事件后再另行拓展
|
||||
> - 与 RegSystemNewDayEvent 类似，但是触发时间为 offset 时间到达每天的 00:00:00
|
||||
|
||||
***
|
||||
#### func OnOffsetTimeNewDayEvent(name string)
|
||||
<span id="OnOffsetTimeNewDayEvent"></span>
|
||||
> 偏移时间新的一天事件
|
||||
|
||||
***
|
||||
#### func WithCaller(handle func (name string, caller func ())) Option
|
||||
<span id="WithCaller"></span>
|
||||
> 通过其他的 handle 执行 Caller
|
||||
|
||||
***
|
||||
#### func WithMark(mark string) Option
|
||||
<span id="WithMark"></span>
|
||||
> 通过特定的标记创建定时器
|
||||
|
||||
***
|
||||
#### func NewPool(tickerPoolSize int) *Pool
|
||||
<span id="NewPool"></span>
|
||||
> 创建一个定时器池，当 tickerPoolSize 小于等于 0 时，将会引发 panic，可指定为 DefaultTickerPoolSize
|
||||
|
||||
***
|
||||
#### func SetPoolSize(size int)
|
||||
<span id="SetPoolSize"></span>
|
||||
> 设置标准池定时器池大小
|
||||
> - 默认值为 DefaultTickerPoolSize，当定时器池中的定时器不足时，会自动创建新的定时器，当定时器释放时，会将多余的定时器进行释放，否则将放入定时器池中
|
||||
|
||||
***
|
||||
#### func GetTicker(size int, options ...Option) *Ticker
|
||||
<span id="GetTicker"></span>
|
||||
> 获取标准池中的一个定时器
|
||||
|
||||
***
|
||||
### SystemNewDayEventHandle
|
||||
### SystemNewDayEventHandle `STRUCT`
|
||||
|
||||
```go
|
||||
type SystemNewDayEventHandle struct{}
|
||||
type SystemNewDayEventHandle func()
|
||||
```
|
||||
### Option
|
||||
### Option `STRUCT`
|
||||
|
||||
```go
|
||||
type Option struct{}
|
||||
type Option func(ticker *Ticker)
|
||||
```
|
||||
### Pool
|
||||
### Pool `STRUCT`
|
||||
定时器池
|
||||
```go
|
||||
type Pool struct {
|
||||
@@ -111,7 +123,7 @@ type Pool struct {
|
||||
> 释放定时器池的资源，释放后由其产生的 Ticker 在 Ticker.Release 后将不再回到池中，而是直接释放
|
||||
> - 虽然定时器池已被释放，但是依旧可以产出 Ticker
|
||||
***
|
||||
### Scheduler
|
||||
### Scheduler `STRUCT`
|
||||
调度器
|
||||
```go
|
||||
type Scheduler struct {
|
||||
@@ -138,7 +150,7 @@ type Scheduler struct {
|
||||
#### func (*Scheduler) Caller()
|
||||
> 可由外部发起调用的执行函数
|
||||
***
|
||||
### Ticker
|
||||
### Ticker `STRUCT`
|
||||
定时器
|
||||
```go
|
||||
type Ticker struct {
|
||||
@@ -168,6 +180,32 @@ type Ticker struct {
|
||||
***
|
||||
#### func (*Ticker) Cron(name string, expression string, handleFunc interface {}, args ...interface {})
|
||||
> 通过 cron 表达式设置一个调度器，当 cron 表达式错误时，将会引发 panic
|
||||
<details>
|
||||
<summary>查看 / 收起单元测试</summary>
|
||||
|
||||
|
||||
```go
|
||||
|
||||
func TestTicker_Cron(t *testing.T) {
|
||||
ticker := timer.GetTicker(10)
|
||||
ticker.After("1_sec", time.Second, func() {
|
||||
t.Log(time.Now().Format(time.DateTime), "1_sec")
|
||||
})
|
||||
ticker.Loop("1_sec_loop_3", 0, time.Second, 3, func() {
|
||||
t.Log(time.Now().Format(time.DateTime), "1_sec_loop_3")
|
||||
})
|
||||
ticker.Cron("5_sec_cron", "0/5 * * * * * ?", func() {
|
||||
t.Log(time.Now().Format(time.DateTime), "5_sec_cron")
|
||||
})
|
||||
time.Sleep(times.Week)
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
***
|
||||
#### func (*Ticker) CronByInstantly(name string, expression string, handleFunc interface {}, args ...interface {})
|
||||
> 与 Cron 相同，但是会立即执行一次
|
||||
|
||||
Reference in New Issue
Block a user