agscheduler

type Backend interface {
	// Backend name.
	Name() string

	// Initialization functions for each backend,
	// called when the scheduler run `SetBackend`.
	Init() error

	// Record the metadata of the job to this backend.
	RecordMetadata(r Record) error

	// Record the result of the job run to this backend.
	RecordResult(id uint64, status string, result string) error

	// Get records by job id from this backend.
	//  @return records, total, error.
	GetRecords(jId string, page, pageSize int) ([]Record, int64, error)

	// Get all records from this backend.
	//  @return records, total, error.
	GetAllRecords(page, pageSize int) ([]Record, int64, error)

	// Delete records by job id from this backend.
	DeleteRecords(jId string) error

	// Delete all records from this backend.
	DeleteAllRecords() error

	// Clear all resources bound to this backend.
	Clear() error
}

type Broker struct {
	// Job queues.
	// def: map[<queue>]QueuePkg
	Queues map[string]QueuePkg
	// contains filtered or unexported fields
}

type CallbackPkg struct {
	Callback func(ep EventPkg)
	Event    event
}

type ClusterNode struct {
	// Main node RPC listening address.
	// If you are the main, `EndpointMain` is the same as `Endpoint`.
	// Default: `127.0.0.1:36380`
	EndpointMain string
	// The unique identifier of this node.
	// RPC listening address.
	// Used to expose the cluster's internal API.
	// Default: `127.0.0.1:36380`
	Endpoint string
	// gRPC listening address.
	// Used to expose the external API.
	// Default: `127.0.0.1:36360`
	EndpointGRPC string
	// HTTP listening address.
	// Used to expose the external API.
	// Default: `127.0.0.1:36370`
	EndpointHTTP string
	// Useful when a job specifies a queue.
	// A queue can correspond to multiple nodes.
	// Default: `default`
	Queue string
	// Node mode, for Scheduler high availability.
	// If the value is `HA`, the node will join the raft group.
	// Default: “, Options `HA`
	Mode string

	// Bind to each other and the Scheduler.
	Scheduler *Scheduler

	// For Scheduler high availability.
	// Bind to each other and the Raft.
	Raft *Raft
	// Used to mark the status of Cluster Scheduler operation.
	SchedulerCanStart bool
	// contains filtered or unexported fields
}

type EventPkg struct {
	Event event
	JobId string
	Data  any
}

type FuncPkg struct {
	Func func(context.Context, Job) (result string)
	// About this function.
	Info string
}

type FuncUnregisteredError string

type HeartbeatArgs struct {
	Term           int
	LeaderEndpoint string

	SchedulerCanStart bool
}

type HeartbeatReply struct {
	Term int
}

type Job struct {
	// The unique identifier of this job, automatically generated.
	// It should not be set manually.
	Id string `json:"id"`
	// User defined.
	Name string `json:"name"`
	// Optional: `JOB_TYPE_DATETIME` | `JOB_TYPE_INTERVAL` | `JOB_TYPE_CRON`
	Type string `json:"type"`
	// It can be used when Type is `JOB_TYPE_DATETIME`.
	// e.g. `2023-09-22 07:30:08`
	StartAt string `json:"start_at"`
	// This field is useless.
	EndAt string `json:"end_at"`
	// It can be used when Type is `JOB_TYPE_INTERVAL`.
	// e.g. `2s`
	Interval string `json:"interval"`
	// It can be used when Type is `JOB_TYPE_CRON`.
	// See `https://en.wikipedia.org/wiki/Cron`.
	// e.g. `*/1 * * * *`
	CronExpr string `json:"cron_expr"`
	// Refer to `time.LoadLocation`.
	// See `https://en.wikipedia.org/wiki/List_of_tz_database_time_zones`
	// Default: `UTC`
	Timezone string `json:"timezone"`
	// The job actually runs the function,
	// and you need to register it through 'RegisterFuncs' before using it.
	// Since it cannot be stored by serialization,
	// when using gRPC or HTTP calls, you should use `FuncName`.
	Func func(context.Context, Job) (result string) `json:"-"`
	// The actual path of `Func`.
	// This field has a higher priority than `Func`
	// e.g. `main.xxxFunc`
	//      `github.com/agscheduler/agscheduler/examples.PrintMsg`
	FuncName string `json:"func_name"`
	// Arguments for `Func`.
	Args map[string]any `json:"args"`
	// The running timeout of `Func`.
	// Default: `1h`
	Timeout string `json:"timeout"`
	// Used in cluster mode, if empty, randomly pick a node to run `Func`,
	// but when broker exist, if empty, randomly pick a queue to run `Func`.
	Queues []string `json:"queues"`
	// Maximum number of concurrent instances for this job.
	// Minimum value is 1, cannot be set to 0 or negative.
	// Default: 1
	// Note: In protobuf, values ≤ 0 will be treated as 1.
	MaxInstances int `json:"max_instances"`

	// Automatic update, not manual setting.
	LastRunTime time.Time `json:"last_run_time"`
	// Automatic update, not manual setting.
	// When the job is paused, this field is set to `9999-09-09 09:09:09`.
	NextRunTime time.Time `json:"next_run_time"`
	// Optional: `JOB_STATUS_RUNNING` | `JOB_STATUS_PAUSED`
	// It should not be set manually.
	Status string `json:"status"`
}

type JobNotFoundError string

type JobSlice []Job

type JobTimeoutError struct {
	FullName string
	Timeout  string
	Err      error
}

type Listener struct {
	Callbacks []CallbackPkg
}

type Node struct {
	EndpointMain string
	Endpoint     string
	EndpointGRPC string
	EndpointHTTP string
	Queue        string
	Mode         string

	NodeMap TypeNodeMap
}

type Queue interface {
	// Queue name.
	Name() string

	// Initialization functions for each queue,
	// called when the scheduler run `SetBroker`.
	Init(ctx context.Context) error

	// Push job to this queue.
	PushJob(bJ []byte) error

	// Pull job from this queue.
	PullJob() <-chan []byte

	// Count the number of jobs in this queue.
	//  @return -1, nil, if the queue does not support this feature or error.
	CountJobs() (int, error)

	// Clear all resources bound to this queue.
	Clear() error
}

type QueuePkg struct {
	Queue Queue
	// Number of workers.
	// Default: `2`
	Workers int
}

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

type Record struct {
	// Unique Id
	Id uint64 `json:"id"`
	// Job id
	JobId string `json:"job_id"`
	// Job name
	JobName string `json:"job_name"`
	// Optional: `RECORD_STATUS_RUNNING` | `RECORD_STATUS_COMPLETED` | `RECORD_STATUS_ERROR` | `RECORD_STATUS_TIMEOUT`
	Status string `json:"status"`
	// The result of the job run
	Result string `json:"result"`
	// Start time
	StartAt time.Time `json:"start_at"`
	// End time
	EndAt time.Time `json:"end_at"`
}

type RecordSlice []Record

type Recorder struct {
	// Record store
	// It should not be used directly.
	Backend Backend
	// contains filtered or unexported fields
}

type Role int

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

type Store interface {
	// Store name.
	Name() string

	// Initialization functions for each store,
	// called when the scheduler run `SetStore`.
	Init() error

	// Add job to this store.
	AddJob(j Job) error

	// Get the job from this store.
	//  @return error `JobNotFoundError` if there are no job.
	GetJob(id string) (Job, error)

	// Get all jobs from this store.
	GetAllJobs() ([]Job, error)

	// Update job in store with a newer version.
	UpdateJob(j Job) error

	// Delete the job from this store.
	DeleteJob(id string) error

	// Delete all jobs from this store.
	DeleteAllJobs() error

	// Get the earliest next run time of all the jobs stored in this store,
	// or `time.Time{}` if there are no job.
	// Used to set the wakeup interval for the scheduler.
	GetNextRunTime() (time.Time, error)

	// Clear all resources bound to this store.
	Clear() error
}

type TypeNodeMap map[string]map[string]any

type VoteArgs struct {
	Term              int
	CandidateEndpoint string
}

type VoteReply struct {
	Term        int
	VoteGranted bool
}