expirationwatch

Documentation

Index

• type ExpiredItem
• type Watcher
  • func New() *Watcher
  • func (w *Watcher) Add(expirationTimestamp time.Time, id string)
  • func (w *Watcher) Prune(timestamp time.Time) []ExpiredItem
  • func (w *Watcher) Remove(expirationTimestamp time.Time, id string)

Types

type ExpiredItem

type ExpiredItem struct {
	ExpirationTimestamp time.Time
	ID                  string
}

ExpiredItem represents an expired item returned from the Watcher

type Watcher

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

Watcher watches the expiration of items

func New

func New() *Watcher

New instantiates a new expiration watcher

func (*Watcher) Add

func (w *Watcher) Add(expirationTimestamp time.Time, id string)

Add adds a new item identified by an ID to the expiration watcher

func (*Watcher) Prune

func (w *Watcher) Prune(timestamp time.Time) []ExpiredItem

Prune checks for any expired items given a timestamp and removes any expired items from the expiration watcher and returns them to the caller

func (*Watcher) Remove

func (w *Watcher) Remove(expirationTimestamp time.Time, id string)

Remove removes the item with a specified id from the expiration watcher