tasks_manager

Documentation

Index

• Variables
• type ActionsInterface
• type Manager
  • func NewManager(logger hclog.Logger) *Manager
  • func (m *Manager) AddOptionalTask(ctx context.Context, reqStorage logical.Storage, ...) (string, bool, error)
  • func (m *Manager) AddTask(ctx context.Context, reqStorage logical.Storage, ...) (string, error)
  • func (m *Manager) Paths() []*framework.Path
  • func (m *Manager) PeriodicFunc(ctx context.Context, req *logical.Request) error
  • func (m *Manager) RunTask(ctx context.Context, reqStorage logical.Storage, ...) (string, error)
  • func (m *Manager) TaskFailedCallback(ctx context.Context, uuid string, log []byte, taskErr error)
  • func (m *Manager) TaskStartedCallback(ctx context.Context, uuid string)
  • func (m *Manager) TaskSucceededCallback(ctx context.Context, uuid string, log []byte)
  • func (m *Manager) WrapTaskFunc(taskFunc func(context.Context, logical.Storage) error, ...) func(ctx context.Context) error
• type Task

Variables

var (
	ErrBusy            = errors.New("busy")
	ErrContextCanceled = errors.New("context canceled")
)

Types

type ActionsInterface

type ActionsInterface interface {
	// RunTask runs task or returns busy error
	RunTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(ctx context.Context, storage logical.Storage) error) (string, error)

	// AddTask adds task to queue
	AddTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(ctx context.Context, storage logical.Storage) error) (string, error)

	// AddOptionalTask adds task to queue if empty
	AddOptionalTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(ctx context.Context, storage logical.Storage) error) (string, bool, error)
}

type Manager

type Manager struct {
	Storage logical.Storage
	Worker  worker.Interface
	// contains filtered or unexported fields
}

func NewManager

func NewManager(logger hclog.Logger) *Manager

func (*Manager) AddOptionalTask

func (m *Manager) AddOptionalTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(context.Context, logical.Storage) error) (string, bool, error)

func (*Manager) AddTask

func (m *Manager) AddTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(context.Context, logical.Storage) error) (string, error)

func (*Manager) Paths

func (m *Manager) Paths() []*framework.Path

func (*Manager) PeriodicFunc

func (m *Manager) PeriodicFunc(ctx context.Context, req *logical.Request) error

func (*Manager) RunTask

func (m *Manager) RunTask(ctx context.Context, reqStorage logical.Storage, taskFunc func(context.Context, logical.Storage) error) (string, error)

func (*Manager) TaskFailedCallback

func (m *Manager) TaskFailedCallback(ctx context.Context, uuid string, log []byte, taskErr error)

func (*Manager) TaskStartedCallback

func (m *Manager) TaskStartedCallback(ctx context.Context, uuid string)

func (*Manager) TaskSucceededCallback

func (m *Manager) TaskSucceededCallback(ctx context.Context, uuid string, log []byte)

func (*Manager) WrapTaskFunc

func (m *Manager) WrapTaskFunc(taskFunc func(context.Context, logical.Storage) error, taskTimeoutDuration time.Duration) func(ctx context.Context) error

WrapTaskFunc separates processing of the context and the taskFunc execution in the background

type Task

type Task struct {
	UUID     string    `structs:"uuid" json:"uuid"`
	Status   string    `structs:"status" json:"status"`
	Reason   string    `structs:"reason" json:"reason"`
	Created  time.Time `structs:"created" json:"created"`
	Modified time.Time `structs:"modified" json:"modified"`
}