memory

Documentation

Overview

Package memory providers in-memory cache containers.

Index

• type Container
  • func (c Container) Available() bool
  • func (c Container) NewContainer(capacity int) caching.Container
  • func (c Container) Register(function func(int) caching.Container)

Types

type Container

type Container byte

Container represents a memory cache container that implemented in another package.

const (
	// FIFO represents a memory container using replacement algorithm using FIFO (first in first out).
	FIFO Container = iota + 1

	// LFU represents a memory container using replacement algorithm using LFU (least frequently used).
	LFU

	// LRU represents a memory container using replacement algorithm using LRU (least recently used).
	LRU

	// MRU represents a memory container using replacement algorithm using MRU (most recently used).
	MRU

	// ARC represents a memory container using replacement algorithm using ARC (adaptive/adjustable replacement cache).
	ARC
)

Memory Containers.

func (Container) Available

func (c Container) Available() bool

Available reports whether the given container is linked into the binary.

func (Container) NewContainer

func (c Container) NewContainer(capacity int) caching.Container

NewContainer returns a new memory container.

func (Container) Register

func (c Container) Register(function func(int) caching.Container)

Register registers the container container. This is intended to be called from the init function in packages that implement container functions.