server zh cn

服务端

• 使用NewServer()初始化服务，其参数是server的配置，所有配置在下面

import "github.com/gojuukaze/YTask/v3"

ser := ytask.Server.NewServer(
		ytask.Config.Broker(&broker),
		ytask.Config.Backend(&backend),
		...
)

服务端配置

配置	是否必须	默认值	code	说明
Broker	*		ytask.Config.Broker
Backend		nil	ytask.Config.Backend
Debug		FALSE	ytask.Config.Debug	是否开启debug
StatusExpires		1day	ytask.Config.StatusExpires	单位：秒，任务状态的过期时间, -1:永久保存（有的backend可能不支持）
ResultExpires		1day	ytask.Config.ResultExpires	单位：秒，任务结果的过期时间, -1:永久保存 （有的backend可能不支持）

• 任务状态、结果有什么不同？

  • 状态： 任务的开始、运行、成功、失败状态
  • 结果： 函数的返回值

• 对于mongo backend 过期时间 0代表不存储，>0代表永久存储

注册任务

使用Add注册任务

func addFunc(a,b int) (int, bool){
    return a+b, true
}

// group1 : 任务所属组，也是队列的名字
// add : 任务名 
// addFunc : 任务函数
ser.Add("group1","add",addFunc)

任务函数的 参数、返回值 支持所有能被系列化为json的类型。

如果需要在函数中控制任务的重试等东西，则函数的第一个参数为TaskCtl (带TaskCtl函数和其他函数使用上没区别)

如：

func addFunc(ctl *controller.TaskCtl, a int, b int) (int, int) {
	if ... {
        // retry
		ctl.Retry(errors.New("ctl.Retry"))
        return 0, 0
	}

	return a + b, a - b
}

ser.Add("group1","add",addFunc)

运行与停止

// group1 : 运行的组名
// 3 : 并发任务数
// false : 是否开启延时任务
ser.Run("group1", 3, false)

quit := make(chan os.Signal, 1)
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
<-quit
ser.Shutdown(context.Background())

运行多个group

• V2.2.0+ 才支持

ser:=ytask.Server.NewServer(...)

ser.Run("g1", 5)
ser.Run("g2", 5)