interface.go

package agscheduler

import (
	"context"
	"time"
)

// Defines the interface that each store must implement.
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
}

// Defines the interface that each queue must implement.
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
}

// Defines the interface that each backend must implement.
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
}