softref

Documentation

Index

• Variables
• type Pool
  • func NewPool(logger logadapter.WarnLogger) *Pool
  • func (p *Pool) NewSoftRef(resource Resource) (ref *SoftRef, existedPreviously bool)
• type Resource
• type SoftRef

Variables

var DefaultPool = NewPool(&jot.Logger{})

DefaultPool is a global default soft reference pool.

Types

type Pool

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

Pool is used to track soft references to resources.

func NewPool

func NewPool(logger logadapter.WarnLogger) *Pool

NewPool creates a new soft reference pool. 'logger' may be nil.

func (*Pool) NewSoftRef

func (p *Pool) NewSoftRef(resource Resource) (ref *SoftRef, existedPreviously bool)

NewSoftRef returns a SoftRef to the given resource, along with a flag indicating if a reference existed previously.

type Resource

type Resource interface {
	// Key returns a unique key for this resource. Must never change.
	Key() string
	// Release is called when the resource is no longer being referenced by any remaining soft references.
	Release()
}

Resource is a resource that will be used with a pool.

type SoftRef

type SoftRef struct {
	Key      string
	Resource Resource
}

SoftRef is a soft reference to a given resource.