gc

Documentation

Index

• type GC
  • func New(options ...Option) (GC, error)
• type Logger
• type Option
  • func WithInterval(interval time.Duration) Option
  • func WithLogger(logger Logger) Option
  • func WithTimeout(timeout time.Duration) Option
• type Task

Types

type GC

type GC interface {
	// Add adds GC task
	Add(string, Task)

	// 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, error)

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 WithInterval

func WithInterval(interval time.Duration) Option

WithInterval set the interval for GC collection

func WithLogger

func WithLogger(logger Logger) Option

WithLogger set the logger for GC

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout set the timeout for GC collection

type Task

type Task interface {
	// The actual function to run GC task
	RunGC() error
}

Task is an interface used to run GC instance