job

Documentation

Index

• Constants
• type Job
  • func New(cfg *config.Config, gdb *gorm.DB) (*Job, error)
  • func (j *Job) Serve()
  • func (j *Job) Stop()
• type Preheat
• type PreheatType
  • func (p PreheatType) String() string
• type SyncPeers
• type Task

Constants

const DefaultTaskPollingInterval = 10 * time.Second

DefaultTaskPollingInterval is the default interval for polling task.

Types

type Job

type Job struct {
	*internaljob.Job
	Preheat
	SyncPeers
	Task
}

Job is an implementation of job.

func New

func New(cfg *config.Config, gdb *gorm.DB) (*Job, error)

New returns a new Job.

func (*Job) Serve

func (j *Job) Serve()

Serve starts the job server.

func (*Job) Stop

func (j *Job) Stop()

Stop stops the job server.

type Preheat

type Preheat interface {
	// CreatePreheat creates a preheat job.
	CreatePreheat(context.Context, []models.Scheduler, types.PreheatArgs) (*internaljob.GroupJobState, error)
}

Preheat is an interface for preheat job.

type PreheatType

type PreheatType string

preheatImage is an image for preheat.

const (
	// PreheatImageType is image type of preheat job.
	PreheatImageType PreheatType = "image"

	// PreheatFileType is file type of preheat job.
	PreheatFileType PreheatType = "file"
)

func (PreheatType) String

func (p PreheatType) String() string

String returns the string representation of PreheatType.

type SyncPeers

type SyncPeers interface {
	// CreateSyncPeers creates sync peers job, and merge the sync peer results with the data
	// in the peer table in the database. It is a synchronous operation, and it will returns
	// an error if the sync peers job is failed.
	CreateSyncPeers(context.Context, []models.Scheduler) error

	// Serve started sync peers server.
	Serve()

	// Stop sync peers server.
	Stop()
}

SyncPeers is an interface for sync peers. It is only supported in Rust client, refer to https://github.com/dragonflyoss/client.

type Task

type Task interface {
	// CreateGetTask create a get task job.
	CreateGetTask(context.Context, []models.Scheduler, types.GetTaskArgs) (*internaljob.GroupJobState, error)

	// CreateDeleteTask create a delete task job.
	CreateDeleteTask(context.Context, []models.Scheduler, types.DeleteTaskArgs) (*internaljob.GroupJobState, error)
}

Task is an interface for manager tasks.