grace

type Config struct {
	// Workers 可选，工作进程配置
	Workers map[string]*WorkerConfig `validate:"required,min=1"`

	// StatusDir 必填，状态数据文件目录，如 主进程的 pid 文件都存放在这里
	StatusDir string `validate:"required"`

	// LogDir 必填，日志文件目录
	// 每个子进程一个子目录
	LogDir string `validate:"required"`

	// StopTimeout 可选，优雅关闭的最长时间，若不填写使用默认值 "10s"
	StopTimeout string

	// CheckInterval 可选，检查版本的间隔时间，默认为 "5s"
	CheckInterval string

	// StartWait 可选，启动新进程后，老进程退出前的等待时间,默认为 "5s"
	StartWait string

	// Keep 可选，是否保持子进程一直存在
	Keep bool
}

type Consumer interface {
	// Start 开始运行 同步、阻塞
	Start(ctx context.Context) error

	// Stop 关闭
	Stop(ctx context.Context) error

	// String 资源的描述
	String() string
}

type Grace struct {
	Option *Option

	// Logger logger，若为空，
	// 将使用默认的使用标准库的log.Writer作为输出
	Logger *log.Logger
	// contains filtered or unexported fields
}

type Option struct {
	StatusDir string

	LogDir string

	// StopTimeout 子进程优雅退出的超时时间
	StopTimeout time.Duration

	// 检查版本的间隔时间，默认为 5 秒
	CheckInterval time.Duration

	// StartWait 可选，启动新进程后，老进程退出前的等待时间,默认为 3 秒
	StartWait time.Duration

	// Keep 是否保持子进程存活
	// 若为 true，当子进程不存在时，将自动拉起
	Keep bool
}

type Resource interface {
	// Open 打开文件，执行后立即返回
	Open(ctx context.Context) error

	// File 资源的文件，父进程使用，以将file传递给子进程
	File(ctx context.Context) (*os.File, error)

	// Listener 获取 Listener
	Listener(ctx context.Context) (net.Listener, error)

	// String 资源的描述
	String() string
}

type ResourceDriverFunc func(index int, dsn string) (Resource, error)

type Server interface {
	Serve(l net.Listener) error
	Shutdown(ctx context.Context) error
}

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

type WorkerConfig struct {
	// EnvFile 可选，提前配置 Cmd 的环境变量的文件
	// 在执行 Cmd 前，通过此文件获取env 信息
	// 1.先直接解析该文件，获取 kv，正确的格式为：
	// key1=1
	// key2=2
	// 若文件不是这个格式，则解析失败
	// 2.尝试执行当前文件，若文件输出的  kv 对，则解析成功，否则为失败
	// 若文件行以 # 开头，会当做注释
	// 允许有 0 个 kv 对
	EnvFile string

	// HomeDir 可选，执行应用程序的根目录
	// Cmd、Watches 对应的文件路径都是相对于此目录的
	HomeDir string

	// LogDir 必填，当前子进程的日志目录
	LogDir string `validate:"required"`

	// Cmd 必填，工作进程的 cmd
	Cmd string `validate:"required"`

	// StopTimeout  优雅关闭的最长时间，若不填写，则使用全局 Config 的
	StopTimeout string

	// StartWait 可选，启动新进程后，老进程退出前的等待时间,若不填写，则使用全局 Config 的
	StartWait string

	// Listen 可选，监听的资源，如 "tcp@127.0.0.1:8909",
	Listen []string

	// CmdArgs 可选，工作进程 cmd 的其他参数
	CmdArgs []string

	// Watches 可选，用于监听版本变化情况的文件列表
	Watches []string
}