background

Documentation

Index

• Variables
• type CallbackFunc
• type Worker
  • func NewWorker(parent context.Context, name string) *Worker
  • func (b *Worker) Close(ctx context.Context, err error) error
  • func (b *Worker) CloseReason() error
  • func (b *Worker) Context() context.Context
  • func (b *Worker) Done() <-chan struct{}
  • func (b *Worker) Start(name string, f CallbackFunc)
  • func (b *Worker) StopDone() <-chan empty.Struct

Variables

var (
	ErrAlreadyClosed = xerrors.Wrap(errors.New("ydb: background worker already closed"))
)

Types

type CallbackFunc

type CallbackFunc func(ctx context.Context)

type Worker

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

A Worker must not be copied after first use

func NewWorker

func NewWorker(parent context.Context, name string) *Worker

func (*Worker) Close

func (b *Worker) Close(ctx context.Context, err error) error

func (*Worker) CloseReason

func (b *Worker) CloseReason() error

func (*Worker) Context

func (b *Worker) Context() context.Context

func (*Worker) Done

func (b *Worker) Done() <-chan struct{}

func (*Worker) Start

func (b *Worker) Start(name string, f CallbackFunc)

func (*Worker) StopDone

func (b *Worker) StopDone() <-chan empty.Struct