singleflight

Documentation

Index

• type Call
  • func NewCall(fn func() (interface{}, error)) *Call
  • func (c *Call) Do() (interface{}, error)
  • func (c *Call) DoChan() <-chan Result
• type Group
  • func (g *Group) Do(key string, fn func() (interface{}, error), forgetAfter time.Duration) (interface{}, error)
  • func (g *Group) DoChan(key string, fn func() (interface{}, error), forgetAfter time.Duration) <-chan Result
  • func (g *Group) Forget(key string)
• type Result

Types

type Call

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

singleflight Call, only call fn once it's a wrapper of sync.Once to store return values

func NewCall

func NewCall(fn func() (interface{}, error)) *Call

func (*Call) Do

func (c *Call) Do() (interface{}, error)

func (*Call) DoChan

func (c *Call) DoChan() <-chan Result

type Group

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

a group of Call, use key to identify

func (*Group) Do

func (g *Group) Do(key string, fn func() (interface{}, error), forgetAfter time.Duration) (interface{}, error)

about forgetAfter: - timer start before fn be called - only make sense if this call not hit cache, so you can't reset forget time - non-positive value means never forget

func (*Group) DoChan

func (g *Group) DoChan(key string, fn func() (interface{}, error), forgetAfter time.Duration) <-chan Result

unblock Do, return a result channel

func (*Group) Forget

func (g *Group) Forget(key string)

type Result

type Result struct {
	Val interface{}
	Err error
}