policer

Documentation

Index

• type Network
• type Option
  • func WithContainerSource(v container.Source) Option
  • func WithHeadTimeout(v time.Duration) Option
  • func WithLocalStorage(v *engine.StorageEngine) Option
  • func WithLogger(v *zap.Logger) Option
  • func WithMaxCapacity(capacity uint32) Option
  • func WithNetmapKeys(v netmap.AnnouncedKeys) Option
  • func WithNetwork(n Network) Option
  • func WithNodeLoader(l nodeLoader) Option
  • func WithObjectBatchSize(s uint32) Option
  • func WithPlacementBuilder(v placement.Builder) Option
  • func WithPool(p *ants.Pool) Option
  • func WithRedundantCopyCallback(cb RedundantCopyCallback) Option
  • func WithRemoteHeader(v *headsvc.RemoteHeader) Option
  • func WithReplicationCooldown(d time.Duration) Option
  • func WithReplicator(v *replicator.Replicator) Option
• type Policer
  • func New(opts ...Option) *Policer
  • func (p *Policer) Reload(opts ...Option)
  • func (p *Policer) Run(ctx context.Context)
• type RedundantCopyCallback

Types

type Network

type Network interface {
	// IsLocalNodeInNetmap checks whether the local node belongs to the current
	// network map. If it is impossible to check this fact, IsLocalNodeInNetmap
	// returns false.
	IsLocalNodeInNetmap() bool
}

Network provides information about the NeoFS network to Policer for work.

type Option

type Option func(*cfg)

Option is an option for Policer constructor.

func WithContainerSource

func WithContainerSource(v container.Source) Option

WithContainerSource returns option to set container source of Policer.

func WithHeadTimeout

func WithHeadTimeout(v time.Duration) Option

WithHeadTimeout returns option to set Head timeout of Policer.

func WithLocalStorage

func WithLocalStorage(v *engine.StorageEngine) Option

WithLocalStorage returns option to set local object storage of Policer.

func WithLogger

func WithLogger(v *zap.Logger) Option

WithLogger returns option to set Logger of Policer.

func WithMaxCapacity

func WithMaxCapacity(capacity uint32) Option

WithMaxCapacity returns option to set max capacity that can be set to the pool.

func WithNetmapKeys

func WithNetmapKeys(v netmap.AnnouncedKeys) Option

WithNetmapKeys returns option to set tool to work with announced public keys.

func WithNetwork

func WithNetwork(n Network) Option

WithNetwork provides Network component.

func WithNodeLoader

func WithNodeLoader(l nodeLoader) Option

WithNodeLoader returns option to set NeoFS node load source.

func WithObjectBatchSize

func WithObjectBatchSize(s uint32) Option

WithObjectBatchSize returns option to set maximum objects read from the Storage at once.

func WithPlacementBuilder

func WithPlacementBuilder(v placement.Builder) Option

WithPlacementBuilder returns option to set object placement builder of Policer.

func WithPool

func WithPool(p *ants.Pool) Option

WithPool returns option to set pool for policy and replication operations.

func WithRedundantCopyCallback

func WithRedundantCopyCallback(cb RedundantCopyCallback) Option

WithRedundantCopyCallback returns option to set callback to pass redundant local object copies detected by Policer.

func WithRemoteHeader

func WithRemoteHeader(v *headsvc.RemoteHeader) Option

WithRemoteHeader returns option to set object header receiver of Policer.

func WithReplicationCooldown

func WithReplicationCooldown(d time.Duration) Option

WithReplicationCooldown returns option to set replication cooldown: the Policer will not submit more than one task per a provided time duration.

func WithReplicator

func WithReplicator(v *replicator.Replicator) Option

WithReplicator returns option to set object replicator of Policer.

type Policer

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

Policer represents the utility that verifies compliance with the object storage policy.

func New

func New(opts ...Option) *Policer

New creates, initializes and returns Policer instance.

func (*Policer) Reload

func (p *Policer) Reload(opts ...Option)

Reload allows runtime reconfiguration for the following parameters: - WithHeadTimeout; - [WithObjectCacheTime]; - WithReplicationCooldown; - WithMaxCapacity; - WithObjectBatchSize; - [WithObjectCacheSize].

func (*Policer) Run

func (p *Policer) Run(ctx context.Context)

type RedundantCopyCallback

type RedundantCopyCallback func(oid.Address)

RedundantCopyCallback is a callback to pass the redundant local copy of the object.