audit

Documentation

Index

• Constants
• Variables
• func Select(ids []cid.ID, epoch, index, size uint64) []cid.ID
• type EpochSource
• type Indexer
• type Params
• type Processor
  • func New(p *Params) (*Processor, error)
  • func (ap *Processor) ListenerNotificationHandlers() []event.NotificationHandlerInfo
  • func (ap *Processor) ListenerNotificationParsers() []event.NotificationParserInfo
  • func (ap *Processor) StartAuditHandler() event.Handler
  • func (ap *Processor) TimersHandlers() []event.NotificationHandlerInfo
• type Start
  • func NewAuditStartEvent(epoch uint64) Start
  • func (a Start) Epoch() uint64
  • func (a Start) MorphEvent()
• type TaskManager

Constants

const ProcessorPoolSize = 1

ProcessorPoolSize limits pool size for audit Processor. Processor manages audit tasks and fills queue for the next epoch. This process must not be interrupted by a new audit epoch, so we limit the pool size for the processor to one.

Variables

var ErrInvalidIRNode = errors.New("node is not in the inner ring list")

Functions

func Select

func Select(ids []cid.ID, epoch, index, size uint64) []cid.ID

Types

type EpochSource

type EpochSource interface {
	// EpochCounter must return current epoch number.
	EpochCounter() uint64
}

EpochSource is an interface that provides actual epoch information.

type Indexer

type Indexer interface {
	InnerRingIndex() int
	InnerRingSize() int
}

Indexer is a callback interface for inner ring global state.

type Params

type Params struct {
	Log              *logger.Logger
	NetmapClient     *nmClient.Client
	ContainerClient  *cntClient.Client
	IRList           Indexer
	SGSource         storagegroup.SGSource
	RPCSearchTimeout time.Duration
	TaskManager      TaskManager
	Reporter         audit.Reporter
	Key              *ecdsa.PrivateKey
	EpochSource      EpochSource
}

Params of the processor constructor.

type Processor

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

Processor of events related to data audit.

func New

func New(p *Params) (*Processor, error)

New creates audit processor instance.

func (*Processor) ListenerNotificationHandlers

func (ap *Processor) ListenerNotificationHandlers() []event.NotificationHandlerInfo

ListenerNotificationHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerNotificationParsers

func (ap *Processor) ListenerNotificationParsers() []event.NotificationParserInfo

ListenerNotificationParsers for the 'event.Listener' event producer.

func (*Processor) StartAuditHandler

func (ap *Processor) StartAuditHandler() event.Handler

StartAuditHandler for the internal event producer.

func (*Processor) TimersHandlers

func (ap *Processor) TimersHandlers() []event.NotificationHandlerInfo

TimersHandlers for the 'Timers' event producer.

type Start

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

Start is an event to start a new round of data audit.

func NewAuditStartEvent

func NewAuditStartEvent(epoch uint64) Start

func (Start) Epoch

func (a Start) Epoch() uint64

func (Start) MorphEvent

func (a Start) MorphEvent()

MorphEvent implements the Event interface.

type TaskManager

type TaskManager interface {
	PushTask(*audit.Task) error

	// Must skip all tasks planned for execution and
	// return their number.
	Reset() int
}