taskutils

Documentation

Index

• func ContextWithHandler(ctx context.Context, handler *PbHandler) context.Context
• func NewHandler(c context.Context) (*PbHandler, ClearFunc)
• type AtServiceTask
  • func NewAtServiceTask(poolSize int) *AtServiceTask
• type AtStorageTask
  • func NewAtStorageTask(poolSize int) *AtStorageTask
• type BetweenStorageTask
  • func NewBetweenStorageTask(poolSize int) *BetweenStorageTask
• type ClearFunc
• type PbHandler
  • func HandlerFromContext(ctx context.Context) *PbHandler
  • func (h *PbHandler) StartProgress(d time.Duration)
  • func (h *PbHandler) WaitProgress()

Functions

func ContextWithHandler

func ContextWithHandler(ctx context.Context, handler *PbHandler) context.Context

ContextWithHandler return a ctx contains handler

func NewHandler

func NewHandler(c context.Context) (*PbHandler, ClearFunc)

NewHandler new a PbHandler to handle progress bar, and a cancelFunc to cancel the handler

Types

type AtServiceTask

type AtServiceTask struct {
	navvy.Task
	types.Pool
	types.Fault

	types.Service
}

AtServiceTask is the root task for service only task.

func NewAtServiceTask

func NewAtServiceTask(poolSize int) *AtServiceTask

NewAtServiceTask will create a new between storage task.

type AtStorageTask

type AtStorageTask struct {
	navvy.Task
	types.Pool
	types.Fault

	types.Path
	types.Storage
	types.Type
}

AtStorageTask is the root task for single storage task.

func NewAtStorageTask

func NewAtStorageTask(poolSize int) *AtStorageTask

NewAtStorageTask will create a new between storage task.

type BetweenStorageTask

type BetweenStorageTask struct {
	navvy.Task
	types.Pool
	types.Fault

	types.SourcePath
	types.SourceStorage
	types.SourceType
	types.DestinationPath
	types.DestinationStorage
	types.DestinationType
}

BetweenStorageTask is the root task for tasks operate between two storager.

func NewBetweenStorageTask

func NewBetweenStorageTask(poolSize int) *BetweenStorageTask

NewBetweenStorageTask will create a new between storage task.

type ClearFunc

type ClearFunc func()

ClearFunc is the alias of func to clear PbHandler

type PbHandler

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

PbHandler is used to handle progress bar

func HandlerFromContext

func HandlerFromContext(ctx context.Context) *PbHandler

HandlerFromContext get handler from ctx, if not exist, return nil

func (*PbHandler) StartProgress

func (h *PbHandler) StartProgress(d time.Duration)

StartProgress start to get state from state center. d is the duration time between two data, Start a ticker to get data from noah periodically. The data from noah is a map with taskID as key and its state as value. So we range the data and update relevant bar's progress.

func (*PbHandler) WaitProgress

func (h *PbHandler) WaitProgress()

WaitProgress wait the progress bar to complete