jobs

Documentation

Index

• Constants
• Variables
• func GenerateNextStartDateTime(now time.Time, nextStartTime time.Time) *time.Time
• type ConfigService
• type JobServer
  • func NewJobServer(configService ConfigService, store store.Store) *JobServer
  • func (srv *JobServer) CancellationWatcher(ctx context.Context, jobId string, cancelChan chan interface{})
  • func (srv *JobServer) CheckForPendingJobsByType(jobType string) (bool, *model.AppError)
  • func (srv *JobServer) ClaimJob(job *model.Job) (bool, *model.AppError)
  • func (srv *JobServer) Config() *model.Config
  • func (srv *JobServer) CreateJob(jobType string, jobData map[string]string) (*model.Job, *model.AppError)
  • func (srv *JobServer) GetJob(id string) (*model.Job, *model.AppError)
  • func (srv *JobServer) GetLastSuccessfulJobByType(jobType string) (*model.Job, *model.AppError)
  • func (srv *JobServer) InitSchedulers() *Schedulers
  • func (srv *JobServer) InitWorkers() *Workers
  • func (srv *JobServer) MakeTestWorker(name string) *TestWorker
  • func (srv *JobServer) MakeWatcher(workers *Workers, pollingInterval int) *Watcher
  • func (srv *JobServer) RequestCancellation(jobId string) *model.AppError
  • func (srv *JobServer) SetJobCanceled(job *model.Job) *model.AppError
  • func (srv *JobServer) SetJobError(job *model.Job, jobError *model.AppError) *model.AppError
  • func (srv *JobServer) SetJobProgress(job *model.Job, progress int64) *model.AppError
  • func (srv *JobServer) SetJobSuccess(job *model.Job) *model.AppError
  • func (srv *JobServer) StartSchedulers()
  • func (srv *JobServer) StartWorkers()
  • func (srv *JobServer) StopSchedulers()
  • func (srv *JobServer) StopWorkers()
• type Schedulers
  • func (schedulers *Schedulers) Start() *Schedulers
  • func (schedulers *Schedulers) Stop() *Schedulers
• type StaticConfigService
  • func (StaticConfigService) AddConfigListener(func(old, current *model.Config)) string
  • func (s StaticConfigService) Config() *model.Config
  • func (StaticConfigService) RemoveConfigListener(string)
• type TestWorker
  • func (worker *TestWorker) DoJob(job *model.Job)
  • func (worker *TestWorker) JobChannel() chan<- model.Job
  • func (worker *TestWorker) Run()
  • func (worker *TestWorker) Stop()
• type Watcher
  • func (watcher *Watcher) PollAndNotify()
  • func (watcher *Watcher) Start()
  • func (watcher *Watcher) Stop()
• type Workers
  • func (workers *Workers) Start() *Workers
  • func (workers *Workers) Stop() *Workers

Constants

const (
	CANCEL_WATCHER_POLLING_INTERVAL = 5000
)

Variables

var DEFAULT_WATCHER_POLLING_INTERVAL = 15000

Default polling interval for jobs termination. (Defining as `var` rather than `const` allows tests to lower the interval.)

Functions

func GenerateNextStartDateTime

func GenerateNextStartDateTime(now time.Time, nextStartTime time.Time) *time.Time

Types

type ConfigService

type ConfigService interface {
	Config() *model.Config
	AddConfigListener(func(old, current *model.Config)) string
	RemoveConfigListener(string)
}

type JobServer

type JobServer struct {
	ConfigService ConfigService
	Store         store.Store
	Workers       *Workers
	Schedulers    *Schedulers

	DataRetentionJob        ejobs.DataRetentionJobInterface
	MessageExportJob        ejobs.MessageExportJobInterface
	ElasticsearchAggregator ejobs.ElasticsearchAggregatorInterface
	ElasticsearchIndexer    ejobs.ElasticsearchIndexerInterface
	LdapSync                ejobs.LdapSyncInterface
}

func NewJobServer

func NewJobServer(configService ConfigService, store store.Store) *JobServer

func (*JobServer) CancellationWatcher

func (srv *JobServer) CancellationWatcher(ctx context.Context, jobId string, cancelChan chan interface{})

func (*JobServer) CheckForPendingJobsByType

func (srv *JobServer) CheckForPendingJobsByType(jobType string) (bool, *model.AppError)

func (*JobServer) ClaimJob

func (srv *JobServer) ClaimJob(job *model.Job) (bool, *model.AppError)

func (*JobServer) Config

func (srv *JobServer) Config() *model.Config

func (*JobServer) CreateJob

func (srv *JobServer) CreateJob(jobType string, jobData map[string]string) (*model.Job, *model.AppError)

func (*JobServer) GetJob

func (srv *JobServer) GetJob(id string) (*model.Job, *model.AppError)

func (*JobServer) GetLastSuccessfulJobByType

func (srv *JobServer) GetLastSuccessfulJobByType(jobType string) (*model.Job, *model.AppError)

func (*JobServer) InitSchedulers

func (srv *JobServer) InitSchedulers() *Schedulers

func (*JobServer) InitWorkers

func (srv *JobServer) InitWorkers() *Workers

func (*JobServer) MakeTestWorker

func (srv *JobServer) MakeTestWorker(name string) *TestWorker

func (*JobServer) MakeWatcher

func (srv *JobServer) MakeWatcher(workers *Workers, pollingInterval int) *Watcher

func (*JobServer) RequestCancellation

func (srv *JobServer) RequestCancellation(jobId string) *model.AppError

func (*JobServer) SetJobCanceled

func (srv *JobServer) SetJobCanceled(job *model.Job) *model.AppError

func (*JobServer) SetJobError

func (srv *JobServer) SetJobError(job *model.Job, jobError *model.AppError) *model.AppError

func (*JobServer) SetJobProgress

func (srv *JobServer) SetJobProgress(job *model.Job, progress int64) *model.AppError

func (*JobServer) SetJobSuccess

func (srv *JobServer) SetJobSuccess(job *model.Job) *model.AppError

func (*JobServer) StartSchedulers

func (srv *JobServer) StartSchedulers()

func (*JobServer) StartWorkers

func (srv *JobServer) StartWorkers()

func (*JobServer) StopSchedulers

func (srv *JobServer) StopSchedulers()

func (*JobServer) StopWorkers

func (srv *JobServer) StopWorkers()

type Schedulers

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

func (*Schedulers) Start

func (schedulers *Schedulers) Start() *Schedulers

func (*Schedulers) Stop

func (schedulers *Schedulers) Stop() *Schedulers

type StaticConfigService

type StaticConfigService struct {
	Cfg *model.Config
}

func (StaticConfigService) AddConfigListener

func (StaticConfigService) AddConfigListener(func(old, current *model.Config)) string

func (StaticConfigService) Config

func (s StaticConfigService) Config() *model.Config

func (StaticConfigService) RemoveConfigListener

func (StaticConfigService) RemoveConfigListener(string)

type TestWorker

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

func (*TestWorker) DoJob

func (worker *TestWorker) DoJob(job *model.Job)

func (*TestWorker) JobChannel

func (worker *TestWorker) JobChannel() chan<- model.Job

func (*TestWorker) Run

func (worker *TestWorker) Run()

func (*TestWorker) Stop

func (worker *TestWorker) Stop()

type Watcher

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

func (*Watcher) PollAndNotify

func (watcher *Watcher) PollAndNotify()

func (*Watcher) Start

func (watcher *Watcher) Start()

func (*Watcher) Stop

func (watcher *Watcher) Stop()

type Workers

type Workers struct {
	ConfigService ConfigService
	Watcher       *Watcher

	DataRetention            model.Worker
	MessageExport            model.Worker
	ElasticsearchIndexing    model.Worker
	ElasticsearchAggregation model.Worker
	LdapSync                 model.Worker
	// contains filtered or unexported fields
}

func (*Workers) Start

func (workers *Workers) Start() *Workers

func (*Workers) Stop

func (workers *Workers) Stop() *Workers