audittask

Documentation

Index

• type Manager
  • func New(opts ...Option) *Manager
  • func (m *Manager) Listen(ctx context.Context)
  • func (m *Manager) PushTask(t *audit.Task) error
  • func (m *Manager) Reset() (popped int)
• type Option
  • func WithContainerCommunicator(cnrCom auditor.ContainerCommunicator) Option
  • func WithLogger(l *zap.Logger) Option
  • func WithMaxPDPSleepInterval(dur time.Duration) Option
  • func WithPDPWorkerPoolGenerator(f func() (util.WorkerPool, error)) Option
  • func WithPoRWorkerPoolGenerator(f func() (util.WorkerPool, error)) Option
  • func WithQueueCapacity(capacity uint32) Option
  • func WithWorkerPool(p util.WorkerPool) Option

Types

type Manager

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

Manager represents an entity performing data audit tasks.

func New

func New(opts ...Option) *Manager

New creates, initializes and returns new Manager instance.

func (*Manager) Listen

func (m *Manager) Listen(ctx context.Context)

Listen starts the process of processing tasks from the queue.

The listener is terminated by context.

func (*Manager) PushTask

func (m *Manager) PushTask(t *audit.Task) error

PushTask adds a task to the queue for processing.

Returns error if task was not added to the queue.

func (*Manager) Reset

func (m *Manager) Reset() (popped int)

Reset pops all tasks from the queue. Returns amount of popped elements.

type Option

type Option func(*cfg)

Option is a Manager's constructor option.

func WithContainerCommunicator

func WithContainerCommunicator(cnrCom auditor.ContainerCommunicator) Option

WithContainerCommunicator returns option to set component of communication with container nodes.

func WithLogger

func WithLogger(l *zap.Logger) Option

WithLogger returns option to specify Manager's logger.

func WithMaxPDPSleepInterval

func WithMaxPDPSleepInterval(dur time.Duration) Option

WithMaxPDPSleepInterval returns option to set maximum sleep interval between range hash requests as part of PDP check.

func WithPDPWorkerPoolGenerator

func WithPDPWorkerPoolGenerator(f func() (util.WorkerPool, error)) Option

WithPDPWorkerPoolGenerator returns option to set worker pool for PDP pairs processing. Callback caller owns returned pool and must release it appropriately.

func WithPoRWorkerPoolGenerator

func WithPoRWorkerPoolGenerator(f func() (util.WorkerPool, error)) Option

WithPoRWorkerPoolGenerator returns option to set worker pool for PoR SG processing. Callback caller owns returned pool and must release it appropriately.

func WithQueueCapacity

func WithQueueCapacity(capacity uint32) Option

WithQueueCapacity returns option to set task queue capacity.

func WithWorkerPool

func WithWorkerPool(p util.WorkerPool) Option

WithWorkerPool returns option to set worker pool for task execution.