hk

Documentation

Overview

Package hk provides mechanism for registering cleanup functions which are invoked at specified intervals.

• Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.

Package hk provides mechanism for registering cleanup functions which are invoked at specified intervals.

• Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.

Index

• Constants
• Variables
• func Init(stopping *atomic.Bool)
• func Reg(name string, f CleanupFunc, interval time.Duration)
• func TestInit()
• func Unreg(name string)
• func WaitStarted()
• type Action
• type CleanupFunc

Constants

const (
	DelOldIval      = 8 * time.Minute // hk interval: cleanup old
	PruneActiveIval = 2 * time.Minute // hk interval: prune active

	OldAgeLso      = time.Minute      // when list-objects is considered old
	OldAgeLsoNotif = 10 * time.Second // notifications-wise
	OldAgeX        = time.Hour        // all other X
)

const (
	DayInterval   = 24 * time.Hour
	UnregInterval = 365 * DayInterval // to unregister upon return from the callback
)

const NameSuffix = ".gc" // reg name suffix

Variables

var DefaultHK *housekeeper

Functions

func Init

func Init(stopping *atomic.Bool)

func Reg

func Reg(name string, f CleanupFunc, interval time.Duration)

func TestInit

func TestInit()

func Unreg

func Unreg(name string)

func WaitStarted

func WaitStarted()

Types

type Action

type Action interface {
	fmt.Stringer
	Housekeep() time.Duration
}

type CleanupFunc

type CleanupFunc = func() time.Duration