muc

README

Memory Usage Controller

A simple library to cope with memory usage in Go programming language.

Documentation

Index

• Constants
• type MemoryUsageController
  • func NewMemoryUsageController(memUsageLimitMb uint, memoryUsedToLimitRatioThreshold float64, ...) (muc *MemoryUsageController, err error)
  • func (muc *MemoryUsageController) CheckFreeMemory() (err error)
  • func (muc *MemoryUsageController) GetMemoryUsage() (usageMb uint, err error)
• type MemoryUsageCriterion
  • func NewMemoryUsageCriterion(c byte) MemoryUsageCriterion
  • func (c MemoryUsageCriterion) IsValid() bool

Constants

const (
	ErrUsageLimitError             = "usage limit error"
	ErrUsageRatioThresholdError    = "usage ratio threshold error"
	ErrUsageIsBeyondLimits         = "memory usage is beyond the limits"
	ErrMemoryUsageCriterionInvalid = "memory usage criterion is not valid"
	ErrMemoryUsageCriterionUnknown = "memory usage criterion is unknown"
)

Errors.

const (
	MemoryUsageCriterionWorkingSet     = 1
	MemoryUsageCriterionResidentMemory = 2
)

Memory Usage Criterion.

const (
	MB = 1 * 1000 * 1000 // 1 M.
)

Types

type MemoryUsageController

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

MemoryUsageController is the memory usage controller.

func NewMemoryUsageController

func NewMemoryUsageController(
	memUsageLimitMb uint,
	memoryUsedToLimitRatioThreshold float64,
	memoryUsageCriterion byte,
	verboseMode bool,
) (muc *MemoryUsageController, err error)

func (*MemoryUsageController) CheckFreeMemory

func (muc *MemoryUsageController) CheckFreeMemory() (err error)

CheckFreeMemory checks free memory.

func (*MemoryUsageController) GetMemoryUsage

func (muc *MemoryUsageController) GetMemoryUsage() (usageMb uint, err error)

GetMemoryUsage gets the memory usage amount. Result is set in MB.

type MemoryUsageCriterion

type MemoryUsageCriterion byte

MemoryUsageCriterion is memory usage criterion.

func NewMemoryUsageCriterion

func NewMemoryUsageCriterion(c byte) MemoryUsageCriterion

func (MemoryUsageCriterion) IsValid

func (c MemoryUsageCriterion) IsValid() bool