window

Documentation

Index

• type Config
• type Window
  • func New(config Config) *Window
  • func (w *Window) Add(value interface{})
  • func (w *Window) Length() int
  • func (w *Window) Oldest() (interface{}, bool)

Types

type Config

type Config struct {
	Clock   *mockable.Clock
	MaxSize int
	TTL     time.Duration
}

Config exposes parameters for Window

type Window

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

Window is an interface which represents a sliding window of elements.

func New

func New(config Config) *Window

New returns an instance of window

func (*Window) Add

func (w *Window) Add(value interface{})

Add adds an element to a window and also evicts any elements if they've been present in the window beyond the configured time-to-live

func (*Window) Length

func (w *Window) Length() int

Length returns the number of elements in the window.

func (*Window) Oldest

func (w *Window) Oldest() (interface{}, bool)

Oldest returns the oldest element in the window.