gc

Documentation

Index

• type GC
  • func New(opts ...Option) *GC
  • func (gc *GC) DeleteObjects(list ...*object.Address)
  • func (gc *GC) Run(ctx context.Context)
• type Option
  • func WithLogger(v *logger.Logger) Option
  • func WithQueueCapacity(v uint32) Option
  • func WithRemover(v Remover) Option
  • func WithSleepInterval(v time.Duration) Option
  • func WithWorkingInterval(v time.Duration) Option
• type Remover

Types

type GC

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

GC represents an object garbage collector.

func New

func New(opts ...Option) *GC

New creates, initializes and returns GC instance.

func (*GC) DeleteObjects

func (gc *GC) DeleteObjects(list ...*object.Address)

DeleteObjects adds list of adresses to delete queue.

func (*GC) Run

func (gc *GC) Run(ctx context.Context)

type Option

type Option func(*cfg)

Option represents GC constructor option.

func WithLogger

func WithLogger(v *logger.Logger) Option

WithLogger returns option to set logging component.

func WithQueueCapacity

func WithQueueCapacity(v uint32) Option

WithQueueCapacity returns option to set delete queue capacity.

func WithRemover

func WithRemover(v Remover) Option

WithRemover returns option to set object remover.

func WithSleepInterval

func WithSleepInterval(v time.Duration) Option

WithSleepInteval returns option to set sleep interval of GC.

func WithWorkingInterval

func WithWorkingInterval(v time.Duration) Option

WithWorkingInterval returns option to set working interval of GC.

type Remover

type Remover interface {
	// Delete removes object from physical storage.
	Delete(...*object.Address) error
}

Remover is an interface of the component that stores objects.