gc

Documentation

Index

• type GC
  • func New(options ...Option) GC
• type Logger
• type Option
  • func WithLogger(logger Logger) Option
• type Runner
• type Task

Types

type GC

type GC interface {
	// Add adds GC task
	Add(Task) error

	// Run GC task
	Run(string) error

	// Run all registered GC tasks
	RunAll()

	// Serve running the GC task
	Serve()

	// Stop running the GC task
	Stop()
}

GC is the interface used for release resource

func New

func New(options ...Option) GC

New returns a new GC instence

type Logger

type Logger interface {
	// Infof logs routine messages for GC
	Infof(template string, args ...interface{})
	// Error logs error messages for GC
	Errorf(template string, args ...interface{})
}

Logger is the interface used in GC for logging

type Option

type Option func(g *gc)

Option is a functional option for configuring the GC

func WithLogger

func WithLogger(logger Logger) Option

WithLogger set the logger for GC

type Runner

type Runner interface {
	RunGC() error
}

type Task

type Task struct {
	ID       string
	Interval time.Duration
	Timeout  time.Duration
	Runner   Runner
}

Task is an struct used to run GC instance