policer

Documentation

Index

• type BuryFunc
• type KeySpaceIterator
• type LocalObjectGetFunc
• type LocalObjectHeaderFunc
• type MetricsRegister
• type Option
  • func WithBuryFunc(f BuryFunc) Option
  • func WithContainerSource(v container.Source) Option
  • func WithHeadTimeout(v time.Duration) Option
  • func WithKeySpaceIterator(it KeySpaceIterator) Option
  • func WithKeyStorage(ks *util.KeyStorage) Option
  • func WithLocalObjectGetFunc(v LocalObjectGetFunc) Option
  • func WithLocalObjectHeaderFunc(v LocalObjectHeaderFunc) Option
  • func WithLogger(v *logger.Logger) Option
  • func WithMetrics(m MetricsRegister) Option
  • func WithNetmapKeys(v netmap.AnnouncedKeys) Option
  • func WithPlacementBuilder(v placement.Builder) Option
  • func WithPool(p *ants.Pool) Option
  • func WithRedundantCopyCallback(cb RedundantCopyCallback) Option
  • func WithRemoteObjectGetFunc(v RemoteObjectGetFunc) Option
  • func WithRemoteObjectHeaderFunc(v RemoteObjectHeaderFunc) Option
  • func WithReplicator(v Replicator) Option
• type Policer
  • func New(opts ...Option) *Policer
  • func (p *Policer) Run(ctx context.Context)
• type RedundantCopyCallback
• type RemoteObjectGetFunc
• type RemoteObjectHeaderFunc
• type Replicator

Types

type BuryFunc

type BuryFunc func(context.Context, oid.Address) error

BuryFunc is the function to bury (i.e. inhume) an object.

type KeySpaceIterator

type KeySpaceIterator interface {
	Next(context.Context, uint32) ([]objectcore.Info, error)
	Rewind()
}

KeySpaceIterator is the interface that allows iterating over the key space of local storage. Note that the underlying implementation might be circular: i.e. it can restart when the end of the key space is reached.

type LocalObjectGetFunc

type LocalObjectGetFunc func(context.Context, oid.Address) (*objectSDK.Object, error)

type LocalObjectHeaderFunc

type LocalObjectHeaderFunc func(context.Context, oid.Address) (*objectSDK.Object, error)

LocalObjectHeaderFunc is the function to obtain HEAD info from the current node.

type MetricsRegister

type MetricsRegister interface {
	IncProcessedObjects()
}

type Option

type Option func(*cfg)

Option is an option for Policer constructor.

func WithBuryFunc

func WithBuryFunc(f BuryFunc) Option

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 WithKeySpaceIterator

func WithKeySpaceIterator(it KeySpaceIterator) Option

func WithKeyStorage

func WithKeyStorage(ks *util.KeyStorage) Option

func WithLocalObjectGetFunc

func WithLocalObjectGetFunc(v LocalObjectGetFunc) Option

func WithLocalObjectHeaderFunc

func WithLocalObjectHeaderFunc(v LocalObjectHeaderFunc) Option

WithLocalObjectHeaderFunc returns option to set local object header receiver of Policer.

func WithLogger

func WithLogger(v *logger.Logger) Option

WithLogger returns option to set Logger of Policer.

func WithMetrics

func WithMetrics(m MetricsRegister) Option

WithMetrics returns option to set metrics.

func WithNetmapKeys

func WithNetmapKeys(v netmap.AnnouncedKeys) Option

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

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 WithRemoteObjectGetFunc

func WithRemoteObjectGetFunc(v RemoteObjectGetFunc) Option

func WithRemoteObjectHeaderFunc

func WithRemoteObjectHeaderFunc(v RemoteObjectHeaderFunc) Option

WithRemoteObjectHeaderFunc returns option to set remote object header receiver of Policer.

func WithReplicator

func WithReplicator(v 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) Run

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

type RedundantCopyCallback

type RedundantCopyCallback func(context.Context, oid.Address)

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

type RemoteObjectGetFunc

type RemoteObjectGetFunc func(context.Context, netmapSDK.NodeInfo, oid.Address) (*objectSDK.Object, error)

type RemoteObjectHeaderFunc

type RemoteObjectHeaderFunc func(context.Context, netmapSDK.NodeInfo, oid.Address, bool) (*objectSDK.Object, error)

RemoteObjectHeaderFunc is the function to obtain HEAD info from a specific remote node.

type Replicator

type Replicator interface {
	HandleReplicationTask(ctx context.Context, task replicator.Task, res replicator.TaskResult)
	HandlePullTask(ctx context.Context, task replicator.Task)
	HandleLocalPutTask(ctx context.Context, task replicator.Task)
}

Replicator is the interface to a consumer of replication tasks.