worker

Documentation

Index

• type Interface
  • func NewWorker(ctx context.Context, taskChan chan *Task, callbacks TaskCallbacksInterface) Interface
• type Job
  • func (j *Job) Log() []byte
• type SafeBuffer
  • func NewSafeBuffer() *SafeBuffer
  • func (b *SafeBuffer) Bytes() []byte
  • func (b *SafeBuffer) Write(p []byte) (n int, err error)
• type Task
• type TaskCallbacksInterface
• type Worker
  • func (w *Worker) CancelRunningJobByTaskUUID(uuid string) bool
  • func (w *Worker) HoldRunningJobByTaskUUID(uuid string, do func(job *Job)) bool
  • func (w *Worker) Start()

Types

type Interface

type Interface interface {
	Start()
	CancelRunningJobByTaskUUID(uuid string) bool
	HoldRunningJobByTaskUUID(uuid string, do func(job *Job)) bool
}

func NewWorker

func NewWorker(ctx context.Context, taskChan chan *Task, callbacks TaskCallbacksInterface) Interface

type Job

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

func (*Job) Log

func (j *Job) Log() []byte

type SafeBuffer

type SafeBuffer struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

SafeBuffer prevents possible conflicts when shared by goroutines. In the current version, locking is implemented for

- Write, which is used by logboek

- Bytes, which can be used to get the log of the running job

func NewSafeBuffer

func NewSafeBuffer() *SafeBuffer

func (*SafeBuffer) Bytes

func (b *SafeBuffer) Bytes() []byte

func (*SafeBuffer) Write

func (b *SafeBuffer) Write(p []byte) (n int, err error)

type Task

type Task struct {
	Context context.Context
	UUID    string
	Action  func(ctx context.Context) error
}

type TaskCallbacksInterface

type TaskCallbacksInterface interface {
	TaskStartedCallback(ctx context.Context, uuid string)
	TaskFailedCallback(ctx context.Context, uuid string, log []byte, err error)
	TaskSucceededCallback(ctx context.Context, uuid string, log []byte)
}

type Worker

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

func (*Worker) CancelRunningJobByTaskUUID

func (w *Worker) CancelRunningJobByTaskUUID(uuid string) bool

func (*Worker) HoldRunningJobByTaskUUID

func (w *Worker) HoldRunningJobByTaskUUID(uuid string, do func(job *Job)) bool

func (*Worker) Start

func (w *Worker) Start()